Skip to content

Commit 68e2818

Browse files
alex-treebeardalex-treebeard
committed
docs
1 parent 381c6f2 commit 68e2818

File tree

6 files changed

+122
-56
lines changed

6 files changed

+122
-56
lines changed

‎Makefile‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,10 @@ post-start:
1111

1212
docs:
1313
terraform-docs markdown . > ./README.md
14+
terraform-docs markdown examples/k3s > examples/k3s/README.md
15+
terraform-docs markdown examples/eks > examples/eks/README.md
16+
terraform-docs markdown examples/aks > examples/aks/README.md
1417

1518
fmt:
16-
terraform fmt .
19+
terraform fmt . modules/* examples/*
1720
.PHONY: build

‎examples/aks/README.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | ~> 2.12.1 |
6+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.25.2 |
7+
| <a name="requirement_kustomization"></a> [kustomization](#requirement\_kustomization) | ~> 0.9.5 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_azurerm"></a> [azurerm](#provider\_azurerm) | 3.92.0 |
14+
15+
## Modules
16+
17+
| Name | Source | Version |
18+
|------|--------|---------|
19+
| <a name="module_treebeardkf"></a> [treebeardkf](#module\_treebeardkf) | ../.. | n/a |
20+
21+
## Resources
22+
23+
| Name | Type |
24+
|------|------|
25+
| [azurerm_kubernetes_cluster.aks](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster) | resource |
26+
| [azurerm_resource_group.aks](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/resource_group) | resource |
27+
28+
## Inputs
29+
30+
No inputs.
31+
32+
## Outputs
33+
34+
No outputs.

‎examples/aks/main.tf‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ provider "kubernetes" {
4848
cluster_ca_certificate = base64decode(azurerm_kubernetes_cluster.aks.kube_config.0.cluster_ca_certificate)
4949
}
5050

51-
# Helm provider configuration
5251
provider "helm" {
5352
kubernetes {
5453
host = azurerm_kubernetes_cluster.aks.kube_config.0.host
@@ -62,11 +61,11 @@ provider "kustomization" {
6261
kubeconfig_raw = azurerm_kubernetes_cluster.aks.kube_config_raw
6362
}
6463

65-
# module "treebeardkf" {
66-
# source = "../.."
67-
# hostname = "kf.example.com"
68-
# protocol = "https://"
69-
# port = ""
70-
# enable_kuberay = false
71-
# enable_mlflow = false
72-
# }
64+
module "treebeardkf" {
65+
source = "../.."
66+
hostname = "kf.example.com"
67+
protocol = "https://"
68+
port = ""
69+
enable_kuberay = false
70+
enable_mlflow = false
71+
}

‎examples/eks/README.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
## Requirements
2+
3+
| Name | Version |
4+
|------|---------|
5+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | 5.28.0 |
6+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | ~> 2.12.1 |
7+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.25.2 |
8+
| <a name="requirement_kustomization"></a> [kustomization](#requirement\_kustomization) | ~> 0.9.5 |
9+
10+
## Providers
11+
12+
| Name | Version |
13+
|------|---------|
14+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.28.0 |
15+
| <a name="provider_helm"></a> [helm](#provider\_helm) | 2.12.1 |
16+
| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | 2.25.2 |
17+
18+
## Modules
19+
20+
| Name | Source | Version |
21+
|------|--------|---------|
22+
| <a name="module_eks"></a> [eks](#module\_eks) | terraform-aws-modules/eks/aws | ~> 19.20 |
23+
| <a name="module_iam_eks_role"></a> [iam\_eks\_role](#module\_iam\_eks\_role) | terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks | 5.34.0 |
24+
| <a name="module_treebeardkf"></a> [treebeardkf](#module\_treebeardkf) | ../.. | n/a |
25+
| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | 5.1.2 |
26+
27+
## Resources
28+
29+
| Name | Type |
30+
|------|------|
31+
| [helm_release.ebs_csi_driver](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
32+
| [kubernetes_annotations.default-storageclass](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/annotations) | resource |
33+
| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/5.28.0/docs/data-sources/availability_zones) | data source |
34+
35+
## Inputs
36+
37+
| Name | Description | Type | Default | Required |
38+
|------|-------------|------|---------|:--------:|
39+
| <a name="input_aws_profile"></a> [aws\_profile](#input\_aws\_profile) | AWS profile to use for authentication. | `any` | n/a | yes |
40+
| <a name="input_aws_region"></a> [aws\_region](#input\_aws\_region) | AWS region to launch servers. | `any` | n/a | yes |
41+
42+
## Outputs
43+
44+
No outputs.

‎examples/eks/main.tf‎

Lines changed: 25 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@ module "eks" {
9393
cidr_blocks = ["0.0.0.0/0"]
9494
},
9595
istio_injection_webhook = {
96-
description = "Allow istio injection"
97-
protocol = "tcp"
98-
from_port = "15017"
99-
to_port = "15017"
100-
type = "ingress"
96+
description = "Allow istio injection"
97+
protocol = "tcp"
98+
from_port = "15017"
99+
to_port = "15017"
100+
type = "ingress"
101101
source_cluster_security_group = true
102102
}
103103
}
@@ -116,8 +116,8 @@ provider "kubernetes" {
116116
host = module.eks.cluster_endpoint
117117
cluster_ca_certificate = base64decode(module.eks.cluster_certificate_authority_data)
118118
exec {
119-
command = "aws"
120-
api_version="client.authentication.k8s.io/v1beta1"
119+
command = "aws"
120+
api_version = "client.authentication.k8s.io/v1beta1"
121121
args = [
122122
"--region",
123123
var.aws_region,
@@ -127,7 +127,7 @@ provider "kubernetes" {
127127
module.eks.cluster_name
128128
]
129129
env = {
130-
name = "AWS_PROFILE"
130+
name = "AWS_PROFILE"
131131
value = var.aws_profile
132132
}
133133
}
@@ -138,8 +138,8 @@ provider "helm" {
138138
host = module.eks.cluster_endpoint
139139
cluster_ca_certificate = base64decode(module.eks.cluster_certificate_authority_data)
140140
exec {
141-
command = "aws"
142-
api_version="client.authentication.k8s.io/v1beta1"
141+
command = "aws"
142+
api_version = "client.authentication.k8s.io/v1beta1"
143143
args = [
144144
"--region",
145145
var.aws_region,
@@ -149,7 +149,7 @@ provider "helm" {
149149
module.eks.cluster_name
150150
]
151151
env = {
152-
name = "AWS_PROFILE"
152+
name = "AWS_PROFILE"
153153
value = var.aws_profile
154154
}
155155
}
@@ -161,9 +161,9 @@ provider "kustomization" {
161161
}
162162

163163
module "iam_eks_role" {
164-
source = "terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks"
165-
version = "5.34.0"
166-
role_name = "ebs-csi"
164+
source = "terraform-aws-modules/iam/aws//modules/iam-role-for-service-accounts-eks"
165+
version = "5.34.0"
166+
role_name = "ebs-csi"
167167
attach_ebs_csi_policy = true
168168
oidc_providers = {
169169
main = {
@@ -186,12 +186,12 @@ resource "kubernetes_annotations" "default-storageclass" {
186186
}
187187
}
188188

189-
resource helm_release ebs_csi_driver {
190-
name = "aws-ebs-csi-driver"
191-
chart = "aws-ebs-csi-driver"
189+
resource "helm_release" "ebs_csi_driver" {
190+
name = "aws-ebs-csi-driver"
191+
chart = "aws-ebs-csi-driver"
192192
repository = "https://kubernetes-sigs.github.io/aws-ebs-csi-driver"
193-
namespace = "kube-system"
194-
version = "2.28.1"
193+
namespace = "kube-system"
194+
version = "2.28.1"
195195
values = [
196196
<<EOF
197197
controller:
@@ -206,25 +206,11 @@ storageClasses:
206206
]
207207
}
208208

209-
# module "eks_blueprints_addons" {
210-
# source = "aws-ia/eks-blueprints-addons/aws"
211-
# version = "~> 1.0" #ensure to update this to the latest/desired version
212-
213-
# cluster_name = module.eks.cluster_name
214-
# cluster_endpoint = module.eks.cluster_endpoint
215-
# cluster_version = module.eks.cluster_version
216-
# oidc_provider_arn = module.eks.oidc_provider_arn
217-
218-
# eks_addons = {
219-
220-
# }
221-
# }
222-
223209
module "treebeardkf" {
224-
source = "../.."
225-
hostname = "kf.example.com"
226-
protocol = "https://"
227-
port = ""
228-
enable_kuberay = false
229-
enable_mlflow = false
210+
source = "../.."
211+
hostname = "kf.example.com"
212+
protocol = "https://"
213+
port = ""
214+
enable_kuberay = false
215+
enable_mlflow = false
230216
}

‎examples/k3s/main.tf‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ terraform {
1919
}
2020

2121
variable "kubeconfig" {
22-
type = string
22+
type = string
2323
}
2424

2525
provider "kustomization" {
@@ -37,10 +37,10 @@ provider "kubernetes" {
3737
}
3838

3939
module "treebeardkf" {
40-
source = "../.."
41-
hostname = "kf.example.com"
42-
protocol = "https://"
43-
port = ""
44-
enable_kuberay = false
45-
enable_mlflow = false
40+
source = "../.."
41+
hostname = "kf.example.com"
42+
protocol = "https://"
43+
port = ""
44+
enable_kuberay = false
45+
enable_mlflow = false
4646
}

0 commit comments

Comments
 (0)