Skip to content

Commit

Permalink
Correct few issues in test docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adityabhatia committed Dec 13, 2023
1 parent bf18885 commit 08bb15f
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/book/src/developer/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ Now you can start the e2e test via IDE as described above but with the additiona
**Note**: This can also be used to debug controllers during e2e tests as described in [Developing Cluster API with Tilt](./tilt.md#wiring-up-debuggers).

The e2e tests also create a local clusterctl repository. After it has been created on a first test execution this step can also be
skipped by setting `-e2e.cluster-config=<ARTIFACTS>/repository/clusterctl-config.yaml`. This also works with a clusterctl repository created
skipped by setting `-e2e.clusterctl-config=<ARTIFACTS>/repository/clusterctl-config.yaml`. This also works with a clusterctl repository created
via [Create the local repository](http://localhost:3000/clusterctl/developers.html#create-the-local-repository).

**Feature gates**: E2E tests often use features which need to be enabled first. Make sure to enable the feature gates in the tilt settings file:
Expand Down
14 changes: 7 additions & 7 deletions docs/book/src/developer/tilt.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@ workflow that offers easy deployments and rapid iterative builds.
## Prerequisites

1. [Docker](https://docs.docker.com/install/): v19.03 or newer
1. [kind](https://kind.sigs.k8s.io): v0.20.0 or newer
1. [Tilt](https://docs.tilt.dev/install.html): v0.30.8 or newer
1. [kustomize](https://github.com/kubernetes-sigs/kustomize): provided via `make kustomize`
1. [envsubst](https://github.com/drone/envsubst): provided via `make envsubst`
1. [helm](https://github.com/helm/helm): v3.7.1 or newer
1. Clone the [Cluster API](https://github.com/kubernetes-sigs/cluster-api) repository
2. [kind](https://kind.sigs.k8s.io): v0.20.0 or newer
3. [Tilt](https://docs.tilt.dev/install.html): v0.30.8 or newer
4. [kustomize](https://github.com/kubernetes-sigs/kustomize): provided via `make kustomize`
5. [envsubst](https://github.com/drone/envsubst): provided via `make envsubst`
6. [helm](https://github.com/helm/helm): v3.7.1 or newer
7. Clone the [Cluster API](https://github.com/kubernetes-sigs/cluster-api) repository
locally
1. Clone the provider(s) you want to deploy locally as well
8. Clone the provider(s) you want to deploy locally as well

## Getting started

Expand Down
4 changes: 2 additions & 2 deletions docs/book/src/user/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ When there is more than one way to obtain resources from the same Infrastructure
A component responsible for turning a server into a Kubernetes node as well as for:

1. Generating the cluster certificates, if not otherwise specified
1. Initializing the control plane, and gating the creation of other nodes until it is complete
1. Joining control plane and worker nodes to the cluster
2. Initializing the control plane, and gating the creation of other nodes until it is complete
3. Joining control plane and worker nodes to the cluster

## Control plane

Expand Down
10 changes: 5 additions & 5 deletions docs/book/src/user/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,15 @@ misconfigured or there might be problems with the network. The following steps d
be troubleshooted systematically.

1. Access the Node via ssh.
1. Take a look at cloud-init logs via `less /var/log/cloud-init-output.log` or `journalctl -u cloud-init --since "1 day ago"`.
2. Take a look at cloud-init logs via `less /var/log/cloud-init-output.log` or `journalctl -u cloud-init --since "1 day ago"`.
(Note: cloud-init persists logs of the commands it executes (like kubeadm) only after they have returned.)
1. It might also be helpful to take a look at `journalctl --since "1 day ago"`.
1. If you see that kubeadm times out waiting for the static Pods to come up, take a look at:
3. It might also be helpful to take a look at `journalctl --since "1 day ago"`.
4. If you see that kubeadm times out waiting for the static Pods to come up, take a look at:
1. containerd: `crictl ps -a`, `crictl logs`, `journalctl -u containerd`
1. Kubelet: `journalctl -u kubelet --since "1 day ago"`
2. Kubelet: `journalctl -u kubelet --since "1 day ago"`
(Note: it might be helpful to increase the Kubelet log level by e.g. setting `--v=8` via
`systemctl edit --full kubelet && systemctl restart kubelet`)
1. If Node bootstrapping consistently fails and the kubeadm logs are not verbose enough, the `kubeadm` verbosity
5. If Node bootstrapping consistently fails and the kubeadm logs are not verbose enough, the `kubeadm` verbosity
can be increased via `KubeadmConfigSpec.Verbosity`.

## Labeling nodes with reserved labels such as `node-role.kubernetes.io` fails with kubeadm error during bootstrap
Expand Down

0 comments on commit 08bb15f

Please sign in to comment.