From f6110723eb5294e6f668021e7705a075bd1208c4 Mon Sep 17 00:00:00 2001 From: Ignacio Anaya Date: Fri, 2 Aug 2024 15:13:34 -0300 Subject: [PATCH] docs: add missing template fos status datasources --- docs/data-sources/env_azure_status.md | 40 ++++++++++++++++++- docs/data-sources/env_gcp_status.md | 38 +++++++++++++++++- docs/data-sources/env_k8s_status.md | 34 +++++++++++++++- docs/index.md | 2 +- examples/provider/provider.tf | 2 +- .../data-sources/env_azure_status.md.tmpl | 20 ++++++++++ templates/data-sources/env_gcp_status.md.tmpl | 20 ++++++++++ templates/data-sources/env_k8s_status.md.tmpl | 20 ++++++++++ 8 files changed, 170 insertions(+), 6 deletions(-) create mode 100644 templates/data-sources/env_azure_status.md.tmpl create mode 100644 templates/data-sources/env_gcp_status.md.tmpl create mode 100644 templates/data-sources/env_k8s_status.md.tmpl diff --git a/docs/data-sources/env_azure_status.md b/docs/data-sources/env_azure_status.md index 9db0b95..253d29b 100644 --- a/docs/data-sources/env_azure_status.md +++ b/docs/data-sources/env_azure_status.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "altinitycloud_env_azure_status Data Source - terraform-provider-altinitycloud" subcategory: "" description: |- @@ -10,7 +9,44 @@ description: |- Altinity.Cloud Azure environment status data source. It will long pool the status until `matching_spec` is `true`. Use this data source to wait for the environment is fully provisioned. - +## Example Usage + +### Read Azure environment status: +```terraform +data "altinitycloud_env_azure_status" "current" { + name = "acme-staging" +} +``` + +### Wait for Azure environment to be fully provisioned: +```terraform +resource "altinitycloud_env_aws" "this" { + name = "acme-staging" + aws_account_id = "123456789012" + region = "us-east-1" + zones = ["us-east-1a", "us-east-1b"] + cidr = "10.67.0.0/21" + + node_groups = [ + { + node_type = "t4g.large" + capacity_per_zone = 10 + reservations = ["SYSTEM", "ZOOKEEPER"] + }, + { + node_type = "m6i.large" + capacity_per_zone = 10 + reservations = ["CLICKHOUSE"] + } + ] + cloud_connect = true +} + +data "altinitycloud_env_aws_status" "current" { + name = altinitycloud_env_aws.this.name + wait_for_applied_spec_revision = altinitycloud_env_aws.this.spec_revision +} +``` ## Schema diff --git a/docs/data-sources/env_gcp_status.md b/docs/data-sources/env_gcp_status.md index a8176c7..c775f1c 100644 --- a/docs/data-sources/env_gcp_status.md +++ b/docs/data-sources/env_gcp_status.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "altinitycloud_env_gcp_status Data Source - terraform-provider-altinitycloud" subcategory: "" description: |- @@ -10,7 +9,44 @@ description: |- Altinity.Cloud GCP environment status data source. It will long pool the status until `matching_spec` is `true`. Use this data source to wait for the environment is fully provisioned. +## Example Usage +### Read GCP environment status: +```terraform +data "altinitycloud_env_gcp_status" "current" { + name = "acme-staging" +} +``` + +### Wait for GCP environment to be fully provisioned: +```terraform +resource "altinitycloud_env_aws" "this" { + name = "acme-staging" + aws_account_id = "123456789012" + region = "us-east-1" + zones = ["us-east-1a", "us-east-1b"] + cidr = "10.67.0.0/21" + + node_groups = [ + { + node_type = "t4g.large" + capacity_per_zone = 10 + reservations = ["SYSTEM", "ZOOKEEPER"] + }, + { + node_type = "m6i.large" + capacity_per_zone = 10 + reservations = ["CLICKHOUSE"] + } + ] + cloud_connect = true +} + +data "altinitycloud_env_aws_status" "current" { + name = altinitycloud_env_aws.this.name + wait_for_applied_spec_revision = altinitycloud_env_aws.this.spec_revision +} +``` ## Schema diff --git a/docs/data-sources/env_k8s_status.md b/docs/data-sources/env_k8s_status.md index 58ed40c..6e5935d 100644 --- a/docs/data-sources/env_k8s_status.md +++ b/docs/data-sources/env_k8s_status.md @@ -1,5 +1,4 @@ --- -# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "altinitycloud_env_k8s_status Data Source - terraform-provider-altinitycloud" subcategory: "" description: |- @@ -10,7 +9,40 @@ description: |- Altinity.Cloud K8S environment status data source. It will long pool the status until `matching_spec` is `true`. Use this data source to wait for the environment is fully provisioned. +## Example Usage +### Read K8S environment status: +```terraform +data "altinitycloud_env_k8s_status" "current" { + name = "acme-staging" +} +``` + +### Wait for K8S environment to be fully provisioned: +```terraform +resource "altinitycloud_env_k8s" "this" { + name = "acme-staging" + distribution = "EKS" + + node_groups = [ + { + node_type = "t4g.large" + capacity_per_zone = 10 + reservations = ["SYSTEM", "ZOOKEEPER"] + }, + { + node_type = "m6i.large" + capacity_per_zone = 10 + reservations = ["CLICKHOUSE"] + } + ] +} + +data "altinitycloud_env_k8s_status" "current" { + name = altinitycloud_env_k8s.this.name + wait_for_applied_spec_revision = altinitycloud_env_k8s.this.spec_revision +} +``` ## Schema diff --git a/docs/index.md b/docs/index.md index 9b594df..fd64e91 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,7 +27,7 @@ terraform { altinitycloud = { source = "altinity/altinitycloud" # https://github.com/altinity/terraform-provider-altinitycloud/blob/master/CHANGELOG.md - version = "0.2.6" + version = "0.2.7" } } } diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf index d654198..d7d2fac 100644 --- a/examples/provider/provider.tf +++ b/examples/provider/provider.tf @@ -3,7 +3,7 @@ terraform { altinitycloud = { source = "altinity/altinitycloud" # https://github.com/altinity/terraform-provider-altinitycloud/blob/master/CHANGELOG.md - version = "0.2.6" + version = "0.2.7" } } } diff --git a/templates/data-sources/env_azure_status.md.tmpl b/templates/data-sources/env_azure_status.md.tmpl new file mode 100644 index 0000000..2fdecfe --- /dev/null +++ b/templates/data-sources/env_azure_status.md.tmpl @@ -0,0 +1,20 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +## Example Usage + +### Read Azure environment status: +{{tffile "examples/data-sources/altinitycloud_env_azure_status/main.tf"}} + +### Wait for Azure environment to be fully provisioned: +{{tffile "examples/data-sources/altinitycloud_env_azure_status/wait.tf"}} + +{{ .SchemaMarkdown | trimspace }} diff --git a/templates/data-sources/env_gcp_status.md.tmpl b/templates/data-sources/env_gcp_status.md.tmpl new file mode 100644 index 0000000..77db421 --- /dev/null +++ b/templates/data-sources/env_gcp_status.md.tmpl @@ -0,0 +1,20 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +## Example Usage + +### Read GCP environment status: +{{tffile "examples/data-sources/altinitycloud_env_gcp_status/main.tf"}} + +### Wait for GCP environment to be fully provisioned: +{{tffile "examples/data-sources/altinitycloud_env_aws_status/wait.tf"}} + +{{ .SchemaMarkdown | trimspace }} diff --git a/templates/data-sources/env_k8s_status.md.tmpl b/templates/data-sources/env_k8s_status.md.tmpl new file mode 100644 index 0000000..16ee23c --- /dev/null +++ b/templates/data-sources/env_k8s_status.md.tmpl @@ -0,0 +1,20 @@ +--- +page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}" +subcategory: "" +description: |- +{{ .Description | plainmarkdown | trimspace | prefixlines " " }} +--- + +# {{.Name}} ({{.Type}}) + +{{ .Description | trimspace }} + +## Example Usage + +### Read K8S environment status: +{{tffile "examples/data-sources/altinitycloud_env_k8s_status/main.tf"}} + +### Wait for K8S environment to be fully provisioned: +{{tffile "examples/data-sources/altinitycloud_env_k8s_status/wait.tf"}} + +{{ .SchemaMarkdown | trimspace }}