Spec-Zone.ru › Ansible

Модуль google.cloud.gcp_sql_ssl_cert – Создает сертификат GCP SslCert

Примечание

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

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

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

Для использования в playbook, укажите: google.cloud.gcp_sql_ssl_cert.

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

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

  • Представляет сертификат SSL, созданный для экземпляра Cloud SQL. Для использования сертификата SSL необходимо иметь клиентский сертификат SSL и связанный с ним клиентский ключ SSL. Клиентский ключ можно загрузить только при создании сертификата SSL с помощью метода insert.

Требования

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

  • python >= 2.6
  • requests >= 2.18.4
  • google-auth >= 1.3.0

Параметры

Параметр

Комментарии

access_token

строка

Токен доступа OAuth2, если тип учетных данных — accesstoken.

auth_kind

строка / обязательно

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

Варианты:

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

cert

строка

PEM-представление сертификата X.509.

cert_serial_number

строка

Серийный номер, извлеченный из сертификата.

common_name

строка

Имя, предоставленное пользователем. Ограничено [a-zA-Z.-_ ]+.

create_time

строка

Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

env_type

строка

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

Это не должно устанавливаться, если вы не знаете, что делаете.

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

expiration_time

строка

Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

instance

словарь / обязательно

Имя экземпляра Cloud SQL. Это не включает идентификатор проекта.

Это поле представляет собой ссылку на ресурс Instance в GCP. Его можно указать двумя способами. Во-первых, вы можете разместить словарь с ключом «name» и значением имени вашего ресурса. В качестве альтернативы, вы можете добавить `register: name-of-resource` к задаче gcp_sql_instance, а затем установить это поле instance в “{{ name-of-resource }}”

private_key

строка

Закрытый ключ, связанный с сертификатом.

project

строка

Используемый проект Google Cloud Platform.

scopes

список / элементы=строка

Массив используемых областей

service_account_contents

jsonarg

Содержимое файла Service Account JSON, либо в виде словаря, либо в виде JSON-строки, которая его представляет.

service_account_email

строка

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

service_account_file

путь

Путь к файлу Service Account JSON, если в качестве типа выбран serviceaccount.

sha1_fingerprint

строка

SHA-1 сертификата.

state

строка

Должен ли данный объект существовать в GCP

Варианты:

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

Примеры

- name: create a instance
  google.cloud.gcp_sql_instance:
    name: "{{resource_name}}-2"
    settings:
      ip_configuration:
        authorized_networks:
        - name: google dns server
          value: 8.8.8.8/32
      tier: db-n1-standard-1
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instance

- name: create a SSL cert
  google.cloud.gcp_sql_ssl_cert:
    common_name: "{{resource_name}}"
    instance: "{{instance['name'}}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возврата

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

Ключ

Описание

cert

строка

Представление сертификата X.509 в формате PEM.

Возвращено: успех

certSerialNumber

строка

Серийный номер, извлечённый из сертификата.

Возвращено: успех

commonName

строка

Указанное пользователем имя. Ограничено значением [a-zA-Z.-_ ]+.

Возвращено: успех

createTime

строка

Время создания сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

Возвращено: успех

expirationTime

строка

Время истечения срока действия сертификата в формате RFC 3339, например 2012-11-15T16:19:00.094Z.

Возвращено: успех

instance

словарь

Имя экземпляра Cloud SQL. Не включает идентификатор проекта.

Возвращено: успех

privateKey

строка

Закрытый ключ, связанный с сертификатом.

Возвращено: успех

sha1Fingerprint

строка

SHA-1 отпечаток сертификата.

Возвращено: успех

Авторы

  • Google Inc. (@googlecloudplatform)

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

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

© 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/google/cloud/gcp_sql_ssl_cert_module.html

Spec-Zone.ru

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