From 51e858abb65f4fae849ffca06696fd8243352b05 Mon Sep 17 00:00:00 2001 From: Max Laverse Date: Mon, 24 Dec 2018 21:56:02 +0100 Subject: [PATCH] Indicate that contextName and clusterName are optional --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 9cb3181..0d5a62a 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,11 @@ node { ``` The arguments to the `withKubeConfig` step are: -* `credentialsId` - the Jenkins identifier of the credentials to use. -* `caCertificate` - an optional certificate to check the Kubernetes api server's against. If you don't specify one, the CA verification will be skipped. -* `serverUrl` - the url of the api server -* `contextName` - name of the context to create or to switch to if a raw kubeconfig was provided -* `clusterName` - name of the cluster to create or to switch to if a raw kubeconfig was provided +* `credentialsId` - the Jenkins identifier of the credentials to authenticate against the cluster, or of a raw KubeConfig file. +* `caCertificate` (optional) - an certificate to check the Kubernetes api server's against. If you don't specify one, the CA verification will be skipped. +* `serverUrl` (optional with raw KubeConfig) - the url of the api server +* `contextName` (optional) - name of the context to create or to switch to if a raw kubeconfig was provided +* `clusterName` (optioanl) - name of the cluster to create or to switch to if a raw kubeconfig was provided ### From the web interface