From 18cef15da4a24d99765bbafde2fa07ea15235aa7 Mon Sep 17 00:00:00 2001
From: Dominic <solaveritasteliberum@gmail.com>
Date: Sat, 25 Nov 2023 23:50:12 -0800
Subject: [PATCH] Add documentation on Kubernetes securityContext (#2822)

The new docs explain how to use the recently introduced kubernetes
backend option to set the security context for pipeline steps.

See #2550

---------

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
---
 .../22-backends/40-kubernetes.md              | 39 +++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/docs/docs/30-administration/22-backends/40-kubernetes.md b/docs/docs/30-administration/22-backends/40-kubernetes.md
index a62c69cad..abd1b5b28 100644
--- a/docs/docs/30-administration/22-backends/40-kubernetes.md
+++ b/docs/docs/30-administration/22-backends/40-kubernetes.md
@@ -157,6 +157,45 @@ steps:
     [...]
 ```
 
+### `securityContext`
+
+Use the following configuration to set the `securityContext` for the pod/container running a given pipeline step:
+
+```yaml
+steps:
+  test:
+    image: alpine
+    commands:
+      - echo Hello world
+    backend_options:
+      kubernetes:
+        securityContext:
+          runAsUser: 999
+          runAsGroup: 999
+          privileged: true
+    [...]
+```
+
+Note that the `backend_options.kubernetes.securityContext` object allows you to set both pod and container level security context options in one object.
+By default, the properties will be set at the pod level. Properties that are only supported on the container level will be set there instead. So, the
+configuration shown above will result in something like the following pod spec:
+
+```yaml
+kind: Pod
+spec:
+  securityContext:
+    runAsUser: 999
+    runAsGroup: 999
+  containers:
+    - name: wp-01hcd83q7be5ymh89k5accn3k6-0-step-0
+      image: alpine
+      securityContext:
+        privileged: true
+  [...]
+```
+
+See the [kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) for more information on using `securityContext`.
+
 ## Tips and tricks
 
 ### CRI-O