Added linkchecker and fixed broken links

Author: anshuman-agarwala

.github/workflows/link-checker.yml

@@ -0,0 +1,18 @@
+name: "Link Checker"
+on:
+  merge_group:
+  pull_request:
+    branches:
+      - master
+jobs:
+  linkchecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@1d97d84f0bc547f7b25f4c2170d87d810dc2fb2c
+        with:
+          fail: true
+        env:
+          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.lycheeignore

@@ -0,0 +1,2 @@
+.*localhost.*
+.*127.0.0.1.*

CONTRIBUTING.md

@@ -44,4 +44,3 @@ Vagrant with VirtualBox or libvirt driver helps you to quickly spin test cluster
 6. Sign the CNCF CLA (<https://git.k8s.io/community/CLA.md#the-contributor-license-agreement>)
 7. Submit a pull request.
 8. Work with the reviewers on their suggestions.
-9. Ensure to rebase to the HEAD of your target branch and squash un-necessary commits (<https://blog.carbonfive.com/always-squash-and-rebase-your-git-commits/>) before final merger of your contribution.

README.md

@@ -5,7 +5,7 @@
 If you have questions, check the documentation at [kubespray.io](https://kubespray.io) and join us on the [kubernetes slack](https://kubernetes.slack.com), channel **\#kubespray**.
 You can get your invite [here](http://slack.k8s.io/)
 
-- Can be deployed on **[AWS](docs/cloud_providers/aws.md), GCE, [Azure](docs/cloud_providers/azure.md), [OpenStack](docs/cloud_controllers/openstack.md), [vSphere](docs/cloud_controllers/vsphere.md), [Equinix Metal](docs/cloud_providers/equinix-metal.md) (bare metal), Oracle Cloud Infrastructure (Experimental), or Baremetal**
+- Can be deployed on **[AWS](docs/cloud_providers/aws.md), GCE, [Azure](docs/cloud_providers/azure.md), [OpenStack](docs/cloud_controllers/openstack.md), [vSphere](docs/cloud_controllers/vsphere.md), Oracle Cloud Infrastructure (Experimental), or Baremetal**
 - **Highly available** cluster
 - **Composable** (Choice of the network plugin for instance)
 - Supports most popular **Linux distributions**
@@ -72,7 +72,6 @@ vagrant up
 - [Fedora CoreOS bootstrap](docs/operating_systems/fcos.md)
 - [openSUSE setup](docs/operating_systems/opensuse.md)
 - [Downloaded artifacts](docs/advanced/downloads.md)
-- [Equinix Metal](docs/cloud_providers/equinix-metal.md)
 - [OpenStack](docs/cloud_controllers/openstack.md)
 - [vSphere](docs/cloud_controllers/vsphere.md)
 - [Large deployments](docs/operations/large-deployments.md)
@@ -183,9 +182,6 @@ You can choose among ten network plugins. (default: `calico`, except Vagrant use
 
 - [cilium](http://docs.cilium.io/en/latest/): layer 3/4 networking (as well as layer 7 to protect and secure application protocols), supports dynamic insertion of BPF bytecode into the Linux kernel to implement security services, networking and visibility logic.
 
-- [weave](docs/CNI/weave.md): Weave is a lightweight container overlay network that doesn't require an external K/V database cluster.
-    (Please refer to `weave` [troubleshooting documentation](https://www.weave.works/docs/net/latest/troubleshooting/)).
-
 - [kube-ovn](docs/CNI/kube-ovn.md): Kube-OVN integrates the OVN-based Network Virtualization with Kubernetes. It offers an advanced Container Network Fabric for Enterprises.
 
 - [kube-router](docs/CNI/kube-router.md): Kube-router is a L3 CNI for Kubernetes networking aiming to provide operational
@@ -197,7 +193,7 @@ You can choose among ten network plugins. (default: `calico`, except Vagrant use
 
 - [multus](docs/CNI/multus.md): Multus is a meta CNI plugin that provides multiple network interface support to pods. For each interface Multus delegates CNI calls to secondary CNI plugins such as Calico, macvlan, etc.
 
-- [custom_cni](roles/network-plugin/custom_cni/) : You can specify some manifests that will be applied to the clusters to bring you own CNI and use non-supported ones by Kubespray.
+- [custom_cni](roles/network_plugin/custom_cni/) : You can specify some manifests that will be applied to the clusters to bring you own CNI and use non-supported ones by Kubespray.
   See `tests/files/custom_cni/README.md` and `tests/files/custom_cni/values.yaml`for an example with a CNI provided by a Helm Chart.
 
 The network plugin to use is defined by the variable `kube_network_plugin`. There is also an
@@ -212,7 +208,6 @@ See also [Network checker](docs/advanced/netcheck.md).
 
 ## Community docs and resources
 
-- [kubernetes.io/docs/setup/production-environment/tools/kubespray/](https://kubernetes.io/docs/setup/production-environment/tools/kubespray/)
 - [kubespray, monitoring and logging](https://github.com/gregbkr/kubernetes-kargo-logging-monitoring) by @gregbkr
 - [Deploy Kubernetes w/ Ansible & Terraform](https://rsmitty.github.io/Terraform-Ansible-Kubernetes/) by @rsmitty
 - [Deploy a Kubernetes Cluster with Kubespray (video)](https://www.youtube.com/watch?v=CJ5G4GpqDy0)
@@ -227,6 +222,6 @@ See also [Network checker](docs/advanced/netcheck.md).
 
 [![Build graphs](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/badges/master/pipeline.svg)](https://gitlab.com/kargo-ci/kubernetes-sigs-kubespray/-/pipelines)
 
-CI/end-to-end tests sponsored by: [CNCF](https://cncf.io), [Equinix Metal](https://metal.equinix.com/), [OVHcloud](https://www.ovhcloud.com/), [ELASTX](https://elastx.se/).
+CI/end-to-end tests sponsored by: [CNCF](https://cncf.io), [Equinix Metal](https://deploy.equinix.com/), [OVHcloud](https://www.ovhcloud.com/), [ELASTX](https://elastx.se/).
 
 See the [test matrix](docs/developers/test_cases.md) for details.

contrib/terraform/openstack/README.md

@@ -10,7 +10,7 @@ most modern installs of OpenStack that support the basic services.
 
 ### Known compatible public clouds
 
-- [Auro](https://auro.io/)
+- [Auro](https://www.cacloud.com/)
 - [Betacloud](https://www.betacloud.io/)
 - [CityCloud](https://www.citycloud.com/)
 - [DreamHost](https://www.dreamhost.com/cloud/computing/)
@@ -705,18 +705,6 @@ $ kubectl config use-context default-system
 kubectl version
 ```
 
-## GlusterFS
-
-GlusterFS is not deployed by the standard `cluster.yml` playbook, see the
-[GlusterFS playbook documentation](../../network-storage/glusterfs/README.md)
-for instructions.
-
-Basically you will install Gluster as
-
-```ShellSession
-ansible-playbook --become -i inventory/$CLUSTER/hosts ./contrib/network-storage/glusterfs/glusterfs.yml
-```
-
 ## What's next
 
 Try out your new Kubernetes cluster with the [Hello Kubernetes service](https://kubernetes.io/docs/tasks/access-application-cluster/service-access-application-cluster/).

docs/CNI/calico.md

@@ -180,7 +180,7 @@ calico_group_id=rr1
 The inventory above will deploy the following topology assuming that calico's
 `global_as_num` is set to `65400`:
 
-![Image](figures/kubespray-calico-rr.png?raw=true)
+![Image](../figures/kubespray-calico-rr.png?raw=true)
 
 ### Optional : Define default endpoint to host action
 
@@ -407,7 +407,7 @@ To view the logs you need to use the `tc` command to read the kernel trace buffe
 tc exec bpf debug
 ```
 
-Please see [Calico eBPF troubleshooting guide](https://docs.projectcalico.org/maintenance/troubleshoot/troubleshoot-ebpf#ebpf-program-debug-logs).
+Please see [Calico eBPF troubleshooting guide](https://docs.tigera.io/calico/latest/operations/ebpf/troubleshoot-ebpf#ebpf-program-debug-logs).
 
 ## Wireguard Encryption
 

docs/CNI/cilium.md

@@ -355,7 +355,7 @@ To validate that Hubble UI is properly configured, set up a port forwarding for
 kubectl port-forward -n kube-system svc/hubble-ui 12000:80
 ```
 
-and then open [http://localhost:12000/](http://localhost:12000/).
+and then open <http://localhost:12000/>.
 
 ## Hubble metrics
 
@@ -380,7 +380,7 @@ Cilium relies on the kernel's BPF support, which is extremely fast at runtime bu
 
 As a result, the Cilium DaemonSet pods can take a significant time to start, which scales with the number of nodes and endpoints in your cluster.
 
-As part of cluster.yml, this DaemonSet is restarted, and Kubespray's [default timeouts for this operation](../roles/network_plugin/cilium/defaults/main.yml)
+As part of cluster.yml, this DaemonSet is restarted, and Kubespray's [default timeouts for this operation](../../roles/network_plugin/cilium/defaults/main.yml)
 are not appropriate for large clusters.
 
 This means that you will likely want to update these timeouts to a value more in-line with your cluster's number of nodes and their respective CPU performance.

docs/CNI/flannel.md

@@ -4,8 +4,6 @@ Flannel is a network fabric for containers, designed for Kubernetes
 
 Supported [backends](https://github.com/flannel-io/flannel/blob/master/Documentation/backends.md#wireguard): `vxlan`, `host-gw` and `wireguard`
 
-**Warning:** You may encounter this [bug](https://github.com/coreos/flannel/pull/1282) with `VXLAN` backend, while waiting on a newer Flannel version the current workaround (`ethtool --offload flannel.1 rx off tx off`) is showcase in kubespray [networking test](tests/testcases/040_check-network-adv.yml:31).
-
 ## Verifying flannel install
 
 * Flannel configuration file should have been created there

docs/CSI/vsphere-csi.md

@@ -99,4 +99,4 @@ kubectl exec -it nginx -- df -h | grep /usr/share/nginx/html
 
 ## More info
 
-For further information about the vSphere CSI Driver, you can refer to the official [vSphere Cloud Provider documentation](https://cloud-provider-vsphere.sigs.k8s.io/container_storage_interface.html).
+For further information about the vSphere CSI Driver, you can refer to the official [vSphere Cloud Provider documentation](https://cloud-provider-vsphere.sigs.k8s.io/).

docs/_sidebar.md

@@ -4,8 +4,8 @@ Kubespray can be installed as an [Ansible collection](https://docs.ansible.com/a
 
 ## Requirements
 
-- An inventory file with the appropriate host groups. See the [README](../README.md#usage).
-- A `group_vars` directory. These group variables **need** to match the appropriate variable names under `inventory/local/group_vars`. See the [README](../README.md#usage).
+- An inventory file with the appropriate host groups. See the [README](../../README.md#usage).
+- A `group_vars` directory. These group variables **need** to match the appropriate variable names under `inventory/local/group_vars`. See the [README](../../README.md#usage).
 
 ## Usage
 

docs/ansible/ansible_collection.md

@@ -4,7 +4,7 @@
 
 Kubespray has been tested on a number of OpenStack Public Clouds including (in alphabetical order):
 
-- [Auro](https://auro.io/)
+- [Auro](https://www.cacloud.com/)
 - [Betacloud](https://www.betacloud.io/)
 - [CityCloud](https://www.citycloud.com/)
 - [DreamHost](https://www.dreamhost.com/cloud/computing/)

docs/cloud_controllers/openstack.md

@@ -122,4 +122,4 @@ Use instance metadata service where possible
 
 ## Provisioning Azure with Resource Group Templates
 
-You'll find Resource Group Templates and scripts to provision the required infrastructure to Azure in [*contrib/azurerm*](../contrib/azurerm/README.md)
+You'll find Resource Group Templates and scripts to provision the required infrastructure to Azure in [*contrib/azurerm*](../../contrib/azurerm/README.md)

docs/cloud_providers/azure.md

@@ -36,7 +36,7 @@ You can reach the maintainers of this project at:
 
 ### Code of conduct
 
-Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
+Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](../../code-of-conduct.md).
 
 ## License
 

docs/ingress/alb_ingress_controller.md

@@ -38,7 +38,7 @@ Variables are listed with their default values, if applicable.
 #### CentOS/RHEL/AlmaLinux/Rocky Linux
 
 * `centos_fastestmirror_enabled: false`
-  Whether the [fastestmirror](https://wiki.centos.org/PackageManagement/Yum/FastestMirror) yum plugin should be enabled.
+  Whether the [fastestmirror](https://wiki.centos.org/PackageManagement(2f)Yum(2f)FastestMirror.html) yum plugin should be enabled.
 
 ## Example Playbook
 

docs/operating_systems/bootstrap-os.md

@@ -14,4 +14,4 @@ openSUSE Leap installation Notes:
 
   ```sudo zypper -n install python-Jinja2 python-netaddr```
 
-Now you can continue with [Preparing your deployment](getting-started.md#starting-custom-deployment)
+Now you can continue with [Preparing your deployment](../getting_started/getting-started.md)

docs/operating_systems/opensuse.md

@@ -19,4 +19,4 @@ Alternatively you can use the values `identity`, `aesgcm`, `aescbc` or `kms`.
 
 ## Details about Secretbox
 
-Secretbox uses [Poly1305](https://cr.yp.to/mac.html) as message-authentication code and [XSalsa20](https://www.xsalsa20.com/) as secret-key authenticated encryption and secret-key encryption.
+Secretbox uses [Poly1305](https://cr.yp.to/mac.html) as message-authentication code and [XSalsa20](https://en.wikipedia.org/wiki/Salsa20#XSalsa20_with_192-bit_nonce) as secret-key authenticated encryption and secret-key encryption.

docs/operations/encrypting-secret-data-at-rest.md

@@ -128,7 +128,7 @@ Let's take a deep look to the resultant **kubernetes** configuration:
   See <https://kubernetes.io/docs/reference/access-authn-authz/kubelet-tls-bootstrapping/> for more information on the subject.
 * If you are installing **kubernetes** in an AppArmor-based OS (eg. Debian/Ubuntu) you can enable the `AppArmor` feature gate uncommenting the lines with the comment `# AppArmor-based OS` on top.
 * The `kubelet_systemd_hardening`, both with `kubelet_secure_addresses` setup a minimal firewall on the system. To better understand how these variables work, here's an explanatory image:
-  ![kubelet hardening](img/kubelet-hardening.png)
+  ![kubelet hardening](../img/kubelet-hardening.png)
 
 Once you have the file properly filled, you can run the **Ansible** command to start the installation: