From 68c8c057758fcd6fd1472f8ee6fd51115d1d4198 Mon Sep 17 00:00:00 2001
From: rptaylor <rptaylor@uvic.ca>
Date: Tue, 11 Feb 2020 01:36:00 -0800
Subject: [PATCH] improve documentation about user account and connecting to
API (#5415)
* improve documentation about user acct and connecting to API
* fix lint
---
docs/getting-started.md | 10 +++-------
docs/vars.md | 2 +-
2 files changed, 4 insertions(+), 8 deletions(-)
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 6ba7db03b..a240ac54f 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -85,13 +85,8 @@ More details on this process are in the [HA guide](ha-mode.md).
Kubespray permits connecting to the cluster remotely on any IP of any
kube-master host on port 6443 by default. However, this requires
-authentication. One could generate a kubeconfig based on one installed
-kube-master hosts (needs improvement) or connect with a username and password.
-By default, a user with admin rights is created, named `kube`.
-The password can be viewed after deployment by looking at the file
-`{{ credentials_dir }}/kube_user.creds` (`credentials_dir` is set to `{{ inventory_dir }}/credentials` by default). This contains a randomly generated
-password. If you wish to set your own password, just precreate/modify this
-file yourself.
+authentication. One can get a kubeconfig from kube-master hosts
+(see [below](#accessing-kubernetes-api)) or connect with a [username and password](vars.md#user-accounts).
For more information on kubeconfig and accessing a Kubernetes cluster, refer to
the Kubernetes [documentation](https://kubernetes.io/docs/tasks/access-application-cluster/configure-access-multiple-clusters/).
@@ -121,6 +116,7 @@ host and can optionally be configured on your ansible host by setting
- If `kubectl_localhost` enabled, `kubectl` will download onto `/usr/local/bin/` and setup with bash completion. A helper script `inventory/mycluster/artifacts/kubectl.sh` also created for setup with below `admin.conf`.
- If `kubeconfig_localhost` enabled `admin.conf` will appear in the `inventory/mycluster/artifacts/` directory after deployment.
+- The location where these files are downloaded to can be configured via the `artifacts_dir` variable.
You can see a list of nodes by running the following commands:
diff --git a/docs/vars.md b/docs/vars.md
index 383a5c70c..be7bb6c38 100644
--- a/docs/vars.md
+++ b/docs/vars.md
@@ -183,7 +183,7 @@ in the form of dicts of key-value pairs of configuration parameters that will be
## User accounts
-By default, a user with admin rights is created, named `kube`.
+The variable `kube_basic_auth` is false by default, but if set to true, a user with admin rights is created, named `kube`.
The password can be viewed after deployment by looking at the file
`{{ credentials_dir }}/kube_user.creds` (`credentials_dir` is set to `{{ inventory_dir }}/credentials` by default). This contains a randomly generated
password. If you wish to set your own password, just precreate/modify this
--
GitLab