From 93cbcb61b81a0c38123eb1b3eadcc99cc58cdc26 Mon Sep 17 00:00:00 2001 From: Maxime Guyot Date: Thu, 25 Jun 2020 20:56:37 +0200 Subject: [PATCH] Fix some doc links (#6328) --- docs/getting-started.md | 6 +++--- docs/test_cases.md | 2 +- docs/vagrant.md | 2 +- docs/vars.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 60ec3f6f7..4a1fea6b8 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -36,7 +36,7 @@ ansible-playbook -i inventory/mycluster/hosts.yml cluster.yml -b -v \ --private-key=~/.ssh/private_key ``` -See more details in the [ansible guide](docs/ansible.md). +See more details in the [ansible guide](/docs/ansible.md). ### Adding nodes @@ -81,12 +81,12 @@ kube-apiserver via port 8080. A kubeconfig file is not necessary in this case, because kubectl will use to connect. The kubeconfig files generated will point to localhost (on kube-masters) and kube-node hosts will connect either to a localhost nginx proxy or to a loadbalancer if configured. -More details on this process are in the [HA guide](docs/ha-mode.md). +More details on this process are in the [HA guide](/docs/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 can get a kubeconfig from kube-master hosts -(see [below](#accessing-kubernetes-api)) or connect with a [username and password](vars.md#user-accounts). +(see [below](#accessing-kubernetes-api)) or connect with a [username and password](/docs/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/). diff --git a/docs/test_cases.md b/docs/test_cases.md index 67600dae1..3b572d8b8 100644 --- a/docs/test_cases.md +++ b/docs/test_cases.md @@ -20,7 +20,7 @@ Note, the canal network plugin deploys flannel as well plus calico policy contro ## Test cases -The [CI Matrix](docs/ci.md) displays OS, Network Plugin and Container Manager tested. +The [CI Matrix](/docs/ci.md) displays OS, Network Plugin and Container Manager tested. All tests are breakdown into 3 "stages" ("Stage" means a build step of the build pipeline) as follows: diff --git a/docs/vagrant.md b/docs/vagrant.md index da385f74d..f132ead8a 100644 --- a/docs/vagrant.md +++ b/docs/vagrant.md @@ -24,7 +24,7 @@ The supported operating systems for vagrant are defined in the `SUPPORTED_OS` co ## File and image caching -Kubespray can take quite a while to start on a laptop. To improve provisioning speed, the variable 'download_run_once' is set. This will make kubespray download all files and containers just once and then redistributes them to the other nodes and as a bonus, also cache all downloads locally and re-use them on the next provisioning run. For more information on download settings see [download documentation](downloads.md). +Kubespray can take quite a while to start on a laptop. To improve provisioning speed, the variable 'download_run_once' is set. This will make kubespray download all files and containers just once and then redistributes them to the other nodes and as a bonus, also cache all downloads locally and re-use them on the next provisioning run. For more information on download settings see [download documentation](/docs/downloads.md). ## Example use of Vagrant diff --git a/docs/vars.md b/docs/vars.md index bf13b7ccb..f3e621b04 100644 --- a/docs/vars.md +++ b/docs/vars.md @@ -38,11 +38,11 @@ Some variables of note include: * *loadbalancer_apiserver* - If defined, all hosts will connect to this address instead of localhost for kube-masters and kube-master[0] for kube-nodes. See more details in the - [HA guide](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ha-mode.md). + [HA guide](/docs/ha-mode.md). * *loadbalancer_apiserver_localhost* - makes all hosts to connect to the apiserver internally load balanced endpoint. Mutual exclusive to the `loadbalancer_apiserver`. See more details in the - [HA guide](https://github.com/kubernetes-sigs/kubespray/blob/master/docs/ha-mode.md). + [HA guide](/docs/ha-mode.md). ## Cluster variables