Merge branch 'master' into nav-bar-background-color

Signed-off-by: krrrr38 <[email protected]>

Makefile

@@ -297,11 +297,15 @@ $(GOPATH)/bin/goimports:
 	go install golang.org/x/tools/cmd/[email protected]
 
 pkg/apis/workflow/v1alpha1/generated.proto: $(GOPATH)/bin/go-to-protobuf $(PROTO_BINARIES) $(TYPES) $(GOPATH)/src/github.com/gogo/protobuf
+	# These files are generated on a v3/ folder by the tool. Link them to the root folder
+	[ -e ./v3 ] || ln -s . v3
 	$(GOPATH)/bin/go-to-protobuf \
 		--go-header-file=./hack/custom-boilerplate.go.txt \
 		--packages=github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1 \
 		--apimachinery-packages=+k8s.io/apimachinery/pkg/util/intstr,+k8s.io/apimachinery/pkg/api/resource,k8s.io/apimachinery/pkg/runtime/schema,+k8s.io/apimachinery/pkg/runtime,k8s.io/apimachinery/pkg/apis/meta/v1,k8s.io/api/core/v1,k8s.io/api/policy/v1beta1 \
 		--proto-import $(GOPATH)/src
+	# Delete the link
+	[ -e ./v3 ] && rm -rf v3
 	touch pkg/apis/workflow/v1alpha1/generated.proto
 
 # this target will also create a .pb.go and a .pb.gw.go file, but in Make 3 we cannot use _grouped target_, instead we must choose
@@ -499,20 +503,28 @@ clean:
 # swagger
 
 pkg/apis/workflow/v1alpha1/openapi_generated.go: $(GOPATH)/bin/openapi-gen $(TYPES)
+	# These files are generated on a v3/ folder by the tool. Link them to the root folder
+	[ -e ./v3 ] || ln -s . v3
 	$(GOPATH)/bin/openapi-gen \
 	  --go-header-file ./hack/custom-boilerplate.go.txt \
 	  --input-dirs github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1 \
 	  --output-package github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1 \
 	  --report-filename pkg/apis/api-rules/violation_exceptions.list
+	# Delete the link
+	[ -e ./v3 ] && rm -rf v3
 
 
 # generates many other files (listers, informers, client etc).
 pkg/apis/workflow/v1alpha1/zz_generated.deepcopy.go: $(TYPES)
+	# These files are generated on a v3/ folder by the tool. Link them to the root folder
+	[ -e ./v3 ] || ln -s . v3
 	bash $(GOPATH)/pkg/mod/k8s.io/[email protected]/generate-groups.sh \
 	    "deepcopy,client,informer,lister" \
 	    github.com/argoproj/argo-workflows/v3/pkg/client github.com/argoproj/argo-workflows/v3/pkg/apis \
 	    workflow:v1alpha1 \
 	    --go-header-file ./hack/custom-boilerplate.go.txt
+	# Delete the link
+	[ -e ./v3 ] && rm -rf v3
 
 dist/kubernetes.swagger.json:
 	@mkdir -p dist

cmd/argo/commands/archive/list.go

@@ -46,7 +46,7 @@ func NewListCommand() *cobra.Command {
 				listOpts.Continue = resp.Continue
 			}
 			sort.Sort(workflows)
-			err = printer.PrintWorkflows(workflows, os.Stdout, printer.PrintOpts{Output: output, Namespace: true})
+			err = printer.PrintWorkflows(workflows, os.Stdout, printer.PrintOpts{Output: output, Namespace: true, UID: true})
 			errors.CheckError(err)
 		},
 	}

config/config.go

@@ -125,8 +125,7 @@ type Config struct {
 	// https://argoproj.github.io/argo-workflows/workflow-executors/#emissary-emissary
 	Images map[string]Image `json:"images,omitempty"`
 
-	// UI defines a config for UI
-	UI *wfv1.UI `json:"ui,omitempty"`
+	RetentionPolicy *RetentionPolicy `json:"retentionPolicy,omitempty"`
 }
 
 func (c Config) GetContainerRuntimeExecutor(labels labels.Labels) (string, error) {

config/retention_policy.go

@@ -0,0 +1,7 @@
+package config
+
+type RetentionPolicy struct {
+	Completed int `json:"completed,omitempty"`
+	Failed    int `json:"failed,omitempty"`
+	Errored   int `json:"errored,omitempty"`
+}

hack/check-logging.sh

@@ -17,7 +17,7 @@
 #
 # As a last resort, use `log.Info(fmt.Sprintf(""))`.
 
-set -eu
+set -eux
 
 from=$(git merge-base --fork-point origin/master)
 count=$(git diff "$from" -- '*.go' | grep '^+' | grep -v '\(fmt\|errors\).Errorf' | grep -c '\(Debug\|Info\|Warn\|Warning\|Error\)f' || true)

manifests/quick-start-minimal.yaml

@@ -733,6 +733,10 @@ data:
     path: /metrics
     port: 9090
   namespaceParallelism: "10"
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

manifests/quick-start-mysql.yaml

@@ -752,6 +752,10 @@ data:
       passwordSecret:
         name: argo-mysql-config
         key: password
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

manifests/quick-start-postgres.yaml

@@ -752,6 +752,10 @@ data:
       passwordSecret:
         name: argo-postgres-config
         key: password
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

manifests/quick-start/minimal/kustomization.yaml

@@ -3,3 +3,7 @@ kind: Kustomization
 
 resources:
   - ../base
+
+patchesStrategicMerge:
+  - overlays/workflow-controller-configmap.yaml
+

manifests/quick-start/minimal/overlays/workflow-controller-configmap.yaml

@@ -0,0 +1,9 @@
+apiVersion: v1
+data:
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
+kind: ConfigMap
+metadata:
+  name: workflow-controller-configmap

manifests/quick-start/mysql/overlays/workflow-controller-configmap.yaml

@@ -19,6 +19,10 @@ data:
       passwordSecret:
         name: argo-mysql-config
         key: password
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

manifests/quick-start/postgres/overlays/workflow-controller-configmap.yaml

@@ -19,6 +19,10 @@ data:
       passwordSecret:
         name: argo-postgres-config
         key: password
+  retentionPolicy: |
+    completed: 10
+    failed: 3
+    errored: 3
 kind: ConfigMap
 metadata:
   name: workflow-controller-configmap

test/e2e/cli_test.go

@@ -1402,6 +1402,7 @@ func (s *CLISuite) TestArchive() {
 					assert.Contains(t, lines[0], "NAMESPACE")
 					assert.Contains(t, lines[0], "NAME")
 					assert.Contains(t, lines[0], "STATUS")
+					assert.Contains(t, lines[0], "UID")
 					assert.Contains(t, lines[1], "argo")
 					assert.Contains(t, lines[1], "basic")
 					assert.Contains(t, lines[1], "Succeeded")

test/e2e/fixtures/when.go

@@ -302,6 +302,32 @@ func (w *When) WaitForWorkflow(options ...interface{}) *When {
 	}
 }
 
+func (w *When) WaitForWorkflowList(listOptions metav1.ListOptions, condition func(list []wfv1.Workflow) bool) *When {
+	w.t.Helper()
+	timeout := defaultTimeout
+	start := time.Now()
+	_, _ = fmt.Println("Waiting", timeout.String(), "for workflows", listOptions)
+	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+	defer cancel()
+	for {
+		select {
+		case <-ctx.Done():
+			w.t.Errorf("timeout after %v waiting for condition", timeout)
+			return w
+		default:
+			wfList, err := w.client.List(ctx, listOptions)
+			if err != nil {
+				w.t.Error(err)
+				return w
+			}
+			if ok := condition(wfList.Items); ok {
+				_, _ = fmt.Printf("Condition met after %s\n", time.Since(start).Truncate(time.Second))
+				return w
+			}
+		}
+	}
+}
+
 func (w *When) hydrateWorkflow(wf *wfv1.Workflow) {
 	w.t.Helper()
 	err := w.hydrator.Hydrate(wf)

test/e2e/functional_test.go

@@ -84,6 +84,28 @@ spec:
 		ExpectWorkflowDeleted()
 }
 
+func (s *FunctionalSuite) TestWorkflowRetention() {
+	listOptions := metav1.ListOptions{LabelSelector: "workflows.argoproj.io/phase=Failed"}
+	s.Given().
+		Workflow("@testdata/exit-1.yaml").
+		When().
+		SubmitWorkflow().
+		WaitForWorkflow(fixtures.ToBeFailed).
+		Given().
+		Workflow("@testdata/exit-1.yaml").
+		When().
+		SubmitWorkflow().
+		WaitForWorkflow(fixtures.ToBeFailed).
+		Given().
+		Workflow("@testdata/exit-1.yaml").
+		When().
+		SubmitWorkflow().
+		WaitForWorkflow(fixtures.ToBeFailed).
+		WaitForWorkflowList(listOptions, func(list []wfv1.Workflow) bool {
+			return len(list) == 2
+		})
+}
+
 // in this test we create a poi quota, and then  we create a workflow that needs one more pod than the quota allows
 // because we run them in parallel, the first node will run to completion, and then the second one
 func (s *FunctionalSuite) TestResourceQuota() {

test/e2e/manifests/mixins/workflow-controller-configmap.yaml

@@ -19,4 +19,8 @@ data:
       limits:
         cpu: 0.5
         memory: 128Mi
+  retentionPolicy: |
+    completed: 10
+    failed: 2
+    errored: 2
   kubeletInsecure: "true"

util/printer/workflow-printer.go

@@ -51,6 +51,7 @@ type PrintOpts struct {
 	NoHeaders bool
 	Namespace bool
 	Output    string
+	UID       bool
 }
 
 func printTable(wfList []wfv1.Workflow, out io.Writer, opts PrintOpts) {
@@ -63,6 +64,9 @@ func printTable(wfList []wfv1.Workflow, out io.Writer, opts PrintOpts) {
 		if opts.Output == "wide" {
 			_, _ = fmt.Fprint(w, "\tP/R/C\tPARAMETERS")
 		}
+		if opts.UID {
+			_, _ = fmt.Fprint(w, "\tUID")
+		}
 		_, _ = fmt.Fprint(w, "\n")
 	}
 	for _, wf := range wfList {
@@ -81,6 +85,9 @@ func printTable(wfList []wfv1.Workflow, out io.Writer, opts PrintOpts) {
 			_, _ = fmt.Fprintf(w, "\t%d/%d/%d", pending, running, completed)
 			_, _ = fmt.Fprintf(w, "\t%s", parameterString(wf.Spec.Arguments.Parameters))
 		}
+		if opts.UID {
+			_, _ = fmt.Fprintf(w, "\t%s", wf.UID)
+		}
 		_, _ = fmt.Fprintf(w, "\n")
 	}
 	_ = w.Flush()

workflow/common/util.go

@@ -17,6 +17,7 @@ import (
 	apiv1 "k8s.io/api/core/v1"
 	apierr "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/client-go/kubernetes"
@@ -353,3 +354,9 @@ func GetTemplateHolderString(tmplHolder wfv1.TemplateReferenceHolder) string {
 func GenerateOnExitNodeName(parentNodeName string) string {
 	return fmt.Sprintf("%s.onExit", parentNodeName)
 }
+
+func IsDone(un *unstructured.Unstructured) bool {
+	return un.GetDeletionTimestamp() == nil &&
+		un.GetLabels()[LabelKeyCompleted] == "true" &&
+		un.GetLabels()[LabelKeyWorkflowArchivingStatus] != "Pending"
+}

workflow/common/util_test.go

@@ -7,6 +7,7 @@ import (
 	"github.com/stretchr/testify/assert"
 	corev1 "k8s.io/api/core/v1"
 	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/client-go/kubernetes/fake"
 
 	wfv1 "github.com/argoproj/argo-workflows/v3/pkg/apis/workflow/v1alpha1"
@@ -141,3 +142,22 @@ func TestGetTemplateHolderString(t *testing.T) {
 		ClusterScope: true,
 	}}))
 }
+
+func TestIsDone(t *testing.T) {
+	assert.False(t, IsDone(&unstructured.Unstructured{}))
+	assert.True(t, IsDone(&unstructured.Unstructured{Object: map[string]interface{}{
+		"metadata": map[string]interface{}{
+			"labels": map[string]interface{}{
+				LabelKeyCompleted: "true",
+			},
+		},
+	}}))
+	assert.False(t, IsDone(&unstructured.Unstructured{Object: map[string]interface{}{
+		"metadata": map[string]interface{}{
+			"labels": map[string]interface{}{
+				LabelKeyCompleted:               "true",
+				LabelKeyWorkflowArchivingStatus: "Pending",
+			},
+		},
+	}}))
+}

workflow/controller/controller.go

@@ -56,11 +56,11 @@ import (
 	"github.com/argoproj/argo-workflows/v3/workflow/controller/pod"
 	"github.com/argoproj/argo-workflows/v3/workflow/cron"
 	"github.com/argoproj/argo-workflows/v3/workflow/events"
+	"github.com/argoproj/argo-workflows/v3/workflow/gccontroller"
 	"github.com/argoproj/argo-workflows/v3/workflow/hydrator"
 	"github.com/argoproj/argo-workflows/v3/workflow/metrics"
 	"github.com/argoproj/argo-workflows/v3/workflow/signal"
 	"github.com/argoproj/argo-workflows/v3/workflow/sync"
-	"github.com/argoproj/argo-workflows/v3/workflow/ttlcontroller"
 	"github.com/argoproj/argo-workflows/v3/workflow/util"
 )
 
@@ -184,12 +184,12 @@ func (wfc *WorkflowController) newThrottler() sync.Throttler {
 	}
 }
 
-// RunTTLController runs the workflow TTL controller
-func (wfc *WorkflowController) runTTLController(ctx context.Context, workflowTTLWorkers int) {
+// runGCcontroller runs the workflow garbage collector controller
+func (wfc *WorkflowController) runGCcontroller(ctx context.Context, workflowTTLWorkers int) {
 	defer runtimeutil.HandleCrash(runtimeutil.PanicHandlers...)
 
-	ttlCtrl := ttlcontroller.NewController(wfc.wfclientset, wfc.wfInformer, wfc.metrics)
-	err := ttlCtrl.Run(ctx.Done(), workflowTTLWorkers)
+	gcCtrl := gccontroller.NewController(wfc.wfclientset, wfc.wfInformer, wfc.metrics, wfc.Config.RetentionPolicy)
+	err := gcCtrl.Run(ctx.Done(), workflowTTLWorkers)
 	if err != nil {
 		panic(err)
 	}
@@ -321,7 +321,7 @@ func (wfc *WorkflowController) startLeading(ctx context.Context, logCtx *log.Ent
 	go wfc.workflowGarbageCollector(ctx.Done())
 	go wfc.archivedWorkflowGarbageCollector(ctx.Done())
 
-	go wfc.runTTLController(ctx, workflowTTLWorkers)
+	go wfc.runGCcontroller(ctx, workflowTTLWorkers)
 	go wfc.runCronController(ctx)
 	go wait.Until(wfc.syncWorkflowPhaseMetrics, 15*time.Second, ctx.Done())
 	go wait.Until(wfc.syncPodPhaseMetrics, 15*time.Second, ctx.Done())

workflow/controller/operator.go

@@ -1760,6 +1760,8 @@ func (woc *wfOperationCtx) executeTemplate(ctx context.Context, nodeName string,
 	// the container. The status of this node should be "Success" if any
 	// of the retries succeed. Otherwise, it is "Failed".
 	retryNodeName := ""
+
+	// Here it is needed to be updated
 	if woc.retryStrategy(processedTmpl) != nil {
 		retryNodeName = nodeName
 		retryParentNode := node