Skip to content

Commit

Permalink
chore: improve documentation (#2433)
Browse files Browse the repository at this point in the history
- adds an example for external secret (how to use and create)
- adds notes on tolerations when the controlplane runs isolated

For: #2432
  • Loading branch information
till authored Oct 24, 2023
1 parent 8da2313 commit 9b3e6e6
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
2 changes: 1 addition & 1 deletion charts/openstack-cloud-controller-manager/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Openstack Cloud Controller Manager Helm Chart
icon: https://object-storage-ca-ymq-1.vexxhost.net/swift/v1/6e4619c416ff4bd19e1c087f27a43eea/www-images-prod/openstack-logo/OpenStack-Logo-Vertical.png
home: https://github.com/kubernetes/cloud-provider-openstack
name: openstack-cloud-controller-manager
version: 2.29.0-alpha.3
version: 2.29.0-alpha.4
maintainers:
- name: eumel8
email: [email protected]
Expand Down
30 changes: 29 additions & 1 deletion charts/openstack-cloud-controller-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,40 @@ If you want to enable health checks for your Load Balancers (optional), set `clo

Then run:

```
```sh
helm repo add cpo https://kubernetes.github.io/cloud-provider-openstack
helm repo update
helm install openstack-ccm cpo/openstack-cloud-controller-manager --values openstack-ccm.yaml
```

## Using an external secret

In order to use an external secret for the OCCM:

```yaml
secret:
enabled: true
name: cloud-config
create: false
```
Create the secret with:
```sh
kubectl create secret -n kube-system generic cloud-config --from-file=./cloud.conf
```

## Tolerations

To deploy OCCM to worker nodes only (e.g. when the controlplane is isolated), adjust the tolerations in the chart:

```yaml
tolerations:
- key: node.cloudprovider.kubernetes.io/uninitialized
value: "true"
effect: NoSchedule
```
## Unsupported configurations
- The chart does not support the mounting of custom `clouds.yaml` files. Therefore, the following config values in the `[Global]` section won’t have any effect:
Expand Down

0 comments on commit 9b3e6e6

Please sign in to comment.