support for private clusters and proxy

spotinst · Oct 4, 2023 · 056e99b · 056e99b
1 parent 3fdcaa3
commit 056e99b
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 2 deletions.
diff --git a/charts/ocean-kubernetes-controller/README.md b/charts/ocean-kubernetes-controller/README.md
@@ -21,11 +21,40 @@ helm repo update
 3. Install `ocean-kubernetes-controller`:
 
 ```sh
-helm install my-release spot/ocean-kubernetes-controller
+helm install spot spot/ocean-kubernetes-controller \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN
 ```
 
 > NOTE: Please configure all required chart values using the `set` command line argument or a `values.yaml` file.
 
+## Installation With HTTPS Proxy
+
+In case you need to configure a proxy with a custom CA bundle you should use the following:
+
+```sh
+helm install spot spot/ocean-kubernetes-controller \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN \
+  --set spotinst.proxyUrl=$SPOTINST_PROXY_URL \
+  --set caBundleSecret.create=true \
+  --set caBundleSecret.data="$(cat ./path/to/ca.pem)"
+```
+
+If you already have a CA bundle secret you can instead use:
+
+```sh
+helm install spot spot/ocean-kubernetes-controller \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN \
+  --set spotinst.proxyUrl=$SPOTINST_PROXY_URL \
+  --set caBundleSecret.name=my-ca-bundle-secret \
+  --set caBundleSecret.key=bundle.pem
+```
+
 ## Requirements
 
 Kubernetes: `>=1.20.0-0`

diff --git a/charts/ocean-kubernetes-controller/README.md.gotmpl b/charts/ocean-kubernetes-controller/README.md.gotmpl
@@ -23,11 +23,40 @@ helm repo update
 3. Install `{{ template "chart.name" . }}`:
 
 ```sh
-helm install my-release spot/{{ template "chart.name" . }}
+helm install spot spot/{{ template "chart.name" . }} \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN
 ```
 
 > NOTE: Please configure all required chart values using the `set` command line argument or a `values.yaml` file.
 
+## Installation With HTTPS Proxy
+
+In case you need to configure a proxy with a custom CA bundle you should use the following:
+
+```sh
+helm install spot spot/{{ template "chart.name" . }} \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN \
+  --set spotinst.proxyUrl=$SPOTINST_PROXY_URL \
+  --set caBundleSecret.create=true \
+  --set caBundleSecret.data="$(cat ./path/to/ca.pem)"
+```
+
+If you already have a CA bundle secret you can instead use:
+
+```sh
+helm install spot spot/{{ template "chart.name" . }} \
+  --set spotinst.account=$SPOTINST_ACCOUNT \
+  --set spotinst.clusterIdentifier=$SPOTINST_CLUSTER_IDENTIFIER \
+  --set spotinst.token=$SPOTINST_TOKEN \
+  --set spotinst.proxyUrl=$SPOTINST_PROXY_URL \
+  --set caBundleSecret.name=my-ca-bundle-secret \
+  --set caBundleSecret.key=bundle.pem
+```
+
 {{ template "chart.requirementsSection" . }}
 
 {{ template "chart.valuesSection" . }}