diff --git a/docs/configuration-validation.md b/docs/configuration-validation.md index ea9b1f8ed996..dedee6795baf 100644 --- a/docs/configuration-validation.md +++ b/docs/configuration-validation.md @@ -9,6 +9,6 @@ k0s config validate --config path/to/config/file `config validate` sub-command can validate the following: 1. YAML formatting -2. [SAN addresses](/configuration/#specapi) -3. [Network providers](/configuration/#specnetwork) -4. [Worker profiles](/configuration/#specworkerprofiles) +2. [SAN addresses](configuration.md#specapi) +3. [Network providers](configuration.md#specnetwork) +4. [Worker profiles](configuration.md#specworkerprofiles) diff --git a/docs/configuration.md b/docs/configuration.md index 8111f412eb31..a14473527338 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -35,7 +35,7 @@ options should be placed in the `spec.k0s.config` section of the k0sctl's configuration file. See the section on how to install [k0s via k0sctl][k0sctl-install] and the [k0sctl README] for more information. -[k0sctl-install]: ../k0sctl-install +[k0sctl-install]: k0sctl-install.md [k0sctl README]: https://github.com/k0sproject/k0sctl/blob/main/README.md ## Configuration file reference @@ -274,7 +274,7 @@ changes. | `type` | The type of the node-local load balancer to deploy on worker nodes. Default: `EnvoyProxy`. (This is the only option for now.) | | `envoyProxy` | Configuration options related to the "EnvoyProxy" type of load balancing. | -[node-local load balancing]: ../nllb +[node-local load balancing]: nllb.md ##### `spec.network.nodeLocalLoadBalancing.envoyProxy` diff --git a/docs/examples/nginx-ingress.md b/docs/examples/nginx-ingress.md index 3be0ba42e5f7..eeea3b728013 100644 --- a/docs/examples/nginx-ingress.md +++ b/docs/examples/nginx-ingress.md @@ -268,4 +268,4 @@ For more information about NGINX Ingress Controller installation, take a look at ## Alternative examples for Ingress Controllers on k0s -[Traefik Ingress](../traefik-ingress) +[Traefik Ingress](traefik-ingress.md) diff --git a/docs/high-availability.md b/docs/high-availability.md index c3c6f3f0f290..ccc3a77e09dd 100644 --- a/docs/high-availability.md +++ b/docs/high-availability.md @@ -84,10 +84,15 @@ First and foremost, all controllers should utilize the same CA certificates and /var/lib/k0s/pki/etcd/ca.crt ``` -To generate these certificates, you have two options: either generate them manually using the instructions provided [here](../custom-ca/) and then share it across controller nodes, or utilize k0sctl for automated generation and sharing. +To generate these certificates, you have two options: either generate them +manually using the instructions for [installing custom CA certificates], and +then share them between controller nodes, or use k0sctl to generate and share +them automatically. The second important aspect is: the load balancer address must be configured to k0s either by using `k0s.yaml` or by using k0sctl to automatically deploy all controllers with the same configuration: +[installing custom CA certificates]: custom-ca.md + ### Configuration using k0s.yaml (for each controller) Note to update your load balancer's public ip address into two places. diff --git a/docs/nllb.md b/docs/nllb.md index 7452cf54256b..03ffad378b02 100644 --- a/docs/nllb.md +++ b/docs/nllb.md @@ -13,7 +13,7 @@ with the cluster using management tools such as [Lens](https://k8slens.dev/) or `kubectl`), but rather makes the cluster itself internally resilient to controller node outages. -[externally managed load balancer]: ../high-availability/#load-balancer +[externally managed load balancer]: high-availability.md#load-balancer ## Technical functionality @@ -37,7 +37,7 @@ following: * The cluster doesn't use an externally managed load balancer, i.e. the cluster configuration doesn't specify a non-empty [`spec.api.externalAddress`][specapi]. -* K0s isn't running as a [single node](../k0s-single-node/), i.e. it isn't +* K0s isn't running as a [single node](k0s-single-node.md), i.e. it isn't started using the `--single` flag. * The cluster should have multiple controller nodes. Node-local load balancing also works with a single controller node, but is only useful in conjunction @@ -53,7 +53,7 @@ spec: type: EnvoyProxy ``` -Or alternatively, if using [`k0sctl`](../k0sctl-install/), add the following to +Or alternatively, if using [`k0sctl`](k0sctl-install.md), add the following to the k0sctl configuration (`k0sctl.yaml`): ```yaml @@ -71,7 +71,7 @@ All newly added worker nodes will then use node-local load balancing. The k0s worker process on worker nodes that are already running must be restarted for the new configuration to take effect. -[specapi]: ../configuration/#specapi +[specapi]: configuration.md#specapi ## Full example using `k0sctl` diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md index 979e8c5c31fa..0b3c54cab643 100644 --- a/docs/troubleshooting.md +++ b/docs/troubleshooting.md @@ -67,7 +67,7 @@ io.containerd.snapshotter.v1 zfs linux/amd64 ok ... ``` -- create a containerd config according to the [documentation](/runtime): `$ containerd config default > /etc/k0s/containerd.toml` +- create a containerd config according to the [documentation](runtime.md): `$ containerd config default > /etc/k0s/containerd.toml` - modify the line in `/etc/k0s/containerd.toml`: ```toml