Skip to content

Commit ca53fed

Browse files
Merge pull request #121 from CleverCloud/devel/fdubois/doc/update-config
doc(readme): update configuration section
2 parents 9de06f7 + 0488e28 commit ca53fed

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,11 @@ $ kubectl apply -f https://raw.githubusercontent.com/CleverCloud/clever-operator
110110

111111
### Global
112112

113-
To work properly the operator need to be configured with at least credentials to connect the Clever Cloud's API. Those
114-
configurations could be provided through a ConfigMap, a Secret or by the environment.
113+
To work properly, the operator needs to be configured with at least credentials to connect the Clever Cloud's API.
114+
Those configurations could be provided through a `ConfigMap`, a `Secret` or by the environment.
115+
116+
An example of deployment using a `Secret` is located at [deployments/kubernetes/v1.30.0/20-deployment.yaml](./deployments/kubernetes/v1.30.0/20-deployment.yaml).
117+
An example of deployment using a `ConfigMap` is located at [deployments/helm/](./deployments/kubernetes/helm/templates/configmap.yaml).
115118

116119
Environment variables are:
117120

@@ -133,11 +136,6 @@ retrieve its configuration:
133136
- `$HOME/.local/share/clever-operator/config.{toml,yaml,json}`
134137
- `config.{toml,yaml,json}`
135138

136-
### Namespace
137-
138-
It is possible to override configuration to connect the Clever Cloud's api through a `Secret` named `clever-operator` and using the `config` key.
139-
Only available configuration keys is `api` from the [`Configuration`](config.sample.toml).
140-
141139
## License
142140

143141
See the [license](LICENSE).

config.sample.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,9 @@ token = ""
1313
secret = ""
1414
consumer-key = ""
1515
consumer-secret = ""
16+
17+
# Operator settings
18+
#
19+
# For the moment, only the listen port is available.
20+
[operator]
21+
listen = "0.0.0.0:8080"

0 commit comments

Comments
 (0)