kubernetes.core.kubectl подключение – Выполнение задач в подах, работающих в Kubernetes.
Примечание
Этот плагин подключения входит в коллекцию kubernetes.core (версия 3.2.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install kubernetes.core. Для использования этого плагина подключения необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в книге задач укажите: kubernetes.core.kubectl.
Описание
- Используйте команду kubectl exec для выполнения задач в, или для помещения/получения файлов в, поды, работающие в контейнерной платформе Kubernetes.
Требования
Ниже перечислены требования к локальному узлу-контроллеру, на котором выполняется это подключение.
- kubectl (бинарник go)
Параметры
Параметр | Комментарии |
|---|---|
ca_cert псевдонимы: kubectl_ssl_ca_cert строка | Путь к сертификату CA, используемому для аутентификации с API. По умолчанию: Конфигурация:
|
client_cert псевдонимы: kubectl_cert_file строка | Путь к сертификату, используемому для аутентификации с API. По умолчанию: Конфигурация:
|
client_key псевдонимы: kubectl_key_file строка | Путь к файлу ключа, используемому для аутентификации с API. По умолчанию: Конфигурация:
|
kubectl_container строка | Имя контейнера. Требуется, когда под содержит более одного контейнера. По умолчанию: Конфигурация:
|
kubectl_context строка | Имя контекста, найденного в файле конфигурации K8s. По умолчанию: Конфигурация:
|
kubectl_extra_args строка | Дополнительные аргументы для передачи команде kubectl. Обратите внимание, что эта информация передаётся напрямую в командную строку и может содержать конфиденциальные данные. По умолчанию: Конфигурация:
|
kubectl_host строка | URL для доступа к API. По умолчанию: Конфигурация:
|
kubectl_kubeconfig строка | Путь к файлу конфигурации kubectl. По умолчанию ~/.kube/config Конфигурацию можно задать в виде словаря. Добавлено в версии 2.4.0. По умолчанию: Конфигурация:
|
kubectl_local_env_vars словарь добавлено в kubernetes.core 3.1.0 | Локальные переменные окружения, которые нужно передать команде kubectl. Обратите внимание, что эта информация передаётся напрямую в командную строку и может содержать конфиденциальные данные. По умолчанию: Конфигурация:
|
kubectl_namespace строка | Пространство имён под. По умолчанию: Конфигурация:
|
kubectl_password строка | Укажите пароль для аутентификации с API. Обратите внимание, что эта информация передаётся напрямую в командную строку и может содержать конфиденциальные данные. Рекомендуется использовать варианты аутентификации на основе файлов. По умолчанию: Конфигурация:
|
kubectl_pod string | Имя Pod. Требуется, когда имя хоста не совпадает с именем pod. По умолчанию: Настройка:
|
kubectl_token string | Токен доступа к API. Обратите внимание, что эта информация передается непосредственно в командную строку, что может привести к раскрытию конфиденциальных данных. Рекомендуется использовать опции аутентификации на основе файла. Настройка:
|
kubectl_username string | Укажите имя пользователя для аутентификации с API. По умолчанию: Настройка:
|
validate_certs aliases: kubectl_verify_ssl string | Проверять ли сертификат SSL сервера API. По умолчанию true. По умолчанию: Настройка:
|
Примеры
- name: Run a command in a pod using local kubectl with kubeconfig file ~/.kube/config
hosts: localhost
gather_facts: no
vars:
ansible_connection: kubernetes.core.kubectl
ansible_kubectl_namespace: my-namespace
ansible_kubectl_pod: my-pod
ansible_kubectl_container: my-container
tasks:
# be aware that the command is executed as the user that started the container
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
- name: Run a command in a pod using local kubectl with inventory variables
# Example inventory:
# k8s:
# hosts:
# foo.example.com:
# ansible_connection: kubernetes.core.kubectl
# ansible_kubectl_kubeconfig: /root/.kube/foo.example.com.config
# ansible_kubectl_pod: my-foo-pod
# ansible_kubectl_container: my-foo-container
# ansible_kubectl_namespace: my-foo-namespace
# bar.example.com:
# ansible_connection: kubernetes.core.kubectl
# ansible_kubectl_kubeconfig: /root/.kube/bar.example.com.config
# ansible_kubectl_pod: my-bar-pod
# ansible_kubectl_container: my-bar-container
# ansible_kubectl_namespace: my-bar-namespace
hosts: k8s
gather_facts: no
tasks:
# be aware that the command is executed as the user that started the container
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
- name: Run a command in a pod using dynamic inventory
hosts: localhost
gather_facts: no
vars:
kubeconfig: /root/.kube/config
namespace: my-namespace
my_app: my-app
tasks:
- name: Get My App pod info based on label
kubernetes.core.k8s_info:
kubeconfig: "{{ kubeconfig }}"
namespace: "{{ namespace }}"
kind: Pod
label_selectors: app.kubernetes.io/name = "{{ my_app }}"
register: my_app_pod
- name: Get My App pod name
ansible.builtin.set_fact:
my_app_pod_name: "{{ my_app_pod.resources[0].metadata.name }}"
- name: Add My App pod to inventory
ansible.builtin.add_host:
name: "{{ my_app_pod_name }}"
ansible_connection: kubernetes.core.kubectl
ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
ansible_kubectl_pod: "{{ my_app_pod_name }}"
ansible_kubectl_namespace: "{{ namespace }}"
- name: Run a command in My App pod
# be aware that the command is executed as the user that started the container
# and requires python to be installed in the image
ansible.builtin.command: echo "Hello, World!"
delegate_to: "{{ my_app_pod_name }}"
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/kubernetes/core/kubectl_connection.html
