From cd5ae57cf613d61d6bc805849c839c847ad1340d Mon Sep 17 00:00:00 2001 From: shivi28 Date: Mon, 3 Oct 2022 07:54:08 +0530 Subject: [PATCH] Doc improvements --- docs/getting_started.md | 6 +++--- docs/troubleshooting_guide.md | 6 ++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/getting_started.md b/docs/getting_started.md index 0113dfe41..68c532ef7 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -16,7 +16,7 @@ Kubernetes cluster will be transformed into a [management cluster](https://clust 1. **Existing Management Cluster** - For production use-cases a "real" Kubernetes cluster should be used with appropriate backup and DR policies and procedures in place. The Kubernetes cluster must be at least v1.19.1. + For production use-cases a "real" Kubernetes cluster should be used with appropriate backup and DR policies and procedures in place. The Kubernetes cluster must be at least greater than v1.22.x. ```bash export KUBECONFIG=<...> @@ -163,7 +163,7 @@ docker cp ~/bootstrap-kubeconfig.conf host$i:/bootstrap-kubeconfig.conf done ``` -Start the host agent on each of the hosts and keep it running. +Start host agent on each of the hosts from root user and keep it running. >**IMPORTANT NOTE**: Use the `--skip-installation` flag if using target `make prepare-byoh-docker-host-image-dev` as we already have k8s components included in this docker image. This flag will skip k8s installation attempt on the host. The `--skip-installation` flag should not be used with target `make prepare-byoh-docker-host-image` as it's docker image doesn't come with k8s components installed. @@ -262,7 +262,7 @@ You can use the script `hack/install-host-agent-service.sh` to start the agent a ```shell ./install-host-agent-service.sh path/to/agent/binary ``` - +**Note** : Ensure to properly shutdown processes, release ports, etc on each byoh agent re-run (i.e. pkill byoh-agent processes, etc) [cluster-api-book]: https://cluster-api.sigs.k8s.io/ [glossary-bootstrapping]: https://cluster-api.sigs.k8s.io/reference/glossary.html#bootstrap diff --git a/docs/troubleshooting_guide.md b/docs/troubleshooting_guide.md index ff5e918eb..9c2bc0f7a 100644 --- a/docs/troubleshooting_guide.md +++ b/docs/troubleshooting_guide.md @@ -109,3 +109,9 @@ E0308 05:18:54.733622 11351 cli-dev.go:151] "msg"="error installing/uninstall ``` ### Solution Sometimes it may happen that the OS and K8s version combination used is not supported by `BYOH` out of the box. This will require manually installing all the dependencies and using the `--skip-installation` flag. This flag will skip k8s installation attempt on the host. + +## Github rate-limiting issue during clusterctl init +### Problem +During `clusterctl init -i byoh`, sometimes we might face github rate limit error and unable to pull providers. +### Solution +To fix it set environment variable `GITHUB_TOKEN` and fetch its value from github. To create new `GITHUB_TOKEN` refer [this doc](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).