docs: add links to altinity and aks sample

Altinity · Aug 2, 2024 · 55d69b5 · 55d69b5
1 parent ee3aa45
commit 55d69b5
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 0 deletions.
diff --git a/docs/resources/env_aws.md b/docs/resources/env_aws.md
@@ -7,6 +7,8 @@ description: |-
 
 # altinitycloud_env_aws (Resource)
 
+> For a detailed guide on provisioning an AWS environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-cloud-byoc/aws-remote-provisioning/#method-1-using-our-terraform-module).
+
 Bring Your Own Cloud (BYOC) AWS environment resource.
 
 ## Example Usage

diff --git a/docs/resources/env_azure.md b/docs/resources/env_azure.md
@@ -7,6 +7,8 @@ description: |-
 
 # altinitycloud_env_azure (Resource)
 
+> For a detailed guide on provisioning an Azure environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-cloud-byoc/aks-remote-provisioning/#using-terraform).
+
 Bring Your Own Cloud (BYOC) Azure environment resource.
 
 ## Example Usage

diff --git a/docs/resources/env_k8s.md b/docs/resources/env_k8s.md
@@ -7,6 +7,8 @@ description: |-
 
 # altinitycloud_env_k8s (Resource)
 
+> For a detailed guide on provisioning a K8S environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-kubernetes-byok/terraform/).
+
 Bring Your Own Kubernetes (BYOK) environment resource.
 
 ## Example Usage
@@ -89,6 +91,40 @@ resource "altinitycloud_env_k8s" "this" {
 }
 ```
 
+BYOK/AKS (Azure):
+```terraform
+resource "altinitycloud_env_certificate" "this" {
+  env_name = "acme-staging"
+}
+
+provider "kubernetes" {
+  # https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs
+  config_context = "make sure provider points at the AKS you want to connect"
+}
+
+module "altinitycloud_connect" {
+  source = "altinity/connect/altinitycloud"
+  pem    = altinitycloud_env_certificate.this.pem
+}
+
+resource "altinitycloud_env_k8s" "this" {
+  name         = altinitycloud_env_certificate.this.env_name
+  distribution = "AKS"
+  // node_groups should match existing node pools configuration.
+  node_groups = [
+    {
+      node_type         = "Standard_B2s_v2"
+      capacity_per_zone = 10
+      reservations      = ["CLICKHOUSE", "SYSTEM", "ZOOKEEPER"]
+    }
+  ]
+  depends_on = [
+    // "depends_on" is here to enforce "this resource, then altinitycloud_connect" order on destroy.
+    module.altinitycloud_connect
+  ]
+}
+```
+
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/examples/resources/altinitycloud_env_k8s/aks/main.tf b/examples/resources/altinitycloud_env_k8s/aks/main.tf
@@ -0,0 +1,30 @@
+resource "altinitycloud_env_certificate" "this" {
+  env_name = "acme-staging"
+}
+
+provider "kubernetes" {
+  # https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs
+  config_context = "make sure provider points at the AKS you want to connect"
+}
+
+module "altinitycloud_connect" {
+  source = "altinity/connect/altinitycloud"
+  pem    = altinitycloud_env_certificate.this.pem
+}
+
+resource "altinitycloud_env_k8s" "this" {
+  name         = altinitycloud_env_certificate.this.env_name
+  distribution = "AKS"
+  // node_groups should match existing node pools configuration.
+  node_groups = [
+    {
+      node_type         = "Standard_B2s_v2"
+      capacity_per_zone = 10
+      reservations      = ["CLICKHOUSE", "SYSTEM", "ZOOKEEPER"]
+    }
+  ]
+  depends_on = [
+    // "depends_on" is here to enforce "this resource, then altinitycloud_connect" order on destroy.
+    module.altinitycloud_connect
+  ]
+}
diff --git a/templates/resources/env_aws.md.tmpl b/templates/resources/env_aws.md.tmpl
@@ -7,6 +7,8 @@ description: |-
 
 # {{.Name}} ({{.Type}})
 
+> For a detailed guide on provisioning an AWS environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-cloud-byoc/aws-remote-provisioning/#method-1-using-our-terraform-module).
+
 {{ .Description | trimspace }}
 
 ## Example Usage

diff --git a/templates/resources/env_azure.md.tmpl b/templates/resources/env_azure.md.tmpl
@@ -7,6 +7,8 @@ description: |-
 
 # {{.Name}} ({{.Type}})
 
+> For a detailed guide on provisioning an Azure environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-cloud-byoc/aks-remote-provisioning/#using-terraform).
+
 {{ .Description | trimspace }}
 
 ## Example Usage

diff --git a/templates/resources/env_k8s.md.tmpl b/templates/resources/env_k8s.md.tmpl
@@ -7,6 +7,8 @@ description: |-
 
 # {{.Name}} ({{.Type}})
 
+> For a detailed guide on provisioning a K8S environment using Terraform, check our official [documentation](https://docs.altinity.com/altinitycloudanywhere/bring-your-own-kubernetes-byok/terraform/).
+
 {{ .Description | trimspace }}
 
 ## Example Usage
@@ -17,6 +19,9 @@ BYOK/EKS (AWS)
 BYOK/GKE (GCP):
 {{tffile "examples/resources/altinitycloud_env_k8s/gke/main.tf"}}
 
+BYOK/AKS (Azure):
+{{tffile "examples/resources/altinitycloud_env_k8s/aks/main.tf"}}
+
 {{ .SchemaMarkdown | trimspace }}
 {{- if .HasImport }}