Skip to content

Commit d8436ae

Browse files
committed
dind docs fixups
1 parent 55087ae commit d8436ae

4 files changed

Lines changed: 12 additions & 12 deletions

File tree

charts/sourcegraph-executor/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Sourcegraph executor helm charts
22

3-
This directory contains two Helm charts for deploying executors on Kubernetes. [See the docs](https://docs.sourcegraph.com/admin/executors/deploy_executors_kubernetes) for more information on executors on Kubernetes.
3+
This directory contains two Helm charts for deploying executors on Kubernetes. [See the docs](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-kubernetes) for more information on executors on Kubernetes.
44

55
## Native Kubernetes (k8s)
66
This chart deploys executors that interact with the Kubernetes API to handle jobs.
77

88
> ⚠️ **Beta:** Native Kubernetes executors are in beta. For production workloads, consider deploying using
9-
> [Terraform](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-terraform) or the
10-
> [Linux binary](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-binary) for better long-term support.
9+
> [Terraform](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-terraform) or the
10+
> [Linux binary](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary) for better long-term support.
1111
1212
Your cluster will need to allow configuration of the following RBAC rules:
1313

@@ -21,6 +21,6 @@ Your cluster will need to allow configuration of the following RBAC rules:
2121
> ⚠️ **Beta:** Docker-in-Docker Kubernetes executors are not recommended for production use.
2222
> This method requires privileged access to a container runtime daemon and does not use Firecracker
2323
> isolation. For production workloads, consider a
24-
> [non-Kubernetes method](https://docs.sourcegraph.com/admin/executors).
24+
> [non-Kubernetes method](https://sourcegraph.com/docs/admin/executors).
2525
2626
This chart deploys executors that deploy a [Docker in Docker](https://www.docker.com/blog/docker-can-now-run-within-docker/) sidecar with each executor pod to avoid accessing the host container runtime directly. This method requires privileged access to a container runtime daemon in order to operate correctly.

charts/sourcegraph-executor/dind/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This chart contains two deployments, Sourcegraph Executors and a private Docker
1010
> ⚠️ **Beta:** Docker-in-Docker Kubernetes executors are not recommended for production use.
1111
> This method requires privileged access to a container runtime daemon. For production workloads,
1212
> consider deploying via
13-
> [Terraform](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-terraform) or
14-
> [binary](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-binary).
13+
> [Terraform](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-terraform) or
14+
> [binary](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary).
1515
1616
Use cases:
1717

@@ -85,7 +85,7 @@ In addition to the documented values, the `executor` and `private-docker-registr
8585
| executor.storage.class | string | `""` | StorageClass for the ephemeral volume. Only used when type is ephemeral. Defaults to the cluster default StorageClass when empty. |
8686
| executor.storage.size | string | `""` | Size of the scratch volume. emptyDir: sets sizeLimit (optional, leave empty for unlimited). ephemeral: sets the PVC storage request (required). |
8787
| executor.storage.type | string | `"emptyDir"` | Type of scratch volume for job workspaces. One of: emptyDir, ephemeral. emptyDir: plain emptyDir, no storage class required. ephemeral: per-pod PVC via the cluster default storage class; size is required. |
88-
| privateDockerRegistry.enabled | bool | `true` | Whether to deploy the private registry. Only one registry is needed when deploying multiple executors. More information: https://docs.sourcegraph.com/admin/executors/deploy_executors#using-private-registries |
88+
| privateDockerRegistry.enabled | bool | `true` | Whether to deploy the private registry. Only one registry is needed when deploying multiple executors. More information: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors#using-private-registries |
8989
| privateDockerRegistry.env | object | `{"REGISTRY_PROXY_REMOTEURL":{"value":"https://registry-1.docker.io"}}` | Extra environment variables to set on the registry container. Registry can be configured with environment variables using the pattern REGISTRY_<SECTION>_<KEY> (uppercase). Full reference: https://distribution.github.io/distribution/about/configuration To proxy an internal private registry with credentials, override REGISTRY_PROXY_REMOTEURL and supply REGISTRY_PROXY_USERNAME / REGISTRY_PROXY_PASSWORD, e.g.: env: REGISTRY_PROXY_REMOTEURL: value: https://my-internal-registry.example.com REGISTRY_PROXY_USERNAME: value: myuser REGISTRY_PROXY_PASSWORD: valueFrom: secretKeyRef: name: registry-proxy-credentials key: password |
9090
| privateDockerRegistry.image.registry | string | `"index.docker.io"` | |
9191
| privateDockerRegistry.image.repository | string | `"registry"` | |
@@ -128,4 +128,4 @@ kubectl logs -l app=executor -c executor
128128

129129
[sourcegraph/sourcegraph]: ../sourcegraph/
130130
[sourcegraph/sourcegraph-executor]: ./
131-
[executor]: https://docs.sourcegraph.com/admin/executors
131+
[executor]: https://sourcegraph.com/docs/admin/executors

charts/sourcegraph-executor/dind/README.md.gotmpl

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ This chart contains two deployments, Sourcegraph Executors and a private Docker
1010
> ⚠️ **Beta:** Docker-in-Docker Kubernetes executors are not recommended for production use.
1111
> This method requires privileged access to a container runtime daemon. For production workloads,
1212
> consider deploying via
13-
> [Terraform](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-terraform) or
14-
> [binary](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-binary).
13+
> [Terraform](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-terraform) or
14+
> [binary](https://sourcegraph.com/docs/self-hosted/executors/deploy-executors-binary).
1515

1616
Use cases:
1717

@@ -74,4 +74,4 @@ kubectl logs -l app=executor -c executor
7474

7575
[sourcegraph/sourcegraph]: ../sourcegraph/
7676
[sourcegraph/sourcegraph-executor]: ./
77-
[executor]: https://docs.sourcegraph.com/admin/executors
77+
[executor]: https://sourcegraph.com/docs/admin/executors

charts/sourcegraph-executor/dind/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ dind:
206206
207207
privateDockerRegistry:
208208
# -- Whether to deploy the private registry. Only one registry is needed when deploying multiple executors.
209-
# More information: https://docs.sourcegraph.com/admin/executors/deploy_executors#using-private-registries
209+
# More information: https://sourcegraph.com/docs/self-hosted/executors/deploy-executors#using-private-registries
210210
enabled: true
211211
image:
212212
registry: index.docker.io

0 commit comments

Comments
 (0)