mirror of
https://github.com/kubernetes-sigs/kubespray.git
synced 2026-02-15 18:20:02 -03:30
Adjust the table style to make it easier to read (#9731)
Signed-off-by: Fish-pro <zechun.chen@daocloud.io>
This commit is contained in:
Fish-pro
GitHub
250
docs/ansible.md
250
docs/ansible.md
@@ -25,7 +25,7 @@ test -f requirements-$ANSIBLE_VERSION.yml && \
|
||||
Based on the table below and the available python version for your ansible host you should choose the appropriate ansible version to use with kubespray.
|
||||
|
||||
| Ansible Version | Python Version |
|
||||
| --------------- | -------------- |
|
||||
|-----------------|----------------|
|
||||
| 2.11 | 2.7,3.5-3.9 |
|
||||
| 2.12 | 3.8-3.10 |
|
||||
|
||||
@@ -104,135 +104,135 @@ the `-e` runtime flags (most simple way) or other layers described in the docs.
|
||||
Kubespray uses only a few layers to override things (or expect them to
|
||||
be overridden for roles):
|
||||
|
||||
Layer | Comment
|
||||
------|--------
|
||||
**role defaults** | provides best UX to override things for Kubespray deployments
|
||||
inventory vars | Unused
|
||||
**inventory group_vars** | Expects users to use ``all.yml``,``k8s_cluster.yml`` etc. to override things
|
||||
inventory host_vars | Unused
|
||||
playbook group_vars | Unused
|
||||
playbook host_vars | Unused
|
||||
**host facts** | Kubespray overrides for internal roles' logic, like state flags
|
||||
play vars | Unused
|
||||
play vars_prompt | Unused
|
||||
play vars_files | Unused
|
||||
registered vars | Unused
|
||||
set_facts | Kubespray overrides those, for some places
|
||||
**role and include vars** | Provides bad UX to override things! Use extra vars to enforce
|
||||
block vars (only for tasks in block) | Kubespray overrides for internal roles' logic
|
||||
task vars (only for the task) | Unused for roles, but only for helper scripts
|
||||
**extra vars** (always win precedence) | override with ``ansible-playbook -e @foo.yml``
|
||||
| Layer | Comment |
|
||||
|----------------------------------------|------------------------------------------------------------------------------|
|
||||
| **role defaults** | provides best UX to override things for Kubespray deployments |
|
||||
| inventory vars | Unused |
|
||||
| **inventory group_vars** | Expects users to use ``all.yml``,``k8s_cluster.yml`` etc. to override things |
|
||||
| inventory host_vars | Unused |
|
||||
| playbook group_vars | Unused |
|
||||
| playbook host_vars | Unused |
|
||||
| **host facts** | Kubespray overrides for internal roles' logic, like state flags |
|
||||
| play vars | Unused |
|
||||
| play vars_prompt | Unused |
|
||||
| play vars_files | Unused |
|
||||
| registered vars | Unused |
|
||||
| set_facts | Kubespray overrides those, for some places |
|
||||
| **role and include vars** | Provides bad UX to override things! Use extra vars to enforce |
|
||||
| block vars (only for tasks in block) | Kubespray overrides for internal roles' logic |
|
||||
| task vars (only for the task) | Unused for roles, but only for helper scripts |
|
||||
| **extra vars** (always win precedence) | override with ``ansible-playbook -e @foo.yml`` |
|
||||
|
||||
## Ansible tags
|
||||
|
||||
The following tags are defined in playbooks:
|
||||
|
||||
| Tag name | Used for
|
||||
|--------------------------------|---------
|
||||
| annotate | Create kube-router annotation
|
||||
| apps | K8s apps definitions
|
||||
| asserts | Check tasks for download role
|
||||
| aws-ebs-csi-driver | Configuring csi driver: aws-ebs
|
||||
| azure-csi-driver | Configuring csi driver: azure
|
||||
| bastion | Setup ssh config for bastion
|
||||
| bootstrap-os | Anything related to host OS configuration
|
||||
| calico | Network plugin Calico
|
||||
| calico_rr | Configuring Calico route reflector
|
||||
| canal | Network plugin Canal
|
||||
| cephfs-provisioner | Configuring CephFS
|
||||
| cert-manager | Configuring certificate manager for K8s
|
||||
| cilium | Network plugin Cilium
|
||||
| cinder-csi-driver | Configuring csi driver: cinder
|
||||
| client | Kubernetes clients role
|
||||
| cloud-provider | Cloud-provider related tasks
|
||||
| cluster-roles | Configuring cluster wide application (psp ...)
|
||||
| cni | CNI plugins for Network Plugins
|
||||
| containerd | Configuring containerd engine runtime for hosts
|
||||
| container_engine_accelerator | Enable nvidia accelerator for runtimes
|
||||
| container-engine | Configuring container engines
|
||||
| container-runtimes | Configuring container runtimes
|
||||
| coredns | Configuring coredns deployment
|
||||
| crio | Configuring crio container engine for hosts
|
||||
| crun | Configuring crun runtime
|
||||
| csi-driver | Configuring csi driver
|
||||
| dashboard | Installing and configuring the Kubernetes Dashboard
|
||||
| dns | Remove dns entries when resetting
|
||||
| docker | Configuring docker engine runtime for hosts
|
||||
| download | Fetching container images to a delegate host
|
||||
| etcd | Configuring etcd cluster
|
||||
| etcd-secrets | Configuring etcd certs/keys
|
||||
| etchosts | Configuring /etc/hosts entries for hosts
|
||||
| external-cloud-controller | Configure cloud controllers
|
||||
| external-openstack | Cloud controller : openstack
|
||||
| external-provisioner | Configure external provisioners
|
||||
| external-vsphere | Cloud controller : vsphere
|
||||
| facts | Gathering facts and misc check results
|
||||
| files | Remove files when resetting
|
||||
| flannel | Network plugin flannel
|
||||
| gce | Cloud-provider GCP
|
||||
| gcp-pd-csi-driver | Configuring csi driver: gcp-pd
|
||||
| gvisor | Configuring gvisor runtime
|
||||
| helm | Installing and configuring Helm
|
||||
| ingress-controller | Configure ingress controllers
|
||||
| ingress_alb | AWS ALB Ingress Controller
|
||||
| init | Windows kubernetes init nodes
|
||||
| iptables | Flush and clear iptable when resetting
|
||||
| k8s-pre-upgrade | Upgrading K8s cluster
|
||||
| k8s-secrets | Configuring K8s certs/keys
|
||||
| k8s-gen-tokens | Configuring K8s tokens
|
||||
| kata-containers | Configuring kata-containers runtime
|
||||
| krew | Install and manage krew
|
||||
| kubeadm | Roles linked to kubeadm tasks
|
||||
| kube-apiserver | Configuring static pod kube-apiserver
|
||||
| kube-controller-manager | Configuring static pod kube-controller-manager
|
||||
| kube-vip | Installing and configuring kube-vip
|
||||
| kubectl | Installing kubectl and bash completion
|
||||
| kubelet | Configuring kubelet service
|
||||
| kube-ovn | Network plugin kube-ovn
|
||||
| kube-router | Network plugin kube-router
|
||||
| kube-proxy | Configuring static pod kube-proxy
|
||||
| localhost | Special steps for the localhost (ansible runner)
|
||||
| local-path-provisioner | Configure External provisioner: local-path
|
||||
| local-volume-provisioner | Configure External provisioner: local-volume
|
||||
| macvlan | Network plugin macvlan
|
||||
| master | Configuring K8s master node role
|
||||
| metallb | Installing and configuring metallb
|
||||
| metrics_server | Configuring metrics_server
|
||||
| netchecker | Installing netchecker K8s app
|
||||
| network | Configuring networking plugins for K8s
|
||||
| mounts | Umount kubelet dirs when reseting
|
||||
| multus | Network plugin multus
|
||||
| nginx | Configuring LB for kube-apiserver instances
|
||||
| node | Configuring K8s minion (compute) node role
|
||||
| nodelocaldns | Configuring nodelocaldns daemonset
|
||||
| node-label | Tasks linked to labeling of nodes
|
||||
| node-webhook | Tasks linked to webhook (grating access to resources)
|
||||
| nvidia_gpu | Enable nvidia accelerator for runtimes
|
||||
| oci | Cloud provider: oci
|
||||
| persistent_volumes | Configure csi volumes
|
||||
| persistent_volumes_aws_ebs_csi | Configuring csi driver: aws-ebs
|
||||
| persistent_volumes_cinder_csi | Configuring csi driver: cinder
|
||||
| persistent_volumes_gcp_pd_csi | Configuring csi driver: gcp-pd
|
||||
| persistent_volumes_openstack | Configuring csi driver: openstack
|
||||
| policy-controller | Configuring Calico policy controller
|
||||
| post-remove | Tasks running post-remove operation
|
||||
| post-upgrade | Tasks running post-upgrade operation
|
||||
| pre-remove | Tasks running pre-remove operation
|
||||
| pre-upgrade | Tasks running pre-upgrade operation
|
||||
| preinstall | Preliminary configuration steps
|
||||
| registry | Configuring local docker registry
|
||||
| reset | Tasks running doing the node reset
|
||||
| resolvconf | Configuring /etc/resolv.conf for hosts/apps
|
||||
| rbd-provisioner | Configure External provisioner: rdb
|
||||
| services | Remove services (etcd, kubelet etc...) when resetting
|
||||
| snapshot | Enabling csi snapshot
|
||||
| snapshot-controller | Configuring csi snapshot controller
|
||||
| upgrade | Upgrading, f.e. container images/binaries
|
||||
| upload | Distributing images/binaries across hosts
|
||||
| vsphere-csi-driver | Configuring csi driver: vsphere
|
||||
| weave | Network plugin Weave
|
||||
| win_nodes | Running windows specific tasks
|
||||
| youki | Configuring youki runtime
|
||||
| Tag name | Used for |
|
||||
|--------------------------------|-------------------------------------------------------|
|
||||
| annotate | Create kube-router annotation |
|
||||
| apps | K8s apps definitions |
|
||||
| asserts | Check tasks for download role |
|
||||
| aws-ebs-csi-driver | Configuring csi driver: aws-ebs |
|
||||
| azure-csi-driver | Configuring csi driver: azure |
|
||||
| bastion | Setup ssh config for bastion |
|
||||
| bootstrap-os | Anything related to host OS configuration |
|
||||
| calico | Network plugin Calico |
|
||||
| calico_rr | Configuring Calico route reflector |
|
||||
| canal | Network plugin Canal |
|
||||
| cephfs-provisioner | Configuring CephFS |
|
||||
| cert-manager | Configuring certificate manager for K8s |
|
||||
| cilium | Network plugin Cilium |
|
||||
| cinder-csi-driver | Configuring csi driver: cinder |
|
||||
| client | Kubernetes clients role |
|
||||
| cloud-provider | Cloud-provider related tasks |
|
||||
| cluster-roles | Configuring cluster wide application (psp ...) |
|
||||
| cni | CNI plugins for Network Plugins |
|
||||
| containerd | Configuring containerd engine runtime for hosts |
|
||||
| container_engine_accelerator | Enable nvidia accelerator for runtimes |
|
||||
| container-engine | Configuring container engines |
|
||||
| container-runtimes | Configuring container runtimes |
|
||||
| coredns | Configuring coredns deployment |
|
||||
| crio | Configuring crio container engine for hosts |
|
||||
| crun | Configuring crun runtime |
|
||||
| csi-driver | Configuring csi driver |
|
||||
| dashboard | Installing and configuring the Kubernetes Dashboard |
|
||||
| dns | Remove dns entries when resetting |
|
||||
| docker | Configuring docker engine runtime for hosts |
|
||||
| download | Fetching container images to a delegate host |
|
||||
| etcd | Configuring etcd cluster |
|
||||
| etcd-secrets | Configuring etcd certs/keys |
|
||||
| etchosts | Configuring /etc/hosts entries for hosts |
|
||||
| external-cloud-controller | Configure cloud controllers |
|
||||
| external-openstack | Cloud controller : openstack |
|
||||
| external-provisioner | Configure external provisioners |
|
||||
| external-vsphere | Cloud controller : vsphere |
|
||||
| facts | Gathering facts and misc check results |
|
||||
| files | Remove files when resetting |
|
||||
| flannel | Network plugin flannel |
|
||||
| gce | Cloud-provider GCP |
|
||||
| gcp-pd-csi-driver | Configuring csi driver: gcp-pd |
|
||||
| gvisor | Configuring gvisor runtime |
|
||||
| helm | Installing and configuring Helm |
|
||||
| ingress-controller | Configure ingress controllers |
|
||||
| ingress_alb | AWS ALB Ingress Controller |
|
||||
| init | Windows kubernetes init nodes |
|
||||
| iptables | Flush and clear iptable when resetting |
|
||||
| k8s-pre-upgrade | Upgrading K8s cluster |
|
||||
| k8s-secrets | Configuring K8s certs/keys |
|
||||
| k8s-gen-tokens | Configuring K8s tokens |
|
||||
| kata-containers | Configuring kata-containers runtime |
|
||||
| krew | Install and manage krew |
|
||||
| kubeadm | Roles linked to kubeadm tasks |
|
||||
| kube-apiserver | Configuring static pod kube-apiserver |
|
||||
| kube-controller-manager | Configuring static pod kube-controller-manager |
|
||||
| kube-vip | Installing and configuring kube-vip |
|
||||
| kubectl | Installing kubectl and bash completion |
|
||||
| kubelet | Configuring kubelet service |
|
||||
| kube-ovn | Network plugin kube-ovn |
|
||||
| kube-router | Network plugin kube-router |
|
||||
| kube-proxy | Configuring static pod kube-proxy |
|
||||
| localhost | Special steps for the localhost (ansible runner) |
|
||||
| local-path-provisioner | Configure External provisioner: local-path |
|
||||
| local-volume-provisioner | Configure External provisioner: local-volume |
|
||||
| macvlan | Network plugin macvlan |
|
||||
| master | Configuring K8s master node role |
|
||||
| metallb | Installing and configuring metallb |
|
||||
| metrics_server | Configuring metrics_server |
|
||||
| netchecker | Installing netchecker K8s app |
|
||||
| network | Configuring networking plugins for K8s |
|
||||
| mounts | Umount kubelet dirs when reseting |
|
||||
| multus | Network plugin multus |
|
||||
| nginx | Configuring LB for kube-apiserver instances |
|
||||
| node | Configuring K8s minion (compute) node role |
|
||||
| nodelocaldns | Configuring nodelocaldns daemonset |
|
||||
| node-label | Tasks linked to labeling of nodes |
|
||||
| node-webhook | Tasks linked to webhook (grating access to resources) |
|
||||
| nvidia_gpu | Enable nvidia accelerator for runtimes |
|
||||
| oci | Cloud provider: oci |
|
||||
| persistent_volumes | Configure csi volumes |
|
||||
| persistent_volumes_aws_ebs_csi | Configuring csi driver: aws-ebs |
|
||||
| persistent_volumes_cinder_csi | Configuring csi driver: cinder |
|
||||
| persistent_volumes_gcp_pd_csi | Configuring csi driver: gcp-pd |
|
||||
| persistent_volumes_openstack | Configuring csi driver: openstack |
|
||||
| policy-controller | Configuring Calico policy controller |
|
||||
| post-remove | Tasks running post-remove operation |
|
||||
| post-upgrade | Tasks running post-upgrade operation |
|
||||
| pre-remove | Tasks running pre-remove operation |
|
||||
| pre-upgrade | Tasks running pre-upgrade operation |
|
||||
| preinstall | Preliminary configuration steps |
|
||||
| registry | Configuring local docker registry |
|
||||
| reset | Tasks running doing the node reset |
|
||||
| resolvconf | Configuring /etc/resolv.conf for hosts/apps |
|
||||
| rbd-provisioner | Configure External provisioner: rdb |
|
||||
| services | Remove services (etcd, kubelet etc...) when resetting |
|
||||
| snapshot | Enabling csi snapshot |
|
||||
| snapshot-controller | Configuring csi snapshot controller |
|
||||
| upgrade | Upgrading, f.e. container images/binaries |
|
||||
| upload | Distributing images/binaries across hosts |
|
||||
| vsphere-csi-driver | Configuring csi driver: vsphere |
|
||||
| weave | Network plugin Weave |
|
||||
| win_nodes | Running windows specific tasks |
|
||||
| youki | Configuring youki runtime |
|
||||
|
||||
Note: Use the ``bash scripts/gen_tags.sh`` command to generate a list of all
|
||||
tags found in the codebase. New tags will be listed with the empty "Used for"
|
||||
|
||||
Reference in New Issue
Block a user