Skip to content

Commit 40c08bf

Browse files
author
Guru Raghupathy
committed
Added documentation
1 parent 04544b7 commit 40c08bf

File tree

5 files changed

+233
-0
lines changed

5 files changed

+233
-0
lines changed

‎.terraform-docs.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
formatter: markdown table
2+
3+
recursive:
4+
enabled: true
5+
6+
output:
7+
file: docs.md
8+
mode: inject

‎docs.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.6 |
7+
| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.82.0 |
8+
| <a name="requirement_google-beta"></a> [google-beta](#requirement\_google-beta) | >= 4.82.0 |
9+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
10+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
11+
12+
## Providers
13+
14+
No providers.
15+
16+
## Modules
17+
18+
| Name | Source | Version |
19+
|------|--------|---------|
20+
| <a name="module_devops"></a> [devops](#module\_devops) | ./environments/devops | n/a |
21+
22+
## Resources
23+
24+
No resources.
25+
26+
## Inputs
27+
28+
| Name | Description | Type | Default | Required |
29+
|------|-------------|------|---------|:--------:|
30+
| <a name="input_environment_cluster_name"></a> [environment\_cluster\_name](#input\_environment\_cluster\_name) | The Association of Cluster Name and Environments | `map(string)` | <pre>{<br> "devops": "devops-k8s-cluster"<br>}</pre> | no |
31+
| <a name="input_environment_k8s_version"></a> [environment\_k8s\_version](#input\_environment\_k8s\_version) | The Association of k8s version and Environments | `map(string)` | <pre>{<br> "devops": "1.27.4-gke.900"<br>}</pre> | no |
32+
| <a name="input_environment_letsencrypt_email"></a> [environment\_letsencrypt\_email](#input\_environment\_letsencrypt\_email) | The Association of Letsencrypt Email and Environments | `map(string)` | <pre>{<br> "devops": "[email protected]"<br>}</pre> | no |
33+
| <a name="input_environment_master_ipv4_cidr_block"></a> [environment\_master\_ipv4\_cidr\_block](#input\_environment\_master\_ipv4\_cidr\_block) | The master IPV4 CIDR Block like 172.16.0.0/28 | `map(string)` | <pre>{<br> "devops": "172.16.0.0/28"<br>}</pre> | no |
34+
| <a name="input_environment_pod_cidr"></a> [environment\_pod\_cidr](#input\_environment\_pod\_cidr) | The Cluster POD Cidr Like 10.48.0.0/14 | `map(string)` | <pre>{<br> "devops": "10.48.0.0/14"<br>}</pre> | no |
35+
| <a name="input_environment_pod_cidr_name"></a> [environment\_pod\_cidr\_name](#input\_environment\_pod\_cidr\_name) | The Cluster POD CIDR Name Like devops-k8s-pod-cidr | `map(string)` | <pre>{<br> "devops": "devops-k8s-pod-cidr"<br>}</pre> | no |
36+
| <a name="input_environment_project"></a> [environment\_project](#input\_environment\_project) | The Association of Projects and Environment names | `map(string)` | <pre>{<br> "devops": "guru-playground"<br>}</pre> | no |
37+
| <a name="input_environment_region"></a> [environment\_region](#input\_environment\_region) | The Association of Regions and Environments | `map(string)` | <pre>{<br> "devops": "us-central1"<br>}</pre> | no |
38+
| <a name="input_environment_spot_tier"></a> [environment\_spot\_tier](#input\_environment\_spot\_tier) | Stop Pool Instance Type Like e2-standard-2 | `map(string)` | <pre>{<br> "devops": "e2-standard-2"<br>}</pre> | no |
39+
| <a name="input_environment_subnet_cidr"></a> [environment\_subnet\_cidr](#input\_environment\_subnet\_cidr) | The Cluster subnet CIDR Like 10.0.0.0/18 | `map(string)` | <pre>{<br> "devops": "10.0.0.0/18"<br>}</pre> | no |
40+
| <a name="input_environment_subnet_name"></a> [environment\_subnet\_name](#input\_environment\_subnet\_name) | The cluster subnet name like devops-k8s-subnet | `map(string)` | <pre>{<br> "devops": "devops-k8s-subnet"<br>}</pre> | no |
41+
| <a name="input_environment_svc_cidr"></a> [environment\_svc\_cidr](#input\_environment\_svc\_cidr) | The Cluster Service CIDR Like 10.52.0.0/20 | `map(string)` | <pre>{<br> "devops": "10.52.0.0/20"<br>}</pre> | no |
42+
| <a name="input_environment_svc_cidr_name"></a> [environment\_svc\_cidr\_name](#input\_environment\_svc\_cidr\_name) | The Cluster Service CIDR Name Like devops-k8s-svc-cidr | `map(string)` | <pre>{<br> "devops": "devops-k8s-svc-cidr"<br>}</pre> | no |
43+
| <a name="input_environment_tier"></a> [environment\_tier](#input\_environment\_tier) | Default Pool Instance Type Like e2-standard-2 | `map(string)` | <pre>{<br> "devops": "e2-standard-2"<br>}</pre> | no |
44+
| <a name="input_environment_vpc_name"></a> [environment\_vpc\_name](#input\_environment\_vpc\_name) | VPC Name Like devops-k8s-vpc | `map(string)` | <pre>{<br> "devops": "devops-k8s-vpc"<br>}</pre> | no |
45+
| <a name="input_environment_zone"></a> [environment\_zone](#input\_environment\_zone) | The Association of Zones and Environments | `map(string)` | <pre>{<br> "devops": "us-central1-a"<br>}</pre> | no |
46+
47+
## Outputs
48+
49+
| Name | Description |
50+
|------|-------------|
51+
| <a name="output_devops_k8s_nginx_controller_lb_ip"></a> [devops\_k8s\_nginx\_controller\_lb\_ip](#output\_devops\_k8s\_nginx\_controller\_lb\_ip) | n/a |
52+
<!-- END_TF_DOCS -->

‎modules/gke/docs.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.6 |
7+
| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.82.0 |
8+
| <a name="requirement_google-beta"></a> [google-beta](#requirement\_google-beta) | >= 4.82.0 |
9+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
10+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
11+
12+
## Providers
13+
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="provider_google"></a> [google](#provider\_google) | >= 4.82.0 |
17+
| <a name="provider_google-beta"></a> [google-beta](#provider\_google-beta) | >= 4.82.0 |
18+
19+
## Modules
20+
21+
No modules.
22+
23+
## Resources
24+
25+
| Name | Type |
26+
|------|------|
27+
| [google-beta_google_container_cluster.cluster](https://registry.terraform.io/providers/hashicorp/google-beta/latest/docs/resources/google_container_cluster) | resource |
28+
| [google_compute_address.nat](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_address) | resource |
29+
| [google_compute_firewall.firewall](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_firewall) | resource |
30+
| [google_compute_network.vpc](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_network) | resource |
31+
| [google_compute_router.router](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_router) | resource |
32+
| [google_compute_router_nat.nat](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_router_nat) | resource |
33+
| [google_compute_subnetwork.subnet](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_subnetwork) | resource |
34+
| [google_container_node_pool.general](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_node_pool) | resource |
35+
| [google_container_node_pool.spot](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/container_node_pool) | resource |
36+
| [google_project_service.compute](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_service) | resource |
37+
| [google_project_service.container](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/project_service) | resource |
38+
| [google_service_account.kubernetes_service_account](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/service_account) | resource |
39+
| [google_client_config.client_config](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/client_config) | data source |
40+
| [google_container_cluster.my_cluster](https://registry.terraform.io/providers/hashicorp/google/latest/docs/data-sources/container_cluster) | data source |
41+
42+
## Inputs
43+
44+
| Name | Description | Type | Default | Required |
45+
|------|-------------|------|---------|:--------:|
46+
| <a name="input_k8s_additional_node_zones"></a> [k8s\_additional\_node\_zones](#input\_k8s\_additional\_node\_zones) | The Additional zones GKE instance | `list(string)` | <pre>[<br> ""<br>]</pre> | no |
47+
| <a name="input_k8s_address_type"></a> [k8s\_address\_type](#input\_k8s\_address\_type) | The address type for GKE instance | `string` | `"EXTERNAL"` | no |
48+
| <a name="input_k8s_cluster_location"></a> [k8s\_cluster\_location](#input\_k8s\_cluster\_location) | The Region or zone of the GKE instance | `string` | n/a | yes |
49+
| <a name="input_k8s_cluster_name"></a> [k8s\_cluster\_name](#input\_k8s\_cluster\_name) | The name of the GKE instance | `string` | n/a | yes |
50+
| <a name="input_k8s_cluster_node_pool_version"></a> [k8s\_cluster\_node\_pool\_version](#input\_k8s\_cluster\_node\_pool\_version) | Cluster And Node Pool Version | `string` | n/a | yes |
51+
| <a name="input_k8s_enable_managed_prometheus_monitoring"></a> [k8s\_enable\_managed\_prometheus\_monitoring](#input\_k8s\_enable\_managed\_prometheus\_monitoring) | Enable Managed Prometheus Monitoring | `bool` | `true` | no |
52+
| <a name="input_k8s_firewall_ports_allow"></a> [k8s\_firewall\_ports\_allow](#input\_k8s\_firewall\_ports\_allow) | The ports opened by GKE instance | `list(string)` | <pre>[<br> "22"<br>]</pre> | no |
53+
| <a name="input_k8s_firewall_source_ranges"></a> [k8s\_firewall\_source\_ranges](#input\_k8s\_firewall\_source\_ranges) | The Source IP to allow GKE instance | `list(string)` | <pre>[<br> "0.0.0.0/0"<br>]</pre> | no |
54+
| <a name="input_k8s_master_ipv4_cidr_block"></a> [k8s\_master\_ipv4\_cidr\_block](#input\_k8s\_master\_ipv4\_cidr\_block) | The cidr BLOCK for master GKE instance | `string` | n/a | yes |
55+
| <a name="input_k8s_network_tier"></a> [k8s\_network\_tier](#input\_k8s\_network\_tier) | The network Tier for GKE instance | `string` | `"PREMIUM"` | no |
56+
| <a name="input_k8s_pod_cidr"></a> [k8s\_pod\_cidr](#input\_k8s\_pod\_cidr) | The CIDR of the POD for this GKE instance | `string` | n/a | yes |
57+
| <a name="input_k8s_pod_cidr_name"></a> [k8s\_pod\_cidr\_name](#input\_k8s\_pod\_cidr\_name) | The CIDR Name of the POD for this GKE instance | `string` | n/a | yes |
58+
| <a name="input_k8s_project"></a> [k8s\_project](#input\_k8s\_project) | The Project of the GKE instance | `string` | n/a | yes |
59+
| <a name="input_k8s_region"></a> [k8s\_region](#input\_k8s\_region) | The Region of the GKE instance | `string` | `"us-central1"` | no |
60+
| <a name="input_k8s_service_account_name"></a> [k8s\_service\_account\_name](#input\_k8s\_service\_account\_name) | The Service Account name GKE instance | `string` | n/a | yes |
61+
| <a name="input_k8s_spot_tier"></a> [k8s\_spot\_tier](#input\_k8s\_spot\_tier) | The instance tiers are based on the machine | `string` | `"e2-f1-micro"` | no |
62+
| <a name="input_k8s_spot_tier_node_count"></a> [k8s\_spot\_tier\_node\_count](#input\_k8s\_spot\_tier\_node\_count) | The nodes in this pool | `number` | `2` | no |
63+
| <a name="input_k8s_subnet_cidr"></a> [k8s\_subnet\_cidr](#input\_k8s\_subnet\_cidr) | The CIDR of the VPC SUBNET for this GKE instance | `string` | n/a | yes |
64+
| <a name="input_k8s_subnet_name"></a> [k8s\_subnet\_name](#input\_k8s\_subnet\_name) | The Name of the VPC SUBNET for this GKE instance | `string` | n/a | yes |
65+
| <a name="input_k8s_svc_cidr"></a> [k8s\_svc\_cidr](#input\_k8s\_svc\_cidr) | The CIDR of the SVC for this GKE instance | `string` | n/a | yes |
66+
| <a name="input_k8s_svc_cidr_name"></a> [k8s\_svc\_cidr\_name](#input\_k8s\_svc\_cidr\_name) | The CIDR Name of the SVC for this GKE instance | `string` | n/a | yes |
67+
| <a name="input_k8s_tier"></a> [k8s\_tier](#input\_k8s\_tier) | The instance tiers are based on the machine | `string` | `"e2-f1-micro"` | no |
68+
| <a name="input_k8s_tier_node_count"></a> [k8s\_tier\_node\_count](#input\_k8s\_tier\_node\_count) | The nodes in this pool | `string` | `2` | no |
69+
| <a name="input_k8s_vpc_name"></a> [k8s\_vpc\_name](#input\_k8s\_vpc\_name) | The Name of the VPC for this GKE instance | `string` | n/a | yes |
70+
71+
## Outputs
72+
73+
| Name | Description |
74+
|------|-------------|
75+
| <a name="output_k8s_project_cluster_cluster_ca_cert"></a> [k8s\_project\_cluster\_cluster\_ca\_cert](#output\_k8s\_project\_cluster\_cluster\_ca\_cert) | n/a |
76+
| <a name="output_k8s_project_cluster_endpoint"></a> [k8s\_project\_cluster\_endpoint](#output\_k8s\_project\_cluster\_endpoint) | n/a |
77+
| <a name="output_k8s_project_cluster_token"></a> [k8s\_project\_cluster\_token](#output\_k8s\_project\_cluster\_token) | n/a |
78+
<!-- END_TF_DOCS -->

‎modules/kcert/docs.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.6 |
7+
| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.82.0 |
8+
| <a name="requirement_google-beta"></a> [google-beta](#requirement\_google-beta) | >= 4.82.0 |
9+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
10+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
11+
12+
## Providers
13+
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.11.0 |
17+
18+
## Modules
19+
20+
No modules.
21+
22+
## Resources
23+
24+
| Name | Type |
25+
|------|------|
26+
| [helm_release.kcert_letsencrypt](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
27+
28+
## Inputs
29+
30+
| Name | Description | Type | Default | Required |
31+
|------|-------------|------|---------|:--------:|
32+
| <a name="input_kcert_controller_chart"></a> [kcert\_controller\_chart](#input\_kcert\_controller\_chart) | The helm chart | `string` | `"kcert"` | no |
33+
| <a name="input_kcert_controller_chart_version"></a> [kcert\_controller\_chart\_version](#input\_kcert\_controller\_chart\_version) | The helm chart version | `string` | `"1.0.6"` | no |
34+
| <a name="input_kcert_controller_create_namespace"></a> [kcert\_controller\_create\_namespace](#input\_kcert\_controller\_create\_namespace) | Create the namespace | `bool` | `true` | no |
35+
| <a name="input_kcert_controller_namespace"></a> [kcert\_controller\_namespace](#input\_kcert\_controller\_namespace) | The namespace where to install | `string` | `"kcert"` | no |
36+
| <a name="input_kcert_controller_repository"></a> [kcert\_controller\_repository](#input\_kcert\_controller\_repository) | The helm repository | `string` | `"https://nabsul.github.io/helm"` | no |
37+
| <a name="input_kcert_letsencrypt_email"></a> [kcert\_letsencrypt\_email](#input\_kcert\_letsencrypt\_email) | The Email for kcert letsencrypt | `string` | n/a | yes |
38+
| <a name="input_nginx_controller_helm_host"></a> [nginx\_controller\_helm\_host](#input\_nginx\_controller\_helm\_host) | The endpoint of the k8s cluster | `string` | n/a | yes |
39+
| <a name="input_nginx_controller_helm_token"></a> [nginx\_controller\_helm\_token](#input\_nginx\_controller\_helm\_token) | The token of the k8s cluster | `string` | n/a | yes |
40+
| <a name="input_nginx_controller_k8s_cluster_ca_cert"></a> [nginx\_controller\_k8s\_cluster\_ca\_cert](#input\_nginx\_controller\_k8s\_cluster\_ca\_cert) | The CA certificate of the k8s cluster | `string` | n/a | yes |
41+
| <a name="input_nginx_controller_k8s_project"></a> [nginx\_controller\_k8s\_project](#input\_nginx\_controller\_k8s\_project) | The Project where the k8s cluster is installed | `string` | n/a | yes |
42+
43+
## Outputs
44+
45+
No outputs.
46+
<!-- END_TF_DOCS -->

‎modules/nginx_controller/docs.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.4.6 |
7+
| <a name="requirement_google"></a> [google](#requirement\_google) | >= 4.82.0 |
8+
| <a name="requirement_google-beta"></a> [google-beta](#requirement\_google-beta) | >= 4.82.0 |
9+
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
10+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
11+
12+
## Providers
13+
14+
| Name | Version |
15+
|------|---------|
16+
| <a name="provider_google"></a> [google](#provider\_google) | >= 4.82.0 |
17+
| <a name="provider_helm"></a> [helm](#provider\_helm) | >= 2.11.0 |
18+
19+
## Modules
20+
21+
No modules.
22+
23+
## Resources
24+
25+
| Name | Type |
26+
|------|------|
27+
| [google_compute_address.reserved_static_ip](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/compute_address) | resource |
28+
| [helm_release.nginx_controller](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
29+
30+
## Inputs
31+
32+
| Name | Description | Type | Default | Required |
33+
|------|-------------|------|---------|:--------:|
34+
| <a name="input_nginx_controller_chart"></a> [nginx\_controller\_chart](#input\_nginx\_controller\_chart) | The helm chart | `string` | `"ingress-nginx"` | no |
35+
| <a name="input_nginx_controller_chart_version"></a> [nginx\_controller\_chart\_version](#input\_nginx\_controller\_chart\_version) | The helm chart version | `string` | `"4.6.0"` | no |
36+
| <a name="input_nginx_controller_helm_host"></a> [nginx\_controller\_helm\_host](#input\_nginx\_controller\_helm\_host) | The endpoint of the k8s cluster | `string` | n/a | yes |
37+
| <a name="input_nginx_controller_helm_token"></a> [nginx\_controller\_helm\_token](#input\_nginx\_controller\_helm\_token) | The token of the k8s cluster | `string` | n/a | yes |
38+
| <a name="input_nginx_controller_k8s_cluster_ca_cert"></a> [nginx\_controller\_k8s\_cluster\_ca\_cert](#input\_nginx\_controller\_k8s\_cluster\_ca\_cert) | The CA certificate of the k8s cluster | `string` | n/a | yes |
39+
| <a name="input_nginx_controller_k8s_project"></a> [nginx\_controller\_k8s\_project](#input\_nginx\_controller\_k8s\_project) | The Project where the k8s cluster is installed | `string` | n/a | yes |
40+
| <a name="input_nginx_controller_project"></a> [nginx\_controller\_project](#input\_nginx\_controller\_project) | The project | `string` | n/a | yes |
41+
| <a name="input_nginx_controller_region"></a> [nginx\_controller\_region](#input\_nginx\_controller\_region) | The region | `string` | n/a | yes |
42+
| <a name="input_nginx_controller_repository"></a> [nginx\_controller\_repository](#input\_nginx\_controller\_repository) | The helm repository | `string` | `"https://kubernetes.github.io/ingress-nginx"` | no |
43+
44+
## Outputs
45+
46+
| Name | Description |
47+
|------|-------------|
48+
| <a name="output_k8s_nginx_controller_lb_ip"></a> [k8s\_nginx\_controller\_lb\_ip](#output\_k8s\_nginx\_controller\_lb\_ip) | n/a |
49+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)