Update documentation to match new backend_options setting

woodpecker-ci · May 23, 2023 · f48c685 · f48c685
1 parent e06cc3f
commit f48c685
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 12 deletions.
diff --git a/docs/docs/30-administration/22-backends/40-kubernetes.md b/docs/docs/30-administration/22-backends/40-kubernetes.md
@@ -53,12 +53,14 @@ pipeline:
       - go get
       - go build
       - go test
-    resources:
-      requests:
-        memory: 128Mi
-        cpu: 1000m
-      limits:
-        memory: 256Mi
+    backend_options:
+      kubernetes:
+        resources:
+          requests:
+            memory: 128Mi
+            cpu: 1000m
+          limits:
+            memory: 256Mi
 ```
 
 See the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/) for more information on using resources.
diff --git a/pipeline/schema/schema.json b/pipeline/schema/schema.json
@@ -244,8 +244,8 @@
           "enum": ["fail", "ignore"],
           "default": "fail"
         },
-        "resources": {
-          "$ref": "#/definitions/step_resources"
+        "backend_options": {
+          "$ref": "#/definitions/step_backend_options"
         }
       }
     },
@@ -483,19 +483,38 @@
       "description": "Read more: https://woodpecker-ci.org/docs/usage/pipeline-syntax#directory",
       "type": "string"
     },
-    "step_resources": {
+    "step_backend_options": {
+      "description": "Advanced options for the different agent backends",
+      "type": "object",
+      "properties": {
+        "kubernetes" :{
+          "$ref": "#/definitions/step_backend_kubernetes_resources"
+        }
+      }
+    },
+    "step_backend_kubernetes": {
+      "description": "Advanced options for the kubernetes agent backends",
+      "type": "object",
+      "properties": {
+        "resources" :{
+          "$ref": "#/definitions/step_backend_kubernetes_resources"
+        }
+      }
+    },
+    "step_backend_kubernetes_resources": {
       "description": "Resources for the kubernetes backend. Read more: https://woodpecker-ci.org/docs/administration/backends/kubernetes",
       "type": "object",
       "properties": {
         "requests": {
-          "$ref": "#/definitions/step_resources_object"
+          "$ref": "#/definitions/step_kubernetes_resources_object"
         },
         "limits": {
-          "$ref": "#/definitions/step_resources_object"
+          "$ref": "#/definitions/step_kubernetes_resources_object"
         }
       }
     },
-    "step_resources_object": {
+    "step_kubernetes_resources_object": {
+      "description": "A list of kubernetes resource mappings",
       "type": "object",
       "additionalProperties": {
         "type": "string"