Skip to content

Commit

Permalink
Merge pull request #588 from linode/dev
Browse files Browse the repository at this point in the history
v0.31.0
  • Loading branch information
ykim-akamai authored Sep 17, 2024
2 parents eb7f259 + 7769e33 commit e1d019b
Show file tree
Hide file tree
Showing 55 changed files with 622 additions and 337 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ Name | Description |
[linode.cloud.firewall_list](./docs/modules/firewall_list.md)|List and filter on Firewalls.|
[linode.cloud.image_list](./docs/modules/image_list.md)|List and filter on Images.|
[linode.cloud.instance_list](./docs/modules/instance_list.md)|List and filter on Instances.|
[linode.cloud.instance_type_list](./docs/modules/instance_type_list.md)|**NOTE: This module has been deprecated in favor of `type_list`.|
[linode.cloud.lke_version_list](./docs/modules/lke_version_list.md)|List Kubernetes versions available for deployment to a Kubernetes cluster.|
[linode.cloud.instance_type_list](./docs/modules/instance_type_list.md)|**NOTE: This module has been deprecated in favor of `type_list`.**|
[linode.cloud.lke_version_list](./docs/modules/lke_version_list.md)|List and filter on LKE Versions.|
[linode.cloud.nodebalancer_list](./docs/modules/nodebalancer_list.md)|List and filter on Node Balancers.|
[linode.cloud.object_cluster_list](./docs/modules/object_cluster_list.md)|**NOTE: This module has been deprecated because it relies on deprecated API endpoints. Going forward, `region` will be the preferred way to designate where Object Storage resources should be created.**|
[linode.cloud.placement_group_list](./docs/modules/placement_group_list.md)|List and filter on Placement Groups.|
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/firewall_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Get info about a Linode Firewall.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Firewall to resolve. **(Conflicts With: `id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Firewall to resolve. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Firewall to resolve. **(Conflicts With: `id`)** |

## Return Values

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/image_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Get info about a Linode Image.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Image to resolve. **(Conflicts With: `id`)** |
| `id` | <center>`str`</center> | <center>Optional</center> | The ID of the Image to resolve. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Image to resolve. **(Conflicts With: `id`)** |

## Return Values

Expand Down
7 changes: 6 additions & 1 deletion docs/modules/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@ Manage Linode Instances, Configs, and Disks.
| `auto_disk_resize` | <center>`bool`</center> | <center>Optional</center> | Whether implicitly created disks should be resized during a type change operation. **(Default: `False`)** |
| `tags` | <center>`list`</center> | <center>Optional</center> | An array of tags applied to this object. Tags are for organizational purposes only. **(Updatable)** |
| [`placement_group` (sub-options)](#placement_group) | <center>`dict`</center> | <center>Optional</center> | A Placement Group to create this Linode under. |
| `disk_encryption` | <center>`str`</center> | <center>Optional</center> | The disk encryption status of this Linode. NOTE: Disk encryption may not currently be available to all users. **(Choices: `enabled`, `disabled`)** |
| `swap_size` | <center>`int`</center> | <center>Optional</center> | When deploying from an Image, this field is optional, otherwise it is ignored. This is used to set the swap disk size for the newly-created Linode. |

### configs
Expand Down Expand Up @@ -274,6 +275,7 @@ Manage Linode Instances, Configs, and Disks.
| `authorized_keys` | <center>`list`</center> | <center>Optional</center> | A list of SSH public key parts to deploy for the root user. |
| `authorized_users` | <center>`list`</center> | <center>Optional</center> | A list of usernames. |
| `filesystem` | <center>`str`</center> | <center>Optional</center> | The filesystem to create this disk with. |
| `disk_encryption` | <center>`str`</center> | <center>Optional</center> | The disk encryption status of this disk.NOTE: Disk encryption may not currently be available to all users. **(Choices: `enabled`, `disabled`)** |
| `image` | <center>`str`</center> | <center>Optional</center> | An Image ID to deploy the Disk from. |
| `root_pass` | <center>`str`</center> | <center>Optional</center> | The root user’s password on the newly-created Linode. |
| `stackscript_id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript to use when creating the instance. See the [Linode API documentation](https://techdocs.akamai.com/linode-api/reference/get-stack-scripts). |
Expand Down Expand Up @@ -354,6 +356,8 @@ Manage Linode Instances, Configs, and Disks.
"placement_group_type": "anti_affinity:local",
"placement_group_policy": "strict"
}
"disk_encryption": "enabled",
"lke_cluster_id": null
}
```
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-linode-instance) for a list of returned fields
Expand Down Expand Up @@ -439,7 +443,8 @@ Manage Linode Instances, Configs, and Disks.
"label": "Debian 9 Disk",
"size": 48640,
"status": "ready",
"updated": "2018-01-01T00:01:01"
"updated": "2018-01-01T00:01:01",
"disk_encryption": "enabled"
}
]
```
Expand Down
7 changes: 5 additions & 2 deletions docs/modules/instance_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Get info about a Linode Instance.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Instance to resolve. **(Conflicts With: `id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Instance to resolve. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Instance to resolve. **(Conflicts With: `id`)** |

## Return Values

Expand Down Expand Up @@ -89,6 +89,8 @@ Get info about a Linode Instance.
"placement_group_type": "anti_affinity:local",
"placement_group_policy": "strict"
}
"disk_encryption": "enabled",
"lke_cluster_id": null
}
```
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-linode-instance) for a list of returned fields
Expand Down Expand Up @@ -174,7 +176,8 @@ Get info about a Linode Instance.
"label": "Debian 9 Disk",
"size": 48640,
"status": "ready",
"updated": "2018-01-01T00:01:01"
"updated": "2018-01-01T00:01:01",
"disk_encryption": "enabled"
}
]
```
Expand Down
4 changes: 3 additions & 1 deletion docs/modules/instance_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,9 @@ List and filter on Instances.
],
"type": "g6-standard-1",
"updated": "2018-01-01T00:01:01",
"watchdog_enabled": true
"watchdog_enabled": true,
"disk_encryption": "enabled",
"lke_cluster_id": null
}
]
```
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/instance_type_list.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# instance_type_list

**NOTE: This module has been deprecated in favor of `type_list`.
**NOTE: This module has been deprecated in favor of `type_list`.**

List and filter on Linode Instance Types.
List and filter on Instance Types.

- [Minimum Required Fields](#minimum-required-fields)
- [Examples](#examples)
Expand Down
1 change: 1 addition & 0 deletions docs/modules/ip_share.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ WARNING! This module makes use of beta endpoints and requires the C(api_version)
|-----------|------|----------|------------------------------------------------------------------------------|
| `ips` | <center>`list`</center> | <center>**Required**</center> | A list of secondary Linode IPs to share with the primary Linode. |
| `linode_id` | <center>`int`</center> | <center>**Required**</center> | The ID of the primary Linode that the addresses will be shared with. |
| `state` | <center>`str`</center> | <center>**Required**</center> | The desired state of the target. **(Choices: `present`, `absent`)** |

## Return Values

Expand Down
12 changes: 12 additions & 0 deletions docs/modules/lke_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Manage Linode LKE clusters.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>**Required**</center> | This Kubernetes cluster’s unique label. |
| `state` | <center>`str`</center> | <center>**Required**</center> | The desired state of the target. **(Choices: `present`, `absent`)** |
| `k8s_version` | <center>`str`</center> | <center>Optional</center> | The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed. A version upgrade requires that you manually recycle the nodes in your cluster. **(Updatable)** |
| `region` | <center>`str`</center> | <center>Optional</center> | This Kubernetes cluster’s location. |
| `tags` | <center>`list`</center> | <center>Optional</center> | An array of tags applied to the Kubernetes cluster. |
Expand Down Expand Up @@ -87,6 +88,8 @@ Manage Linode LKE clusters.
| `count` | <center>`int`</center> | <center>**Required**</center> | The number of nodes in the Node Pool. **(Updatable)** |
| `type` | <center>`str`</center> | <center>**Required**</center> | The Linode Type for all of the nodes in the Node Pool. |
| [`autoscaler` (sub-options)](#autoscaler) | <center>`dict`</center> | <center>Optional</center> | When enabled, the number of nodes autoscales within the defined minimum and maximum values. **(Updatable)** |
| `labels` | <center>`dict`</center> | <center>Optional</center> | Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects. **(Updatable)** |
| [`taints` (sub-options)](#taints) | <center>`list`</center> | <center>Optional</center> | Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. **(Updatable)** |

### autoscaler

Expand All @@ -96,6 +99,14 @@ Manage Linode LKE clusters.
| `max` | <center>`int`</center> | <center>Optional</center> | The maximum number of nodes to autoscale to. Defaults to the value provided by the count field. **(Updatable)** |
| `min` | <center>`int`</center> | <center>Optional</center> | The minimum number of nodes to autoscale to. Defaults to the Node Pool’s count. **(Updatable)** |

### taints

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `key` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint key. **(Updatable)** |
| `value` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint value. **(Updatable)** |
| `effect` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint effect. **(Choices: `NoSchedule`, `PreferNoSchedule`, `NoExecute`; Updatable)** |

## Return Values

- `cluster` - The LKE cluster in JSON serialized form.
Expand Down Expand Up @@ -139,6 +150,7 @@ Manage Linode LKE clusters.
"max": 12,
"min": 3
},
"disk_encryption": "enabled",
"count": 6,
"disks": [
{
Expand Down
1 change: 1 addition & 0 deletions docs/modules/lke_cluster_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Get info about a Linode LKE cluster.
"max": 12,
"min": 3
},
"disk_encryption": "enabled",
"count": 6,
"disks": [
{
Expand Down
11 changes: 11 additions & 0 deletions docs/modules/lke_node_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Manage Linode LKE cluster node pools.
| `type` | <center>`str`</center> | <center>Optional</center> | The Linode Type for all of the nodes in the Node Pool. Required if `state` == `present`. |
| `skip_polling` | <center>`bool`</center> | <center>Optional</center> | If true, the module will not wait for all nodes in the node pool to be ready. **(Default: `False`)** |
| `wait_timeout` | <center>`int`</center> | <center>Optional</center> | The period to wait for the node pool to be ready in seconds. **(Default: `600`)** |
| `labels` | <center>`dict`</center> | <center>Optional</center> | Key-value pairs added as labels to nodes in the node pool. Labels help classify your nodes and to easily select subsets of objects. **(Updatable)** |
| [`taints` (sub-options)](#taints) | <center>`list`</center> | <center>Optional</center> | Kubernetes taints to add to node pool nodes. Taints help control how pods are scheduled onto nodes, specifically allowing them to repel certain pods. **(Updatable)** |

### autoscaler

Expand All @@ -77,6 +79,14 @@ Manage Linode LKE cluster node pools.
| `type` | <center>`str`</center> | <center>**Required**</center> | This custom disk partition’s filesystem type. **(Choices: `raw`, `ext4`)** |
| `size` | <center>`int`</center> | <center>**Required**</center> | The size of this custom disk partition in MB. |

### taints

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `key` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint key. **(Updatable)** |
| `value` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint value. **(Updatable)** |
| `effect` | <center>`str`</center> | <center>**Required**</center> | The Kubernetes taint effect. **(Choices: `NoSchedule`, `PreferNoSchedule`, `NoExecute`; Updatable)** |

## Return Values

- `node_pool` - The Node Pool in JSON serialized form.
Expand All @@ -89,6 +99,7 @@ Manage Linode LKE cluster node pools.
"max": 12,
"min": 3
},
"disk_encryption": "enabled",
"count": 6,
"disks": [
{
Expand Down
17 changes: 13 additions & 4 deletions docs/modules/lke_version_list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# lke_version_list

List Kubernetes versions available for deployment to a Kubernetes cluster.
List and filter on LKE Versions.

- [Minimum Required Fields](#minimum-required-fields)
- [Examples](#examples)
Expand All @@ -24,12 +24,21 @@ List Kubernetes versions available for deployment to a Kubernetes cluster.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `order` | <center>`str`</center> | <center>Optional</center> | The order to list lke versions in. **(Choices: `desc`, `asc`; Default: `asc`)** |
| `count` | <center>`int`</center> | <center>Optional</center> | The number of results to return. If undefined, all results will be returned. |
| `order` | <center>`str`</center> | <center>Optional</center> | The order to list LKE Versions in. **(Choices: `desc`, `asc`; Default: `asc`)** |
| `order_by` | <center>`str`</center> | <center>Optional</center> | The attribute to order LKE Versions by. |
| [`filters` (sub-options)](#filters) | <center>`list`</center> | <center>Optional</center> | A list of filters to apply to the resulting LKE Versions. |
| `count` | <center>`int`</center> | <center>Optional</center> | The number of LKE Versions to return. If undefined, all results will be returned. |

### filters

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-lke-versions). |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values

- `lke_versions` - The returned LKE versions.
- `lke_versions` - The returned LKE Versions.

- Sample Response:
```json
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/nodebalancer_info.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Get info about a Linode Node Balancer.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer to resolve. **(Conflicts With: `id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Node Balancer to resolve. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer to resolve. **(Conflicts With: `id`)** |

## Return Values

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/nodebalancer_stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ Get info about a Linode Node Balancer Stats.
| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer Stats to resolve. **(Conflicts With: `id`)** |
| `id` | <center>`int`</center> | <center>Optional</center> | The ID of the Node Balancer Stats to resolve. **(Conflicts With: `label`)** |
| `label` | <center>`str`</center> | <center>Optional</center> | The label of the Node Balancer Stats to resolve. **(Conflicts With: `id`)** |

## Return Values

Expand Down
Loading

0 comments on commit e1d019b

Please sign in to comment.