ibmcloud.ansible_collection.ibm_container_cluster (1.2.2) — module

Configure IBM Cloud 'ibm_container_cluster' 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

Create, update or destroy an IBM Cloud 'ibm_container_cluster' resource


Requirements

Inputs

    
id:
    description:
    - (Required when updating or destroying existing resource) IBM Cloud Resource ID.
    required: false
    type: str

crn:
    description:
    - CRN of resource instance
    required: false
    type: str

albs:
    description:
    - None
    elements: dict
    required: false
    type: list

name:
    description:
    - (Required for new resource) The cluster name
    required: false
    type: str

tags:
    description:
    - None
    elements: str
    required: false
    type: list

state:
    choices:
    - available
    - absent
    default: available
    description:
    - State of resource
    required: false

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

billing:
    default: hourly
    description:
    - None
    required: false
    type: str

webhook:
    description:
    - None
    elements: dict
    required: false
    type: list

hardware:
    description:
    - (Required for new resource)
    required: false
    type: str

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

no_subnet:
    default: false
    description:
    - None
    required: false
    type: bool

subnet_id:
    description:
    - None
    elements: str
    required: false
    type: list

datacenter:
    description:
    - (Required for new resource) The datacenter where this cluster will be deployed
    required: false
    type: str

is_trusted:
    default: false
    description:
    - None
    required: false
    type: bool

server_url:
    description:
    - None
    required: false
    type: str

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

worker_num:
    default: 0
    description:
    - Number of worker nodes
    required: false
    type: int

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

kube_version:
    description:
    - None
    required: false
    type: str

machine_type:
    description:
    - None
    required: false
    type: str

resource_crn:
    description:
    - The crn of the resource
    required: false
    type: str

worker_pools:
    description:
    - None
    elements: dict
    required: false
    type: list

workers_info:
    description:
    - The IDs of the worker node
    elements: dict
    required: false
    type: list

resource_name:
    description:
    - The name of the resource
    required: false
    type: str

ingress_secret:
    description:
    - None
    required: false
    type: str

public_vlan_id:
    description:
    - None
    required: false
    type: str

disk_encryption:
    default: true
    description:
    - None
    required: false
    type: bool

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

private_vlan_id:
    description:
    - None
    required: false
    type: str

resource_status:
    description:
    - The status of the resource
    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

ingress_hostname:
    description:
    - None
    required: false
    type: str

default_pool_size:
    default: 1
    description:
    - The size of the default worker pool
    required: false
    type: int

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

wait_time_minutes:
    default: 90
    description:
    - None
    required: false
    type: int

update_all_workers:
    default: false
    description:
    - None
    required: false
    type: bool

resource_group_name:
    description:
    - The resource group name in which resource is provisioned
    required: false
    type: str

public_service_endpoint:
    description:
    - None
    required: false
    type: bool

resource_controller_url:
    description:
    - The URL of the IBM Cloud dashboard that can be used to explore and view details
      about this cluster
    required: false
    type: str

private_service_endpoint:
    description:
    - None
    required: false
    type: bool

public_service_endpoint_url:
    description:
    - None
    required: false
    type: str

private_service_endpoint_url:
    description:
    - None
    required: false
    type: str