Spec-Zone.ru › Ansible

модуль google.cloud.gcp_cloudbuildv2_connection — создает ресурс GCP Cloudbuildv2.Connection

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

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

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_cloudbuildv2_connection.

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Подключение к системе управления версиями, например GitHub, GitHub Enterprise, Bitbucket Data Center/Cloud или GitLab.

Требования

Следующие требования должны быть выполнены на хосте, на котором выполняется этот модуль.

  • python >= 3.8
  • requests >= 2.18.4
  • google-auth >= 2.25.1

Параметры

Параметр

Комментарии

access_token

string

Токен доступа, используемый для аутентификации.

annotations

dictionary

Позволяет клиентам хранить небольшие объемы произвольных данных.

auth_kind

string / обязательно

Тип используемых учетных данных.

Варианты:

  • "accesstoken"
  • "application"
  • "machineaccount"
  • "serviceaccount"

bitbucket_cloud_config

dictionary

Конфигурация подключений к Bitbucket Cloud.

authorizer_credential

dictionary / обязательно

Токен доступа с разрешениями на использование областей `webhook`, `repository`, `repository:admin` и `pullrequest`.

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

Рекомендуется использовать системную учетную запись для создания этих учетных данных.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

read_authorizer_credential

dictionary / обязательно

Токен доступа с разрешением `repository`.

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

Рекомендуется использовать системную учетную запись для создания учетных данных.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

webhook_secret_secret_version

string / обязательно

Ресурс SecretManager, содержащий секрет веб-перехватчика, используемый для проверки событий веб-перехватчика; формат: `projects/*/secrets/*/versions/*`.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

workspace

string / обязательно

Идентификатор рабочей области Bitbucket Cloud, подключаемой к Google Cloud Platform.

bitbucket_data_center_config

dictionary

Конфигурация подключений к Bitbucket Data Center.

authorizer_credential

dictionary / обязательно

Токен доступа HTTP с разрешением в области `REPO_ADMIN`.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

host_uri

string / обязательно

URI узла Bitbucket Data Center, для которого создается это подключение.

read_authorizer_credential

dictionary / обязательно

Токен доступа HTTP с разрешением `REPO_READ`.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

server_version

string

Только для вывода.

Версия Bitbucket Data Center, работающего на узле `host_uri`.

service_directory_config

dictionary

Конфигурация использования Service Directory для приватного подключения к Bitbucket Data Center.

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

Если это поле оставить пустым, вызовы Bitbucket Data Center будут выполняться через общедоступный Интернет.

service

string / обязательно

Имя службы Service Directory.

Формат: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

ssl_ca

string

Сертификат SSL для запросов к Bitbucket Data Center.

webhook_secret_secret_version

string / обязательно

Ресурс SecretManager, содержащий секрет веб-перехватчика, используемый для проверки событий веб-перехватчика; формат: `projects/*/secrets/*/versions/*`.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

disabled

boolean

Если для параметра disabled задано значение true, функциональность этого подключения отключается.

Методы API для работы с репозиториями и обработка веб-перехватчиков для репозиториев в этом подключении будут отключены.

Варианты:

  • false
  • true

env_type

string

Указывает, в какой среде Ansible выполняется этот модуль.

Не задавайте этот параметр, если не знаете, что делаете.

Он изменяет только строку User Agent для всех запросов API.

github_config

dictionary

Конфигурация подключений к github.com.

app_installation_id

integer

Идентификатор установки приложения GitHub App.

authorizer_credential

dictionary

Учетные данные OAuth учетной записи, авторизовавшей GitHub App для Cloud Build.

Рекомендуется использовать служебную учетную запись вместо учетной записи обычного пользователя.

Токен OAuth должен быть связан с GitHub App для Cloud Build.

oauth_token_secret_version

string

Ресурс SecretManager, содержащий токен OAuth, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

github_enterprise_config

dictionary

Конфигурация подключений к экземпляру GitHub Enterprise.

app_id

integer

Идентификатор GitHub App, созданного из манифеста.

app_installation_id

integer

Идентификатор установки GitHub App.

app_slug

string

Имя GitHub App в формате, удобном для использования в URL.

host_uri

string / обязательно

URI узла GitHub Enterprise, для которого создается это подключение.

private_key_secret_version

string

Ресурс SecretManager, содержащий закрытый ключ GitHub App; формат: `projects/*/secrets/*/versions/*`.

service_directory_config

dictionary

Конфигурация использования Service Directory для приватного подключения к серверу GitHub Enterprise.

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

Если это поле оставить пустым, вызовы сервера GitHub Enterprise будут выполняться через общедоступный Интернет.

service

string / обязательно

Имя службы Service Directory.

Формат: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

ssl_ca

string

Сертификат SSL для запросов к GitHub Enterprise.

webhook_secret_secret_version

string

Ресурс SecretManager, содержащий секрет веб-перехватчика GitHub App; формат: `projects/*/secrets/*/versions/*`.

gitlab_config

dictionary

Конфигурация подключений к gitlab.com или экземпляру GitLab Enterprise.

authorizer_credential

dictionary / обязательно

Персональный токен доступа GitLab с разрешением в области `api`.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

host_uri

string

URI узла GitLab Enterprise, для которого создается это подключение.

Если значение не указано, используется значение по умолчанию https://gitlab.com.

read_authorizer_credential

dictionary / обязательно

Персональный токен доступа GitLab с минимально необходимым разрешением в области `read_api`.

user_token_secret_version

string / обязательно

Ресурс SecretManager, содержащий токен пользователя, который авторизует подключение Cloud Build.

Формат: `projects/*/secrets/*/versions/*`.

username

string

Только для вывода.

Имя пользователя, связанное с этим токеном.

server_version

string

Только для вывода.

Версия сервера GitLab Enterprise, работающего на узле `host_uri`.

service_directory_config

dictionary

Конфигурация использования Service Directory для приватного подключения к серверу GitLab Enterprise.

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

Если это поле оставить пустым, вызовы сервера GitLab Enterprise будут выполняться через общедоступный Интернет.

service

string / обязательно

Имя службы Service Directory.

Формат: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}.

ssl_ca

string

Сертификат SSL для запросов к GitLab Enterprise.

webhook_secret_secret_version

string / обязательно

Ресурс SecretManager, содержащий секрет веб-перехватчика проекта GitLab Enterprise; формат: `projects/*/secrets/*/versions/*`.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

location

string / обязательно

Расположение ресурса.

name

string / обязательно

Имя ресурса подключения.

Это свойство неизменяемо. Чтобы изменить его, необходимо удалить ресурс и создать его заново.

project

string

Проект Google Cloud Platform, который нужно использовать.

scopes

list / elements=string

Массив областей доступа для использования.

service_account_contents

jsonarg

Содержимое JSON-файла учетной записи службы

в виде словаря или строки JSON, представляющей его.

service_account_email

string

Необязательный адрес электронной почты учетной записи службы, если выбран

machineaccount и пользователь не хочет использовать адрес по умолчанию.

service_account_file

path

Путь к JSON-файлу учетной записи службы, если в качестве типа

выбрано serviceaccount.

state

string

Должен ли ресурс существовать в GCP.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

Примечания

Примечание

  • Справочник API: https://cloud.google.com/build/docs/api/reference/rest
  • Официальное руководство по документации: https://cloud.google.com/build/docs
  • Для аутентификации можно задать auth_kind с помощью переменной окружения GCP_AUTH_KIND.
  • Для аутентификации можно задать service_account_file с помощью переменной окружения GCP_SERVICE_ACCOUNT_FILE.
  • Для аутентификации можно задать service_account_contents с помощью переменной окружения GCP_SERVICE_ACCOUNT_CONTENTS.
  • Для аутентификации можно задать service_account_email с помощью переменной окружения GCP_SERVICE_ACCOUNT_EMAIL.
  • Для аутентификации можно задать access_token с помощью переменной окружения GCP_ACCESS_TOKEN.
  • Для аутентификации можно задать scopes с помощью переменной окружения GCP_SCOPES.
  • Значения переменных окружения используются только в том случае, если значения в плейбуке не заданы.
  • Параметры service_account_email, service_account_file, service_account_file и access_token являются взаимоисключающими.

Примеры

- name: Create github enterprise connection
  google.cloud.gcp_cloudbuildv2_connection:
    name: ghe_conn
    state: present
    location: us-central1
    github_enterprise_config:
      host_uri: https://github.example.com
      app_id: 12345
      app_installation_id: 67890
      app_slug: my-app
      private_key_secret_version: "projects/{{ gcp_project }}/secrets/github-pk/versions/1"
      webhook_secret_secret_version: "projects/{{ gcp_project }}/secrets/github-webhook/versions/1"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

################################################################################

- name: Create github connection
  google.cloud.gcp_cloudbuildv2_connection:
    name: github_conn
    state: present
    location: us-central1
    github_config:
      app_installation_id: 123456
      authorizer_credential:
        oauth_token_secret_version: "projects/{{ gcp_project }}/secrets/github-oauth-token/versions/1"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

################################################################################

- name: Create gitlab connection
  google.cloud.gcp_cloudbuildv2_connection:
    name: gitlab_conn
    state: present
    location: us-central1
    gitlab_config:
      authorizer_credential:
        user_token_secret_version: "projects/{{ gcp_project }}/secrets/gitlab-api-token/versions/3"
      read_authorizer_credential:
        user_token_secret_version: "projects/{{ gcp_project }}/secrets/gitlab-read-api-token/versions/1"
      webhook_secret_secret_version: "projects/{{ gcp_project }}/secrets/gitlab-webhook/versions/4"
      host_uri: https://gitlab.example.com  # if unset, defaults to gitlab.com
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ

Описание

changed

boolean

Был ли изменен ресурс.

Возвращается: всегда

createTime

string

Только для вывода.

Временная метка, присвоенная сервером и указывающая время создания подключения.

Возвращается: при успехе

etag

string

Эта контрольная сумма вычисляется сервером на основе значений других полей. Ее можно передавать в запросах на обновление и удаление, чтобы убедиться, что клиент располагает актуальным значением перед продолжением операции.

Возвращается: при успехе

installationState

dictionary

Только для вывода.

Состояние установки подключения.

Возвращается: при успехе

actionUri

string

Только для вывода.

Ссылка для перехода к следующему действию.

Пустая строка, если установка уже завершена.

Возвращается: при успехе

message

string

Только для вывода.

Сообщение о том, что пользователю нужно сделать дальше, чтобы продолжить установку.

Пустая строка, если установка уже завершена.

Возвращается: при успехе

stage

string

Только для вывода.

Текущий этап процесса установки.

Возвращается: при успехе

reconciling

boolean

Только для вывода.

Установлено значение true, когда подключение настраивается или обновляется в фоновом режиме.

Возвращается: при успехе

state

string

Текущее состояние ресурса.

Возвращается: всегда

updateTime

string

Только для вывода.

Временная метка, присвоенная сервером и указывающая время обновления подключения.

Возвращается: при успехе

Авторы

  • Google Inc. (@googlecloudplatform)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_cloudbuildv2_connection_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API