replaced kubeapply jetstack cert-manager approach with helm install (coder#899)

sharkymark · web-flow · commit e0499d3233ed · 2022-03-18T09:20:56.000-05:00
diff --git a/changelog/1.28.0.md b/changelog/1.28.0.md
@@ -11,8 +11,7 @@ description: "Released on 02/16/2022"
 <!-- Turn off linting to avoid changing the link -->
 <!-- markdownlint-disable MD044 -->
 
-[version support policy]:
-  ../setup/kubernetes#supported-kubernetes-versions
+[version support policy]: ../setup/kubernetes#supported-kubernetes-versions
 
 <!-- markdownlint-enable MD044 -->
 
diff --git a/guides/tls-certificates/azureDNS.md b/guides/tls-certificates/azureDNS.md
@@ -14,10 +14,10 @@ authority.
 > differently from earlier versions of Coder. Ensure that you're reading the
 > docs applicable to your Coder version.
 
-This guide will show you how to install cert-manager v1.4.0 and set up your
-cluster to issue Let's Encrypt certificates for your Coder installation so that
-you can enable HTTPS on your Coder deployment. It will also show you how to
-configure your Coder hostname and dev URLs.
+This guide will show you how to install cert-manager and set up your cluster to
+issue Let's Encrypt certificates for your Coder installation so that you can
+enable HTTPS on your Coder deployment. It will also show you how to configure
+your Coder hostname and dev URLs.
 
 There are three available methods to configuring the Azure DNS DNS01 Challenge
 via cert-manager:
@@ -84,7 +84,7 @@ the domain you're using for your Coder deployment.
    cert-manager:
 
    ```console
-   kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.4.0/cert-manager.yaml
+   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.7.1/cert-manager.yaml
    ```
 
 1. Check that cert-manager installs correctly by running
@@ -300,11 +300,14 @@ However, to use all of the functionality you set up in this tutorial, use the
 following command instead:
 
 ```console
+# be sure to update the `stringValue` placeholder with the
+# proper value for your devurlsHostSecretName and hostSecretName
+
 helm upgrade --install coder coder/coder --namespace coder \
   --version=<CODER_VERSION> \
-  --set coderd.devurlsHost="coder.example.com" \
-  --set coderd.tls.devurlsHostSecretName="coder-certs" \
-  --set coderd.tls.hostSecretName="coder-certs" \
+  --set coderd.devurlsHost="*.coder.example.com" \
+  --set coderd.tls.devurlsHostSecretName="coder-certs-stringValue" \
+  --set coderd.tls.hostSecretName="coder-certs-stringValue" \
   --wait
 ```
 
diff --git a/guides/tls-certificates/cloudDNS.md b/guides/tls-certificates/cloudDNS.md
@@ -14,10 +14,10 @@ authority.
 > differently from earlier versions of Coder. Ensure that you're reading the
 > docs applicable to your Coder version.
 
-This guide will show you how to install cert-manager v1.4.0 and set up your
-cluster to issue Let's Encrypt certificates for your Coder installation so that
-you can enable HTTPS on your Coder deployment. It will also show you how to
-configure your Coder hostname and dev URLs.
+This guide will show you how to install cert-manager and set up your cluster to
+issue Let's Encrypt certificates for your Coder installation so that you can
+enable HTTPS on your Coder deployment. It will also show you how to configure
+your Coder hostname and dev URLs.
 
 > We recommend reviewing the official cert-manager
 > [documentation](https://cert-manager.io/docs/) if you encounter any issues or
@@ -36,14 +36,44 @@ You must have:
 
 ## Step 1: Add cert-manager to your Kubernetes cluster
 
-To add cert-manager to your cluster, run:
+There are two ways to add cert-manager to your Kubernetes cluster.
+
+## Option 1: `kubectl apply`
+
+Add cert-manager to your cluster
+[using `kubectl apply`](https://cert-manager.io/docs/installation/kubectl/) by
+running:
 
 ```console
 kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.7.1/cert-manager.yaml
 ```
 
-More specifics can be found in the
-[cert-manager install documentation](https://cert-manager.io/docs/installation/kubernetes/#installing-with-regular-manifests).
+## Option 2: Helm
+
+Add cert-manager to your cluster
+[using Helm](https://cert-manager.io/docs/installation/helm/).
+
+First, add the Helm repo:
+
+```console
+helm repo add jetstack https://charts.jetstack.io
+```
+
+Then, install cert-manager and create its namespace (check for the
+[latest cert-manager version](https://cert-manager.io/docs/installation/supported-releases/#installing-with-regular-manifests),
+since they may change)
+
+```console
+helm install \
+  cert-manager jetstack/cert-manager \
+  --namespace cert-manager \
+  --version v1.7.0 \ # update version if necessary
+  --create-namespace \
+  --set installCRDs=true
+```
+
+You can find additional information in
+[cert-manager's installation docs](https://cert-manager.io/docs/installation/kubernetes/#installing-with-regular-manifests).
 
 Once you've started the installation process, verify that all the pods are
 running:
@@ -177,11 +207,14 @@ However, to use all of the functionality you set up in this tutorial, use the
 following command instead:
 
 ```console
+# be sure to update the `stringValue` placeholder with the
+# proper value for your devurlsHostSecretName and hostSecretName
+
 helm upgrade --install coder coder/coder --namespace coder \
   --version=<CODER_VERSION> \
   --set coderd.devurlsHost="*.coder.example.com" \
-  --set coderd.tls.devurlsHostSecretName="coder-certs" \
-  --set coderd.tls.hostSecretName="coder-certs" \
+  --set coderd.tls.devurlsHostSecretName="coder-certs-stringValue" \
+  --set coderd.tls.hostSecretName="coder-certs-stringValue" \
   --wait
 ```
 
diff --git a/guides/tls-certificates/cloudflare.md b/guides/tls-certificates/cloudflare.md
@@ -14,9 +14,9 @@ authority.
 > differently from earlier versions of Coder. Ensure that you're reading the
 > docs applicable to your Coder version.
 
-This guide will show you how to install cert-manager v1.4.0 and set up your
-cluster to issue Let's Encrypt certificates for your Coder installation so that
-you can enable HTTPS on your Coder deployment.
+This guide will show you how to install cert-manager and set up your cluster to
+issue Let's Encrypt certificates for your Coder installation so that you can
+enable HTTPS on your Coder deployment.
 
 > We recommend reviewing the official cert-manager
 > [documentation](https://cert-manager.io/docs/) if you encounter any issues or
@@ -34,7 +34,7 @@ You must have:
 ## Step 1: Add cert-manager to your Kubernetes cluster
 
 ```console
-kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.4.0/cert-manager.yaml
+kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.7.1/cert-manager.yaml
 ```
 
 More specifics can be found in the
@@ -201,14 +201,16 @@ kubectl apply -f certificate.yaml
 ## Step 4: Configure Coder to issue and use the certificates
 
 If you're using the default LoadBalancer to access Coder, you can use the
-following helm values to use the certificate.
+following Helm values to use the certificate.
 
 ```yaml
+# be sure to update the `stringValue` placeholder with the
+# proper value for your devurlsHostSecretName and hostSecretName
 coderd:
   devurlsHost: "*.coder.example.com"
   tls:
-    devurlsHostSecretName: "coder-certs"
-    hostSecretName: "coder-certs"
+    devurlsHostSecretName: "coder-certs-stringValue"
+    hostSecretName: "coder-certs-stringValue"
 ```
 
 Be sure to change `coder.example.com` to the domain for your Coder deployment.
diff --git a/guides/tls-certificates/route53.md b/guides/tls-certificates/route53.md
@@ -14,10 +14,10 @@ authority.
 > differently from earlier versions of Coder. Ensure that you're reading the
 > docs applicable to your Coder version.
 
-This guide will show you how to install cert-manager v1.4.0 and set up your
-cluster to issue Let's Encrypt certificates for your Coder installation so that
-you can enable HTTPS on your Coder deployment. It will also show you how to
-configure your Coder hostname and dev URLs.
+This guide will show you how to install cert-manager and set up your cluster to
+issue Let's Encrypt certificates for your Coder installation so that you can
+enable HTTPS on your Coder deployment. It will also show you how to configure
+your Coder hostname and dev URLs.
 
 ## Prerequisites
 
@@ -42,7 +42,7 @@ You should also:
    cert-manager:
 
    ```console
-   kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.4.0/cert-manager.yaml
+   kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.7.1/cert-manager.yaml
    ```
 
 1. Check that cert-manager installs correctly by running
@@ -199,11 +199,14 @@ However, to use all of the functionality you set up in this tutorial, use the
 following command instead:
 
 ```console
+# be sure to update the `stringValue` placeholder with the
+# proper value for your devurlsHostSecretName and hostSecretName
+
 helm upgrade --install coder coder/coder --namespace coder \
   --version=<CODER_VERSION> \
   --set coderd.devurlsHost="*.coder.example.com" \
-  --set coderd.tls.devurlsHostSecretName="coder-certs" \
-  --set coderd.tls.hostSecretName="coder-certs" \
+  --set coderd.tls.devurlsHostSecretName="coder-certs-stringValue" \
+  --set coderd.tls.hostSecretName="coder-certs-stringValue" \
   --wait
 ```
 
