Skip to content

Commit 35e402c

Browse files
committed
wording improvements
1 parent 397d974 commit 35e402c

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,12 @@ extraVolumes:
2929
secretName: oscloudsyaml
3030
```
3131
32-
The referenced `extraVolumeMount` points to a `Secret` containing the `clouds.yaml` file, which provides the OpenStack Keystone credentials to the webhook provider. While it seems cumbersome to require a file instead of the commonly used `OS_*` environment variables, the use of a `clouds.yaml` file offers more structure, capabilities and allows for better validation.
32+
The referenced `extraVolumeMount` points to a `Secret` containing a [`clouds.yaml` file](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#clouds-yaml),
33+
which provides the OpenStack Keystone credentials to the webhook provider.
34+
`OS_*` environment variables are not supported for configuration, since the use of a `clouds.yaml` file offers more structure, capabilities and allows for better validation.
35+
The one exception to this is `OS_CLOUD` for setting the name of the cloud in `clouds.yaml` to use.
3336

34-
The following example is a basic example of such a file, using `openstack` as the cloud name (which is the default used by this webhook):
37+
The following example is a basic example of a `clouds.yaml` file, using `openstack` as the cloud name (the default used by this webhook):
3538

3639
```yaml
3740
clouds:
@@ -58,7 +61,8 @@ In such cases, please raise a GitHub issue with as much detail as possible. PRs
5861

5962
## Development
6063

61-
To run the webhook locally, you'll also require a [clouds.yaml](https://docs.openstack.org/python-openstackclient/pike/configuration/index.html#clouds-yaml) file in one of the standard-locations. Also the name of the entry to be used has be given via `OS_CLOUD` environment variable.
64+
To run the webhook locally, you'll also require a [clouds.yaml](https://docs.openstack.org/python-openstackclient/pike/configuration/index.html#clouds-yaml) file in one of the standard-locations.
65+
Also the name of the entry to be used has be given via `OS_CLOUD` environment variable.
6266
You can then start the webhook server using:
6367

6468
```sh

0 commit comments

Comments
 (0)