ArtifactCleanupRun

Description
ArtifactCleanupRun is the Schema for the artifactcleanupruns API
Type
object

Specification

PropertyTypeDescription
apiVersionstring

APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kindstring

Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadataObjectMeta

ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.

specobject

ArtifactCleanupRunSpec defines the desired state of ArtifactCleanupRun

statusobject

ArtifactCleanupRunStatus defines the observed state of ArtifactCleanupRun

.spec

Description
ArtifactCleanupRunSpec defines the desired state of ArtifactCleanupRun
Type
object
PropertyTypeDescription
artifactCleanupRefobject

Reference to an existing ArtifactCleanup

artifactCleanupSpecobject

In-line spec for ArtifactCleanup. This options is mutually exclusive with artifactCleanupRef.

dryRunboolean

True means that the simulation runs without performing specific cleanup operations.

statusstring

Status Used for cancelling a ArtifactCleanupRun (and maybe more later on)

.spec.artifactCleanupRef

Description
Reference to an existing ArtifactCleanup
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.artifactCleanupSpec

Description
In-line spec for ArtifactCleanup. This options is mutually exclusive with artifactCleanupRef.
Type
object
PropertyTypeDescription
addressobject

Address stores the integrated service API address

historyLimitsobject

HistoryLimits limits the number of executed items are preserved It only calculates already completed items

integrationClassNamestring

IntegrationClassName sets the name of IntegrationClass that this integration is implemented

integrationRefobject

Reference to specific integration that contains the tool API define.

policiesarray

List of strategies.

resourceobject

Resources array of predefined resources to be used

triggersobject

all triggers defined for triggering current artifactcleanup

.spec.artifactCleanupSpec.address

Description
Address stores the integrated service API address
Type
object
PropertyTypeDescription
CACertsstring

CACerts is the Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.

namestring

Name is the name of the address.

urlstring

.spec.artifactCleanupSpec.historyLimits

Description
HistoryLimits limits the number of executed items are preserved It only calculates already completed items
Type
object
PropertyTypeDescription
countinteger

Sets a hard count for all finished items to be cleared from storage

.spec.artifactCleanupSpec.integrationRef

Description
Reference to specific integration that contains the tool API define.
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.artifactCleanupSpec.policies

Description
List of strategies.
Type
array

.spec.artifactCleanupSpec.policies[]

Description
Policy A detailed description of the policy, including warehouse, cleanup rules, and retention rules.
Type
object
PropertyTypeDescription
cleanupRulesarray

Clean up the list of rules.

repositoryobject

A list of Repository to match. Regular expressions are supported.

retentionRulesarray

Retention a list of rules.

.spec.artifactCleanupSpec.policies[].cleanupRules

Description
Clean up the list of rules.
Type
array

.spec.artifactCleanupSpec.policies[].cleanupRules[]

Description
Rule Describes the parameters of the rule.
Type
object
PropertyTypeDescription
durationstring

The interval for saving time type rules.

namestring

Rule names are for display purposes only.

quantityinteger

Quantity value used to hold quantity type rules.

regexpstring

The regular expression used to hold the match type rules.

typestring

Rule type

.spec.artifactCleanupSpec.policies[].repository

Description
A list of Repository to match. Regular expressions are supported.
Type
object
PropertyTypeDescription
namestring

Matches the warehouse rule name, for display only.

regexpstring

Regular expression that matches the repository.

.spec.artifactCleanupSpec.policies[].retentionRules

Description
Retention a list of rules.
Type
array

.spec.artifactCleanupSpec.policies[].retentionRules[]

Description
Rule Describes the parameters of the rule.
Type
object
PropertyTypeDescription
durationstring

The interval for saving time type rules.

namestring

Rule names are for display purposes only.

quantityinteger

Quantity value used to hold quantity type rules.

regexpstring

The regular expression used to hold the match type rules.

typestring

Rule type

.spec.artifactCleanupSpec.resource

Description
Resources array of predefined resources to be used
Type
object
Required
nametype
PropertyTypeDescription
annotationsobject

Annotations provides a method to annotate specific resources in order to provide some metadata

namestring

Name stores the name of the resource object

propertiesobject

Properties of the resource. This is used to transmit fields and values to the integration class

readOnlyboolean

ReadOnly adds a desired behaviour for consumers of this resource

replicationPolicyRefobject

ReplicationPolicyRef stores a reference to a policy that generated this resource used by the ClusterIntegration object when replicating and creating Integration objects

subResourcesarray

SubResources sub resource to be used in resource

subtypestring

Subtype of resource associated with the object

syncPolicystring

SyncPolicy specifies how resources are synced to the system. Defaults to "SyncOnly"

typestring

Type of resource associated with the object

.spec.artifactCleanupSpec.resource.annotations

Description
Annotations provides a method to annotate specific resources in order to provide some metadata
Type
object

.spec.artifactCleanupSpec.resource.properties

Description
Properties of the resource. This is used to transmit fields and values to the integration class
Type
object

.spec.artifactCleanupSpec.resource.replicationPolicyRef

Description
ReplicationPolicyRef stores a reference to a policy that generated this resource used by the ClusterIntegration object when replicating and creating Integration objects
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.artifactCleanupSpec.resource.subResources

Description
SubResources sub resource to be used in resource
Type
array

.spec.artifactCleanupSpec.resource.subResources[]

Type
object
Required
nametype
PropertyTypeDescription
annotationsobject

Annotations provides a method to annotate specific resources in order to provide some metadata

namestring

Name stores the name of the resource object

propertiesobject

Properties of the resource. This is used to transmit fields and values to the integration class

subtypestring

Subtype of resource associated with the object

typestring

Type of resource associated with the object

.spec.artifactCleanupSpec.resource.subResources[].annotations

Description
Annotations provides a method to annotate specific resources in order to provide some metadata
Type
object

.spec.artifactCleanupSpec.resource.subResources[].properties

Description
Properties of the resource. This is used to transmit fields and values to the integration class
Type
object

.spec.artifactCleanupSpec.triggers

Description
all triggers defined for triggering current artifactcleanup
Type
object
PropertyTypeDescription
cronTriggersarray

List of timed triggers

.spec.artifactCleanupSpec.triggers.cronTriggers

Description
List of timed triggers
Type
array

.spec.artifactCleanupSpec.triggers.cronTriggers[]

Description
ArtifactCleanupCronTrigger defines cronTrigger.
Type
object
PropertyTypeDescription
annotationsobject

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

namestring

The name of the timed trigger

specobject

Trigger the desired property periodically.

.spec.artifactCleanupSpec.triggers.cronTriggers[].annotations

Description
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Type
object

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec

Description
Trigger the desired property periodically.
Type
object
Required
schedule
PropertyTypeDescription
brokerstring

Broker instance to listen

disabledboolean

Disabled a switch for crontrigger.

paramsarray

Params for rendering runnable template

runnableRefobject

reference of runnabledefinition

runnableSpecobject

Inline spec for runnable template.

schedulestring

Schedule is the cron schedule.

timezonestring

Timezone modifies the actual time relative to the specified timezone. Defaults to UTC. More general information about time zones: https://www.iana.org/time-zones List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.params

Description
Params for rendering runnable template
Type
array

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.params[]

Description
TriggerValueBinding represent values that will bind to template
Type
object
PropertyTypeDescription
constboolean

If true, indicates that value is a constant, not an expression.

namestring

name of template parameter

valuestring

value of template parameter do we only need type of string

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableRef

Description
reference of runnabledefinition
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec

Description
Inline spec for runnable template.
Type
object
PropertyTypeDescription
kubeobject

Uses a yaml format to create a template for resource

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube

Description
Uses a yaml format to create a template for resource
Type
object
PropertyTypeDescription
parametersarray

Parameters used to generate the resource with jsonpath replacement rules

templateobject

Raw resource definition yaml

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters

Description
Parameters used to generate the resource with jsonpath replacement rules
Type
array

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[]

Description
KubeParameter used to generate the resource with jsonpath replacement rules
Type
object
PropertyTypeDescription
fieldPathsarray

FieldPaths is jsonpath for replacing the parameter value into the resource at render time

namestring

Unique parameter name

requiredboolean

Parameter required, Defaults to false

typestring

Parameter value type, one of [string, number, boolean], default is string

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[].fieldPaths

Description
FieldPaths is jsonpath for replacing the parameter value into the resource at render time
Type
array

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[].fieldPaths[]

Type
string

.spec.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.template

Description
Raw resource definition yaml
Type
object

.status

Description
ArtifactCleanupRunStatus defines the observed state of ArtifactCleanupRun
Type
object
PropertyTypeDescription
annotationsobject

Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.

artifactCleanupSpecobject

When spec.artifactCleanupRef is used, the spec will be stored here for future reference

completionTimestring

CompletionTime is the time when StageRun completed.

conditionsarray

Conditions the latest available observations of a resource's current state.

observedGenerationinteger

ObservedGeneration is the 'Generation' of the Service that was last processed by the controller.

resourcesarray

Resources stores a list of clean record.

startTimestring

StartTime is the time when StageRun actually started.

summaryobject

Describe the overall result of the cleanup. Record success, failure, ignore the number of records.

triggeredByobject

TriggeredBy stores a list of triggered information.

.status.annotations

Description
Annotations is additional Status fields for the Resource to save some additional State as well as convey more information to the user. This is roughly akin to Annotations on any k8s resource, just the reconciler conveying richer information outwards.
Type
object

.status.artifactCleanupSpec

Description
When spec.artifactCleanupRef is used, the spec will be stored here for future reference
Type
object
PropertyTypeDescription
addressobject

Address stores the integrated service API address

historyLimitsobject

HistoryLimits limits the number of executed items are preserved It only calculates already completed items

integrationClassNamestring

IntegrationClassName sets the name of IntegrationClass that this integration is implemented

integrationRefobject

Reference to specific integration that contains the tool API define.

policiesarray

List of strategies.

resourceobject

Resources array of predefined resources to be used

triggersobject

all triggers defined for triggering current artifactcleanup

.status.artifactCleanupSpec.address

Description
Address stores the integrated service API address
Type
object
PropertyTypeDescription
CACertsstring

CACerts is the Certification Authority (CA) certificates in PEM format according to https://www.rfc-editor.org/rfc/rfc7468.

namestring

Name is the name of the address.

urlstring

.status.artifactCleanupSpec.historyLimits

Description
HistoryLimits limits the number of executed items are preserved It only calculates already completed items
Type
object
PropertyTypeDescription
countinteger

Sets a hard count for all finished items to be cleared from storage

.status.artifactCleanupSpec.integrationRef

Description
Reference to specific integration that contains the tool API define.
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status.artifactCleanupSpec.policies

Description
List of strategies.
Type
array

.status.artifactCleanupSpec.policies[]

Description
Policy A detailed description of the policy, including warehouse, cleanup rules, and retention rules.
Type
object
PropertyTypeDescription
cleanupRulesarray

Clean up the list of rules.

repositoryobject

A list of Repository to match. Regular expressions are supported.

retentionRulesarray

Retention a list of rules.

.status.artifactCleanupSpec.policies[].cleanupRules

Description
Clean up the list of rules.
Type
array

.status.artifactCleanupSpec.policies[].cleanupRules[]

Description
Rule Describes the parameters of the rule.
Type
object
PropertyTypeDescription
durationstring

The interval for saving time type rules.

namestring

Rule names are for display purposes only.

quantityinteger

Quantity value used to hold quantity type rules.

regexpstring

The regular expression used to hold the match type rules.

typestring

Rule type

.status.artifactCleanupSpec.policies[].repository

Description
A list of Repository to match. Regular expressions are supported.
Type
object
PropertyTypeDescription
namestring

Matches the warehouse rule name, for display only.

regexpstring

Regular expression that matches the repository.

.status.artifactCleanupSpec.policies[].retentionRules

Description
Retention a list of rules.
Type
array

.status.artifactCleanupSpec.policies[].retentionRules[]

Description
Rule Describes the parameters of the rule.
Type
object
PropertyTypeDescription
durationstring

The interval for saving time type rules.

namestring

Rule names are for display purposes only.

quantityinteger

Quantity value used to hold quantity type rules.

regexpstring

The regular expression used to hold the match type rules.

typestring

Rule type

.status.artifactCleanupSpec.resource

Description
Resources array of predefined resources to be used
Type
object
Required
nametype
PropertyTypeDescription
annotationsobject

Annotations provides a method to annotate specific resources in order to provide some metadata

namestring

Name stores the name of the resource object

propertiesobject

Properties of the resource. This is used to transmit fields and values to the integration class

readOnlyboolean

ReadOnly adds a desired behaviour for consumers of this resource

replicationPolicyRefobject

ReplicationPolicyRef stores a reference to a policy that generated this resource used by the ClusterIntegration object when replicating and creating Integration objects

subResourcesarray

SubResources sub resource to be used in resource

subtypestring

Subtype of resource associated with the object

syncPolicystring

SyncPolicy specifies how resources are synced to the system. Defaults to "SyncOnly"

typestring

Type of resource associated with the object

.status.artifactCleanupSpec.resource.annotations

Description
Annotations provides a method to annotate specific resources in order to provide some metadata
Type
object

.status.artifactCleanupSpec.resource.properties

Description
Properties of the resource. This is used to transmit fields and values to the integration class
Type
object

.status.artifactCleanupSpec.resource.replicationPolicyRef

Description
ReplicationPolicyRef stores a reference to a policy that generated this resource used by the ClusterIntegration object when replicating and creating Integration objects
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status.artifactCleanupSpec.resource.subResources

Description
SubResources sub resource to be used in resource
Type
array

.status.artifactCleanupSpec.resource.subResources[]

Type
object
Required
nametype
PropertyTypeDescription
annotationsobject

Annotations provides a method to annotate specific resources in order to provide some metadata

namestring

Name stores the name of the resource object

propertiesobject

Properties of the resource. This is used to transmit fields and values to the integration class

subtypestring

Subtype of resource associated with the object

typestring

Type of resource associated with the object

.status.artifactCleanupSpec.resource.subResources[].annotations

Description
Annotations provides a method to annotate specific resources in order to provide some metadata
Type
object

.status.artifactCleanupSpec.resource.subResources[].properties

Description
Properties of the resource. This is used to transmit fields and values to the integration class
Type
object

.status.artifactCleanupSpec.triggers

Description
all triggers defined for triggering current artifactcleanup
Type
object
PropertyTypeDescription
cronTriggersarray

List of timed triggers

.status.artifactCleanupSpec.triggers.cronTriggers

Description
List of timed triggers
Type
array

.status.artifactCleanupSpec.triggers.cronTriggers[]

Description
ArtifactCleanupCronTrigger defines cronTrigger.
Type
object
PropertyTypeDescription
annotationsobject

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations

namestring

The name of the timed trigger

specobject

Trigger the desired property periodically.

.status.artifactCleanupSpec.triggers.cronTriggers[].annotations

Description
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
Type
object

.status.artifactCleanupSpec.triggers.cronTriggers[].spec

Description
Trigger the desired property periodically.
Type
object
Required
schedule
PropertyTypeDescription
brokerstring

Broker instance to listen

disabledboolean

Disabled a switch for crontrigger.

paramsarray

Params for rendering runnable template

runnableRefobject

reference of runnabledefinition

runnableSpecobject

Inline spec for runnable template.

schedulestring

Schedule is the cron schedule.

timezonestring

Timezone modifies the actual time relative to the specified timezone. Defaults to UTC. More general information about time zones: https://www.iana.org/time-zones List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.params

Description
Params for rendering runnable template
Type
array

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.params[]

Description
TriggerValueBinding represent values that will bind to template
Type
object
PropertyTypeDescription
constboolean

If true, indicates that value is a constant, not an expression.

namestring

name of template parameter

valuestring

value of template parameter do we only need type of string

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableRef

Description
reference of runnabledefinition
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec

Description
Inline spec for runnable template.
Type
object
PropertyTypeDescription
kubeobject

Uses a yaml format to create a template for resource

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube

Description
Uses a yaml format to create a template for resource
Type
object
PropertyTypeDescription
parametersarray

Parameters used to generate the resource with jsonpath replacement rules

templateobject

Raw resource definition yaml

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters

Description
Parameters used to generate the resource with jsonpath replacement rules
Type
array

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[]

Description
KubeParameter used to generate the resource with jsonpath replacement rules
Type
object
PropertyTypeDescription
fieldPathsarray

FieldPaths is jsonpath for replacing the parameter value into the resource at render time

namestring

Unique parameter name

requiredboolean

Parameter required, Defaults to false

typestring

Parameter value type, one of [string, number, boolean], default is string

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[].fieldPaths

Description
FieldPaths is jsonpath for replacing the parameter value into the resource at render time
Type
array

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.parameters[].fieldPaths[]

Type
string

.status.artifactCleanupSpec.triggers.cronTriggers[].spec.runnableSpec.kube.template

Description
Raw resource definition yaml
Type
object

.status.conditions

Description
Conditions the latest available observations of a resource's current state.
Type
array

.status.conditions[]

Description
Condition defines a readiness condition for a Knative resource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#typical-status-properties
Type
object
Required
statustype
PropertyTypeDescription
lastTransitionTimestring

LastTransitionTime is the last time the condition transitioned from one status to another. We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic differences (all other things held constant).

messagestring

A human readable message indicating details about the transition.

reasonstring

The reason for the condition's last transition.

severitystring

Severity with which to treat failures of this type of condition. When this is not specified, it defaults to Error.

statusstring

Status of the condition, one of True, False, Unknown.

typestring

Type of condition.

.status.resources

Description
Resources stores a list of clean record.
Type
array

.status.resources[]

Description
Resource A detailed description of the cleanup reocrd.
Type
object
PropertyTypeDescription
messagestring

Description of reason info.

reasonstring

Describes the reason for the status, such as Cancelled, InternalServerError, DryRun.

repositorystring

A list of repositories to match. Regular expressions are supported.

statusstring

Describes the cleanup state. (Unknown, True, False)

tagsarray

Retation a list of rules.

versionstring

Clean up the list of rules.

.status.resources[].tags

Description
Retation a list of rules.
Type
array

.status.resources[].tags[]

Type
object
PropertyTypeDescription
namestring

tag name

pullTimestring

tag push time, if Name is empty, the pushtime of the version

pushTimestring

tag pull time, if Name is empty, the pulltime of the version

.status.summary

Description
Describe the overall result of the cleanup. Record success, failure, ignore the number of records.
Type
object
PropertyTypeDescription
failedinteger

Failed records the total number of cleanup failures.

skipedinteger

Skiped records the total number of cleanup ignores.

succeededinteger

Succeeded records the total number of successful cleanups.

.status.triggeredBy

Description
TriggeredBy stores a list of triggered information.
Type
object
PropertyTypeDescription
cloudEventobject

Cloud Event data for the event that triggered.

refobject

Reference to another object that might have triggered this object

triggeredTimestampstring

Date time of creation of triggered event. Will match a resource's metadata.creationTimestamp it is added here for convinience only

triggeredTypestring

Indicates trigger type, such as Manual Automated.

userobject

Reference to the user that triggered the object. Any Kubernetes Subject is accepted.

.status.triggeredBy.cloudEvent

Description
Cloud Event data for the event that triggered.
Type
object
PropertyTypeDescription
datastring

Data event payload

datacontenttypestring
extensionsobject
idstring
sourcestring
specversionstring
subjectstring
timestring
typestring

Type of event

.status.triggeredBy.cloudEvent.extensions

Type
object

.status.triggeredBy.ref

Description
Reference to another object that might have triggered this object
Type
object
PropertyTypeDescription
apiVersionstring

API version of the referent.

fieldPathstring

If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.

kindstring

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

namestring

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

namespacestring

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceVersionstring

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

uidstring

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

.status.triggeredBy.user

Description
Reference to the user that triggered the object. Any Kubernetes `Subject` is accepted.
Type
object
Required
kindname
PropertyTypeDescription
apiGroupstring

APIGroup holds the API group of the referenced subject. Defaults to "" for ServiceAccount subjects. Defaults to "rbac.authorization.k8s.io" for User and Group subjects.

kindstring

Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount". If the Authorizer does not recognized the kind value, the Authorizer should report an error.

namestring

Name of the object being referenced.

namespacestring

Namespace of the referenced object. If the object kind is non-namespace, such as "User" or "Group", and this value is not empty the Authorizer should report an error.

API Endpoints

The following API endpoints are available:

  • /apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns
    • DELETE: delete collection of ArtifactCleanupRun
    • GET: list objects of kind ArtifactCleanupRun
    • POST: create a new ArtifactCleanupRun
  • /apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns/{name}
    • DELETE: delete the specified ArtifactCleanupRun
    • GET: read the specified ArtifactCleanupRun
    • PATCH: partially update the specified ArtifactCleanupRun
    • PUT: replace the specified ArtifactCleanupRun
  • /apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns/{name}/status
    • GET: read status of the specified ArtifactCleanupRun
    • PATCH: partially update status of the specified ArtifactCleanupRun
    • PUT: replace status of the specified ArtifactCleanupRun

/apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns

HTTP method
DELETE
Description
delete collection of ArtifactCleanupRun
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
list objects of kind ArtifactCleanupRun
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRunList schema
401 - UnauthorizedEmpty
HTTP method
POST
Description
create a new ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyArtifactCleanupRun schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
201 - CreatedArtifactCleanupRun schema
202 - AcceptedArtifactCleanupRun schema
401 - UnauthorizedEmpty

/apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns/{name}

HTTP method
DELETE
Description
delete the specified ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
HTTP responses
HTTP codeResponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
GET
Description
read the specified ArtifactCleanupRun
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update the specified ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace the specified ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyArtifactCleanupRun schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
201 - CreatedArtifactCleanupRun schema
401 - UnauthorizedEmpty

/apis/artifacts.katanomi.dev/v1alpha1/namespaces/{namespace}/artifactcleanupruns/{name}/status

HTTP method
GET
Description
read status of the specified ArtifactCleanupRun
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
401 - UnauthorizedEmpty
HTTP method
PATCH
Description
partially update status of the specified ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
401 - UnauthorizedEmpty
HTTP method
PUT
Description
replace status of the specified ArtifactCleanupRun
Query parameters
ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
Body parameters
ParameterTypeDescription
bodyArtifactCleanupRun schemaapplication/json formatted
HTTP responses
HTTP codeResponse body
200 - OKArtifactCleanupRun schema
201 - CreatedArtifactCleanupRun schema
401 - UnauthorizedEmpty