Skip to content

Commit 63f7f0d

Browse files
authored
chore: update readme (#6)
1 parent 61c6020 commit 63f7f0d

File tree

2 files changed

+36
-11
lines changed

2 files changed

+36
-11
lines changed

README.md

Lines changed: 27 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
1-
# terraform-kubernetes-linkerd2
2-
A non-official Linkerd2 Terraform Module
1+
# Terraform Kubernetes Linkerd2
2+
An unofficial Linkerd2 Terraform Module for Kubernetes Cluster
33

4+
# Dependency
5+
- Cert manager must be enabled in your cluster.
6+
7+
# How to use?
8+
1. Setup module.
9+
```
10+
module "linkerd2" {
11+
source = "neko1101/linkerd2/kubernetes"
12+
version = "1.0.0"
13+
}
14+
```
15+
2. Apply
16+
```
17+
terraform init
18+
terraform plan
19+
terraform deploy
20+
```
21+
22+
# Highlights
23+
- Automated cert creation and signing.
24+
- Automated TLS rotation by Cert Manager.
25+
- Long-lived CA by default (20 Years).
26+
- Modular Kubernetes related configurations.
27+
- Modular Helm artifact version.
28+
- Saves time.
429

5-
# TODO
6-
1. terraform-docs
7-
2. automated lint
8-
3. publish to tf registry
9-
4. cni toggle
10-
5. viz toggle
11-
6. jaeger toggle
12-
7. viz ingress toggle
13-
8. modular self-sign tls commonname
1430
<!-- BEGIN_TF_DOCS -->
1531
## Requirements
1632

TODO.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# TODO
2+
1. terraform-docs
3+
2. automated lint
4+
3. publish to tf registry
5+
4. cni toggle
6+
5. viz toggle
7+
6. jaeger toggle
8+
7. viz ingress toggle
9+
8. modular self-sign tls commonname

0 commit comments

Comments
 (0)