Skip to content

Commit 711e1cd

Browse files
PePoDevPePoDev
committed
📝 Update README
1 parent 860aa8f commit 711e1cd

File tree

4 files changed

+126
-48
lines changed

4 files changed

+126
-48
lines changed

‎.chglog/config.yml‎

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,53 @@ style: github
22
template: CHANGELOG.tpl.md
33
info:
44
title: CHANGELOG
5-
repository_url: https://github.com/terraform-aws-modules/terraform-aws-vpc
5+
repository_url: https://github.com/pepodev/terraform-kind-cluster
66
options:
7+
commits:
8+
sort_by: Type
9+
filters:
10+
Type:
11+
- feat
12+
- improvement
13+
- refactor
14+
- fix
15+
- docs
16+
- test
17+
- ci
18+
19+
commit_groups:
20+
group_by: Type
21+
sort_by: Custom
22+
title_order:
23+
- feat
24+
- improvement
25+
- refactor
26+
- fix
27+
- docs
28+
- test
29+
- ci
30+
title_maps:
31+
feat: FEATURES
32+
fix: BUG FIXES
33+
improvement: ENHANCEMENTS
34+
docs: DOCS
35+
refactor: REFACTORS
36+
test: TESTS
37+
ci: CI
38+
739
header:
8-
pattern: "^(.*)$"
40+
pattern: "^(.+)\\s*:\\s*(.+)$"
941
pattern_maps:
42+
- Type
1043
- Subject
44+
45+
notes:
46+
keywords:
47+
- BREAKING CHANGES
48+
- NOTES
49+
50+
refs:
51+
actions:
52+
- Closes
53+
- Fixes
54+
- Resolves

‎CHANGELOG.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
<a name="unreleased"></a>
6+
## [Unreleased]
7+
8+
-
9+
10+
11+
<a name="v0.1.0"></a>
12+
## v0.1.0 - 2021-09-05
13+
14+
- Update README
15+
- Update README
16+
- Basic Kind cluster
17+
- add simple file
18+
-
19+
20+
21+
[Unreleased]: https://github.com/terraform-aws-modules/terraform-aws-eks/compare/v0.1.0...HEAD

‎Makefile‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
.PHONY: changelog release
22

3+
SEMTAG=tools/semtag
4+
5+
CHANGELOG_FILE=CHANGELOG.md
6+
TAG_QUERY=v11.0.0..
7+
8+
scope ?= "minor"
9+
10+
changelog-unrelease:
11+
git-chglog --no-case -o $(CHANGELOG_FILE) $(TAG_QUERY)
12+
313
changelog:
4-
git-chglog -o CHANGELOG.md --next-tag `semtag final -s minor -o`
14+
git-chglog --no-case -o $(CHANGELOG_FILE) --next-tag `$(SEMTAG) final -s $(scope) -o -f` $(TAG_QUERY)
515

616
release:
7-
semtag final -s minor
17+
$(SEMTAG) final -s $(scope)

‎README.md‎

Lines changed: 47 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Kind Cluster
22

3+
[![Lint Status](https://github.com/pepodev/terraform-kind-cluster/workflows/Lint/badge.svg)](https://github.com/pepodev/terraform-kind-cluster/actions)
4+
[![LICENSE](https://img.shields.io/github/license/pepodev/terraform-kind-cluster)](https://github.com/pepodev/terraform-kind-cluster/blob/master/LICENSE)
5+
36
Terraform module which creates Kubernetes Cluster resources on KIND (Kubernetes in Docker).
47

58
## Usage
@@ -8,7 +11,7 @@ Terraform module which creates Kubernetes Cluster resources on KIND (Kubernetes
811

912
```hcl
1013
module "kind_cluster" {
11-
source = "pepodev/cluster/kind"
14+
source = "PePoDev/cluster/kind"
1215
version = "~> 0.1"
1316
1417
cluster_name = "kubernetes-problems"
@@ -28,64 +31,64 @@ module "kind_cluster" {
2831
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
2932
## Requirements
3033

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 |
34+
| Name | Version |
35+
| ---------------------------------------------------------------------------- | -------- |
36+
| <a name="requirement_docker"></a> [docker](#requirement\_docker) | ~> 2.15 |
37+
| <a name="requirement_kind"></a> [kind](#requirement\_kind) | ~> 0.0.9 |
38+
| <a name="requirement_kubectl"></a> [kubectl](#requirement\_kubectl) | ~> 1.11 |
39+
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | ~> 2.4 |
40+
| <a name="requirement_random"></a> [random](#requirement\_random) | ~> 3.1 |
3841

3942
## Providers
4043

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 |
44+
| Name | Version |
45+
| ---------------------------------------------------------------------- | ------- |
46+
| <a name="provider_docker"></a> [docker](#provider\_docker) | 2.15.0 |
47+
| <a name="provider_kind"></a> [kind](#provider\_kind) | 0.0.9 |
48+
| <a name="provider_kubectl"></a> [kubectl](#provider\_kubectl) | 1.11.3 |
49+
| <a name="provider_kubernetes"></a> [kubernetes](#provider\_kubernetes) | 2.4.1 |
50+
| <a name="provider_random"></a> [random](#provider\_random) | 3.1.0 |
4851

4952
## Modules
5053

5154
No modules.
5255

5356
## Resources
5457

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 |
58+
| Name | Type |
59+
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |
60+
| [kind_cluster.this](https://registry.terraform.io/providers/kyma-incubator/kind/latest/docs/resources/cluster) | resource |
61+
| [kubectl_manifest.kubectl_apply_loadbalancer](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource |
62+
| [kubectl_manifest.kubectl_apply_metrics_server](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/resources/manifest) | resource |
63+
| [kubernetes_config_map.loadbalancer_config](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/config_map) | resource |
64+
| [kubernetes_namespace.loadbalancer_namespace](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource |
65+
| [kubernetes_secret.loadbalancer_secret](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret) | resource |
66+
| [random_id.loadbalancer_secret_random](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/id) | resource |
67+
| [docker_network.kind_network](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs/data-sources/network) | data source |
68+
| [kubectl_file_documents.loadbalancer_manifests](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/file_documents) | data source |
6669
| [kubectl_file_documents.metrics_server_manifests](https://registry.terraform.io/providers/gavinbunney/kubectl/latest/docs/data-sources/file_documents) | data source |
6770

6871
## Inputs
6972

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 |
73+
| Name | Description | Type | Default | Required |
74+
| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- | :------: |
75+
| <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 |
76+
| <a name="input_containerd_config_patches"></a> [containerd\_config\_patches](#input\_containerd\_config\_patches) | Path config to existing default for containerd. | `list(string)` | `[]` | no |
77+
| <a name="input_enable_loadbalancer"></a> [enable\_loadbalancer](#input\_enable\_loadbalancer) | Set to true to enable loadbalance for kind cluster. | `bool` | `false` | no |
78+
| <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 |
79+
| <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 |
80+
| <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 |
81+
| <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 |
7982

8083
## Outputs
8184

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. |
85+
| Name | Description |
86+
| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------ |
87+
| <a name="output_client_certificate"></a> [client\_certificate](#output\_client\_certificate) | Client certificate content. |
88+
| <a name="output_client_key"></a> [client\_key](#output\_client\_key) | Client key content. |
89+
| <a name="output_cluster_ca_certificate"></a> [cluster\_ca\_certificate](#output\_cluster\_ca\_certificate) | CA Certificate content. |
90+
| <a name="output_cluster_name"></a> [cluster\_name](#output\_cluster\_name) | The name of cluster, Can be for kube context. |
91+
| <a name="output_endpoint"></a> [endpoint](#output\_endpoint) | Cluster endpoint. |
92+
| <a name="output_kubeconfig"></a> [kubeconfig](#output\_kubeconfig) | Plaintext for kubeconfig generated for this kind cluster. |
93+
| <a name="output_kubeconfig_path"></a> [kubeconfig\_path](#output\_kubeconfig\_path) | Path to kubeconfig file for this kind cluster that auto generated. |
9194
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

0 commit comments

Comments
 (0)