Skip to content

Commit 227c361

Browse files
RandoooomRandoooom
committed
ci: auto generate helm-docs
1 parent c6e7e42 commit 227c361

File tree

5 files changed

+131
-62
lines changed

5 files changed

+131
-62
lines changed

‎Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ docs: core_generate
1111
lib_build: core_generate
1212
pnpm run -C lib build
1313

14+
helm_docs:
15+
cd charts/feedback-fusion && helm-docs
16+
cp charts/feedback-fusion/README.md docs/docs/deployment/helm.md
17+
1418
docs_build: lib_build
1519
cd ./docs && pnpm run -C lib docs:build
1620

‎charts/feedback-fusion/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# feedback-fusion
2+
3+
Feedback-Fusion helm chart
4+
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.0](https://img.shields.io/badge/AppVersion-0.2.0-informational?style=flat-square)
6+
7+
## Installing the Chart
8+
9+
To install the chart use the following commands:
10+
11+
```sh
12+
helm repo add feedback-fusion https://onelitefeathernet.github.io/feedback-fusion/
13+
helm repo update
14+
```
15+
16+
## Values
17+
18+
| Key | Type | Default | Description |
19+
|-----|------|---------|-------------|
20+
| affinity | object | `{}` | |
21+
| feedbackFusion.config.secret | string | `"feedback-fusion-config"` | the secret containing the config.yaml For all configuration options see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/configuration.html |
22+
| feedbackFusion.log | string | `"INFO"` | see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/observability/logging.html |
23+
| fullnameOverride | string | `""` | |
24+
| image.pullPolicy | string | `"IfNotPresent"` | |
25+
| image.repository | string | `"ghcr.io/onelitefeathernet/feedback-fusion"` | |
26+
| image.tag | string | `""` | |
27+
| image.testRepository | string | `"ghcr.io/onelitefeathernet/feedback-fusion-integration"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| ingress.annotations | object | `{}` | |
30+
| ingress.className | string | `""` | |
31+
| ingress.enabled | bool | `false` | |
32+
| ingress.hosts | string | `nil` | |
33+
| ingress.tls | list | `[]` | |
34+
| livenessProbe.grpc.port | int | `8000` | |
35+
| livenessProbe.periodSeconds | int | `5` | |
36+
| nameOverride | string | `""` | |
37+
| nodeSelector | object | `{}` | |
38+
| podAnnotations | object | `{}` | |
39+
| podLabels | object | `{}` | |
40+
| podSecurityContext | object | `{}` | |
41+
| replicaCount | int | `1` | |
42+
| resources | object | `{}` | |
43+
| securityContext | object | `{}` | |
44+
| service.type | string | `"ClusterIP"` | |
45+
| serviceAccount.annotations | object | `{}` | |
46+
| serviceAccount.automount | bool | `true` | |
47+
| serviceAccount.create | bool | `true` | |
48+
| serviceAccount.name | string | `""` | |
49+
| startupProbe.failureThreshold | int | `10` | |
50+
| startupProbe.grpc.port | int | `8000` | |
51+
| startupProbe.periodSeconds | int | `2` | |
52+
| tolerations | list | `[]` | |
53+
| volumeMounts | list | `[]` | |
54+
| volumes | list | `[]` | |
55+
56+
----------------------------------------------
57+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/feedback-fusion/README.md.gotmpl‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.description" . }}
3+
4+
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
5+
6+
## Installing the Chart
7+
8+
To install the chart use the following commands:
9+
10+
```sh
11+
helm repo add feedback-fusion https://onelitefeathernet.github.io/feedback-fusion/
12+
helm repo update
13+
```
14+
15+
{{ template "chart.requirementsSection" . }}
16+
17+
{{ template "chart.valuesSection" . }}
18+
19+
{{ template "helm-docs.versionFooter" . }}

‎charts/feedback-fusion/values.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,11 @@ tolerations: []
9292

9393
affinity: {}
9494

95+
# - Feedback-Fusion specific settings
9596
feedbackFusion:
97+
# -- see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/observability/logging.html
9698
log: INFO
9799
config:
98-
# with config.yaml as key
100+
# -- the secret containing the config.yaml
101+
# For all configuration options see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/configuration.html
99102
secret: feedback-fusion-config

‎docs/docs/deployment/helm.md‎

Lines changed: 47 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,57 @@
1+
# feedback-fusion
12

2-
# Deployment via Helm
3+
Feedback-Fusion helm chart
34

4-
## Prerequisites
5+
![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.2.0](https://img.shields.io/badge/AppVersion-0.2.0-informational?style=flat-square)
56

6-
- Helm installed on your local machine. [Install Helm](https://helm.sh/docs/intro/install/)
7-
- A running Kubernetes cluster. [Set up a Kubernetes cluster](https://kubernetes.io/docs/setup/)
8-
- A running database of your choice. [Supported Databases](/docs/configuration#database-configuration)
7+
## Installing the Chart
98

10-
## Adding the Helm Repository
11-
First, add the `feedback-fusion` Helm repository to your local Helm client:
9+
To install the chart use the following commands:
1210

1311
```sh
1412
helm repo add feedback-fusion https://onelitefeathernet.github.io/feedback-fusion/
1513
helm repo update
1614
```
1715

18-
## Configuration
19-
Before installing the chart, you need to create a Kubernetes secret named `feedback-fusion-config`.
20-
Refer to the [configuration documentation](/docs/configuration) for the fields that need to be set.
21-
22-
#### Chart configuration
23-
24-
| Parameter | Description | Default |
25-
|---------------------------------------------|-----------------------------------------------------------------------------------------------|-----------------------------------------------------------|
26-
| `replicaCount` | Number of replicas for the deployment | `1` |
27-
| `image.repository` | Image repository | `ghcr.io/onelitefeathernet/feedback-fusion` |
28-
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
29-
| `image.tag` | Image tag (overrides the chart appVersion) | `""` |
30-
| `imagePullSecrets` | List of image pull secrets | `[]` |
31-
| `nameOverride` | Override the name of the chart | `""` |
32-
| `fullnameOverride` | Override the full name of the chart | `""` |
33-
| `serviceAccount.create` | Specifies whether a service account should be created | `true` |
34-
| `serviceAccount.automount` | Automatically mount a ServiceAccount's API credentials | `true` |
35-
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |
36-
| `serviceAccount.name` | The name of the service account to use | `""` |
37-
| `podAnnotations` | Annotations to add to the pod | `{}` |
38-
| `podLabels` | Labels to add to the pod | `{}` |
39-
| `podSecurityContext` | Security context for the pod | `{}` |
40-
| `securityContext` | Security context for the container | `{}` |
41-
| `service.type` | Type of service | `ClusterIP` |
42-
| `ingress.enabled` | Enable ingress controller resource | `false` |
43-
| `ingress.className` | Ingress class name | `""` |
44-
| `ingress.annotations` | Ingress annotations | `{}` |
45-
| `ingress.hosts` | List of ingress hosts | `[]` |
46-
| `ingress.tls` | List of TLS configurations for ingress | `[]` |
47-
| `resources` | Resource requests and limits | `{}` |
48-
| `livenessProbe.grpc.port` | GRPC port for liveness probe | `8000` |
49-
| `livenessProbe.periodSeconds` | Period seconds for liveness probe | `5` |
50-
| `startupProbe.grpc.port` | GRPC port for startup probe | `8000` |
51-
| `startupProbe.periodSeconds` | Period seconds for startup probe | `2` |
52-
| `startupProbe.failureThreshold` | Failure threshold for startup probe | `10` |
53-
| `volumes` | Additional volumes for the deployment | `[]` |
54-
| `volumeMounts` | Additional volume mounts for the deployment | `[]` |
55-
| `nodeSelector` | Node selector for pod assignment | `{}` |
56-
| `tolerations` | Tolerations for pod assignment | `[]` |
57-
| `affinity` | Affinity settings for pod assignment | `{}` |
58-
| `feedbackFusion.preset.enabled` | Enable preset configuration | `false` |
59-
| `feedbackFusion.preset.name` | Name of the preset configuration | `feedback-fusion-preset` |
60-
| `feedbackFusion.preset.create` | Create preset configuration | `false` |
61-
| `feedbackFusion.preset.data` | Preset data | `{}` [Preset configuration](/docs/configuration#presets) |
62-
| `feedbackFusion.config.secret` | Name of the secret containing configuration | `feedback-fusion-config` |
63-
| `feedbackFusion.testSecret` | Name of the secret containing configuration for the integration test | `feedback-fusion-integration-test` |
64-
65-
## Install
66-
67-
```sh
68-
helm install feedback-fusion feedback-fusion/feedback-fusion --wait --atomic
69-
```
70-
71-
Your instance should now be up and running :)
16+
## Values
17+
18+
| Key | Type | Default | Description |
19+
|-----|------|---------|-------------|
20+
| affinity | object | `{}` | |
21+
| feedbackFusion.config.secret | string | `"feedback-fusion-config"` | the secret containing the config.yaml For all configuration options see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/configuration.html |
22+
| feedbackFusion.log | string | `"INFO"` | see https://onelitefeathernet.github.io/feedback-fusion/nightly/docs/observability/logging.html |
23+
| fullnameOverride | string | `""` | |
24+
| image.pullPolicy | string | `"IfNotPresent"` | |
25+
| image.repository | string | `"ghcr.io/onelitefeathernet/feedback-fusion"` | |
26+
| image.tag | string | `""` | |
27+
| image.testRepository | string | `"ghcr.io/onelitefeathernet/feedback-fusion-integration"` | |
28+
| imagePullSecrets | list | `[]` | |
29+
| ingress.annotations | object | `{}` | |
30+
| ingress.className | string | `""` | |
31+
| ingress.enabled | bool | `false` | |
32+
| ingress.hosts | string | `nil` | |
33+
| ingress.tls | list | `[]` | |
34+
| livenessProbe.grpc.port | int | `8000` | |
35+
| livenessProbe.periodSeconds | int | `5` | |
36+
| nameOverride | string | `""` | |
37+
| nodeSelector | object | `{}` | |
38+
| podAnnotations | object | `{}` | |
39+
| podLabels | object | `{}` | |
40+
| podSecurityContext | object | `{}` | |
41+
| replicaCount | int | `1` | |
42+
| resources | object | `{}` | |
43+
| securityContext | object | `{}` | |
44+
| service.type | string | `"ClusterIP"` | |
45+
| serviceAccount.annotations | object | `{}` | |
46+
| serviceAccount.automount | bool | `true` | |
47+
| serviceAccount.create | bool | `true` | |
48+
| serviceAccount.name | string | `""` | |
49+
| startupProbe.failureThreshold | int | `10` | |
50+
| startupProbe.grpc.port | int | `8000` | |
51+
| startupProbe.periodSeconds | int | `2` | |
52+
| tolerations | list | `[]` | |
53+
| volumeMounts | list | `[]` | |
54+
| volumes | list | `[]` | |
55+
56+
----------------------------------------------
57+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)