Report custom labels set by agent admins back

agent/rpc/client_grpc.go

@@ -480,12 +480,15 @@ func (c *client) sendLogs(ctx context.Context, entries []*proto.LogEntry) error
 	return nil
 }
 
-func (c *client) RegisterAgent(ctx context.Context, platform, backend, version string, capacity int) (int64, error) {
+func (c *client) RegisterAgent(ctx context.Context, info rpc.AgentInfo) (int64, error) {
 	req := new(proto.RegisterAgentRequest)
-	req.Platform = platform
-	req.Backend = backend
-	req.Version = version
-	req.Capacity = int32(capacity)
+	req.Info = &proto.AgentInfo{
+		Platform:     info.Platform,
+		Backend:      info.Backend,
+		Version:      info.Version,
+		Capacity:     int32(info.Capacity),
+		CustomLabels: info.CustomLabels,
+	}
 
 	res, err := c.client.RegisterAgent(ctx, req)
 	return res.GetAgentId(), err

cmd/agent/core/agent.go

@@ -20,6 +20,7 @@ import (
 	"crypto/tls"
 	"errors"
 	"fmt"
+	"maps"
 	"net/http"
 	"os"
 	"strings"
@@ -198,7 +199,22 @@ func run(ctx context.Context, c *cli.Command, backends []types.Backend) error {
 	log.Debug().Msgf("loaded %s backend engine", backendEngine.Name())
 
 	maxWorkflows := int(c.Int("max-workflows"))
-	agentConfig.AgentID, err = client.RegisterAgent(grpcCtx, engInfo.Platform, backendEngine.Name(), version.String(), maxWorkflows) //nolint:contextcheck
+
+	customLabels := make(map[string]string)
+	if err := stringSliceAddToMap(c.StringSlice("labels"), customLabels); err != nil {
+		return err
+	}
+	if len(customLabels) != 0 {
+		log.Debug().Msgf("custom labels detected: %#v", customLabels)
+	}
+
+	agentConfig.AgentID, err = client.RegisterAgent(grpcCtx, rpc.AgentInfo{ //nolint:contextcheck
+		Version:      version.String(),
+		Backend:      backendEngine.Name(),
+		Platform:     engInfo.Platform,
+		Capacity:     maxWorkflows,
+		CustomLabels: customLabels,
+	})
 	if err != nil {
 		return err
 	}
@@ -210,7 +226,7 @@ func run(ctx context.Context, c *cli.Command, backends []types.Backend) error {
 		<-agentCtx.Done()
 		// Remove stateless agents from server
 		if !agentConfigPersisted.Load() {
-			log.Debug().Msg("unregistering agent from server ...")
+			log.Debug().Msg("unregister agent from server ...")
 			// we want to run it explicit run when context got canceled so run it in background
 			err := client.UnregisterAgent(grpcClientCtx)
 			if err != nil {
@@ -228,16 +244,15 @@ func run(ctx context.Context, c *cli.Command, backends []types.Backend) error {
 		}
 	}
 
+	// set default labels ...
 	labels := map[string]string{
 		"hostname": hostname,
 		"platform": engInfo.Platform,
 		"backend":  backendEngine.Name(),
 		"repo":     "*", // allow all repos by default
 	}
-
-	if err := stringSliceAddToMap(c.StringSlice("filter"), labels); err != nil {
-		return err
-	}
+	// ... and let it overwrite by custom ones
+	maps.Copy(labels, customLabels)
 
 	filter := rpc.Filter{
 		Labels: labels,

cmd/agent/core/flags.go

@@ -60,8 +60,9 @@ var flags = []cli.Flag{
 		Value:   "/etc/woodpecker/agent.conf",
 	},
 	&cli.StringSliceFlag{
-		Sources: cli.EnvVars("WOODPECKER_FILTER_LABELS"),
-		Name:    "filter",
+		Sources: cli.EnvVars("WOODPECKER_AGENT_LABELS", "WOODPECKER_FILTER_LABELS"), // remove WOODPECKER_FILTER_LABELS in v4.x
+		Name:    "labels",
+		Aliases: []string{"filter"}, // remove in v4.x
 		Usage:   "List of labels to filter tasks on. An agent must be assigned every tag listed in a task to be selected.",
 	},
 	&cli.IntFlag{

cmd/server/docs/docs.go

@@ -4402,6 +4402,12 @@ const docTemplate = `{
                 "created": {
                     "type": "integer"
                 },
+                "custom_labels": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    }
+                },
                 "id": {
                     "type": "integer"
                 },

docs/docs/30-administration/15-agent-config.md

@@ -120,11 +120,14 @@ Configures the path of the agent config file.
 
 Configures the number of parallel workflows.
 
-### `WOODPECKER_FILTER_LABELS`
+### `WOODPECKER_AGENT_LABELS`
 
 > Default: empty
 
-Configures labels to filter pipeline pick up. Use a list of key-value pairs like `key=value,second-key=*`. `*` can be used as a wildcard. By default, agents provide three additional labels `platform=os/arch`, `hostname=my-agent` and `repo=*` which can be overwritten if needed. To learn how labels work, check out the [pipeline syntax page](../20-usage/20-workflow-syntax.md#labels).
+Configures custom labels for the agent, to let workflows filter by it.
+Use a list of key-value pairs like `key=value,second-key=*`. `*` can be used as a wildcard.
+By default, agents provide three additional labels `platform=os/arch`, `hostname=my-agent` and `repo=*` which can be overwritten if needed.
+To learn how labels work, check out the [pipeline syntax page](../20-usage/20-workflow-syntax.md#labels).
 
 ### `WOODPECKER_HEALTHCHECK`
 

docs/docs/91-migrations.md

@@ -4,6 +4,8 @@ Some versions need some changes to the server configuration or the pipeline conf
 
 ## `next`
 
+- Deprecate `WOODPECKER_FILTER_LABELS` use `WOODPECKER_AGENT_LABELS`
+- Set `/woodpecker` as defautl workdir for the **woodpecker-cli** container
 - Removed built-in environment variables:
   - `CI_COMMIT_URL` use `CI_PIPELINE_FORGE_URL`
   - `CI_STEP_FINISHED` as empty during execution

pipeline/rpc/peer.go

@@ -55,6 +55,15 @@ type (
 		GrpcVersion   int32  `json:"grpc_version,omitempty"`
 		ServerVersion string `json:"server_version,omitempty"`
 	}
+
+	// AgentInfo represents all the metadata that should be known about an agent.
+	AgentInfo struct {
+		Version      string            `json:"version"`
+		Platform     string            `json:"platform"`
+		Backend      string            `json:"backend"`
+		Capacity     int               `json:"capacity"`
+		CustomLabels map[string]string `json:"custom_labels"`
+	}
 )
 
 //go:generate mockery --name Peer --output mocks --case underscore --note "+build test"
@@ -86,7 +95,7 @@ type Peer interface {
 	EnqueueLog(logEntry *LogEntry)
 
 	// RegisterAgent register our agent to the server
-	RegisterAgent(ctx context.Context, platform, backend, version string, capacity int) (int64, error)
+	RegisterAgent(ctx context.Context, info AgentInfo) (int64, error)
 
 	// UnregisterAgent unregister our agent from the server
 	UnregisterAgent(ctx context.Context) error

pipeline/rpc/proto/version.go

@@ -16,4 +16,4 @@ package proto
 
 // Version is the version of the woodpecker.proto file,
 // IMPORTANT: increased by 1 each time it get changed.
-const Version int32 = 10
+const Version int32 = 11