Skip to content

chore: update readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,32 @@
# terraform-kubernetes-linkerd2
A non-official Linkerd2 Terraform Module
# Terraform Kubernetes Linkerd2
An unofficial Linkerd2 Terraform Module for Kubernetes Cluster

# Dependency
- Cert manager must be enabled in your cluster.

# How to use?
1. Setup module.
```
module "linkerd2" {
source = "neko1101/linkerd2/kubernetes"
version = "1.0.0"
}
```
2. Apply
```
terraform init
terraform plan
terraform deploy
```

# Highlights
- Automated cert creation and signing.
- Automated TLS rotation by Cert Manager.
- Long-lived CA by default (20 Years).
- Modular Kubernetes related configurations.
- Modular Helm artifact version.
- Saves time.

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

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