Skip to content

Commit

Permalink
Update docs and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions committed Apr 1, 2022
1 parent 7d1fbfc commit 0cd7675
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 31 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@

## [v1.0.14](https://github.com/civo/terraform-provider-civo/releases/tag/v1.0.14) (1 April 2022)

### Merged
- [#125](https://github.com/civo/terraform-provider-civo/pull/125) - Updated the terraform SDK in all resources

## [v1.0.13](https://github.com/civo/terraform-provider-civo/releases/tag/v1.0.13) (28 February 2022)

### Merged
Expand Down
6 changes: 3 additions & 3 deletions docs/data-sources/kubernetes_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ output "kubernetes_cluster_output" {
- **kubeconfig** (String) A representation of the Kubernetes cluster's kubeconfig in yaml format
- **kubernetes_version** (String) The version of Kubernetes
- **master_ip** (String) The IP of the Kubernetes master node
- **num_target_nodes** (Number) The size of the Kubernetes cluster
- **num_target_nodes** (Number, Deprecated) The size of the Kubernetes cluster
- **pools** (List of Object) (see [below for nested schema](#nestedatt--pools))
- **ready** (Boolean) If the Kubernetes cluster is ready
- **status** (String) The status of Kubernetes cluster
- **tags** (String) A list of tags
- **target_nodes_size** (String) The size of each node
- **target_nodes_size** (String, Deprecated) The size of each node

<a id="nestedatt--installed_applications"></a>
### Nested Schema for `installed_applications`
Expand Down Expand Up @@ -83,10 +83,10 @@ Read-Only:

Read-Only:

- **count** (Number)
- **id** (String)
- **instance_names** (Set of String)
- **instances** (List of Object) (see [below for nested schema](#nestedobjatt--pools--instances))
- **node_count** (Number)
- **size** (String)

<a id="nestedobjatt--pools--instances"></a>
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/loadbalancer.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ An error will be raised if the provided load balancer name does not exist in you
data civo_loadbalancer "my-lb" {
#id = "c385638f-6bb7-4d74-840c-4d98f3d15082" // Optional
name = "lb-name"
region = "LON1" // Optional
}
output "civo_loadbalancer_output" {
Expand All @@ -34,6 +35,7 @@ output "civo_loadbalancer_output" {

- **id** (String) The id of the load balancer to retrieve (You can find this id from service annotations 'kubernetes.civo.com/loadbalancer-id')
- **name** (String) The name of the load balancer (You can find this name from service annotations 'kubernetes.civo.com/loadbalancer-name')
- **region** (String) The region of the load balancer, if you delcare this field, the datasource will use this value instead of the one defined in the provider

### Read-Only

Expand Down
8 changes: 8 additions & 0 deletions docs/resources/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ resource "civo_instance" "foo" {
- **sshkey_id** (String) The ID of an already uploaded SSH public key to use for login to the default user (optional; if one isn't provided a random password will be set and returned in the initial_password field)
- **tags** (Set of String) An optional list of tags, represented as a key, value pair
- **template** (String, Deprecated) The ID for the template to use to build the instance
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

### Read-Only

Expand All @@ -80,6 +81,13 @@ resource "civo_instance" "foo" {
- **source_type** (String) Instance's source type
- **status** (String) Instance's status

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **create** (String)

## Import

Import is supported using the following syntax:
Expand Down
52 changes: 29 additions & 23 deletions docs/resources/kubernetes_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ resource "civo_firewall_rule" "kubernetes" {
resource "civo_kubernetes_cluster" "my-cluster" {
name = "my-cluster"
applications = "Portainer,Linkerd:Linkerd & Jaeger"
num_target_nodes = 2
target_nodes_size = element(data.civo_instances_size.xsmall.sizes, 0).name
firewall_id = civo_firewall.my-firewall.id
pools {
size = element(data.civo_instances_size.xsmall.sizes, 0).name
node_count = 3
}
}
```

Expand All @@ -58,6 +60,7 @@ resource "civo_kubernetes_cluster" "my-cluster" {
### Required

- **firewall_id** (String) The existing firewall ID to use for this cluster
- **pools** (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--pools))

### Optional

Expand All @@ -67,10 +70,10 @@ resource "civo_kubernetes_cluster" "my-cluster" {
- **kubernetes_version** (String) The version of k3s to install (optional, the default is currently the latest available)
- **name** (String) Name for your cluster, must be unique within your account
- **network_id** (String) The network for the cluster, if not declare we use the default one
- **num_target_nodes** (Number) The number of instances to create (optional, the default at the time of writing is 3)
- **num_target_nodes** (Number, Deprecated) The number of instances to create (optional, the default at the time of writing is 3)
- **region** (String) The region for the cluster, if not declare we use the region in declared in the provider
- **tags** (String) Space separated list of tags, to be used freely as required
- **target_nodes_size** (String) The size of each node (optional, the default is currently g4s.kube.medium)
- **target_nodes_size** (String, Deprecated) The size of each node (optional, the default is currently g4s.kube.medium)

### Read-Only

Expand All @@ -81,23 +84,25 @@ resource "civo_kubernetes_cluster" "my-cluster" {
- **instances** (List of Object) (see [below for nested schema](#nestedatt--instances))
- **kubeconfig** (String, Sensitive) The kubeconfig of the cluster
- **master_ip** (String) The IP address of the master node
- **pools** (List of Object) (see [below for nested schema](#nestedatt--pools))
- **ready** (Boolean) When cluster is ready, this will return `true`
- **status** (String) Status of the cluster

<a id="nestedatt--installed_applications"></a>
### Nested Schema for `installed_applications`
<a id="nestedblock--pools"></a>
### Nested Schema for `pools`

Read-Only:
Required:

- **application** (String)
- **category** (String)
- **installed** (Boolean)
- **version** (String)
- **node_count** (Number) Number of nodes in the nodepool
- **size** (String) Size of the nodes in the nodepool

Read-Only:

<a id="nestedatt--instances"></a>
### Nested Schema for `instances`
- **id** (String) Nodepool ID
- **instance_names** (Set of String) Instance names in the nodepool
- **instances** (List of Object) (see [below for nested schema](#nestedatt--pools--instances))

<a id="nestedatt--pools--instances"></a>
### Nested Schema for `pools.instances`

Read-Only:

Expand All @@ -110,19 +115,20 @@ Read-Only:
- **tags** (Set of String)


<a id="nestedatt--pools"></a>
### Nested Schema for `pools`

<a id="nestedatt--installed_applications"></a>
### Nested Schema for `installed_applications`

Read-Only:

- **count** (Number)
- **id** (String)
- **instance_names** (Set of String)
- **instances** (List of Object) (see [below for nested schema](#nestedobjatt--pools--instances))
- **size** (String)
- **application** (String)
- **category** (String)
- **installed** (Boolean)
- **version** (String)

<a id="nestedobjatt--pools--instances"></a>
### Nested Schema for `pools.instances`

<a id="nestedatt--instances"></a>
### Nested Schema for `instances`

Read-Only:

Expand Down
27 changes: 22 additions & 5 deletions docs/resources/kubernetes_node_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,19 @@ data "civo_instances_size" "xsmall" {
# Create a cluster
resource "civo_kubernetes_cluster" "my-cluster" {
name = "my-cluster"
num_target_nodes = 1
target_nodes_size = element(data.civo_instances_size.xsmall.sizes, 0).name
applications = "Portainer,Linkerd:Linkerd & Jaeger"
firewall_id = civo_firewall.my-firewall.id
pools {
size = element(data.civo_instances_size.xsmall.sizes, 0).name
node_count = 3
}
}
# Add a node pool
resource "civo_kubernetes_node_pool" "front-end" {
cluster_id = civo_kubernetes_cluster.my-cluster.id
num_target_nodes = 1
node_count = 1 // Optional
size = element(data.civo_instances_size.xsmall.sizes, 0).name // Optional
region = "LON1"
}
```
Expand All @@ -52,8 +57,20 @@ resource "civo_kubernetes_node_pool" "front-end" {
### Optional

- **id** (String) The ID of this resource.
- **num_target_nodes** (Number) the number of instances to create (optional, the default at the time of writing is 3)
- **target_nodes_size** (String) the size of each node (optional, the default is currently g4s.kube.medium)
- **node_count** (Number) the number of instances to create (optional, the default at the time of writing is 3)
- **num_target_nodes** (Number, Deprecated) the number of instances to create (optional, the default at the time of writing is 3)
- **size** (String) the size of each node (optional, the default is currently g4s.kube.medium)
- **target_nodes_size** (String, Deprecated) the size of each node (optional, the default is currently g4s.kube.medium)
- **timeouts** (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))

<a id="nestedblock--timeouts"></a>
### Nested Schema for `timeouts`

Optional:

- **create** (String)
- **delete** (String)
- **update** (String)

## Import

Expand Down

0 comments on commit 0cd7675

Please sign in to comment.