Для выполнения действий необходимо наличие токена сервисного аккаунта Kubernetes.

GetKubernetesResource — получает ресурс из кластера Kubernetes.

Пример запроса

group: managed-services.deckhouse.io
version: v1alpha1
resource_type: postgres
resource_name: example-postgres
namespace: default

Спецификация запроса

НазваниеОбязательностьОписаниеВозможные значения
groupДаAPI-группа ресурса. Указывает, к какой группе API относится запрашиваемый объектОпределение требуемых Group и Version
versionДаВерсия API ресурсаОпределение требуемых Group и Version
resource_typeДаТип получаемого ресурса-
resource_nameДаНазвание конкретного ресурса, который необходимо получить-
namespaceДаНеймспейс, в котором находится ресурс-

Ответ

При успешном выполнении действие возвращает объект ресурса в поле resource. Если ресурс не найден, действие завершается с ошибкой.

НазваниеОписание
resourceОбъект ресурса в формате Kubernetes

Определение требуемых Group и Version

Каждому типу ресурса соответствует своя группа API (Group) и версия (Version). Полный список API-ресурсов с их группами и версиями приведён в документации Kubernetes.

Если неизвестно, какие требуются группы API и версии, можно использовать актуальные значения. Существует несколько способов их определить:

С помощью утилиты d8 k

Команда d8 k explain показывает apiVersion для ресурса.

Пример:

d8 k explain deployment

Пример вывода:

GROUP:      apps
KIND:       Deployment
VERSION:    v1

DESCRIPTION:
    Deployment enables declarative updates for Pods and ReplicaSets.
    
FIELDS:
...

С помощью документации

  1. Найдите нужный ресурс (например, Deployment).

  2. В заголовке указана API Group и версия. Пример для Deployment:

    apiVersion: apps/v1

    Здесь:

    • «API Group» — apps;
    • «Version» — v1.
←
Kubernetes / CreateKubernetesResource
Kubernetes / DeleteKubernetesResource
→