Skip to content

Commit d0cd9de

Browse files
committed
Add note on ghcr.io auth errors and on chart source/versions
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent 87c1319 commit d0cd9de

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

docs/uplink/become-a-provider.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ kubectl create namespace inlets
4949

5050
Create the required secret with your inlets-uplink license.
5151

52-
!!! note
52+
!!! note "Check that your license key is in lower-case"
5353

5454
There is a known issue with LemonSqueezy where the UI will copy the license key in lower-case, it needs to be converted to upper-case before being used with Inlets Uplink.
5555

@@ -166,6 +166,14 @@ Make sure to replace the domain and email with your actual domain name and email
166166
167167
### Deploy with Helm
168168
169+
!!! note "The chart is served through a container registry (OCI), not GitHub pages"
170+
171+
Many Helm charts are served over GitHub pages, from a public repository, making it easy to browse and read the source code. We are using an OCI artifact in a container registry, which makes for a more modern alternative. If you want to browse the source, you can simply run `helm template` instead of `helm upgrade`.
172+
173+
**Unauthorized?**
174+
175+
The chart artifacts are public and do not require authentication, however if you run into an "Access denied" or authorization error when interacting with `ghcr.io`, try running `helm registry login ghcr.io` to refresh your credentials, or `docker logout ghcr.io`.
176+
169177
The Helm chart is called *inlets-uplink-provider*, you can deploy it using the custom values.yaml file created above:
170178
171179
```bash
@@ -177,9 +185,19 @@ helm upgrade --install inlets-uplink \
177185
178186
If you want to pin the version of the Helm chart, you can do so with the `--version` flag.
179187
180-
You can browse [all versions of the Helm chart on GitHub](https://ghcr.io/openfaasltd/inlets-uplink-provider)
188+
**Where can I see the various options for values.yaml?**
189+
190+
All of the various options for the Helm chart are documented in the [configuration reference](#configuration-reference).
191+
192+
**How can I view the source code?**
193+
194+
See the note on `helm template` under the [configuration reference](#configuration-reference).
195+
196+
**How can I find the latest version of the chart?**
197+
198+
If you omit a version, Helm will use the latest published OCI artifact, however if you do want to pin it, you can browse [all versions of the Helm chart on GitHub](https://ghcr.io/openfaasltd/inlets-uplink-provider)
181199
182-
Alternatively, you can get the list of tags, including the latest tag via the crane CLI:
200+
As an alternative to using ghcr.io's UI, you can get the list of tags, including the latest tag via the crane CLI:
183201

184202
```bash
185203
arkade get crane

0 commit comments

Comments
 (0)