Promotion represents a request to transition a particular Stage into a particular Freight.
Last changed in Kargo v1.2.0
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.
Freight specifies the piece of Freight to be promoted into the Stage referenced by the Stage field.
Stage specifies the name of the Stage to which this Promotion applies. The Stage referenced by this field MUST be in the same namespace as the Promotion.
Steps specifies the directives to be executed as part of this Promotion. The order in which the directives are executed is the order in which they are listed in this field.
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/references/expression-language for details.
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/references/expression-language for details.
Vars is a list of variables that can be referenced by expressions in promotion steps.
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/references/expression-language for details.
Status describes the current state of the transition represented by this Promotion.
CurrentStep is the index of the current promotion step being executed. This permits steps that have already run successfully to be skipped on subsequent reconciliations attempts.
FinishedAt is the time when the promotion was completed.
Freight is the detail of the piece of freight that was referenced by this promotion.
Charts describes specific versions of specific Helm charts.
Name specifies the name of the chart.
RepoURL specifies the URL of a Helm chart repository. Classic chart repositories (using HTTP/S) can contain differently named charts. When this field points to such a repository, the Name field will specify the name of the chart within the repository. In the case of a repository within an OCI registry, the URL implicitly points to a specific chart and the Name field will be empty.
Version specifies a particular version of the chart.
Commits describes specific Git repository commits.
Author is the author of the commit.
Branch denotes the branch of the repository where this commit was found.
Committer is the person who committed the commit.
ID is the ID of a specific commit in the Git repository specified by RepoURL.
Message is the message associated with the commit. At present, this only contains the first line (subject) of the commit message.
RepoURL is the URL of a Git repository.
Tag denotes a tag in the repository that matched selection criteria and resolved to this commit.
Images describes specific versions of specific container images.
Digest identifies a specific version of the image in the repository specified by RepoURL. This is a more precise identifier than Tag.
GitRepoURL specifies the URL of a Git repository that contains the source code for the image repository referenced by the RepoURL field if Kargo was able to infer it.
RepoURL describes the repository in which the image can be found.
Tag identifies a specific version of the image in the repository specified by RepoURL.
Name is system-assigned identifier that is derived deterministically from the contents of the Freight. i.e. Two pieces of Freight can be compared for equality by comparing their Names.
Origin describes a kind of Freight in terms of its origin.
Kind is the kind of resource from which Freight may have originated. At present, this can only be "Warehouse".
Name is the name of the resource of the kind indicated by the Kind field from which Freight may originate.
FreightCollection contains the details of the piece of Freight referenced by this Promotion as well as any additional Freight that is carried over from the target Stage's current state.
ID is a unique and deterministically calculated identifier for the FreightCollection. It is updated on each use of the UpdateOrPush method.
Freight is a map of FreightReference objects, indexed by their Warehouse origin.
Charts describes specific versions of specific Helm charts.
Name specifies the name of the chart.
RepoURL specifies the URL of a Helm chart repository. Classic chart repositories (using HTTP/S) can contain differently named charts. When this field points to such a repository, the Name field will specify the name of the chart within the repository. In the case of a repository within an OCI registry, the URL implicitly points to a specific chart and the Name field will be empty.
Version specifies a particular version of the chart.
Commits describes specific Git repository commits.
Author is the author of the commit.
Branch denotes the branch of the repository where this commit was found.
Committer is the person who committed the commit.
ID is the ID of a specific commit in the Git repository specified by RepoURL.
Message is the message associated with the commit. At present, this only contains the first line (subject) of the commit message.
RepoURL is the URL of a Git repository.
Tag denotes a tag in the repository that matched selection criteria and resolved to this commit.
Images describes specific versions of specific container images.
Digest identifies a specific version of the image in the repository specified by RepoURL. This is a more precise identifier than Tag.
GitRepoURL specifies the URL of a Git repository that contains the source code for the image repository referenced by the RepoURL field if Kargo was able to infer it.
RepoURL describes the repository in which the image can be found.
Tag identifies a specific version of the image in the repository specified by RepoURL.
Name is system-assigned identifier that is derived deterministically from the contents of the Freight. i.e. Two pieces of Freight can be compared for equality by comparing their Names.
Origin describes a kind of Freight in terms of its origin.
Kind is the kind of resource from which Freight may have originated. At present, this can only be "Warehouse".
Name is the name of the resource of the kind indicated by the Kind field from which Freight may originate.
VerificationHistory is a stack of recent VerificationInfo. By default, the last ten VerificationInfo are stored.
Actor is the name of the entity that initiated or aborted the Verification process.
AnalysisRun is a reference to the Argo Rollouts AnalysisRun that implements the Verification process.
Name is the name of the AnalysisRun.
Namespace is the namespace of the AnalysisRun.
Phase is the last observed phase of the AnalysisRun referenced by Name.
FinishTime is the time at which the Verification process finished.
ID is the identifier of the Verification process.
Message may contain additional information about why the verification process is in its current phase.
Phase describes the current phase of the Verification process. Generally, this will be a reflection of the underlying AnalysisRun's phase, however, there are exceptions to this, such as in the case where an AnalysisRun cannot be launched successfully.
StartTime is the time at which the Verification process was started.
HealthChecks contains the health check directives to be executed after the Promotion has completed.
Config is the configuration for the directive.
Uses identifies a runner that can execute this step.
LastHandledRefresh holds the value of the most recent AnnotationKeyRefresh annotation that was handled by the controller. This field can be used to determine whether the request to refresh the resource has been handled.
Message is a display message about the promotion, including any errors preventing the Promotion controller from executing this Promotion. i.e. If the Phase field has a value of Failed, this field can be expected to explain why.
Phase describes where the Promotion currently is in its lifecycle.
State stores the state of the promotion process between reconciliation attempts.
StepExecutionMetadata tracks metadata pertaining to the execution of individual promotion steps.
Alias is the alias of the step.
ErrorCount tracks consecutive failed attempts to execute the step.
FinishedAt is the time at which the final attempt to execute the step completed.
Message is a display message about the step, including any errors.
StartedAt is the time at which the first attempt to execute the step began.
Status is the high-level outcome of the step.
Source: kargo.akuity.io_promotions.yaml
Changes to Promotion (kargo.akuity.io/v1alpha1) in each Kargo version, compared to the version before it.
2 properties have been added
1 property is now required
2 properties are no longer required
2 properties have changed the description
Released · View Promotion in v1.2.0
3 properties have been added
1 property has changed the description
Released · View Promotion in v1.1.0
3 properties have been removed
Released · View Promotion in v1.0.0
3 properties have been added
4 properties have changed the description
Released · View Promotion in v0.8.0
1 property has been added
2 properties have changed the description
Released · View Promotion in v0.7.0
2 properties have been added
Released · View Promotion in v0.6.0
Promotion was already present in this version of Kargo, the oldest one on kubespec.dev
Released · View Promotion in v0.5.0
No examples of Promotion yet. Contribute one on GitHub.
kubespec.dev