ibmcloud.ansible_collection.ibm_container_cluster_config_info (1.2.2) — module

Retrieve IBM Cloud 'ibm_container_cluster_config' resource

| "added in version" 2.8 of ibmcloud.ansible_collection"

Authors: Jay Carman (@jaywcarman)

preview | supported by community

Install collection

Install with ansible-galaxy collection install ibmcloud.ansible_collection:==1.2.2


Add to requirements.yml

  collections:
    - name: ibmcloud.ansible_collection
      version: 1.2.2

Description

Retrieve an IBM Cloud 'ibm_container_cluster_config' resource


Requirements

Inputs

    
admin:
    default: false
    description:
    - If set to true will download the config for admin
    required: false
    type: bool

region:
    description:
    - The cluster region
    required: false
    type: str

network:
    default: false
    description:
    - If set to true will download the Calico network config with the Admin config
    required: false
    type: bool

download:
    default: true
    description:
    - If set to false will not download the config, otherwise they are downloaded each
      time but onto the same path for a given cluster name/id
    required: false
    type: bool

org_guid:
    description:
    - The bluemix organization guid this cluster belongs to
    required: false
    type: str

config_dir:
    description:
    - The directory where the cluster config to be downloaded. Default is home directory
    required: false
    type: str

space_guid:
    description:
    - The bluemix space guid this cluster belongs to
    required: false
    type: str

account_guid:
    description:
    - The bluemix account guid this cluster belongs to
    required: false
    type: str

cluster_name_id:
    description:
    - The name/id of the cluster
    required: true
    type: str

ibmcloud_region:
    default: us-south
    description:
    - Denotes which IBM Cloud region to connect to
    required: false

config_file_path:
    description:
    - The absolute path to the kubernetes config yml file
    required: false
    type: str

ibmcloud_api_key:
    description:
    - The API Key used for authentification. This can also be provided via the environment
      variable 'IC_API_KEY'.
    required: true

resource_group_id:
    description:
    - ID of the resource group.
    required: false
    type: str

calico_config_file_path:
    description:
    - The absolute path to the calico network config file
    required: false
    type: str