Add dns config option to official feature set (#4418)

Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>

docs/docs/20-usage/20-workflow-syntax.md

@@ -763,6 +763,25 @@ Woodpecker supports to define multiple workflows for a repository. Those workflo
 
 Workflows that should run even on failure should set the `runs_on` tag. See [here](./25-workflows.md#flow-control) for an example.
 
+## Advanced network options for steps
+
+:::warning
+Only allowed if 'Trusted Network' option is enabled in repo settings by an admin.
+:::
+
+### `dns`
+
+If the backend engine understands to change the DNS server and lookup domain,
+this options will be used to alter the default DNS config to a custom one for a specific step.
+
+```yaml
+steps:
+  - name: build
+    image: plugin/abc
+    dns: 1.2.3.4
+    dns_search: 'internal.company'
+```
+
 ## Privileged mode
 
 Woodpecker gives the ability to configure privileged mode in the YAML. You can use this parameter to launch containers with escalated capabilities.

pipeline/backend/kubernetes/pod.go

@@ -162,6 +162,16 @@ func podSpec(step *types.Step, config *config, options BackendOptions, nsp nativ
 		return spec, err
 	}
 
+	if len(step.DNS) != 0 || len(step.DNSSearch) != 0 {
+		spec.DNSConfig = &v1.PodDNSConfig{}
+		if len(step.DNS) != 0 {
+			spec.DNSConfig.Nameservers = step.DNS
+		}
+		if len(step.DNSSearch) != 0 {
+			spec.DNSConfig.Searches = step.DNSSearch
+		}
+	}
+
 	log.Trace().Msgf("using the image pull secrets: %v", config.ImagePullSecretNames)
 	spec.ImagePullSecrets = secretsReferences(config.ImagePullSecretNames)
 	if needsRegistrySecret(step) {

pipeline/frontend/yaml/linter/schema/schema.json

@@ -54,6 +54,20 @@
     }
   },
   "definitions": {
+    "string_or_string_slice": {
+      "oneOf": [
+        {
+          "type": "array",
+          "minLength": 1,
+          "items": {
+            "type": "string"
+          }
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
     "clone": {
       "description": "Configures the clone step. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#clone",
       "oneOf": [
@@ -294,18 +308,7 @@
         },
         "depends_on": {
           "description": "Execute a step after another step has finished.",
-          "oneOf": [
+          "$ref": "#/definitions/string_or_string_slice"
-            {
-              "type": "array",
-              "minLength": 1,
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "string"
-            }
-          ]
         },
         "detach": {
           "description": "Detach a step to run in background until pipeline finishes. Read more: https://woodpecker-ci.org/docs/usage/services#detachment",
@@ -322,18 +325,15 @@
         },
         "entrypoint": {
           "description": "Defines container entrypoint.",
-          "oneOf": [
+          "$ref": "#/definitions/string_or_string_slice"
-            {
+        },
-              "type": "array",
+        "dns": {
-              "minLength": 1,
+          "description": "Change DNS server for step. Only allowed if 'Trusted Network' option is enabled in repo settings by an admin. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#dns",
-              "items": {
+          "$ref": "#/definitions/string_or_string_slice"
-                "type": "string"
+        },
-              }
+        "dns_search": {
-            },
+          "description": "Change DNS lookup domain for step. Only allowed if 'Trusted Network' option is enabled in repo settings by an admin. Read more: https://woodpecker-ci.org/docs/usage/workflow-syntax#dns",
-            {
+          "$ref": "#/definitions/string_or_string_slice"
-              "type": "string"
-            }
-          ]
         }
       }
     },
@@ -370,18 +370,7 @@
         },
         "depends_on": {
           "description": "Execute a step after another step has finished.",
-          "oneOf": [
+          "$ref": "#/definitions/string_or_string_slice"
-            {
-              "type": "array",
-              "minLength": 1,
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "string"
-            }
-          ]
         },
         "detach": {
           "description": "Detach a step to run in background until pipeline finishes. Read more: https://woodpecker-ci.org/docs/usage/services#detachment",

pipeline/frontend/yaml/types/container.go

@@ -32,20 +32,29 @@ type (
 
 	// Container defines a container.
 	Container struct {
-		BackendOptions map[string]any     `yaml:"backend_options,omitempty"`
+		// common
-		Commands       base.StringOrSlice `yaml:"commands,omitempty"`
+		Name       string             `yaml:"name,omitempty"`
-		Entrypoint     base.StringOrSlice `yaml:"entrypoint,omitempty"`
+		Image      string             `yaml:"image,omitempty"`
-		Detached       bool               `yaml:"detach,omitempty"`
+		Pull       bool               `yaml:"pull,omitempty"`
-		Directory      string             `yaml:"directory,omitempty"`
+		Commands   base.StringOrSlice `yaml:"commands,omitempty"`
-		Failure        string             `yaml:"failure,omitempty"`
+		Entrypoint base.StringOrSlice `yaml:"entrypoint,omitempty"`
-		Image          string             `yaml:"image,omitempty"`
+		Directory  string             `yaml:"directory,omitempty"`
-		Name           string             `yaml:"name,omitempty"`
+		Settings   map[string]any     `yaml:"settings"`
-		Pull           bool               `yaml:"pull,omitempty"`
+		// flow control
-		Settings       map[string]any     `yaml:"settings"`
+		DependsOn base.StringOrSlice `yaml:"depends_on,omitempty"`
-		Volumes        Volumes            `yaml:"volumes,omitempty"`
+		When      constraint.When    `yaml:"when,omitempty"`
-		When           constraint.When    `yaml:"when,omitempty"`
+		Failure   string             `yaml:"failure,omitempty"`
-		Ports          []string           `yaml:"ports,omitempty"`
+		Detached  bool               `yaml:"detach,omitempty"`
-		DependsOn      base.StringOrSlice `yaml:"depends_on,omitempty"`
+		// state
+		Volumes Volumes `yaml:"volumes,omitempty"`
+		// network
+		Ports     []string           `yaml:"ports,omitempty"`
+		DNS       base.StringOrSlice `yaml:"dns,omitempty"`
+		DNSSearch base.StringOrSlice `yaml:"dns_search,omitempty"`
+		// backend specific
+		BackendOptions map[string]any `yaml:"backend_options,omitempty"`
+
+		// ACTIVE DEVELOPMENT BELOW
 
 		// TODO: remove base.EnvironmentMap and use map[string]any after v3.0.0 release
 		Environment base.EnvironmentMap `yaml:"environment,omitempty"`
@@ -57,12 +66,10 @@ type (
 		Privileged bool `yaml:"privileged,omitempty"`
 
 		// Undocumented
-		Devices     []string           `yaml:"devices,omitempty"`
+		Devices     []string `yaml:"devices,omitempty"`
-		DNSSearch   base.StringOrSlice `yaml:"dns_search,omitempty"`
+		ExtraHosts  []string `yaml:"extra_hosts,omitempty"`
-		DNS         base.StringOrSlice `yaml:"dns,omitempty"`
+		NetworkMode string   `yaml:"network_mode,omitempty"`
-		ExtraHosts  []string           `yaml:"extra_hosts,omitempty"`
+		Tmpfs       []string `yaml:"tmpfs,omitempty"`
-		NetworkMode string             `yaml:"network_mode,omitempty"`
-		Tmpfs       []string           `yaml:"tmpfs,omitempty"`
 	}
 )