Skip to content

Commit 1380620

Browse files
author
kjthorpe18
committed
Update Helm section
1 parent a413e82 commit 1380620

File tree

1 file changed

+55
-32
lines changed

1 file changed

+55
-32
lines changed

h.helm.md

Lines changed: 55 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,116 +10,139 @@
1010
<p>
1111

1212
```bash
13-
helm create chart-test ## this would create a helm
13+
helm create chart-test ## this creates a basic helm chart
1414
```
1515

1616
</p>
1717
</details>
1818

19-
### Running a Helm chart
20-
19+
### Add the Bitnami repo at https://charts.bitnami.com/bitnami to Helm
2120
<details><summary>show</summary>
2221
<p>
2322

2423
```bash
25-
helm install -f myvalues.yaml myredis ./redis
24+
helm repo add bitnami https://charts.bitnami.com/bitnami
25+
```
26+
27+
Show the list of installed repositories:
28+
```bash
29+
helm repo list
2630
```
2731

2832
</p>
2933
</details>
3034

31-
### Find pending Helm deployments on all namespaces
35+
### Using Helm repo
3236

3337
<details><summary>show</summary>
3438
<p>
3539

40+
Add, list, remove, update and index chart repos
41+
3642
```bash
37-
helm list --pending -A
43+
helm repo add [NAME] [URL] [flags]
44+
45+
helm repo list / helm repo ls
46+
47+
helm repo remove [REPO1] [flags]
48+
49+
helm repo update / helm repo up
50+
51+
helm repo update [REPO1] [flags]
52+
53+
helm repo index [DIR] [flags]
3854
```
3955

4056
</p>
4157
</details>
4258

43-
### Uninstall a Helm release
44-
59+
### Search Repositories for a Chart
4560
<details><summary>show</summary>
4661
<p>
4762

63+
Search all installed repositories for a chart
64+
4865
```bash
49-
helm uninstall -n namespace release_name
66+
helm search repo [keyword]
5067
```
5168

5269
</p>
5370
</details>
5471

55-
### Upgrading a Helm chart
72+
### Download a Helm chart from a repository
5673

5774
<details><summary>show</summary>
5875
<p>
5976

6077
```bash
61-
helm upgrade -f myvalues.yaml -f override.yaml redis ./redis
78+
helm pull [chart URL | repo/chartname] [...] [flags] ## this would download a chart, but not install it
79+
helm pull --untar [repo/chartname] # untar the chart after downloading it (does not create a release)
6280
```
6381

6482
</p>
6583
</details>
6684

67-
### Using Helm repo
85+
### Create a Release
6886

6987
<details><summary>show</summary>
7088
<p>
7189

72-
Add, list, remove, update and index chart repos
90+
Create a release, creating the resources defined in the chart
7391

7492
```bash
75-
helm repo add [NAME] [URL] [flags]
76-
77-
helm repo list / helm repo ls
93+
helm install -f myvalues.yaml myredis ./redis # creates a release from a local chart
94+
helm install [releasename] [repo/chartname] # creates a release from a chart in a repo
95+
# Example: helm install my-app bitnami/nginx
96+
```
7897

79-
helm repo remove [REPO1] [flags]
98+
</p>
99+
</details>
80100

81-
helm repo update / helm repo up
101+
### Find pending Helm deployments on all namespaces
82102

83-
helm repo update [REPO1] [flags]
103+
<details><summary>show</summary>
104+
<p>
84105

85-
helm repo index [DIR] [flags]
106+
```bash
107+
helm list --pending -A
86108
```
87109

88110
</p>
89111
</details>
90112

91-
### Download a Helm chart from a repository
113+
### Uninstall a Helm release
92114

93115
<details><summary>show</summary>
94116
<p>
95117

96118
```bash
97-
helm pull [chart URL | repo/chartname] [...] [flags] ## this would download a helm, not install
98-
helm pull --untar [rep/chartname] # untar the chart after downloading it
119+
helm uninstall -n namespace releasename
99120
```
100121

101122
</p>
102123
</details>
103124

104-
### Add the Bitnami repo at https://charts.bitnami.com/bitnami to Helm
125+
### Upgrading a Helm chart
126+
105127
<details><summary>show</summary>
106128
<p>
107-
129+
108130
```bash
109-
helm repo add bitnami https://charts.bitnami.com/bitnami
131+
helm upgrade [releasename] [repo/chartname] # Upgrade a chart from a repository
132+
helm upgrade -f myvalues.yaml -f override.yaml redis ./redis # Upgrade a local chart from a file
110133
```
111-
134+
112135
</p>
113136
</details>
114137

115-
### Write the contents of the values.yaml file of the `bitnami/node` chart to standard output
138+
### Write the contents of the values.yaml of a chart to standard output
116139
<details><summary>show</summary>
117140
<p>
118-
141+
119142
```bash
120-
helm show values bitnami/node
143+
helm show values [repo/chartname]
121144
```
122-
145+
123146
</p>
124147
</details>
125148

@@ -140,7 +163,7 @@ which returns
140163
## @param replicaCount Specify the number of replicas for the application
141164
replicaCount: 1
142165
```
143-
166+
144167
We can use the `--set` argument during installation to override attribute values. Hence, to set the replica count to 5, we need to run
145168
```bash
146169
helm install mynode bitnami/node --set replicaCount=5

0 commit comments

Comments
 (0)