lke_cluster_info.md

lke_cluster_info

Get info about a Linode LKE cluster.

• Minimum Required Fields
• Examples
• Parameters
• Return Values

Minimum Required Fields

Field	Type	Required	Description
api_token	str	Required	The Linode account personal access token. It is necessary to run the module. It can be exposed by the environment variable LINODE_API_TOKEN instead. See details in Usage.

Examples

- name: Get info about an LKE cluster by label
  linode.cloud.lke_cluster_info:
    label: 'my-cluster' 

- name: Get info about an LKE cluster by ID
  linode.cloud.lke_cluster_info:
    id: 12345

Parameters

Field	Type	Required	Description
id	int	Optional	The ID of the LKE cluster. Optional if label is defined. (Conflicts With: label)
label	str	Optional	The label of the LKE cluster. Optional if id is defined. (Conflicts With: id)

Return Values

• cluster - The LKE cluster in JSON serialized form.

  • Sample Response:

    {
      "control_plane": {
        "acl": {
            "addresses": {
                "ipv4": ["0.0.0.0/0"], 
                "ipv6": ["2001:db8:1234:abcd::/64"]
            }, 
            "enabled": true
        },
        "high_availability": true
      },
      "created": "2019-09-12T21:25:30Z",
      "id": 1234,
      "k8s_version": "1.28",
      "label": "lkecluster12345",
      "region": "us-central",
      "tags": [
        "ecomm",
        "blogs"
      ],
      "updated": "2019-09-13T21:24:16Z"
    }

  • See the Linode API response documentation for a list of returned fields

• node_pools - A list of node pools in JSON serialized form.

  • Sample Response:

    [
      {
        "autoscaler": {
          "enabled": true,
          "max": 12,
          "min": 3
        },
        "disk_encryption": "enabled",
        "count": 6,
        "disks": [
          {
            "size": 1024,
            "type": "ext-4"
          }
        ],
        "id": 456,
        "nodes": [
          {
            "id": "123456",
            "instance_id": 123458,
            "status": "ready"
          }
        ],
        "tags": [
          "example tag",
          "another example"
        ],
        "type": "g6-standard-4"
      }
    ]

  • See the Linode API response documentation for a list of returned fields

• kubeconfig - The Base64-encoded kubeconfig used to access this cluster. NOTE: This value may be unavailable if the cluster is not fully provisioned.

  • Sample Response:

    "a3ViZWNvbmZpZyBjb250ZW50Cg=="

  • See the Linode API response documentation for a list of returned fields

• dashboard_url - The Cluster Dashboard access URL.

  • Sample Response:

    "https://example.dashboard.linodelke.net"

  • See the Linode API response documentation for a list of returned fields