Skip to content

Commit 7244f46

Browse files
committed
Simplify module vars and polish doc links
1 parent 50def1b commit 7244f46

File tree

10 files changed

+18
-36
lines changed

10 files changed

+18
-36
lines changed

cert-manager/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ This directory contains the necessary configurations for **Cert-Manager**, which
66

77
You can deploy Cert-Manager using one of the following methods:
88

9-
### 1. Terraform (Automated)
10-
This method uses the Terraform configuration located in the `terraform/` directory. It is the recommended approach for integration with the full observability stack.
9+
### 1. Automated Deployment
10+
This method uses the Terraform configuration located in the `terraform/` directory. It is the recommended approach for automation.
1111

12-
- [**Terraform Deployment Guide**](../docs/cert-manager-terraform-deployment.md)
12+
For detailed instructions, see the [Terraform deployment guide](../docs/cert-manager-terraform-deployment.md).
1313

1414
### 2. Manual (Helm & Kubectl)
15-
If you prefer to deploy manually using CLI tools, you can follow the manual guide.
16-
17-
- [**Manual Deployment Guide**](../docs/cert-manager-manual-deployment.md)
15+
If you prefer to deploy manually using CLI tools, you can follow the [manual deployment guide](../docs/cert-manager-manual-deployment.md).

cert-manager/terraform/main.tf

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ resource "helm_release" "cert_manager" {
55
repository = "https://charts.jetstack.io"
66
chart = "cert-manager"
77
namespace = var.namespace
8-
create_namespace = var.create_namespace
8+
create_namespace = true
99
version = var.cert_manager_version
1010

1111
set {
1212
name = "installCRDs"
13-
value = var.install_crds
13+
value = "true"
1414
}
1515

1616
wait = true

cert-manager/terraform/variables.tf

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,7 @@ variable "namespace" {
1616
default = "cert-manager"
1717
}
1818

19-
variable "create_namespace" {
20-
description = "Whether to create the namespace"
21-
type = bool
22-
default = true
23-
}
2419

25-
variable "install_crds" {
26-
description = "Whether to install CRDs"
27-
type = bool
28-
default = true
29-
}
3020

3121
variable "letsencrypt_email" {
3222
description = "Email address for Let's Encrypt certificate notifications"

docs/cert-manager-terraform-deployment.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,4 @@ cd observability
6868
| `cert_issuer_kind` | Kind of Issuer (`ClusterIssuer` or `Issuer`) | `ClusterIssuer` |
6969
| `issuer_namespace` | Namespace for Issuer (if Kind is Issuer). Defaults to install namespace. | `null` |
7070
| `ingress_class_name` | Ingress class for solving challenges | `nginx` |
71+
| `issuer_server` | ACME server URL | `https://acme-v02...` |

docs/kubernetes-observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,8 @@ The stack automatically provisions **Cert-Manager** and **NGINX Ingress Controll
8585
> **Important**: Set these to `true` in your `terraform.tfvars` if you are doing a fresh install of the entire stack and need these components.
8686
8787
If you prefer to deploy them standalone or manually, refer to their respective documentation:
88-
- [Cert-Manager Documentation](../cert-manager/README.md)
89-
- [Ingress Controller Documentation](../ingress-controller/README.md)
88+
- [Cert-Manager Documentation](../cert-manager/README.md) - *See [Terraform Deployment Guide](../docs/cert-manager-terraform-deployment.md#variables) for full configuration options.*
89+
- [Ingress Controller Documentation](../ingress-controller/README.md) - *See [Terraform Deployment Guide](../docs/ingress-controller-terraform-deployment.md#variables) for full configuration options.*
9090

9191
## Installation
9292

ingress-controller/README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ This directory contains the configurations for the **NGINX Ingress Controller**,
66

77
You can deploy the Ingress Controller using one of the following methods:
88

9-
### 1. Terraform (Automated)
9+
### 1. Automated Deployment
1010
This method uses the Terraform configuration located in the `terraform/` directory.
1111

12-
- [**Terraform Deployment Guide**](../docs/ingress-controller-terraform-deployment.md)
12+
For detailed instructions, see the [Terraform deployment guide](../docs/ingress-controller-terraform-deployment.md).
1313

1414
### 2. Manual (Helm)
15-
If you prefer to deploy manually using Helm, you can follow the manual guide.
16-
17-
- [**Manual Deployment Guide**](../docs/ingress-controller-manual-deployment.md)
15+
If you prefer to deploy manually using Helm, you can follow the [manual deployment guide](../docs/ingress-controller-manual-deployment.md).

ingress-controller/terraform/main.tf

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ resource "helm_release" "nginx_ingress" {
55
repository = "https://kubernetes.github.io/ingress-nginx"
66
chart = "ingress-nginx"
77
namespace = var.namespace
8-
create_namespace = var.create_namespace
8+
create_namespace = true
99
version = var.nginx_ingress_version
1010

1111
set {

ingress-controller/terraform/variables.tf

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,6 @@ variable "namespace" {
2222
default = "ingress-nginx"
2323
}
2424

25-
variable "create_namespace" {
26-
description = "Whether to create the namespace"
27-
type = bool
28-
default = true
29-
}
3025

3126
variable "replica_count" {
3227
description = "Number of replicas for the controller"

lgtm-stack/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The **LGTM** stack is a comprehensive open-source observability platform powered
1414
This repository provides two guides to help you deploy the stack:
1515

1616
### 1. Automated Deployment
17-
For a fully automated deployment using this stack, please follow the [Kubernetes Observability Guide](../docs/kubernetes-observability.md).
17+
For a fully automated deployment using this stack, please refer to the [observability guide](../docs/kubernetes-observability.md).
1818

1919
### 2. Manual Deployment
2020
If you prefer to configure and deploy components manually, or need to understand the individual steps, please refer to the [Manual LGTM Deployment Guide](../docs/manual-lgtm-deployment.md).

lgtm-stack/terraform/main.tf

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,10 +160,10 @@ module "cert_manager" {
160160
install_cert_manager = var.install_cert_manager
161161
cert_manager_version = var.cert_manager_version
162162
namespace = "cert-manager"
163-
install_crds = true
164-
letsencrypt_email = var.letsencrypt_email
165-
cert_issuer_name = var.cert_issuer_name
166-
cert_issuer_kind = var.cert_issuer_kind
163+
164+
letsencrypt_email = var.letsencrypt_email
165+
cert_issuer_name = var.cert_issuer_name
166+
cert_issuer_kind = var.cert_issuer_kind
167167
# If Kind is Issuer, it must be in the observability namespace to be used by the ingress in that namespace.
168168
# If Kind is ClusterIssuer, this variable is ignored by the module logic.
169169
issuer_namespace = var.namespace

0 commit comments

Comments
 (0)