epostnikof/kubespray
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/kubespray.git synced 2025-12-13 21:34:40 +03:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix typos found in the docs (#12638)

Browse Source 
Signed-off-by: Meza <meza-xyz@proton.me>
This commit is contained in:
Meza
2025-10-22 23:22:38 -04:00
committed by GitHub
parent 3edc979384
commit 1930ab7ed6
9 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CNI/macvlan.md
View File

@@ -32,7 +32,7 @@ add `kube_proxy_masquerade_all: true` in `group_vars/all/all.yml`
* Disable nodelocaldns * Disable nodelocaldns
The nodelocal dns IP is not reacheable. The nodelocal dns IP is not reachable.
Disable it in `sample/group_vars/k8s_cluster/k8s_cluster.yml` Disable it in `sample/group_vars/k8s_cluster/k8s_cluster.yml`

2
docs/CRI/cri-o.md
View File

@@ -80,7 +80,7 @@ The `crio_remap_enable` configures the `/etc/subuid` and `/etc/subgid` files to
By default, 16M uids and gids are reserved for user namespaces (256 pods * 65536 uids/gids) at the end of the uid/gid space. By default, 16M uids and gids are reserved for user namespaces (256 pods * 65536 uids/gids) at the end of the uid/gid space.
The `crio_default_capabilities` configure the default containers capabilities for the crio. The `crio_default_capabilities` configure the default containers capabilities for the crio.
Defaults capabilties are: Defaults capabilities are:
```yaml ```yaml
crio_default_capabilities: crio_default_capabilities:

4
docs/advanced/cert_manager.md
View File

@@ -6,7 +6,7 @@
- [Create New TLS Root CA Certificate and Key](#create-new-tls-root-ca-certificate-and-key) - [Create New TLS Root CA Certificate and Key](#create-new-tls-root-ca-certificate-and-key)
- [Install Cloudflare PKI/TLS `cfssl` Toolkit.](#install-cloudflare-pkitls-cfssl-toolkit) - [Install Cloudflare PKI/TLS `cfssl` Toolkit.](#install-cloudflare-pkitls-cfssl-toolkit)
- [Create Root Certificate Authority (CA) Configuration File](#create-root-certificate-authority-ca-configuration-file) - [Create Root Certificate Authority (CA) Configuration File](#create-root-certificate-authority-ca-configuration-file)
- [Create Certficate Signing Request (CSR) Configuration File](#create-certficate-signing-request-csr-configuration-file) - [Create Certificate Signing Request (CSR) Configuration File](#create-certificate-signing-request-csr-configuration-file)
- [Create TLS Root CA Certificate and Key](#create-tls-root-ca-certificate-and-key) - [Create TLS Root CA Certificate and Key](#create-tls-root-ca-certificate-and-key)
Cert-Manager is a native Kubernetes certificate management controller. It can help with issuing certificates from a variety of sources, such as Let’s Encrypt, HashiCorp Vault, Venafi, a simple signing key pair, or self signed. It will ensure certificates are valid and up to date, and attempt to renew certificates at a configured time before expiry. Cert-Manager is a native Kubernetes certificate management controller. It can help with issuing certificates from a variety of sources, such as Let’s Encrypt, HashiCorp Vault, Venafi, a simple signing key pair, or self signed. It will ensure certificates are valid and up to date, and attempt to renew certificates at a configured time before expiry.
@@ -134,7 +134,7 @@ $ cat > ca-config.json <<EOF
EOF EOF
``` ```
#### Create Certficate Signing Request (CSR) Configuration File #### Create Certificate Signing Request (CSR) Configuration File
The TLS certificate `names` details can be updated to your own specific requirements. The TLS certificate `names` details can be updated to your own specific requirements.

2
docs/advanced/gcp-lb.md
View File

@@ -1,4 +1,4 @@
# GCP Load Balancers for type=LoadBalacer of Kubernetes Services # GCP Load Balancers for type=LoadBalancer of Kubernetes Services
> **Removed**: Since v1.31 (the Kubespray counterpart is v2.27), Kubernetes no longer supports `cloud_provider`. (except external cloud provider) > **Removed**: Since v1.31 (the Kubespray counterpart is v2.27), Kubernetes no longer supports `cloud_provider`. (except external cloud provider)

8
docs/ansible/ansible.md
View File

@@ -42,7 +42,7 @@ Kubespray expects users to use one of the following variables sources for settin
|----------------------------------------|------------------------------------------------------------------------------| |----------------------------------------|------------------------------------------------------------------------------|
| inventory vars | | | inventory vars | |
| - **inventory group_vars** | most used | | - **inventory group_vars** | most used |
| - inventory host_vars | host specifc vars overrides, group_vars is usually more practical | | - inventory host_vars | host specific vars overrides, group_vars is usually more practical |
| **extra vars** (always win precedence) | override with ``ansible-playbook -e @foo.yml`` | | **extra vars** (always win precedence) | override with ``ansible-playbook -e @foo.yml`` |
[!IMPORTANT] [!IMPORTANT]
@@ -122,7 +122,7 @@ The following tags are defined in playbooks:
| metrics_server | Configuring metrics_server | | metrics_server | Configuring metrics_server |
| netchecker | Installing netchecker K8s app | | netchecker | Installing netchecker K8s app |
| network | Configuring networking plugins for K8s | | network | Configuring networking plugins for K8s |
| mounts | Umount kubelet dirs when reseting | | mounts | Umount kubelet dirs when resetting |
| multus | Network plugin multus | | multus | Network plugin multus |
| nginx | Configuring LB for kube-apiserver instances | | nginx | Configuring LB for kube-apiserver instances |
| node | Configuring K8s minion (compute) node role | | node | Configuring K8s minion (compute) node role |
@@ -184,10 +184,10 @@ Note: use `--tags` and `--skip-tags` wisely and only if you're 100% sure what yo
## Troubleshooting Ansible issues ## Troubleshooting Ansible issues
Having the wrong version of ansible, ansible collections or python dependencies can cause issue. Having the wrong version of ansible, ansible collections or python dependencies can cause issue.
In particular, Kubespray ship custom modules which Ansible needs to find, for which you should specify [ANSIBLE_LIBRAY](https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#adding-a-module-or-plugin-outside-of-a-collection) In particular, Kubespray ship custom modules which Ansible needs to find, for which you should specify [ANSIBLE_LIBRARY](https://docs.ansible.com/ansible/latest/dev_guide/developing_locally.html#adding-a-module-or-plugin-outside-of-a-collection)
```ShellSession ```ShellSession
export ANSIBLE_LIBRAY=<kubespray_dir>/library` export ANSIBLE_LIBRARY=<kubespray_dir>/library`
``` ```
A simple way to ensure you get all the correct version of Ansible is to use A simple way to ensure you get all the correct version of Ansible is to use

4
docs/developers/ci-setup.md
View File

@@ -6,7 +6,7 @@ See [.gitlab-ci.yml](/.gitlab-ci.yml) and the included files for an overview.
## Runners ## Runners
Kubespray has 2 types of GitLab runners, both deployed on the Kubespray CI cluster (hosted on Oracle Cloud Infrastucture): Kubespray has 2 types of GitLab runners, both deployed on the Kubespray CI cluster (hosted on Oracle Cloud Infrastructure):
- pods: use the [gitlab-ci kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/) - pods: use the [gitlab-ci kubernetes executor](https://docs.gitlab.com/runner/executors/kubernetes/)
- vagrant: custom executor running in pods with access to the libvirt socket on the nodes - vagrant: custom executor running in pods with access to the libvirt socket on the nodes
@@ -156,7 +156,7 @@ kube_feature_gates:
- "NodeSwap=True" - "NodeSwap=True"
``` ```
## Aditional files ## Additional files
This section documents additional files used to complete a deployment of the kubespray CI, these files sit on the control-plane node and assume a working kubernetes cluster. This section documents additional files used to complete a deployment of the kubespray CI, these files sit on the control-plane node and assume a working kubernetes cluster.

2
docs/ingress/metallb.md
View File

@@ -35,7 +35,7 @@ metallb_config:
effect: "NoSchedule" effect: "NoSchedule"
``` ```
If you'd like to set additional nodeSelector and tolerations values, you can do so in the following fasion: If you'd like to set additional nodeSelector and tolerations values, you can do so in the following fashion:
```yaml ```yaml
metallb_config: metallb_config:

2
docs/operating_systems/rhel.md
View File

@@ -37,4 +37,4 @@ If you have containers that are using iptables in the host network namespace (`h
you need to ensure they are using iptables-nft. you need to ensure they are using iptables-nft.
An example how k8s do the autodetection can be found [in this PR](https://github.com/kubernetes/kubernetes/pull/82966) An example how k8s do the autodetection can be found [in this PR](https://github.com/kubernetes/kubernetes/pull/82966)
The kernel version is lower than the kubenretes 1.32 system validation, please refer to the [kernel requirements](../operations/kernel-requirements.md). The kernel version is lower than the kubernetes 1.32 system validation, please refer to the [kernel requirements](../operations/kernel-requirements.md).

2
docs/operations/kernel-requirements.md
View File

@@ -11,7 +11,7 @@ kubeadm_ignore_preflight_errors:
The Kernel Version Matrixs: The Kernel Version Matrixs:
| OS Verion | Kernel Verion | Kernel >=4.19 | | OS Version | Kernel Version | Kernel >=4.19 |
|--- | --- | --- | |--- | --- | --- |
| RHEL 9 | 5.14 | :white_check_mark: | | RHEL 9 | 5.14 | :white_check_mark: |
| RHEL 8 | 4.18 | :x: | | RHEL 8 | 4.18 | :x: |