Skip to content

Commit 08410a7

Browse files
committed
fix docs
1 parent 54249d1 commit 08410a7

File tree

3 files changed

+107
-17
lines changed

3 files changed

+107
-17
lines changed

charts/excalidraw/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: A Helm chart for Kubernetes
44

55
type: application
66

7-
version: 0.2.7
7+
version: 0.2.8
88
appVersion: 0.0.7
99

1010
kubeVersion: ">=1.19.0"

charts/excalidraw/README.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@
44

55
A Helm chart for Kubernetes
66

7-
**Homepage:** <https://github.com/fullstack-devops/helm-charts/tree/main/charts/excalidraw>
8-
9-
## Maintainers
10-
11-
| Name | Email | Url |
12-
| ---- | ------ | --- |
13-
| eksrha | <[email protected]> | <https://github.com/eksrha> |
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)**
148

159
## Source Code
1610

@@ -20,7 +14,58 @@ A Helm chart for Kubernetes
2014

2115
## Requirements
2216

23-
Kubernetes: `>=1.19.0`
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+
```
2469

2570
## Values
2671

charts/github-actions-runner/README.md

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@
44

55
A Helm chart for Kubernetes
66

7-
**Homepage:** <https://github.com/fullstack-devops/helm-charts/tree/main/charts/github-actions-runner>
8-
9-
## Maintainers
10-
11-
| Name | Email | Url |
12-
| ---- | ------ | --- |
13-
| eksrha | <[email protected]> | <https://github.com/eksrha> |
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)**
148

159
## Source Code
1610

@@ -19,7 +13,58 @@ A Helm chart for Kubernetes
1913

2014
## Requirements
2115

22-
Kubernetes: `>=1.19.0`
16+
- Kubernetes: `>=1.19.0`
17+
- Helm 3.2.0+
18+
- PV provisioner support in the underlying infrastructure
19+
20+
## Dependencies
21+
22+
| Repository | Name | Version |
23+
|------------|------|---------|
24+
25+
## TL;DR
26+
27+
```console
28+
helm repo add fs-devops https://fullstack-devops.github.io/helm-charts/
29+
helm repo update
30+
helm install github-actions-runner fs-devops/github-actions-runner
31+
```
32+
33+
## Installing the Chart
34+
35+
To install the chart with the release name `github-actions-runner`
36+
37+
```console
38+
helm install github-actions-runner fs-devops/github-actions-runner
39+
```
40+
41+
## Uninstalling the Chart
42+
43+
To uninstall the `github-actions-runner` deployment
44+
45+
```console
46+
helm uninstall github-actions-runner
47+
```
48+
49+
The command removes all the Kubernetes components associated with the chart **including persistent volumes** and deletes the release.
50+
51+
## Configuration
52+
53+
Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
54+
55+
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
56+
57+
```console
58+
helm install github-actions-runner \
59+
--set env.TZ="America/New York" \
60+
fs-devops/github-actions-runner
61+
```
62+
63+
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart.
64+
65+
```console
66+
helm install github-actions-runner fs-devops/github-actions-runner -f values.yaml
67+
```
2368

2469
## Values
2570

0 commit comments

Comments
 (0)