Last changed in Kargo v1.3.2
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
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
Spec describes the desired transition of a specific Stage into a specific Freight.
Steps specifies the directives to be executed as part of this PromotionTask. The steps as defined here are inflated into a Promotion when it is built from a PromotionTemplate.
As is the alias this step can be referred to as.
Config is opaque configuration for the PromotionStep that is understood only by each PromotionStep's implementation. It is legal to utilize expressions in defining values at any level of this block. See https://docs.kargo.io/user-guide/reference-docs/expressions for details.
If is an optional expression that, if present, must evaluate to a boolean value. If the expression evaluates to false, the step will be skipped. If the expression does not evaluate to a boolean value, the step will be considered to have failed.
Retry is the retry policy for this step.
ErrorThreshold is the number of consecutive times the step must fail (for any reason) before retries are abandoned and the entire Promotion is marked as failed. If this field is set to 0, the effective default will be a step-specific one. If no step-specific default exists (i.e. is also 0), the effective default will be the system-wide default of 1. A value of 1 will cause the Promotion to be marked as failed after just a single failure; i.e. no retries will be attempted. There is no option to specify an infinite number of retries using a value such as -1. In a future release, Kargo is likely to become capable of distinguishing between recoverable and non-recoverable step failures. At that time, it is planned that unrecoverable failures will not be subject to this threshold and will immediately cause the Promotion to be marked as failed without further condition.
Timeout is the soft maximum interval in which a step that returns a Running status (which typically indicates it's waiting for something to happen) may be retried. The maximum is a soft one because the check for whether the interval has elapsed occurs AFTER the step has run. This effectively means a step may run ONCE beyond the close of the interval. If this field is set to nil, the effective default will be a step-specific one. If no step-specific default exists (i.e. is also nil), the effective default will be the system-wide default of 0. A value of 0 will cause the step to be retried indefinitely unless the ErrorThreshold is reached.
Task is a reference to a PromotionTask that should be inflated into a Promotion when it is built from a PromotionTemplate.
Kind is the type of the PromotionTask. Can be either PromotionTask or ClusterPromotionTask, default is PromotionTask.
Name is the name of the (Cluster)PromotionTask.
Uses identifies a runner that can execute this step.
Vars is a list of variables that can be referenced by expressions in the step's Config. The values override the values specified in the PromotionSpec.
Name is the name of the variable.
Value is the value of the variable. It is allowed to utilize expressions in the value. See https://docs.kargo.io/user-guide/reference-docs/expressions for details.
Vars specifies the variables available to the PromotionTask. The values of these variables are the default values that can be overridden by the step referencing the task.
Name is the name of the variable.
Value is the value of the variable. It is allowed to utilize expressions in the value. See https://docs.kargo.io/user-guide/reference-docs/expressions for details.
Source: kargo.akuity.io_clusterpromotiontasks.yaml
Changes to ClusterPromotionTask (kargo.akuity.io/v1alpha1) in each Kargo version, compared to the version before it.
3 properties have changed the description
Released · View ClusterPromotionTask in v1.3.2
1 property has been added
Released · View ClusterPromotionTask in v1.3.0
ClusterPromotionTask was first seen on this version of Kargo
Released · View ClusterPromotionTask in v1.2.0
No examples of ClusterPromotionTask yet. Contribute one on GitHub.
kubespec.dev