Fast fix kubernetes docs

xrally · Jul 2, 2018 · 2ed5e08 · 2ed5e08
1 parent fe1d86b
commit 2ed5e08
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 38 deletions.
diff --git a/docs/plugins/kubernetes/overview.md b/docs/plugins/kubernetes/overview.md
@@ -50,20 +50,21 @@ specification json/yaml file. See the list of available options:
   etc), Rally team provides this way. Check [existing@kubernetes plugin documentation](https://xrally.org/plugins/kubernetes/plugins/#existing-platform)
   for the list of all available variables. Here is a simple example of this feature:
 
-  ```console
-  # the URL to the Kubernetes host.
-  export KUBERNETES_HOST="https://example.com:3030"
-  #  a path to a file containing TLS certificate to use when connecting to the Kubernetes host.
-  export KUBERNETES_CERT_AUTH="~/.kube/cert_auth_file"
-  # client API key to use as token when connecting to the Kubernetes host.
-  export KUBERNETES_API_KEY="foo"
-  # client API key prefix to use in token when connecting to the Kubernetes host.
-  export KUBERNETES_API_KEY_PREFIX="bar"
-
-  # finally create a Rally environment
-  rally env create --name my-kubernetes --from-sysenv
-  ```
-Check env availbility by the following command:
+```console
+# the URL to the Kubernetes host.
+export KUBERNETES_HOST="https://example.com:3030"
+#  a path to a file containing TLS certificate to use when connecting to the Kubernetes host.
+export KUBERNETES_CERT_AUTH="~/.kube/cert_auth_file"
+# client API key to use as token when connecting to the Kubernetes host.
+export KUBERNETES_API_KEY="foo"
+# client API key prefix to use in token when connecting to the Kubernetes host.
+export KUBERNETES_API_KEY_PREFIX="bar"
+
+# finally create a Rally environment
+rally env create --name my-kubernetes --from-sysenv
+```
+
+Check env availability by the following command:
 
 ```console
 rally env check

diff --git a/docs/plugins/kubernetes/plugins.md b/docs/plugins/kubernetes/plugins.md
@@ -19,33 +19,41 @@ certificates or defining auth token.
 To search configuration in kubeconfig file, rally checks standard
 `$HOME/.kube/config` file or get `KUBECONFIG` envvar.
 
-To define certificates to connect next variables used:
-
-The URL to the Kubernetes host.
-.. envvar:: KUBERNETES_TLS_INSECURE
-Not to verify the host against a CA certificate.
-.. envvar:: KUBERNETES_CERT_AUTH
-A path to a file containing TLS certificate to use when
-connecting to the Kubernetes host.
-.. envvar:: KUBERNETES_CLIENT_CERT
-A path to a file containing client certificate to use when
-connecting to the Kubernetes host.
-.. envvar:: KUBERNETES_CLIENT_KEY
-A path to a file containing client key to use when connecting to
-the Kubernetes host.
+To define certificates to connect next environment variables used:
+
+!!! Quote "$KUBERNETES_HOST" 
+    The URL to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_TLS_INSECURE" 
+    Not to verify the host against a CA certificate.
+
+!!! Quote "$KUBERNETES_CERT_AUTH" 
+    A path to a file containing TLS certificate to use when
+    connecting to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_CLIENT_CERT" 
+    A path to a file containing client certificate to use when
+    connecting to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_CLIENT_KEY" 
+    A path to a file containing client key to use when connecting to
+    the Kubernetes host.
 
 To define auth token to connect next variables used:
 
-The URL to the Kubernetes host.
-.. envvar:: KUBERNETES_CERT_AUTH
-A path to a file containing TLS certificate to use when
-connecting to the Kubernetes host.
-.. envvar:: KUBERNETES_API_KEY
-Client API key to use as token when connecting to the Kubernetes
-host.
-.. envvar:: KUBERNETES_API_KEY_PREFIX
-Client API key prefix to use in token when connecting to the
-Kubernetes host.
+!!! Quote "$KUBERNETES_HOST" 
+    The URL to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_CERT_AUTH" 
+    A path to a file containing TLS certificate to use when
+    connecting to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_API_KEY" 
+    Client API key to use as token when connecting to the Kubernetes host.
+
+!!! Quote "$KUBERNETES_API_KEY_PREFIX" 
+    Client API key prefix to use in token when connecting to the
+    Kubernetes host.
 
 __Platform__: kubernetes