opentelekomcloud.cloud.css_cluster_info (0.14.2) — module

Get info about CSS clusters.

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

Authors: Yustina Kvrivishvili (@YustinaKvr), Vladimir Vshivkov (@vladimirvshivkov)

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

Get CSS cluster info from the OTC.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Get info about clusters
- opentelekomcloud.cloud.css_cluster_info:
    name: "css-ea59"
    start: 1
    limit: 5
  register: result

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

name:
    description:
    - name or ID of the cluster to be queried.
    type: str

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

limit:
    description:
    - Number of clusters to be queried.
    - The default value is 10, indicating that 10 clusters are queried at a time.
    type: int

start:
    default: 1
    description:
    - Start value of the query.
    - The default value is 1, indicating that the query starts from the first cluster.
    type: int

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

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

client_key:
    aliases:
    - key
    description:
    - A path to a client key to use as part of the SSL transaction.
    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

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

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

cluster:
  contains:
    actions:
      description: Indicates the operation that is executed on the cluster.
      sample: REBOOTING
      type: list
    cmk_id:
      description: Key ID used for disk encryption.
      sample: 'null'
      type: str
    created_at:
      description: Time when a cluster is created. The format is ISO8601.
      sample: '2021-10-05T15:55:06'
      type: str
    datastore:
      contains:
        type:
          description: Supported type is elasticsearch
          sample: elasticsearch
          type: str
        version:
          description: Engine version number. The current version is 6.2.3, 7.1.1,
            or 7.6.2.
          sample: 7.6.2
          type: str
      description: Type of the data search engine.
      type: complex
    disk_encryption:
      description: Whether disks are encrypted.
      sample: 'null'
      type: str
    endpoint:
      description: Indicates the IP address and port number of the user used to access
        the VPC.
      sample: 10.0.0.169:9200,10.0.0.191:9200,10.0.0.112:9200
      type: str
    error:
      description:
      - Error codes.
      - CSS.6000 indicates that a cluster fails to be created.
      - CSS.6001 indicates that capacity expansion of a cluster fails.
      - CSS.6002 indicates that a cluster fails to be restarted.
      - CSS.6004 indicates that a node fails to be created in a cluster.
      - CSS.6005 indicates that the service fails to be initialized.
      sample: 'null'
      type: str
    id:
      description: Cluster ID.
      sample: a4edb35e-bded-4a44-ba9c-6b5d1f585f3d
      type: str
    is_disk_encrypted:
      description: Whether disks are encrypted.
      sample: false
      type: bool
    is_https_enabled:
      description: Communication encryption status.
      sample: false
      type: bool
    name:
      description: Cluster name.
      sample: css-test
      type: str
    nodes:
      contains:
        azCode:
          description: AZ to which a node belongs.
          sample: eu-de-01
          type: str
        id:
          description: Node ID.
          sample: 7575d430-c918-4a80-9dba-8baa9ab49862
          type: str
        name:
          description: Node name.
          sample: css-test-iustina-ess-esn-3-1
          type: str
        specCode:
          description: Node specifications.
          sample: css.medium.8
          type: str
        status:
          description:
          - Node status.
          - 100 The operation, such as node creation, is in progress.
          - 200 The instance is available.
          - 303 The instance is unavailable.
          sample: '200'
          type: str
        type:
          description: Supported type is ess (indicating the Elasticsearch node)
          sample: ess
          type: str
      description: Info about nodes included in cluster.
      type: complex
    progress:
      contains:
        CREATING:
          description: Inicates creation of cluster in percentage.
          sample: 2%
          type: str
      description: Cluster operation progress, which indicates the progress of cluster
        creation.
      type: complex
    router_id:
      description: Indicates the VPC ID.
      sample: 7ea09482-793a-4aed-b4ce-447113d10d69
      type: str
    security_group_id:
      description: Security group ID.
      sample: 120888d9-65be-4899-b07d-aa151c2895d4
      type: str
    status:
      description:
      - Return value.
      - 400 BadRequest. Invalid request.
      - 404 NotFound. The requested resource cannot be found.
      - 200 OK. The request is processed successfully.
      sample: '200'
      type: str
    subnet_id:
      description: Subnet ID.
      sample: 8d9bd4e8-3c88-4991-8df3-d5e3cfd9a835
      type: str
    updated_at:
      description:
      - Last modification time of a cluster.
      - The format is ISO8601.
      sample: '2021-10-13T10:35:56'
      type: str
  description:
  - Info about specified CSS cluster.
  returned: On Success
  type: complex