Skip to content

Commit

Permalink
Merge pull request #3947 from twz123/fix-mkdocs-links
Browse files Browse the repository at this point in the history
Correct links in docs
  • Loading branch information
twz123 authored Jan 18, 2024
2 parents 9cee4a9 + 4a8329f commit 2711927
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/configuration-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -287,7 +287,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`

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/nginx-ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
7 changes: 6 additions & 1 deletion docs/high-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/nllb.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2711927

Please sign in to comment.