Skip to content

Commit 2dbdb60

Browse files
benjaminjbcbandy
andauthored
Add docs for helm oci (CrunchyData#3493)
Co-authored-by: Chris Bandy <bandy.chris@gmail.com> Issue: [sc-16938] Co-authored-by: Chris Bandy <bandy.chris@gmail.com>
1 parent 9d2275e commit 2dbdb60

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

docs/config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ postgresVersion14 = "14.6"
5252
postgresVersion13 = "13.9"
5353
postgresVersion12 = "12.13"
5454
postgresVersion11 = "11.18"
55+
operatorHelmRepository = "oci://registry.developers.crunchydata.com/crunchydata/pgo"
5556

5657
[outputs]
5758
home = [ "HTML", "RSS", "JSON"]

docs/content/installation/helm.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ weight: 20
99

1010
This section provides instructions for installing and configuring PGO using Helm.
1111

12+
There are two sources for the PGO Helm chart:
13+
* the Postgres Operator examples repo;
14+
* the Helm chart hosted on the Crunchy container registry, which supports direct Helm installs.
15+
16+
# The Postgres Operator Examples repo
17+
1218
## Prerequisites
1319

1420
First, go to GitHub and [fork the Postgres Operator examples](https://github.com/CrunchyData/postgres-operator-examples/fork)
@@ -103,3 +109,48 @@ Helm [leaves the CRDs][helm-crd-limits] in place. You can remove them with `kube
103109
```shell
104110
kubectl delete -f helm/install/crds
105111
```
112+
113+
# The Crunchy Container Registry
114+
115+
## Installing directly from the registry
116+
117+
Crunchy Data hosts an OCI registry that `helm` can use directly.
118+
(Not all `helm` commands support OCI registries. For more information on
119+
which commands can be used, see [the Helm documentation](https://helm.sh/docs/topics/registries/).)
120+
121+
You can install PGO directly from the registry using the `helm install` command:
122+
123+
```
124+
helm install pgo {{< param operatorHelmRepository >}}
125+
```
126+
127+
Or to see what values are set in the default `values.yaml` before installing, you could run a
128+
`helm show` command just as you would with any other registry:
129+
130+
```
131+
helm show values {{< param operatorHelmRepository >}}
132+
```
133+
134+
## Downloading from the registry
135+
136+
Rather than deploying directly from the Crunchy registry, you can instead use the registry as the
137+
source for the Helm chart.
138+
139+
To do so, download the Helm chart from the Crunchy Container Registry:
140+
141+
```
142+
# To pull down the most recent Helm chart
143+
helm pull {{< param operatorHelmRepository >}}
144+
145+
# To pull down a specific Helm chart
146+
helm pull {{< param operatorHelmRepository >}} --version {{< param operatorVersion >}}
147+
```
148+
149+
Once the Helm chart has been downloaded, uncompress the bundle
150+
151+
```
152+
tar -xvf pgo-{{< param operatorVersion >}}.tgz
153+
```
154+
155+
And from there, you can follow the instructions above on setting the [Configuration](#configuration)
156+
and installing a local Helm chart.

0 commit comments

Comments
 (0)