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 Oct 27, 2021
1 parent 604a784 commit 31df91f
Show file tree
Hide file tree
Showing 11 changed files with 21 additions and 23 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.2](https://github.com/civo/terraform-provider-civo/releases/tag/v1.0.2) (27 October 2021)

### Merged
- [#102](https://github.com/civo/terraform-provider-civo/pull/102) - Remove newly added id attributes in resources

## [v1.0.1](https://github.com/civo/terraform-provider-civo/releases/tag/v1.0.1) (25 October 2021)

### Merged
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/dns_domain_name.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,13 @@ resource "civo_dns_domain_name" "main" {

- **name** (String) The name of the domain

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **account_id** (String) The account ID of the domain
- **id** (String) The ID of this resource.

## Import

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/dns_domain_record.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ resource "civo_dns_domain_record" "www" {

### Optional

- **id** (String) The ID of this resource.
- **priority** (Number) Useful for MX records only, the priority mail should be attempted it (defaults to 10)

### Read-Only

- **account_id** (String) The account ID of this resource
- **created_at** (String) Timestamp when this resource was created
- **id** (String) The ID of this resource.
- **updated_at** (String) Timestamp when this resource was updated

## Import
Expand Down
5 changes: 1 addition & 4 deletions docs/resources/firewall.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,10 @@ resource "civo_firewall" "www" {

### Optional

- **id** (String) The ID of this resource.
- **network_id** (String) The firewall network, if is not defined we use the default network
- **region** (String) The firewall region, if is not defined we use the global defined in the provider

### Read-Only

- **id** (String) The ID of this resource.

## Import

Import is supported using the following syntax:
Expand Down
5 changes: 1 addition & 4 deletions docs/resources/firewall_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,12 @@ resource "civo_firewall_rule" "custom_port" {

- **direction** (String) Will this rule affect ingress traffic (only `ingress` is supported now)
- **end_port** (String) The end of the port range (this is optional, by default it will only apply to the single port listed in start_port)
- **id** (String) The ID of this resource.
- **label** (String) A string that will be the displayed name/reference for this rule
- **protocol** (String) The protocol choice from `tcp`, `udp` or `icmp` (the default if unspecified is `tcp`)
- **region** (String) The region for this rule
- **start_port** (String) The start of the port range to configure for this rule (or the single port if required)

### Read-Only

- **id** (String) The ID of this resource.

## Import

Import is supported using the following syntax:
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ resource "civo_instance" "foo" {
- **disk_image** (String) The ID for the disk image to use to build the instance
- **firewall_id** (String) The ID of the firewall to use, from the current list. If left blank or not sent, the default firewall will be used (open to all)
- **hostname** (String) A fully qualified domain name that should be set as the instance's hostname
- **id** (String) The ID of this resource.
- **initial_user** (String) The name of the initial user created on the server (optional; this will default to the template's default_username and fallback to civo)
- **network_id** (String) This must be the ID of the network from the network listing (optional; default network used when not specified)
- **notes** (String) Add some notes to the instance
Expand All @@ -71,7 +72,6 @@ resource "civo_instance" "foo" {
- **cpu_cores** (Number) Instance's CPU cores
- **created_at** (String) Timestamp when the instance was created
- **disk_gb** (Number) Instance's disk (GB)
- **id** (String) The ID of this resource.
- **initial_password** (String, Sensitive) Initial password for login
- **private_ip** (String) Instance's private IP address
- **public_ip** (String) Instance's public IP address
Expand Down
3 changes: 1 addition & 2 deletions docs/resources/kubernetes_cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ resource "civo_kubernetes_cluster" "my-cluster" {
### Optional

- **applications** (String) Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
- **id** (String) The ID of this resource.
- **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
Expand All @@ -75,7 +76,6 @@ resource "civo_kubernetes_cluster" "my-cluster" {
- **api_endpoint** (String) The API server endpoint of the cluster
- **created_at** (String) The timestamp when the cluster was created
- **dns_entry** (String) The DNS name of the cluster
- **id** (String) The ID of this resource.
- **installed_applications** (List of Object) (see [below for nested schema](#nestedatt--installed_applications))
- **instances** (List of Object) (see [below for nested schema](#nestedatt--instances))
- **kubeconfig** (String, Sensitive) The kubeconfig of the cluster
Expand Down Expand Up @@ -115,7 +115,6 @@ 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))
- **size** (String)
Expand Down
5 changes: 1 addition & 4 deletions docs/resources/kubernetes_node_pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,10 @@ 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 g3.k3s.medium)

### Read-Only

- **id** (String) The ID of this resource.

## Import

Import is supported using the following syntax:
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ resource "civo_network" "custom_net" {

### Optional

- **id** (String) The ID of this resource.
- **region** (String) The region of the network

### Read-Only

- **default** (Boolean) If the network is default, this will be `true`
- **id** (String) The ID of this resource
- **name** (String) The name of the network

## Import
Expand Down
5 changes: 4 additions & 1 deletion docs/resources/ssh_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,13 @@ resource "civo_ssh_key" "my-user"{
- **name** (String) a string that will be the reference for the SSH key.
- **public_key** (String) a string containing the SSH public key.

### Optional

- **id** (String) The ID of this resource.

### Read-Only

- **fingerprint** (String) a string containing the SSH finger print.
- **id** (String) The ID of this resource.

## Import

Expand Down
5 changes: 1 addition & 4 deletions docs/resources/volume_attachment.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,7 @@ resource "civo_volume_attachment" "foobar" {

### Optional

- **region** (String) The region for the volume attachment

### Read-Only

- **id** (String) The ID of this resource.
- **region** (String) The region for the volume attachment


0 comments on commit 31df91f

Please sign in to comment.