From 3b3122aa2caad16bd99e7f4eb3d448d985a5a4d2 Mon Sep 17 00:00:00 2001 From: Benjamin Durham Date: Sat, 10 Sep 2022 00:40:52 +1200 Subject: [PATCH] Fix indentation + values.yaml (#234) --- .../ssl-certificates/cert-manager.md | 26 ++++++++-------- .../ssl-certificates/secret-replicator.md | 26 ++++++++-------- .../ssl-certificates/wildcard-certificate.md | 31 ++++++++++--------- 3 files changed, 42 insertions(+), 41 deletions(-) diff --git a/docs/kubernetes/ssl-certificates/cert-manager.md b/docs/kubernetes/ssl-certificates/cert-manager.md index 48a5c44..cf7f08a 100644 --- a/docs/kubernetes/ssl-certificates/cert-manager.md +++ b/docs/kubernetes/ssl-certificates/cert-manager.md @@ -75,7 +75,7 @@ spec: ### ConfigMap -Now we're into the cert-manager-specific YAMLs. First, we create a ConfigMap, containing the entire contents of the helm chart's [values.yaml](https://github.com/bitnami-labs/cert-manager/blob/main/helm/cert-manager/values.yaml). Paste the values into a `values.yaml` key as illustrated below, indented 4 spaces (*since they're "encapsulated" within the ConfigMap YAML*). I create this example yaml in my flux repo: +Now we're into the cert-manager-specific YAMLs. First, we create a ConfigMap, containing the entire contents of the helm chart's [values.yaml](https://github.com/bitnami/charts/blob/master/bitnami/cert-manager/values.yaml). Paste the values into a `values.yaml` key as illustrated below, indented 4 tabs (*since they're "encapsulated" within the ConfigMap YAML*). I create this example yaml in my flux repo at `cert-manager/configmap-cert-manager-helm-chart-value-overrides.yaml`: ```yaml title="/cert-manager/configmap-cert-manager-helm-chart-value-overrides.yaml" apiVersion: v1 @@ -96,26 +96,26 @@ Then work your way through the values you pasted, and change any which are speci Lastly, having set the scene above, we define the HelmRelease which will actually deploy the cert-manager controller into the cluster, with the config we defined above. I save this in my flux repo: -```yaml title="/cert-manager/helmrelease-cert-manager.yaml" +```yaml title="/cert-manager/helmrelease-cert-manager.yaml' apiVersion: helm.toolkit.fluxcd.io/v2beta1 kind: HelmRelease metadata: -name: cert-manager -namespace: cert-manager + name: cert-manager + namespace: cert-manager spec: -chart: + chart: spec: - chart: cert-manager - version: 1.6.x - sourceRef: + chart: cert-manager + version: v1.6.x + sourceRef: kind: HelmRepository name: jetstack namespace: flux-system -interval: 15m -timeout: 5m -releaseName: cert-manager -valuesFrom: -- kind: ConfigMap + interval: 15m + timeout: 5m + releaseName: cert-manager + valuesFrom: + - kind: ConfigMap name: cert-manager-helm-chart-value-overrides valuesKey: values.yaml # This is the default, but best to be explicit for clarity ``` diff --git a/docs/kubernetes/ssl-certificates/secret-replicator.md b/docs/kubernetes/ssl-certificates/secret-replicator.md index 6f4ac78..6671b6e 100644 --- a/docs/kubernetes/ssl-certificates/secret-replicator.md +++ b/docs/kubernetes/ssl-certificates/secret-replicator.md @@ -127,29 +127,29 @@ Note that the following values changed from default, above: Lastly, having set the scene above, we define the HelmRelease which will actually deploy the secret-replicator controller into the cluster, with the config we defined above. I save this in my flux repo: -```yaml title="/secret-replicator/helmrelease-secret-replicator.yaml" + ```yaml title="/secret-replicator/helmrelease-secret-replicator.yaml" apiVersion: helm.toolkit.fluxcd.io/v2beta1 kind: HelmRelease metadata: -name: secret-replicator -namespace: secret-replicator + name: secret-replicator + namespace: secret-replicator spec: -chart: + chart: spec: - chart: secret-replicator - version: 0.6.x - sourceRef: + chart: secret-replicator + version: 0.6.x + sourceRef: kind: HelmRepository name: kiwigrid namespace: flux-system -interval: 15m -timeout: 5m -releaseName: secret-replicator -valuesFrom: -- kind: ConfigMap + interval: 15m + timeout: 5m + releaseName: secret-replicator + valuesFrom: + - kind: ConfigMap name: secret-replicator-helm-chart-value-overrides valuesKey: values.yaml # This is the default, but best to be explicit for clarity -``` + ``` --8<-- "kubernetes-why-not-config-in-helmrelease.md" diff --git a/docs/kubernetes/ssl-certificates/wildcard-certificate.md b/docs/kubernetes/ssl-certificates/wildcard-certificate.md index 6eeff66..e771733 100644 --- a/docs/kubernetes/ssl-certificates/wildcard-certificate.md +++ b/docs/kubernetes/ssl-certificates/wildcard-certificate.md @@ -42,7 +42,8 @@ Thanks to [Sealed Secrets](/kubernetes/sealed-secrets/), we have a safe way of c ### Staging Certificate -Finally, we create our certificates! Here's an example certificate resource which uses the letsencrypt-staging issuer (*to avoid being rate-limited while learning!*). I save this in my flux repo: +Finally, we create our certificates! Here's an example certificate resource which uses the letsencrypt-staging issuer (*to avoid being rate-limited while learning!*). I save this in my flux repo as `/letsencrypt-wildcard-cert/certificate-wildcard-cert-letsencrypt-staging.yaml` + ```yaml title="/letsencrypt-wildcard-cert/certificate-wildcard-cert-letsencrypt-staging.yaml" apiVersion: cert-manager.io/v1 @@ -51,14 +52,14 @@ metadata: name: letsencrypt-wildcard-cert-example.com-staging namespace: letsencrypt-wildcard-cert spec: -# secretName doesn't have to match the certificate name, but it may as well, for simplicity! -secretName: letsencrypt-wildcard-cert-example.com-staging -issuerRef: - name: letsencrypt-staging - kind: ClusterIssuer -dnsNames: - - "example.com" - - "*.example.com" + # secretName doesn't have to match the certificate name, but it may as well, for simplicity! + secretName: letsencrypt-wildcard-cert-example.com-staging + issuerRef: + name: letsencrypt-staging + kind: ClusterIssuer + dnsNames: + - "example.com" + - "*.example.com" ``` ## Serving @@ -88,7 +89,7 @@ If your certificate does not become `Ready` within a few minutes [^1], try watch ### Production Certificate -Once you know you can happily deploy a staging certificate, it's safe enough to attempt your "prod" certificate. I save this in my flux repo: +Once you know you can happily deploy a staging certificate, it's safe enough to attempt your "prod" certificate. I save this in my flux repo as `/letsencrypt-wildcard-cert/certificate-wildcard-cert-letsencrypt-prod.yaml` ```yaml title="/letsencrypt-wildcard-cert/certificate-wildcard-cert-letsencrypt-prod.yaml" apiVersion: cert-manager.io/v1 @@ -98,11 +99,11 @@ metadata: namespace: letsencrypt-wildcard-cert spec: # secretName doesn't have to match the certificate name, but it may as well, for simplicity! -secretName: letsencrypt-wildcard-cert-example.com -issuerRef: - name: letsencrypt-prod - kind: ClusterIssuer -dnsNames: + secretName: letsencrypt-wildcard-cert-example.com + issuerRef: + name: letsencrypt-prod + kind: ClusterIssuer + dnsNames: - "example.com" - "*.example.com" ```