Skip to content

Commit

Permalink
ADD: helm markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
mc256 committed Nov 16, 2022
1 parent ea22901 commit 5de18fa
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 9 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/helm-chart.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ jobs:
shell: bash
run: |-
echo ${{ secrets.GITHUB_TOKEN }} | helm registry login -u ${{ github.repository_owner }} --password-stdin ghcr.io
make build-helm-package push-helm-package
make helm-package push-helm-package
helm registry logout ghcr.io
env:
HELM_EXPERIMENTAL_OCI: '1'
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ helm-package:

.PHONY: push-helm-package
push-helm-package:
helm push /tmp/starlight-proxy-chart-$(VERSIONNUMBER).tgz oci://ghcr.io/mc256/starlight/
helm push /tmp/starlight-$(VERSIONNUMBER).tgz oci://ghcr.io/mc256/starlight/

.PHONY: change-version-number
change-version-number:
Expand Down
10 changes: 3 additions & 7 deletions docs/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
```shell
helm upgrade --install -f starlight/values.yaml \
starlight \
oci://ghcr.io/mc256/starlight/starlight-proxy-chart \
oci://ghcr.io/mc256/starlight/starlight \
--version 0.2.3
```

Expand Down Expand Up @@ -47,7 +47,7 @@ To install the chart with the app name `my-starlight-proxy`:

```shell
helm install my-starlight-proxy \
oci://ghcr.io/mc256/starlight/starlight-proxy-chart \
oci://ghcr.io/mc256/starlight/starlight \
--version 0.2.3
```

Expand All @@ -56,7 +56,7 @@ You may want to set a few parameter for example the domain name for the ingress,

```shell
helm install my-starlight-proxy \
oci://ghcr.io/mc256/starlight/starlight-proxy-chart \
oci://ghcr.io/mc256/starlight/starlight \
--version 0.2.3 \
--set "ingress.hosts={mydomain.local}"
```
Expand Down Expand Up @@ -99,9 +99,6 @@ The Starlight CLI talks to the Starlight Daemon via gRPC socket to request the i
mountPath: /run/starlight
```
The following is a complete example of the a Redis deployment:
```yaml
apiVersion: apps/v1
Expand Down Expand Up @@ -140,7 +137,6 @@ spec:
volumeMounts:
- name: socket
mountPath: /run/starlight

containers:
- name: test-redis
image: harbor.yuri.moe/x/redis:6.2.7
Expand Down

0 comments on commit 5de18fa

Please sign in to comment.