cleanup

coder · ericpaulsen · Jul 24, 2023 · Jul 23, 2023 · Jul 23, 2023 · Jul 23, 2023
commit 582968430c0ac43f8ac0ee5684d504499e2452c1
diff --git a/docs/platforms/kubernetes/deployment-logs.md b/docs/platforms/kubernetes/deployment-logs.md
@@ -1,37 +1,22 @@
-# Deployment logs
+# Kubernetes event logs
 
-To stream kubernetes pods events from the deployment, you can use Coder's [`coder-logstream-kube`](https://github.com/coder/coder-logstream-kube) tool. This can stream logs from the deployment to Coder's workspace startup logs.
+To stream Kubernetes events into your workspace startup logs, you can use Coder's [`coder-logstream-kube`](https://github.com/coder/coder-logstream-kube) tool. `coder-logstream-kube` provides useful information about the workspace pod or deployment, such as:
 
-`coder-logstream-kube` can give you useful information about the deployment, such as:
-
-- Easily determine the reason for a pod provision failure, or why a pod is stuck in a pending state.
+- Causes of pod provisioning failures, or why a pod is stuck in a pending state.
 - Visibility into when pods are OOMKilled, or when they are evicted.
 - Filter by namespace, field selector, and label selector to reduce Kubernetes API load.
 
-## Prerequisite
-
 ## Prerequisites
 
-`coder-logstream-kube` works with the [`kubernetes_deployment`](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/deployment) terraform resource, which requires the `coder` service account to have permission to create deployments. For example if you are using [helm](https://coder.com/docs/v2/latest/install/kubernetes#install-coder-with-helm) to install Coder, you should set `coder.serviceAccount.enableDeployments=true` in your `values.yaml`
+`coder-logstream-kube` works best with the [`kubernetes_deployment`](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/deployment) terraform resource, which requires the `coder` service account to have permission to create deployments. For example if you are using [helm](https://coder.com/docs/v2/latest/install/kubernetes#install-coder-with-helm) to install Coder, you should set `coder.serviceAccount.enableDeployments=true` in your `values.yaml`
 
 ```diff
 coder:
 serviceAccount:
-    # coder.serviceAccount.workspacePerms -- Whether or not to grant the coder
-    # service account permissions to manage workspaces. This includes
-    # permission to manage pods and persistent volume claims in the deployment
-    # namespace.
-    #
-    # It is recommended to keep this on if you are using Kubernetes templates
-    # within Coder.
     workspacePerms: true
-    # coder.serviceAccount.enableDeployments -- Provides the service account permission
-    # to manage Kubernetes deployments.
 -   enableDeployments: false
 +   enableDeployments: true
-    # coder.serviceAccount.annotations -- The Coder service account annotations.
     annotations: {}
-    # coder.serviceAccount.name -- The service account name
     name: coder
 ```