Skip to content

Commit 432c52f

Browse files
authored
misc: document helm chart installation (#190)
Documented the Helm chart installation process.
1 parent 414b081 commit 432c52f

1 file changed

Lines changed: 31 additions & 1 deletion

File tree

README.adoc

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,34 @@ the cloud controller manager.
4242
With the above noted, let's run the Oxide Cloud Controller Manager in your
4343
Kubernetes cluster.
4444

45+
=== Helm Chart
46+
47+
Create a `Secret` to hold the Oxide credentials. The secret
48+
name must match the Helm release's full name, which defaults to
49+
`<RELEASE_NAME>-oxide-cloud-controller-manager`.
50+
51+
[source,shell]
52+
----
53+
kubectl create secret generic <RELEASE_NAME>-oxide-cloud-controller-manager \
54+
--namespace kube-system \
55+
--from-literal=oxide-host=https://oxide.sys.example.com \
56+
--from-literal=oxide-token=oxide-token-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX \
57+
--from-literal=oxide-project=example
58+
----
59+
60+
Install the Helm chart.
61+
62+
[source,shell]
63+
----
64+
helm install <RELEASE_NAME> \
65+
oci://ghcr.io/oxidecomputer/charts/oxide-cloud-controller-manager \
66+
--version X.Y.Z \
67+
--namespace kube-system \
68+
--create-namespace
69+
----
70+
71+
=== Kubernetes Manifest
72+
4573
Create the following `Secret` to hold the Oxide credentials.
4674

4775
[source,yaml]
@@ -60,7 +88,9 @@ stringData:
6088
----
6189

6290
Apply the
63-
link:manifests/oxide-cloud-controller-manager.yaml[oxide-cloud-controller-manager.yaml] Kubernetes manifest.
91+
link:manifests/oxide-cloud-controller-manager.yaml[oxide-cloud-controller-manager.yaml]
92+
Kubernetes manifest. This manifest is generated from the Helm chart in
93+
link:charts/oxide-cloud-controller-manager[charts/oxide-cloud-controller-manager].
6494

6595
[source,shell]
6696
----

0 commit comments

Comments
 (0)