control_plane_acl
Creates, updates, deletes, gets or lists a control_plane_acl resource.
Overview
| Name | control_plane_acl |
| Type | Resource |
| Id | linode.lke.control_plane_acl |
Fields
The following fields are returned by SELECT queries:
- get
Returns a single cluster's control plane access control list. The optional field revision-id provided will be reflected on GET response when (and only after) the ACL stanza is verified as enforced.
| Name | Datatype | Description |
|---|---|---|
addresses | object | Supports keys ipv4 and ipv6. Defaults to {}. |
enabled | boolean | Defines a default policy. A value of true results in a default policy of DENY. A value of false results in a default policy of ALLOW, such as for disabled access controls. It defaults to true. Creating a cluster with ACL, or upgrading a cluster to use ACL for LKE, is an irreversible change. Once upgraded, you can only toggle access controls with this field. |
revision-id | string | Enables clients to track events related to ACL update requests and enforcements. Optional field. If omitted, defaults to a randomly generated string. (example: 20240127r001) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | clusterId | Get a specific cluster's control plane access control List. Learn more... Learn more... | |
update | replace | clusterId | Updates a specific cluster's control plane access control list. Learn more... Learn more... | |
delete | delete | clusterId | Disable control plane access controls and deletes all rules. This has the same effect as calling PUT with an acl json map value of {“enabled” : false}.Learn more... Learn more... |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
clusterId | string | ID of the Kubernetes cluster to look up. (example: {{clusterId}}) |
SELECT examples
- get
Get a specific cluster's control plane access control List.
Learn more...
Learn more...
SELECT
addresses,
enabled,
revision-id
FROM linode.lke.control_plane_acl
WHERE clusterId = '{{ clusterId }}' -- required
;
REPLACE examples
- update
Updates a specific cluster's control plane access control list.
Learn more...
Learn more...
REPLACE linode.lke.control_plane_acl
SET
acl = '{{ acl }}'
WHERE
clusterId = '{{ clusterId }}' --required
RETURNING
acl;
DELETE examples
- delete
Disable control plane access controls and deletes all rules. This has the same effect as calling PUT with an acl json map value of {“enabled” : false}.
Learn more...
Learn more...
DELETE FROM linode.lke.control_plane_acl
WHERE clusterId = '{{ clusterId }}' --required
;