Skip to content

fix: typos and dead link in native k8s executor docs #1805

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.

Sign up for GitHub

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

Open
DaedalusG wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −3
Open

fix: typos and dead link in native k8s executor docs #1805

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/self-hosted/executors/deploy-executors-kubernetes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Executors interact with the Kubernetes API to manage the lifecycle of individual
| API Groups | Resources | Verbs | Reason |
| ---------- | ------------------ | ---------------------- | ----------------------------------------------------------------------------------------- |
| `batch` | `jobs` | `create`, `delete` | Executors create Job pods to run processes. Once Jobs are completed, they are cleaned up. |
| | `pods`, `pods/log` | `get`, `list`, `watch` | Executors need to look up and steam logs from the Job Pods. |
| | `pods`, `pods/log` | `get`, `list`, `watch` | Executors need to look up and stream logs from the Job Pods. |

Here's an example Role YAML to demonstrate the RBAC requirements for native Kubernetes Executors:

Expand Down Expand Up @@ -75,7 +75,7 @@ Native Kubernetes Executors can be deployed via either the `sourcegraph-executor
1. `EXECUTOR_FRONTEND_URL` should match the URL of your Sourcegraph instance
2. `EXECUTOR_FRONTEND_PASSWORD` should match the `executors.accessToken` key in the Sourcegraph instance's site configuration
3. Either `EXECUTOR_QUEUE_NAMES` or `EXECUTOR_QUEUE_NAME` should be set depending on whether the Executor will process batch change or precise auto indexing jobs
4. `EXECUTOR_KUBERNETES_NAMESPACE` should be set to the Kubernetes namespace where you intend to run the worker pods. This should generally match the namesapce where you deploy the Executor resources in the next step.
4. `EXECUTOR_KUBERNETES_NAMESPACE` should be set to the Kubernetes namespace where you intend to run the worker pods. This should generally match the namespace where you deploy the Executor resources in the next step.

<Callout type="note">
Additional environment variables may need to be configured for your
Expand Down Expand Up @@ -141,4 +141,4 @@ The Executor Docker image is available on Docker Hub at [`sourcegraph/executor-k

### Example Configuration YAML

See the local development YAMLs for an example of how to configure the Executor in Kubernetes.
For an example of how to configure the Executor in Kubernetes, see the [`sourcegraph-executor-k8s` Helm chart values reference](https://github.com/sourcegraph/deploy-sourcegraph-helm/blob/main/charts/sourcegraph-executor/k8s/values.yaml).