Skip to content

Commit

Permalink
feat(controller): Support pod GC strategy based on label selector on …
Browse files Browse the repository at this point in the history 
…pods (#5090)

Signed-off-by: terrytangyuan <terrytangyuan@gmail.com>
  • Loading branch information
@terrytangyuan
terrytangyuan committed Feb 22, 2021
1 parent 6618f47 commit d9fb0c3
Show file tree
Hide file tree
Showing 15 changed files with 1,044 additions and 527 deletions.
4 changes: 4 additions & 0 deletions api/jsonschema/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4014,6 +4014,10 @@
"io.argoproj.workflow.v1alpha1.PodGC": {
"description": "PodGC describes how to delete completed pods as they complete",
"properties": {
"labelSelector": {
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector",
"description": "LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue."
},
"strategy": {
"description": "Strategy is the strategy to use. One of \"OnPodCompletion\", \"OnPodSuccess\", \"OnWorkflowCompletion\", \"OnWorkflowSuccess\"",
"type": "string"
Expand Down
4 changes: 4 additions & 0 deletions api/openapi-spec/swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7429,6 +7429,10 @@
"description": "PodGC describes how to delete completed pods as they complete",
"type": "object",
"properties": {
"labelSelector": {
"description": "LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue.",
"$ref": "#/definitions/io.k8s.apimachinery.pkg.apis.meta.v1.LabelSelector"
},
"strategy": {
"description": "Strategy is the strategy to use. One of \"OnPodCompletion\", \"OnPodSuccess\", \"OnWorkflowCompletion\", \"OnWorkflowSuccess\"",
"type": "string"
Expand Down
52 changes: 22 additions & 30 deletions docs/fields.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1596,6 +1596,7 @@ PodGC describes how to delete completed pods as they complete
### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`labelSelector`|[`LabelSelector`](#labelselector)|LabelSelector is the label selector to check if the pods match the labels before being added to the pod GC queue.|
|`strategy`|`string`|Strategy is the strategy to use. One of "OnPodCompletion", "OnPodSuccess", "OnWorkflowCompletion", "OnWorkflowSuccess"|

## Metadata
Expand Down Expand Up @@ -4399,6 +4400,16 @@ ObjectReference contains enough information to let you inspect or modify the ref
|`resourceVersion`|`string`|Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency|
|`uid`|`string`|UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids|

## LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`matchExpressions`|`Array<`[`LabelSelectorRequirement`](#labelselectorrequirement)`>`|matchExpressions is a list of label selector requirements. The requirements are ANDed.|
|`matchLabels`|`Map< string , string >`|matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.|

## IntOrString

_No description available_
Expand Down Expand Up @@ -5011,25 +5022,6 @@ PodDNSConfigOption defines DNS resolver options of a pod.
|`name`|`string`|Required.|
|`value`|`string`|_No description available_|

## LabelSelector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

<details>
<summary>Examples with this field (click to open)</summary>
<br>

- [`daemoned-stateful-set-with-service.yaml`](https://github.com/argoproj/argo-workflows/blob/master/examples/daemoned-stateful-set-with-service.yaml)

- [`event-consumer-workfloweventbinding.yaml`](https://github.com/argoproj/argo-workflows/blob/master/examples/workflow-event-binding/event-consumer-workfloweventbinding.yaml)
</details>

### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`matchExpressions`|`Array<`[`LabelSelectorRequirement`](#labelselectorrequirement)`>`|matchExpressions is a list of label selector requirements. The requirements are ANDed.|
|`matchLabels`|`Map< string , string >`|matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.|

## SELinuxOptions

SELinuxOptions are the labels to be applied to the container
Expand Down Expand Up @@ -5759,6 +5751,17 @@ Represents a vSphere volume resource.
|`storagePolicyName`|`string`|Storage Policy Based Management (SPBM) profile name.|
|`volumePath`|`string`|Path that identifies vSphere volume vmdk|

## LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`key`|`string`|key is the label key that the selector applies to.|
|`operator`|`string`|operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.|
|`values`|`Array< string >`|values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.|

## EnvVarSource

EnvVarSource represents a source for the value of an EnvVar.
Expand Down Expand Up @@ -5955,17 +5958,6 @@ Defines a set of pods (namely those matching the labelSelector relative to the g
|`namespaces`|`Array< string >`|namespaces specifies which namespaces the labelSelector applies to (matches against); null or empty list means "this pod's namespace"|
|`topologyKey`|`string`|This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching the labelSelector in the specified namespaces, where co-located is defined as running on a node whose value of the label with key topologyKey matches that of any node on which any of the selected pods is running. Empty topologyKey is not allowed.|

## LabelSelectorRequirement

A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.

### Fields
| Field Name | Field Type | Description |
|:----------:|:----------:|---------------|
|`key`|`string`|key is the label key that the selector applies to.|
|`operator`|`string`|operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.|
|`values`|`Array< string >`|values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.|

## TypedLocalObjectReference

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Expand Down
23 changes: 23 additions & 0 deletions manifests/base/crds/full/argoproj.io_clusterworkflowtemplates.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -796,6 +796,29 @@ spec:
type: object
podGC:
properties:
labelSelector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
type: object
type: object
strategy:
type: string
type: object
Expand Down
23 changes: 23 additions & 0 deletions manifests/base/crds/full/argoproj.io_cronworkflows.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -817,6 +817,29 @@ spec:
type: object
podGC:
properties:
labelSelector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
type: object
type: object
strategy:
type: string
type: object
Expand Down
46 changes: 46 additions & 0 deletions manifests/base/crds/full/argoproj.io_workflows.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -805,6 +805,29 @@ spec:
type: object
podGC:
properties:
labelSelector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
type: object
type: object
strategy:
type: string
type: object
Expand Down Expand Up @@ -13954,6 +13977,29 @@ spec:
type: object
podGC:
properties:
labelSelector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
type: object
type: object
strategy:
type: string
type: object
Expand Down
23 changes: 23 additions & 0 deletions manifests/base/crds/full/argoproj.io_workflowtemplates.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -795,6 +795,29 @@ spec:
type: object
podGC:
properties:
labelSelector:
properties:
matchExpressions:
items:
properties:
key:
type: string
operator:
type: string
values:
items:
type: string
type: array
required:
- key
- operator
type: object
type: array
matchLabels:
additionalProperties:
type: string
type: object
type: object
strategy:
type: string
type: object
Expand Down
Loading

0 comments on commit d9fb0c3

Please sign in to comment.