opentelekomcloud.cloud.swr_domain (0.14.2) — module

Create, update or delete domains in SWR

| "added in version" 0.14.2 of opentelekomcloud.cloud"

Authors: Ziukina Valeriia (@RusselSand)

Install collection

Install with ansible-galaxy collection install opentelekomcloud.cloud:==0.14.2


Add to requirements.yml

  collections:
    - name: opentelekomcloud.cloud
      version: 0.14.2

Description

Create, update or delete domains in Software Repository for Containers


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Create or delete SWR domain
- name: Create new organization
  opentelekomcloud.cloud.swr_domain:
    namespace: org_name
    repository: repo_name
    access_domain: domain_name
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete the domain
  opentelekomcloud.cloud.swr_domain:
    namespace: org_name
    repository: repo_name
    access_domain: domain_name
    state: absent

Inputs

    
auth:
    description:
    - Dictionary containing auth information as needed by the cloud's auth plugin strategy.
      For the default I(password) plugin, this would contain I(auth_url), I(username),
      I(password), I(project_name) and any information about domains (for example, I(os_user_domain_name)
      or I(os_project_domain_name)) if the cloud supports them. For other plugins, this
      param will need to contain whatever parameters that auth plugin requires. This parameter
      is not needed if a named cloud is provided or OpenStack OS_* environment variables
      are present.
    type: dict

wait:
    default: true
    description:
    - Should ansible wait until the requested resource is complete.
    type: bool

cloud:
    description:
    - Named cloud or cloud config to operate against. If I(cloud) is a string, it references
      a named cloud config as defined in an OpenStack clouds.yaml file. Provides default
      values for I(auth) and I(auth_type). This parameter is not needed if I(auth) is
      provided or if OpenStack OS_* environment variables are present. If I(cloud) is
      a dict, it contains a complete cloud configuration like would be in a section of
      clouds.yaml.
    type: raw

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether resource should be present or absent.
    type: str

permit:
    choices:
    - read
    default: read
    description:
    - Access permission. Currently supported only read
    - Mandatory for CREATE and UPDATE operations
    type: str

ca_cert:
    aliases:
    - cacert
    description:
    - A path to a CA Cert bundle that can be used as part of verifying SSL API requests.
    type: str

timeout:
    default: 180
    description:
    - How long should ansible wait for the requested resource.
    type: int

deadline:
    default: forever
    description:
    - Valid until.
    - If sharing is permanent, the value is forever.
    - Mandatory for CREATE and UPDATE operations
    type: str

auth_type:
    description:
    - Name of the auth plugin to use. If the cloud uses something other than password
      authentication, the name of the plugin should be indicated here and the contents
      of the I(auth) parameter should be updated accordingly.
    type: str

interface:
    aliases:
    - endpoint_type
    choices:
    - admin
    - internal
    - public
    default: public
    description:
    - Endpoint URL type to fetch from the service catalog.
    type: str

namespace:
    description: Mandatory name of organization.
    required: true
    type: str

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    type: str

repository:
    description: Mandatory name of repository
    required: true
    type: str

api_timeout:
    description:
    - How long should the socket layer wait before timing out for API calls. If this is
      omitted, nothing will be passed to the requests library.
    type: int

client_cert:
    aliases:
    - cert
    description:
    - A path to a client certificate to use as part of the SSL transaction.
    type: str

description:
    description: Description for domain
    type: str

region_name:
    description:
    - Name of the region.
    type: str

sdk_log_path:
    description:
    - Path to the logfile of the OpenStackSDK. If empty no log is written
    type: str

access_domain:
    description: Mandatory name of existing domain you want to share
    required: true
    type: str

sdk_log_level:
    choices:
    - ERROR
    - WARN
    - INFO
    - DEBUG
    default: WARN
    description: Log level of the OpenStackSDK
    type: str

validate_certs:
    aliases:
    - verify
    description:
    - Whether or not SSL API requests should be verified.
    - Before Ansible 2.3 this defaulted to C(yes).
    type: bool

Outputs

domain:
  contains:
    access_domain:
      description: Domain name
      sample: domain_name
      type: str
    created:
      description: Time when an image is created. It is the UTC standard time.
      sample: '2021-06-10T08:14:42.56632Z'
      type: str
    creator_id:
      description: ID of the creator
      sample: 0504186e6a8010e01f3ec009a7279baa
      type: str
    creator_name:
      description: Name of the creator
      sample: xxx
      type: str
    deadline:
      description: Expiration time
      sample: '2021-10-01T16:00:00Z'
      type: str
    description:
      description: Description
      sample: description
      type: str
    exist:
      description: Domain exists or not
      sample: true
      type: bool
    namespace:
      description: Organization name
      sample: org_name
      type: str
    permit:
      description: Permission
      sample: read
      type: str
    repository:
      description: Repository name
      sample: repo_name
      type: str
    status:
      description: Status. Valid of true, expired if false
      sample: true
      type: bool
    updated:
      description: Time when an image is updated. It is the UTC standard time.
      sample: '2021-06-10T08:14:42.56632Z'
      type: str
  description: Domain object.
  returned: On Success.
  type: complex