Модуль community.digitalocean.digital_ocean_kubernetes_info — Возвращает информацию об существующем кластере DigitalOcean Kubernetes

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.digitalocean.

Чтобы использовать её в книге задач, укажите: community.digitalocean.digital_ocean_kubernetes_info.

Новое в community.digitalocean 1.3.0

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Возвращает информацию об существующем кластере DigitalOcean Kubernetes.

Параметры

Параметр	Комментарии
name строка / обязательно	Человекопонятное имя кластера Kubernetes.
oauth_token алиасы: API_TOKEN строка / обязательно	Токен DigitalOcean OAuth; может быть указан в `DO_API_KEY`, `DO_API_TOKEN`, или `DO_OAUTH_TOKEN` переменных окружения
return_kubeconfig логическое	Управляет возвратом `kubeconfig`. Варианты: `false` ← (по умолчанию) `true`

Примеры

- name: Get information about an existing DigitalOcean Kubernetes cluster
  community.digitalocean.digital_ocean_kubernetes_info:
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    name: hacktoberfest
    return_kubeconfig: true
  register: my_cluster

- ansible.builtin.debug:
    msg: "Cluster name is {{ my_cluster.data.name }}, ID is {{ my_cluster.data.id }}"

- ansible.builtin.debug:
    msg: "Cluster kubeconfig is {{ my_cluster.data.kubeconfig }}"

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие — поля, уникальные для этого модуля:

Ключ	Описание
data словарь	Кластер DigitalOcean Kubernetes (и необязательный `kubeconfig`) Возвращаемое: changed Пример: {"auto_upgrade": false, "cluster_subnet": "10.244.0.0/16", "created_at": "2020-09-26T21:36:18Z", "endpoint": "https://REDACTED.k8s.ondigitalocean.com", "id": "REDACTED", "ipv4": "REDACTED", "kubeconfig": "apiVersion: v1\nclusters:\n- cluster:\n certificate-authority-data: REDACTED\n server: https://REDACTED.k8s.ondigitalocean.com\n name: do-nyc1-hacktoberfest\ncontexts:\n- context:\n cluster: do-nyc1-hacktoberfest\n user: do-nyc1-hacktoberfest-admin\n name: do-nyc1-hacktoberfest\ncurrent-context: do-nyc1-hacktoberfest\nkind: Config\npreferences: {}\nusers:\n- name: do-nyc1-hacktoberfest-admin\n user:\n token: REDACTED", "maintenance_policy": {"day": "any", "duration": "4h0m0s", "start_time": "13:00"}, "name": "hacktoberfest", "node_pools": [{"auto_scale": false, "count": 1, "id": "REDACTED", "labels": null, "max_nodes": 0, "min_nodes": 0, "name": "hacktoberfest-workers", "nodes": [{"created_at": "2020-09-26T21:36:18Z", "droplet_id": "REDACTED", "id": "REDACTED", "name": "hacktoberfest-workers-3tv46", "status": {"state": "running"}, "updated_at": "2020-09-26T21:40:28Z"}], "size": "s-1vcpu-2gb", "tags": ["k8s", "k8s:REDACTED", "k8s:worker"], "taints": []}], "region": "nyc1", "service_subnet": "10.245.0.0/16", "status": {"state": "running"}, "surge_upgrade": false, "tags": ["k8s", "k8s:REDACTED"], "updated_at": "2020-09-26T21:42:29Z", "version": "1.18.8-do.0", "vpc_uuid": "REDACTED"}

Ключ

Описание

data

словарь

Кластер DigitalOcean Kubernetes (и необязательный kubeconfig)

Возвращаемое: changed

Пример: {"auto_upgrade": false, "cluster_subnet": "10.244.0.0/16", "created_at": "2020-09-26T21:36:18Z", "endpoint": "https://REDACTED.k8s.ondigitalocean.com", "id": "REDACTED", "ipv4": "REDACTED", "kubeconfig": "apiVersion: v1\nclusters:\n- cluster:\n certificate-authority-data: REDACTED\n server: https://REDACTED.k8s.ondigitalocean.com\n name: do-nyc1-hacktoberfest\ncontexts:\n- context:\n cluster: do-nyc1-hacktoberfest\n user: do-nyc1-hacktoberfest-admin\n name: do-nyc1-hacktoberfest\ncurrent-context: do-nyc1-hacktoberfest\nkind: Config\npreferences: {}\nusers:\n- name: do-nyc1-hacktoberfest-admin\n user:\n token: REDACTED", "maintenance_policy": {"day": "any", "duration": "4h0m0s", "start_time": "13:00"}, "name": "hacktoberfest", "node_pools": [{"auto_scale": false, "count": 1, "id": "REDACTED", "labels": null, "max_nodes": 0, "min_nodes": 0, "name": "hacktoberfest-workers", "nodes": [{"created_at": "2020-09-26T21:36:18Z", "droplet_id": "REDACTED", "id": "REDACTED", "name": "hacktoberfest-workers-3tv46", "status": {"state": "running"}, "updated_at": "2020-09-26T21:40:28Z"}], "size": "s-1vcpu-2gb", "tags": ["k8s", "k8s:REDACTED", "k8s:worker"], "taints": []}], "region": "nyc1", "service_subnet": "10.245.0.0/16", "status": {"state": "running"}, "surge_upgrade": false, "tags": ["k8s", "k8s:REDACTED"], "updated_at": "2020-09-26T21:42:29Z", "version": "1.18.8-do.0", "vpc_uuid": "REDACTED"}

Авторы

Mark Mercado (@mamercad)

Ссылки на коллекцию

© 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/community/digitalocean/digital_ocean_kubernetes_info_module.html