Skip navigation links

Package io.vertx.config.kubernetes

=== Kubernetes ConfigMap Store The Kubernetes ConfigMap Store extends the Vert.x Configuration Retriever and provides support Kubernetes Config Map and Secrets.

See: Description

Package io.vertx.config.kubernetes Description

=== Kubernetes ConfigMap Store The Kubernetes ConfigMap Store extends the Vert.x Configuration Retriever and provides support Kubernetes Config Map and Secrets. So, configuration is retrieved by reading the config map or the secrets. ==== Using the Kubernetes ConfigMap Store To use the Kubernetes ConfigMap Store, add the following dependency to the _dependencies_ section of your build descriptor: * Maven (in your `pom.xml`): [source,xml,subs="+attributes"] ---- ${maven.groupId} ${maven.artifactId} ${maven.version} ${maven.groupId} vertx-config ${maven.version} ---- * Gradle (in your `build.gradle` file): [source,groovy,subs="+attributes"] ---- compile '${maven.groupId}:vertx-config:${maven.version}' compile '${maven.groupId}:${maven.artifactId}:${maven.version}' ---- ==== Configuring the store Once added to your classpath or dependencies, you need to configure the ConfigRetriever to use this store: [source, $lang] ---- examples.Examples#example1(io.vertx.core.Vertx) ---- You need to configure the store to find the right configmap. this is done with: * `namespace` - the project namespace, `default` by default. If the `KUBERNETES_NAMESPACE` ENV variable is set, it uses this value. * `name` - the name of the config map * `optional` - whether or not the config map is optional (`true` by default) If the config map is composed by several element, you can use the `key` parameter to tell which `key` is read The application must have the permissions to read the config map. To read data from a secret, just configure the `secret` property to `true`: [source, $lang] ---- examples.Examples#example2(io.vertx.core.Vertx) ---- If the config map is not available, an empty JSON object is passed as configuration chunk. To disable this behavior and explicitly fail, you can set the `optional` configuration to `false`.
Skip navigation links

Copyright © 2018 Eclipse. All rights reserved.