Skip to content

Commit 58ba568

Browse files
authored
docs: add beta warnings for Kubernetes native executor deployment options (#448)
closes PLAT-704 Provide a warning to admins or developers reviewing the k8s-native executors deployment type. These changes are intended to prevent further adoption of a deployment type that may not work with future iteractions sourcegraph and executors
1 parent 3adbbdd commit 58ba568

3 files changed

Lines changed: 12 additions & 0 deletions

File tree

components/executors/dind/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Executors (Docker-in-Docker)
22

3+
> ⚠️ **Beta:** Docker-in-Docker Kubernetes executors are not recommended for production use.
4+
> This method requires privileged access to a container runtime daemon. For production workloads,
5+
> deploy via [Terraform](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-terraform)
6+
> or [binary](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-binary).
7+
38
Executors are Sourcegraph’s solution for running untrusted code in a secure and controllable way. For more information on dind executors and how they are used see the Executors [dind documentation](https://docs.sourcegraph.com/admin/executors/deploy_executors_dind)
49

510
## Deploying

components/executors/k8s/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Executors (Native Kubernetes)
22

3+
> ⚠️ **Beta:** Native Kubernetes executors are in beta. For production workloads, consider deploying using
4+
> [Terraform](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-terraform) or the
5+
> [Linux binary](https://docs.sourcegraph.com/self-hosted/executors/deploy-executors-binary) for better long-term support.
6+
37
Executors are Sourcegraph’s solution for running untrusted code in a secure and controllable way. For more information on native kubernetes executors and how they are used see the [Executors documentation](https://docs.sourcegraph.com/admin/executors/deploy_executors_kubernetes)
48

59
## Deploying

examples/executors/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Quickstart overlay for executors
22

3+
> ⚠️ **Note:** This overlay deploys native Kubernetes executors, which are in beta and not
4+
> recommended for production use.
5+
36
This overlay:
47

58
- deploys Sourcegraph without monitoring services

0 commit comments

Comments
 (0)