VK Cloud logo
Обновлена 3 апреля 2024 г. в 09:41

Работа с секретамиBeta

Эти методы позволяют работать с секретами кластера Cloud Containers, который обеспечивает работу кластера Cloud Spark. Секреты Kubernetes позволяют организовать безопасное хранение и использование чувствительных данных, которые могут понадобиться во время выполнения задания Spark.

create_secret_from_yaml

Создает секрет в указанном пространстве имен на основе предоставленного манифеста. Манифест должен быть в формате YAML.

Необходимая роль токена: Администратор. Подробнее о ролях токенов.

Аргументы метода

Аргумент

Тип

Описание

cluster_id (обязательный)

str

Идентификатор кластера Cloud Spark, в котором нужно создать секрет. Список кластеров Cloud Spark и их идентификаторов можно получить с помощью метода get_clusters

secret_yaml_path (обязательный)

str

Путь к YAML-файлу с манифестом

namespace

str

Имя пространства имен, в котором нужно создать секрет. Это пространство имен должно существовать, иначе секрет не будет создан.

Если опустить этот аргумент при вызове метода, то будет использовано значение по умолчанию: default

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

Возвращает объект класса K8sSecret с информацией о созданном секрете.

Поле

Тип

Описание

name

str

Имя секрета

type

str

Тип секрета

namespace

str

Имя пространства имен, в котором находится секрет

data

dict[str,str]

Данные секрета в виде пар ключ: значение. Для безопасности данные не выводятся в открытом виде

Дополнительная информация

list_secrets

Получает список имен секретов в указанном пространстве имен. Возвращает объект класса K8sObjectNamesList, который содержит в себе список имен секретов.

Чтобы получить детальную информацию об отдельном секрете из списка, используйте метод get_secret_detail.

Необходимая роль токена: Администратор или Пользователь. Подробнее о ролях токенов.

Аргументы метода

Аргумент

Тип

Описание

cluster_id

str

Идентификатор кластера Cloud Spark, для которого нужно получить список секретов.

Список кластеров Cloud Spark и их идентификаторов можно получить с помощью метода get_clusters

namespace

str

Имя пространства имен, из которого нужно получить список секретов.

Если опустить этот аргумент при вызове метода, то будет использовано значение по умолчанию: default

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

Объект класса K8sObjectNamesList, который содержит в себе список имен секретов.

Дополнительная информация

get_secret_detail

Получает подробную информацию о секрете Kubernetes по его имени.

Необходимая роль токена: Администратор или Пользователь. Подробнее о ролях токенов.

Аргументы метода

Аргумент

Тип

Описание

cluster_id (обязательный)

str

Идентификатор кластера Cloud Spark, для которого нужно получить информацию о секрете.

Список кластеров Cloud Spark и их идентификаторов можно получить с помощью метода get_clusters

secret_name (обязательный)

str

Имя секрета, информацию о котором нужно получить.

Список имен секретов можно получить с помощью метода list_secrets

namespace

str

Имя пространства имен, в котором находится секрет.

Если опустить этот аргумент при вызове метода, то будет использовано значение по умолчанию: default

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

Возвращает объект класса K8sSecret с информацией о секрете.

Поле

Тип

Описание

name

str

Имя секрета

type

str

Тип секрета

namespace

str

Имя пространства имен, в котором находится секрет

data

dict[str,str]

Данные секрета в виде пар ключ: значение.

Для безопасности данные не выводятся в открытом виде

Дополнительная информация

delete_secret

Удаляет секрет по его имени.

Необходимая роль токена: Администратор. Подробнее о ролях токенов.

Аргументы метода

Аргумент

Тип

Описание

cluster_id (обязательный)

str

Идентификатор кластера Cloud Spark, для которого нужно получить информацию о секрете.

Список кластеров Cloud Spark и их идентификаторов можно получить с помощью метода get_clusters

secret_name (обязательный)

str

Имя секрета, который нужно удалить.

Список имен секретов можно получить с помощью метода list_secrets

namespace

str

Имя пространства имен, в котором находится секрет.

Если опустить этот аргумент при вызове метода, то будет использовано значение по умолчанию: default

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

Возвращаемого значения нет.

Дополнительная информация