examples: update platform snippets and doc

Signed-off-by: Damien Grisonnet <dgrisonn@redhat.com>
This commit is contained in:
Damien Grisonnet
2021-04-06 11:33:07 +02:00
parent f06175bb3b
commit b59b2c23d8
12 changed files with 38 additions and 81 deletions

View File

@@ -1,18 +1,3 @@
# Adding a new platform specific configuration
Adding a new platform specific configuration requires to update the
[platforms.jsonnet](./platform.jsonnet) file by adding the platform to the list
of existing ones.
This allow configuring the new platform in the following way:
```jsonnet
(import 'kube-prometheus/main.libsonnet') +
{
values+:: {
kubePrometheus+: {
platform: 'example-platform',
}
}
}
```
Adding a new platform specific configuration requires to update the [README](../../../README.md#cluster-creation-tools) and the [platforms.jsonnet](./platform.jsonnet) file by adding the platform to the list of existing ones. This allow the new platform to be discoverable and easily configurable by the users.