Skip to content

Commit c4b7fdb

Browse files
authored
Merge pull request #9 from vdice/docs/add-registry-install-notes
docs(README.md): add registry install notes in anticipation of v0.1.0 release
2 parents e654a7f + f1332ad commit c4b7fdb

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -133,20 +133,29 @@ that prevents the gateway from using this token for impersonating other gateways
133133

134134
### 3. Install the GitHub Gateway
135135

136-
For now, you can only obtain the Helm chart for the Brigade GitHub Gateway by
137-
cloning this repository:
136+
For now, we're using the [GitHub Container Registry](https://ghcr.io) (which is
137+
an [OCI registry](https://helm.sh/docs/topics/registries/)) to host our Helm
138+
chart. Helm 3 has _experimental_ support for OCI registries. In the event that
139+
the Helm 3 dependency proves troublesome for Brigade users, or in the event that
140+
this experimental feature goes away, or isn't working like we'd hope, we will
141+
revisit this choice before going GA.
138142

139-
```console
140-
$ git clone [email protected]:brigadecore/brigade-github-gateway.git
143+
To fetch the Brigade GitHub Gateway chart from the registry:
141144

142-
$ cd brigade-github-gateway/charts/brigade-github-gateway
145+
```console
146+
export HELM_EXPERIMENTAL_OCI=1
147+
helm chart pull ghcr.io/brigadecore/brigade-github-gateway:v0.1.0
148+
helm chart export ghcr.io/brigadecore/brigade-github-gateway:v0.1.0 -d ~/charts
143149
```
144150

151+
As this chart requires custom configuration as described above to function
152+
properly, we'll need to create a chart values file with said config.
153+
145154
Use the following command to extract the full set of configuration options into
146155
a file you can modify:
147156

148157
```console
149-
$ helm inspect values . > my-values.yaml
158+
$ helm inspect values ~/charts/brigade-github-gateway > my-values.yaml
150159
```
151160

152161
Edit `my-values.yaml`, making the following changes:
@@ -169,7 +178,7 @@ Save your changes to `my-values.yaml` and use the following command to install
169178
the gateway using the above customizations:
170179

171180
```console
172-
$ helm install brigade-github-gateway . \
181+
$ helm install brigade-github-gateway ~/charts/brigade-github-gateway \
173182
--create-namespace \
174183
--namespace brigade-github-gateway \
175184
--values my-values.yaml

0 commit comments

Comments
 (0)