Skip to content

Commit aeeb2f0

Browse files
eksrhaeksrha
committed
add helm docs
1 parent f0a30fe commit aeeb2f0

File tree

9 files changed

+436
-71
lines changed

9 files changed

+436
-71
lines changed

‎.github/workflows/release-charts.yml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ jobs:
1717
- name: Checkout
1818
uses: actions/checkout@v2
1919
with:
20-
ref: main
2120
fetch-depth: 0
2221

2322
- name: Configure Git

‎.github/workflows/update-app-version.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,12 @@ jobs:
5656
steps:
5757
- name: Checkout code
5858
uses: actions/checkout@v2
59+
- name: Install helm-docs @latest
60+
env:
61+
DOCS_VERSION: 1.11.0
62+
run: |
63+
wget https://github.com/norwoodj/helm-docs/releases/download/v${DOCS_VERSION}/helm-docs_${DOCS_VERSION}_Linux_x86_64.tar.gz -O helm-docs.tar.gz
64+
tar -xzf helm-docs.tar.gz
5965
- name: Set appVersion and push
6066
shell: bash
6167
env:
@@ -85,6 +91,8 @@ jobs:
8591
git config user.name "$GITHUB_ACTOR"
8692
git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
8793
94+
./helm-docs -t templates/README.md.gotmpl
95+
8896
git status
8997
git commit -a -m "update chart ${{ needs.check_vars.outputs.chart }} to appVersion ${{ needs.check_vars.outputs.appVersion }}"
9098
git push

‎charts/excalidraw/Chart.yaml‎

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,15 @@ apiVersion: v2
22
name: excalidraw
33
description: A Helm chart for Kubernetes
44

5-
# A chart can be either an 'application' or a 'library' chart.
6-
#
7-
# Application charts are a collection of templates that can be packaged into versioned archives
8-
# to be deployed.
9-
#
10-
# Library charts provide useful utilities or functions for the chart developer. They're included as
11-
# a dependency of application charts to inject those utilities and functions into the rendering
12-
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
135
type: application
146

15-
# This is the chart version. This version number should be incremented each time you make changes
16-
# to the chart and its templates, including the app version.
17-
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.1.0
7+
version: 0.1.1
8+
appVersion: 0.0.3
199

20-
# This is the version number of the application being deployed. This version number should be
21-
# incremented each time you make changes to the application. Versions are not expected to
22-
# follow Semantic Versioning. They should reflect the version the application is using.
23-
# It is recommended to use it with quotes.
24-
appVersion: "0.0.1"
10+
kubeVersion: ">=1.19.0"
11+
12+
home: https://github.com/fullstack-devops/helm-charts/tree/main/charts/excalidraw
13+
sources:
14+
- https://github.com/fullstack-devops/excalidraw
15+
- https://github.com/fullstack-devops/excalidraw/pkgs/container/excalidraw
16+
- https://quay.io/repository/fullstack-devops/excalidraw

‎charts/excalidraw/README.md‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# excalidraw
2+
3+
![Version: 0.1.1](https://img.shields.io/badge/Version-0.1.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.0.3](https://img.shields.io/badge/AppVersion-0.0.3-informational?style=flat-square)
4+
5+
A Helm chart for Kubernetes
6+
7+
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/fullstack-devops/helm-charts/issues/new/choose)**
8+
9+
## Source Code
10+
11+
* <https://github.com/fullstack-devops/excalidraw>
12+
* <https://github.com/fullstack-devops/excalidraw/pkgs/container/excalidraw>
13+
* <https://quay.io/repository/fullstack-devops/excalidraw>
14+
15+
## Requirements
16+
17+
- Kubernetes: `>=1.19.0`
18+
- Helm 3.2.0+
19+
- PV provisioner support in the underlying infrastructure
20+
21+
## Dependencies
22+
23+
| Repository | Name | Version |
24+
|------------|------|---------|
25+
26+
## TL;DR
27+
28+
```console
29+
helm repo add fs-devops https://fullstack-devops.github.io/helm-charts/
30+
helm repo update
31+
helm install excalidraw fs-devops/excalidraw
32+
```
33+
34+
## Installing the Chart
35+
36+
To install the chart with the release name `excalidraw`
37+
38+
```console
39+
helm install excalidraw fs-devops/excalidraw
40+
```
41+
42+
## Uninstalling the Chart
43+
44+
To uninstall the `excalidraw` deployment
45+
46+
```console
47+
helm uninstall excalidraw
48+
```
49+
50+
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
51+
52+
## Configuration
53+
54+
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
55+
56+
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
57+
58+
```console
59+
helm install excalidraw \
60+
--set env.TZ="America/New York" \
61+
fs-devops/excalidraw
62+
```
63+
64+
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
65+
66+
```console
67+
helm install excalidraw fs-devops/excalidraw -f values.yaml
68+
```
69+
70+
## Values
71+
72+
| Key | Type | Default | Description |
73+
|-----|------|---------|-------------|
74+
| affinity | object | `{}` | |
75+
| autoscaling.enabled | bool | `false` | |
76+
| autoscaling.maxReplicas | int | `100` | |
77+
| autoscaling.minReplicas | int | `1` | |
78+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
79+
| fullnameOverride | string | `""` | |
80+
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
81+
| image.repository | string | `"quay.io/fullstack-devops/excalidraw"` | image repository |
82+
| image.tag | string | `""` | image tag (default is the chart appVersion) |
83+
| imagePullSecrets | list | `[]` | |
84+
| ingress.annotations | dict | `{}` | Custom Ingress annotations |
85+
| ingress.className | string | `""` | |
86+
| ingress.enabled | bool | `false` | Set to true to generate Ingress resource |
87+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
88+
| ingress.hosts[0].paths[0].path | string | `"/"` | |
89+
| ingress.hosts[0].paths[0].pathType | string | `"ImplementationSpecific"` | |
90+
| ingress.tls | list | `[]` | |
91+
| nameOverride | string | `""` | |
92+
| nodeSelector | object | `{}` | |
93+
| podAnnotations | object | `{}` | |
94+
| podSecurityContext | object | `{}` | |
95+
| replicaCount | int | `1` | |
96+
| resources.limits.cpu | string | `"300m"` | |
97+
| resources.limits.memory | string | `"512Mi"` | |
98+
| resources.requests.cpu | string | `"200m"` | |
99+
| resources.requests.memory | string | `"256Mi"` | |
100+
| securityContext.readOnlyRootFilesystem | bool | `false` | |
101+
| securityContext.runAsNonRoot | bool | `true` | |
102+
| securityContext.runAsUser | int | `101` | |
103+
| service.port | int | `80` | Specify service port |
104+
| service.type | string | `"ClusterIP"` | |
105+
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account |
106+
| serviceAccount.create | bool | `false` | Specifies whether a service account should be created |
107+
| serviceAccount.name | string | `""` | If not set and create is true, a name is generated using the fullname template |
108+
| tolerations | list | `[]` | |
109+
110+
----------------------------------------------
111+
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

‎charts/excalidraw/values.yaml‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,23 @@
55
replicaCount: 1
66

77
image:
8-
repository: "quay.io/fullstack-devops/excalidraw"
9-
pullPolicy: IfNotPresent
10-
# Overrides the image tag whose default is the chart appVersion.
8+
# -- image repository
9+
repository: quay.io/fullstack-devops/excalidraw
10+
# -- image tag (default is the chart appVersion)
1111
tag: ""
12+
# -- image pull policy
13+
pullPolicy: IfNotPresent
1214

1315
imagePullSecrets: []
1416
nameOverride: ""
1517
fullnameOverride: ""
1618

1719
serviceAccount:
18-
# Specifies whether a service account should be created
20+
# -- Specifies whether a service account should be created
1921
create: false
20-
# Annotations to add to the service account
22+
# -- Annotations to add to the service account
2123
annotations: {}
22-
# The name of the service account to use.
23-
# If not set and create is true, a name is generated using the fullname template
24+
# -- If not set and create is true, a name is generated using the fullname template
2425
name: ""
2526

2627
podAnnotations: {}
@@ -39,11 +40,14 @@ securityContext:
3940

4041
service:
4142
type: ClusterIP
43+
# -- (int) Specify service port
4244
port: 80
4345

4446
ingress:
47+
# -- (bool) Set to true to generate Ingress resource
4548
enabled: false
4649
className: ""
50+
# -- (dict) Custom Ingress annotations
4751
annotations:
4852
{}
4953
# kubernetes.io/ingress.class: nginx
@@ -64,10 +68,10 @@ resources:
6468
# resources, such as Minikube. If you do want to specify resources, uncomment the following
6569
# lines, adjust them as necessary, and remove the curly braces after 'resources:'.
6670
limits:
67-
cpu: 1
71+
cpu: 300m
6872
memory: 512Mi
6973
requests:
70-
cpu: 400m
74+
cpu: 200m
7175
memory: 256Mi
7276

7377
autoscaling:

‎charts/github-actions-runner/Chart.yaml‎

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,15 @@ apiVersion: v2
22
name: github-actions-runner
33
description: A Helm chart for Kubernetes
44

5-
# A chart can be either an 'application' or a 'library' chart.
6-
#
7-
# Application charts are a collection of templates that can be packaged into versioned archives
8-
# to be deployed.
9-
#
10-
# Library charts provide useful utilities or functions for the chart developer. They're included as
11-
# a dependency of application charts to inject those utilities and functions into the rendering
12-
# pipeline. Library charts do not define any templates and therefore cannot be deployed.
135
type: application
146

15-
# This is the chart version. This version number should be incremented each time you make changes
16-
# to the chart and its templates, including the app version.
17-
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.3.10
19-
20-
# This is the version number of the application being deployed. This version number should be
21-
# incremented each time you make changes to the application. Versions are not expected to
22-
# follow Semantic Versioning. They should reflect the version the application is using.
23-
# It is recommended to use it with quotes.
7+
version: 0.3.11
248
appVersion: 0.7.0
9+
10+
kubeVersion: ">=1.19.0"
11+
12+
home: https://github.com/fullstack-devops/helm-charts/tree/main/charts/github-actions-runner
13+
sources:
14+
- https://github.com/fullstack-devops/github-actions-runner
15+
- https://github.com/fullstack-devops/github-actions-runner/pkgs/container/github-actions-runner
16+
- https://quay.io/repository/fullstack-devops/github-actions-runner

‎charts/github-actions-runner/README.md‎

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# github-actions-runner
2+
3+
![Version: 0.3.11](https://img.shields.io/badge/Version-0.3.11-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.7.0](https://img.shields.io/badge/AppVersion-0.7.0-informational?style=flat-square)
4+
5+
A Helm chart for Kubernetes
6+
7+
**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/fullstack-devops/helm-charts/issues/new/choose)**
8+
9+
## Source Code
10+
11+
* <https://github.com/fullstack-devops/github-actions-runner>
12+
* <https://github.com/fullstack-devops/github-actions-runner/pkgs/container/github-actions-runner>
13+
* <https://quay.io/repository/fullstack-devops/github-actions-runner>
14+
15+
## Requirements
16+
17+
- Kubernetes: `>=1.19.0`
18+
- Helm 3.2.0+
19+
- PV provisioner support in the underlying infrastructure
20+
21+
## Dependencies
22+
23+
| Repository | Name | Version |
24+
|------------|------|---------|
25+
26+
## TL;DR
27+
28+
```console
29+
helm repo add fs-devops https://fullstack-devops.github.io/helm-charts/
30+
helm repo update
31+
helm install github-actions-runner fs-devops/github-actions-runner
32+
```
33+
34+
## Installing the Chart
35+
36+
To install the chart with the release name `github-actions-runner`
37+
38+
```console
39+
helm install github-actions-runner fs-devops/github-actions-runner
40+
```
41+
42+
## Uninstalling the Chart
43+
44+
To uninstall the `github-actions-runner` deployment
45+
46+
```console
47+
helm uninstall github-actions-runner
48+
```
49+
50+
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
51+
52+
## Configuration
53+
54+
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
55+
56+
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
57+
58+
```console
59+
helm install github-actions-runner \
60+
--set env.TZ="America/New York" \
61+
fs-devops/github-actions-runner
62+
```
63+
64+
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
65+
66+
```console
67+
helm install github-actions-runner fs-devops/github-actions-runner -f values.yaml
68+
```
69+
70+
## Values
71+
72+
| Key | Type | Default | Description |
73+
|-----|------|---------|-------------|
74+
| affinity | object | `{}` | |
75+
| autoscaling.enabled | bool | `false` | |
76+
| autoscaling.maxReplicas | int | `20` | |
77+
| autoscaling.minReplicas | int | `1` | |
78+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
79+
| fullnameOverride | string | `""` | |
80+
| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
81+
| image.repository | string | `"ghcr.io/fullstack-devops/github-actions-runner"` | image repository |
82+
| image.tag | string | `""` | image tag (default is the chart appVersion) |
83+
| imagePullSecrets | list | `[]` | |
84+
| nameOverride | string | `""` | |
85+
| nodeSelector | object | `{}` | |
86+
| podAnnotations | object | `{}` | |
87+
| podSecurityContext | object | `{}` | |
88+
| replicaCount | int | `1` | |
89+
| resources | object | `{}` | |
90+
| runner.additionalFiles.maven.settingsXml | tpl/dict | | example settings.xml, will be placed in global .m2 folder |
91+
| runner.customCerts.configMapRef | string | `""` | |
92+
| runner.env | list | `[]` | inject the runner custom env variables |
93+
| runner.flavor.name | string | `"fullstacked"` | |
94+
| runner.flavor.override | bool | `false` | if override: true -> the runner.flavor will be ignored and image.repository and image.tag will be leading |
95+
| runner.github.accessToken | string | `""` | |
96+
| runner.github.enterpriseApiUrl | string | `""` | |
97+
| runner.github.enterpriseUrl | string | `""` | |
98+
| runner.github.organisation | string | `"fullstack-devpos"` | |
99+
| runner.github.repository | string | `""` | |
100+
| runner.kaniko.enabled | bool | `false` | |
101+
| runner.kaniko.image.repository | string | `""` | |
102+
| runner.kaniko.mountedSecret | string | `""` | |
103+
| runner.labels | string | `""` | |
104+
| securityContext.readOnlyRootFilesystem | bool | `false` | |
105+
| securityContext.runAsNonRoot | bool | `true` | |
106+
| securityContext.runAsUser | int | `1000` | |
107+
| serviceAccount.annotations | object | `{}` | |
108+
| serviceAccount.create | bool | `false` | |
109+
| serviceAccount.name | string | `""` | |
110+
| tolerations | list | `[]` | |
111+
112+
----------------------------------------------
113+
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

0 commit comments

Comments
 (0)