Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed 'applications' argument's description and corresponding examples. #38

Merged
merged 1 commit into from
Jun 14, 2021
Merged

Fixed 'applications' argument's description and corresponding examples. #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion civo/resource_kubernetes_cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ func resourceKubernetesCluster() *schema.Resource {
Optional: true,
Description: "a comma separated list of applications to install." +
"Spaces within application names are fine, but shouldn't be either side of the comma." +
"If you want to remove a default installed application, prefix it with a '-', e.g. -traefik.",
"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.",
},
// Computed resource
"instances": instanceSchema(),
Expand Down
6 changes: 3 additions & 3 deletions docs/resources/kubernetes_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Provides a Civo Kubernetes cluster resource. This can be used to create, delete,

resource "civo_kubernetes_cluster" "my-cluster" {
name = "my-cluster"
applications = "Portainer, Traefik"
applications = "Portainer,Traefik"
num_target_nodes = 4
target_nodes_size = element(data.civo_instances_size.small.sizes, 0).name
}
Expand All @@ -31,7 +31,7 @@ The cluster's kubeconfig is exported as an attribute allowing you to use it with
resource "civo_kubernetes_cluster" "my-cluster" {
name = "my-cluster"
region = "NYC1"
applications = "Portainer, Traefik"
applications = "Portainer,Traefik"
num_target_nodes = 4
target_nodes_size = element(data.civo_instances_size.small.sizes, 0).name
}
Expand All @@ -57,7 +57,7 @@ The following arguments are supported:
* `target_nodes_size` - (Optional) The size of each node (The default is currently g3.k3s.small)
* `kubernetes_version` - (Optional) The version of k3s to install (The default is currently the latest available).
* `tags` - (Optional) A space separated list of tags, to be used freely as required.
* `applications` - (Optional) A comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. If you want to remove a default installed application, prefix it with a '-', e.g. -traefik
* `applications` - (Optional) A 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

## Attributes Reference

Expand Down