Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
virjaina committed Dec 7, 2023
1 parent 12c1c35 commit 59c4cc5
Show file tree
Hide file tree
Showing 15 changed files with 32 additions and 13 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ bin

terraform.tfvars

*/.terraform.lock.hcl
*.terraform.lock.hcl

# Created by https://www.toptal.com/developers/gitignore/api/go,terraform
# Edit at https://www.toptal.com/developers/gitignore?templates=go,terraform
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/cloud_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ Get a cloud account

- `cloud_provider` (String) Slug of the Cloud Provider of the Cloud Account
- `display_name` (String) Name of the Cloud Account

### Optional

- `organisation` (String) Slug of the Organisation

### Read-Only
Expand Down
5 changes: 1 addition & 4 deletions docs/data-sources/cloud_accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,11 @@ List all cloud accounts within an organisation
<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `organisation` (String) Organisation Slug

### Optional

- `cloud_account_name` (String) Cloud Account Name
- `cloud_provider` (String) Cloud Provider Slug
- `organisation` (String) Organisation Slug

### Read-Only

Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/cloud_provider_availability_zones.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ List all availablility zones for a given cloud region
### Required

- `cloud_provider` (String)
- `organisation` (String)
- `region` (String)

### Optional

- `organisation` (String)

### Read-Only

- `availability_zones` (List of String)
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/cloud_provider_regions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ List all regions available for the cloud provider for the organisation
### Required

- `cloud_provider` (String)

### Optional

- `organisation` (String)

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/cloud_providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ List all Cloud Providers
<!-- schema generated by tfplugindocs -->
## Schema

### Required
### Optional

- `organisation` (String)

Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,12 @@ description: |-
### Required

- `environment` (String) Slug of the Environment of the Cluster
- `organisation` (String) Slug of the Organisation of the Cluster
- `slug` (String) Slug of the Cluster

### Optional

- `organisation` (String) Slug of the Organisation of the Cluster

### Read-Only

- `cloud_account_identity` (String) Identity of the Cloud Account used to deploy the Cluster
Expand Down
5 changes: 4 additions & 1 deletion docs/data-sources/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ Get an environment

### Required

- `organisation` (String) Slug of the organisation
- `slug` (String) Slug of the environment

### Optional

- `organisation` (String) Slug of the organisation

### Read-Only

- `id` (Number) The ID of this resource.
Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/nodepool_join_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ This datasource only works for Bring Your Own Node clusters.
- `cluster` (String) Slug of the cluster
- `environment` (String) Slug of the environment of the cluster
- `node_pool_id` (String) ID of the node pool

### Optional

- `organisation` (String) Slug of the Organisation

### Read-Only
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/organisation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Get an organisation
<!-- schema generated by tfplugindocs -->
## Schema

### Required
### Optional

- `slug` (String)

Expand Down
3 changes: 3 additions & 0 deletions docs/data-sources/update_channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ Get a Kubernetes update channel, including current Avisi Cloud Kubernetes versio
### Required

- `name` (String) Name of the update channel

### Optional

- `organisation` (String) Slug of the Organisation

### Read-Only
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ description: |-
### Optional

- `acloud_api` (String, Sensitive)
- `organisation` (String)
2 changes: 1 addition & 1 deletion docs/resources/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Create an Avisi Cloud Kubernetes cluster within an environment
- `cloud_account_identity` (String) Identity of the Cloud Account used to deploy the Cluster. Can only be set on cluster creation.
- `environment` (String) Slug of the Environment of the Cluster. Can only be set on cluster creation.
- `name` (String) Name of the Cluster
- `organisation` (String) Slug of the Organisation of the Cluster. Can only be set on cluster creation.
- `region` (String) Region of the Cloud Provider to deploy the Cluster in. Can only be set on cluster creation.
- `version` (String) Avisi Cloud Kubernetes version of the Cluster

Expand All @@ -33,6 +32,7 @@ Create an Avisi Cloud Kubernetes cluster within an environment
- `enable_network_encryption` (Boolean) Enable Network Encryption at the node level (if supported by the CNI).
- `enable_private_cluster` (Boolean) Enable Private Cluster mode. Can only be set on cluster creation.
- `environment_slug` (String, Deprecated)
- `organisation` (String) Slug of the Organisation of the Cluster. Can only be set on cluster creation.
- `organisation_slug` (String, Deprecated)
- `stopped` (Boolean) Stops the Cluster if set to true. False by default
- `update_channel` (String) Avisi Cloud Kubernetes Update Channel that the Cluster follows
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ Create an environment
### Required

- `name` (String) Name of the Environment
- `organisation` (String) Slug of the Organisation. Can only be set on creation.
- `type` (String) Type of the Environment. Available options: production, staging, development, demo, other

### Optional

- `description` (String) A human readable description about the environment
- `organisation` (String) Slug of the Organisation. Can only be set on creation.
- `organisation_slug` (String, Deprecated)
- `purpose` (String) Purpose of the Environment

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/nodepool.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ Create a node pool for a cluster
- `environment` (String) Slug of the Environment. Can only be set on creation.
- `name` (String) Name of the Node Pool
- `node_size` (String) Type of machines in the Node Pool
- `organisation` (String) Slug of the Organisation. Can only be set on creation.

### Optional

Expand All @@ -35,6 +34,7 @@ Create a node pool for a cluster
- `min_size` (Number) Minimum amount of nodes in the Node Pool. Used when auto_scaling is set to `true`.
- `node_auto_replacement` (Boolean)
- `node_count` (Number) Number of nodes in the Node Pool. Used when auto_scaling is set to `false`.
- `organisation` (String) Slug of the Organisation. Can only be set on creation.
- `organisation_slug` (String, Deprecated)
- `taints` (Block List) Taints to put on the nodes in the Node Pool (see [below for nested schema](#nestedblock--taints))

Expand Down

0 comments on commit 59c4cc5

Please sign in to comment.