Skip to content

Commit eae964d

Browse files
committed
📝 Update README
1 parent 4cff1d7 commit eae964d

File tree

5 files changed

+73
-2
lines changed

5 files changed

+73
-2
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,5 @@ override.tf.json
2727

2828
# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
2929
# example: *tfplan*
30+
31+
.terraform.lock.hcl

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,65 @@ module "kind_cluster" {
2727

2828
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2929
## Requirements
30+
31+
| Name | Version |
32+
|------|---------|
33+
| <a name="requirement_docker"></a> [docker](#requirement\_docker) | ~> 2.15 |
34+
| <a name="requirement_kind"></a> [kind](#requirement\_kind) | ~> 0.0.9 |
35+
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | ~> 1.11 |
36+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.4 |
37+
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.1 |
38+
39+
## Providers
40+
41+
| Name | Version |
42+
|------|---------|
43+
| <a name="provider_docker"></a> [docker](#provider\_docker) | 2.15.0 |
44+
| <a name="provider_kind"></a> [kind](#provider\_kind) | 0.0.9 |
45+
| <a name="provider_kubectl"></a> [kubectl](#provider\_kubectl) | 1.11.3 |
46+
| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | 2.4.1 |
47+
| <a name="provider_random"></a> [random](#provider\_random) | 3.1.0 |
48+
49+
## Modules
50+
51+
No modules.
52+
53+
## Resources
54+
55+
| Name | Type |
56+
|------|------|
57+
| [kind_cluster.this](https://registry.terraform.io/providers/kyma-incubator/kind/latest/docs/resources/cluster) | resource |
58+
| [kubectl_manifest.kubectl_apply_loadbalancer](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource |
59+
| [kubectl_manifest.kubectl_apply_metrics_server](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource |
60+
| [kubernetes_config_map.loadbalancer_config](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | resource |
61+
| [kubernetes_namespace.loadbalancer_namespace](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource |
62+
| [kubernetes_secret.loadbalancer_secret](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource |
63+
| [random_id.loadbalancer_secret_random](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
64+
| [docker_network.kind_network](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/data-sources/network) | data source |
65+
| [kubectl_file_documents.loadbalancer_manifests](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/file_documents) | data source |
66+
| [kubectl_file_documents.metrics_server_manifests](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/file_documents) | data source |
67+
68+
## Inputs
69+
70+
| Name | Description | Type | Default | Required |
71+
|------|-------------|------|---------|:--------:|
72+
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | Cluster name to create k8s cluster in Docker and set kubeconfig, You can use this cluster name select context with kubectl. | `string` | n/a | yes |
73+
| <a name="input_containerd_config_patches"></a> [containerd\_config\_patches](#input\_containerd\_config\_patches) | Path config to existing default for containerd. | `list(string)` | `[]` | no |
74+
| <a name="input_enable_loadbalancer"></a> [enable\_loadbalancer](#input\_enable\_loadbalancer) | Set to true to enable loadbalance for kind cluster. | `bool` | `false` | no |
75+
| <a name="input_enable_metrics_server"></a> [enable\_metrics\_server](#input\_enable\_metrics\_server) | Set to true to install metrics server into cluster. | `bool` | `false` | no |
76+
| <a name="input_kubernetes_version"></a> [kubernetes\_version](#input\_kubernetes\_version) | Specific kubernetes version to create cluster, Must specific in SemVer version. (Check all supported version -> https://hub.docker.com/r/kindest/node/tags) | `string` | `"1.21.1"` | no |
77+
| <a name="input_node_image"></a> [node\_image](#input\_node\_image) | Change base image for kubernetes cluster, This parameter allow you to use local build image. | `string` | `"kindest/node"` | no |
78+
| <a name="input_nodes"></a> [nodes](#input\_nodes) | Nodes information to create cluster with control plan and worker. Default is AIO node. | <pre>list(object({<br> role = string<br> kubeadm_config_patches = list(string)<br> extra_port_mappings = object({<br> listen_address = string<br> container_port = string<br> host_port = string<br> protocol = string<br> })<br> }))</pre> | `[]` | no |
79+
80+
## Outputs
81+
82+
| Name | Description |
83+
|------|-------------|
84+
| <a name="output_client_certificate"></a> [client\_certificate](#output\_client\_certificate) | Client certificate content. |
85+
| <a name="output_client_key"></a> [client\_key](#output\_client\_key) | Client key content. |
86+
| <a name="output_cluster_ca_certificate"></a> [cluster\_ca\_certificate](#output\_cluster\_ca\_certificate) | CA Certificate content. |
87+
| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | The name of cluster, Can be for kube context. |
88+
| <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | Cluster endpoint. |
89+
| <a name="output_kubeconfig"></a> [kubeconfig](#output\_kubeconfig) | Plaintext for kubeconfig generated for this kind cluster. |
90+
| <a name="output_kubeconfig_path"></a> [kubeconfig\_path](#output\_kubeconfig\_path) | Path to kubeconfig file for this kind cluster that auto generated. |
3091
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

option-loadbalancer.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,5 @@ resource "kubectl_manifest" "kubectl_apply_loadbalancer" {
5454

5555
data "kubectl_file_documents" "loadbalancer_manifests" {
5656
count = var.enable_loadbalancer ? 1 : 0
57-
content = file("${path.module}/kubernetes/loadbalancer.yml")
57+
content = file("${path.module}/manifest/loadbalancer.yml")
5858
}

option-metric-server.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ resource "kubectl_manifest" "kubectl_apply_metrics_server" {
55

66
data "kubectl_file_documents" "metrics_server_manifests" {
77
count = var.enable_metrics_server ? 1 : 0
8-
content = file("${path.module}/kubernetes/metrics-server.yml")
8+
content = file("${path.module}/manifest/metrics-server.yml")
99
}

versions.tf

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ terraform {
1212
source = "kreuzwerker/docker"
1313
version = "~> 2.15"
1414
}
15+
kubernetes = {
16+
source = "hashicorp/kubernetes"
17+
version = "~> 2.4"
18+
}
19+
random = {
20+
source = "hashicorp/random"
21+
version = "~> 3.1"
22+
}
1523
}
1624
}
1725

0 commit comments

Comments
 (0)