API Reference
Every field of the Rollout, Environment, OpenKruise and Release resources, grouped by API.
On this page
Rollout API
ApprovalPolicy
ApprovalPolicy is the Schema for the approvalpolicies API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specApprovalPolicySpec | spec defines the desired state of ApprovalPolicy |
statusApprovalPolicyStatus | status defines the observed state of ApprovalPolicy |
ClusterApprovalPolicy
ClusterApprovalPolicy is the Schema for the clusterapprovalpolicies API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specClusterApprovalPolicySpec | spec defines the desired state of ClusterApprovalPolicy |
statusClusterApprovalPolicyStatus | status defines the observed state of ClusterApprovalPolicy |
ClusterRolloutSchedule
ClusterRolloutSchedule is the Schema for the clusterrolloutschedules API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specClusterRolloutScheduleSpec | |
statusClusterRolloutScheduleStatus |
HealthCheck
HealthCheck is the Schema for the healthchecks API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specHealthCheckSpec | |
statusHealthCheckStatus |
Rollout
Rollout is the Schema for the rollouts API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specRolloutSpec | |
statusRolloutStatus |
RolloutApproval
RolloutApproval is the Schema for the rolloutapprovals API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specRolloutApprovalSpec | spec defines the desired state of RolloutApproval |
RolloutDependency
RolloutDependency is the Schema for the rolloutdependencies API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specRolloutDependencySpec | spec defines the desired state of RolloutDependency |
statusRolloutDependencyStatus | status defines the observed state of RolloutDependency |
RolloutGate
RolloutGate is the Schema for the rolloutgates API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specRolloutGateSpec | |
statusRolloutGateStatus |
RolloutSchedule
RolloutSchedule is the Schema for the rolloutschedules API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specRolloutScheduleSpec | |
statusRolloutScheduleStatus |
Definitions
ApprovalPolicySpec
Appears in:
ApprovalPolicySpec defines the desired state of ApprovalPolicy
| Field | Description |
|---|---|
rolloutSelectorLabelSelector | RolloutSelector selects the Rollouts this policy applies to. An empty selector matches every Rollout. |
ApprovalPolicyStatus
Appears in:
ApprovalPolicyStatus defines the observed state of ApprovalPolicy.
| Field | Description |
|---|---|
rollouts[]string | Rollouts lists the matched Rollouts, sorted. |
conditions[]Condition | conditions represent the current state of the ApprovalPolicy resource.
Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
ApprovalRecord
Appears in:
ApprovalRecord is a copy of the RolloutApproval that allowed a deployment, taken when the history entry was written.
| Field | Description |
|---|---|
namestring | Name of the RolloutApproval, in the Rollout's namespace. |
bystring | By is the approval.kuberik.com/by annotation at deploy time, if set. |
BlockedRelease
Appears in:
BlockedRelease describes a consumer release candidate held back by this dependency, and why.
| Field | Description |
|---|---|
tagstring | Tag is the image tag of the blocked release candidate. |
requiredVersionstring | RequiredVersion is the version constraint the candidate places on the provider's contract, verbatim from its requires annotation. |
reasonstring | Reason is a short, machine-readable reason the candidate is blocked. |
ClusterApprovalPolicySpec
Appears in:
ClusterApprovalPolicySpec defines the desired state of ClusterApprovalPolicy
| Field | Description |
|---|---|
rolloutSelectorLabelSelector | RolloutSelector selects the Rollouts this policy applies to. An empty selector matches every Rollout. |
namespaceSelectorLabelSelector | NamespaceSelector restricts the policy to Rollouts in matching namespaces. A nil selector matches every namespace. |
ClusterApprovalPolicyStatus
Appears in:
ClusterApprovalPolicyStatus defines the observed state of ClusterApprovalPolicy.
| Field | Description |
|---|---|
rollouts[]string | Rollouts lists the matched Rollouts, sorted, as <namespace>/<name>. |
conditions[]Condition | conditions represent the current state of the ClusterApprovalPolicy resource.
Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
ClusterRolloutScheduleSpec
Appears in:
ClusterRolloutScheduleSpec defines the desired state of ClusterRolloutSchedule.
| Field | Description |
|---|---|
rolloutSelectorLabelSelector | RolloutSelector is a label selector to match Rollouts across namespaces. |
namespaceSelectorLabelSelector | NamespaceSelector is a label selector to match namespaces. If empty, applies to all namespaces. |
rules[]ScheduleRule | Rules is a list of schedule rules. The schedule is active if ANY rule matches the current time/date. |
timezonestring | Timezone is the IANA timezone for the schedule (e.g., "America/New_York"). Defaults to "UTC" if not specified. |
actionRolloutScheduleAction | Action defines what to do when the schedule is active. - "Allow": Gate passes when active, blocks when inactive - "Deny": Gate blocks when active, passes when inactive |
ClusterRolloutScheduleStatus
Appears in:
ClusterRolloutScheduleStatus defines the observed state of ClusterRolloutSchedule.
| Field | Description |
|---|---|
activebool | Active indicates if the schedule is currently active (any rule matches). |
activeRules[]string | ActiveRules is a list of rule names that are currently active. |
nextTransitionTime | NextTransition is the timestamp when the active state will next change. |
managedGates[]string | ManagedGates is a list of RolloutGate names being managed by this schedule. Format: "namespace/name" |
matchingRolloutsint | MatchingRollouts is the count of rollouts currently matched by the selectors. |
conditions[]Condition | Conditions represents the current state of the schedule. |
DateRange
Appears in:
DateRange represents a date range.
| Field | Description |
|---|---|
startstring | Start date in YYYY-MM-DD format |
endstring | End date in YYYY-MM-DD format |
DayOfWeek
(Alias of string)
Appears in:
DayOfWeek represents a day of the week.
DeploymentHistoryEntry
Appears in:
DeploymentHistoryEntry represents a single entry in the deployment history.
| Field | Description |
|---|---|
idint64 | ID is a unique auto-incrementing identifier for this history entry. |
versionVersionInfo | Version is the version information that was deployed. |
timestampTime | Timestamp is the time when the deployment occurred. |
messagestring | Message provides a descriptive message about this deployment entry This field contains human-readable information about the deployment context. For automatic deployments, it includes information about gate bypass and failed bake unblock. For manual deployments (when wantedVersion is specified), it can contain a custom message provided via the "rollout.kuberik.com/deploy-message" annotation, or defaults to "Manual deployment". |
triggeredByTriggeredByInfo | TriggeredBy indicates what triggered this deployment. Kind can be "User" for manual deployments triggered by a user, or "System" for automatic deployments. Name contains the name of the user or system that triggered the deployment. For user-triggered deployments, this is extracted from the "rollout.kuberik.com/deploy-user" annotation. For system-triggered deployments, this is typically "rollout-controller". |
bakeStatusstring | BakeStatus tracks the bake state for this deployment (e.g., None, InProgress, Succeeded, Failed, Cancelled) The bake process ensures that the deployment is stable and healthy before marking as successful. |
bakeStatusMessagestring | BakeStatusMessage provides details about the bake state for this deployment This field contains human-readable information about why the bake status is what it is. |
bakeStartTimeTime | BakeStartTime is the time when the bake period started for this deployment This is when the rollout controller began monitoring the deployment for stability. |
bakeEndTimeTime | BakeEndTime is the time when the bake period ended for this deployment This is when the bake process completed (either successfully or with failure). |
failedHealthChecks[]FailedHealthCheck | FailedHealthChecks contains all health checks that failed during bake. This field is populated when bake fails due to health check errors. |
lastRetryTimestampTime | LastRetryTimestamp is the time when a retry was most recently requested for this deployment. When set, downstream controllers (health checks, kruise rollout step gates) use this as a cutoff: stale failure conditions with LastTransitionTime older than LastRetryTimestamp are ignored as they reflect the pre-retry state. |
approvalApprovalRecord | Approval names the RolloutApproval that let this build through an approval gate. Nil when no approval gate applied, or when gates were bypassed. |
FailedHealthCheck
Appears in:
FailedHealthCheck represents a health check that failed during bake.
| Field | Description |
|---|---|
namestring | Name is the name of the health check. |
namespacestring | Namespace is the namespace of the health check. |
messagestring | Message is the error message from the health check. |
observations[]HealthCheckObservation | Observations is a snapshot of the health check's status.observations taken when the failure was recorded. It is not updated afterwards, so the figure survives the health check recovering. |
HealthCheckObservation
Appears in:
HealthCheckObservation is one typed fact a health check evaluated. Numeric fields are decimal strings (e.g. “8.2”, “0.082”) so no precision is lost and the CRD stays float-free.
| Field | Description |
|---|---|
namestring | Name of the observed quantity, shown as the label ("error rate", "p99 latency"). |
kindHealthCheckObservationKind | Kind picks the drawing: Threshold (value vs limit), Ratio (value of total), Count (value), State (no number; label only). |
valuestring | Value is the observed number, as a decimal string. |
limitstring | Limit is the boundary for a Threshold observation, as a decimal string. |
totalstring | Total is the denominator for a Ratio observation, as a decimal string. |
directionHealthCheckObservationDirection | Direction, for Threshold: Above is bad when value > limit; Below is bad when value < limit. |
unitstring | Unit of the numbers: Percent (a ratio 0..1), Milliseconds, Seconds, Count, or free text. |
windowstring | Window the observation covers, e.g. "5m". |
healthybool | Healthy says whether this observation alone is within bounds, so a consumer can mark the offending one when several are listed. |
observedTimeTime | ObservedTime is when the provider last evaluated this observation. |
HealthCheckObservationDirection
(Alias of string)
Appears in:
HealthCheckObservationDirection says which side of a Threshold limit is bad.
HealthCheckObservationKind
(Alias of string)
Appears in:
HealthCheckObservationKind selects how an observation is drawn.
HealthCheckSelectorConfig
Appears in:
HealthCheckSelectorConfig defines how to select HealthChecks for a rollout.
| Field | Description |
|---|---|
selectorLabelSelector | Selector specifies the label selector for matching HealthChecks |
namespaceSelectorLabelSelector | NamespaceSelector specifies the namespace selector for matching HealthChecks If not specified, only HealthChecks in the same namespace as the Rollout will be considered |
HealthCheckSpec
Appears in:
HealthCheckSpec defines the desired state of HealthCheck.
| Field | Description |
|---|---|
classstring | Class specifies the type of health check (e.g., 'kustomization') |
HealthCheckStatus
Appears in:
HealthCheckStatus defines the observed state of HealthCheck.
| Field | Description |
|---|---|
statusHealthStatus | Status indicates the health state of the check (e.g., 'Healthy', 'Unhealthy', 'Pending') |
lastErrorTimeTime | LastErrorTime is the timestamp of the most recent error state |
messagestring | Message provides additional details about the health status |
lastChangeTimeTime | LastChangeTime is the timestamp when the health status last changed |
observations[]HealthCheckObservation | Observations are the facts the check last evaluated, most important first. Consumers (the dashboard) draw the first one as the headline figure; Message stays the human sentence. Providers may leave this empty. |
HealthStatus
(Alias of string)
Appears in:
ProviderRolloutReference
Appears in:
ProviderRolloutReference identifies the Rollout that provides a contract.
| Field | Description |
|---|---|
namestring | Name is the name of the providing Rollout. |
namespacestring | Namespace is the namespace of the providing Rollout. Defaults to the namespace of the RolloutDependency. |
ReleaseCandidate
Appears in:
ReleaseCandidate is a release the Rollout could deploy next. It is deliberately lean: full release metadata (digest, revision, version, requires) lives in the ReleaseSlice catalogue and in history entries.
| Field | Description |
|---|---|
tagstring | Tag is the release tag. |
createdTime | Created is the release creation time. |
firstSeenTime | FirstSeen is when the catalogue first admitted this release. |
gatedbool | Gated is true when the release passes every gate. |
blockedBy[]string | BlockedBy lists the gates that do not let this release through. |
ReleaseSourceStatusRef
Appears in:
ReleaseSourceStatusRef is a Rollout’s view of its ReleaseSource.
| Field | Description |
|---|---|
namestring | Name of the ReleaseSource. |
readybool | Ready mirrors the ReleaseSource Ready condition. |
countint32 | Count is the number of releases in the catalogue. |
neweststring | Newest is the tag of the newest release in the catalogue. |
observedAtTime | ObservedAt is when name, ready, count or newest last changed. |
RolloutApprovalSpec
Appears in:
RolloutApprovalSpec defines the desired state of RolloutApproval
| Field | Description |
|---|---|
rolloutRefLocalObjectReference | RolloutRef names the Rollout, in this object's namespace, that the approval is for. |
versionstring | Version is the tag of the release candidate being approved. It is matched against releaseCandidates[].tag. It may name a version that does not exist yet. |
RolloutDependencySpec
Appears in:
RolloutDependencySpec defines the desired state of RolloutDependency.
A RolloutDependency gates a consumer Rollout on the deployed contract version
of a provider Rollout. Each release candidate of the consumer declares what it
requires of the contract via a com.kuberik.rollout.requires.<contract> OCI
annotation. A candidate is admitted only once the provider has successfully
deployed a release whose own contract version
(org.opencontainers.image.version) satisfies that constraint. The result is a
topological rollout: providers advance before the consumers that depend on
them.
| Field | Description |
|---|---|
rolloutRefLocalObjectReference | RolloutRef references the consumer Rollout that this dependency gates.
The Rollout must live in the same namespace as this RolloutDependency. The name is validated here because corev1.LocalObjectReference defaults it to the empty string, which would otherwise be admitted and then fail every lookup. |
providerRefProviderRolloutReference | ProviderRef references the Rollout that provides the contract. |
contractstring | Contract is the contract name matched against the consumer's
com.kuberik.rollout.requires.<contract> annotations.
Defaults to the name of the provider Rollout. |
RolloutDependencyStatus
Appears in:
RolloutDependencyStatus defines the observed state of RolloutDependency.
| Field | Description |
|---|---|
conditions[]Condition | conditions represent the current state of the RolloutDependency resource. Condition types: - "Ready": the dependency was evaluated and its gate is in sync - "Satisfied": no release the consumer could deploy next is held back by this dependency |
providedVersionstring | ProvidedVersion is the contract version currently deployed by the provider Rollout, taken from the OCI version annotation of its deployed release with the numeric per-build ordinal stripped. A real pre-release identifier ("2.0.0-alpha.1") is preserved, because it means the triple has not shipped. |
providedTagstring | ProvidedTag is the image tag of the provider release that ProvidedVersion was read from. |
admittedVersions[]string | AdmittedVersions lists the consumer release candidate tags admitted by this dependency. This is the allow list published to the managed RolloutGate. Named for symmetry with RolloutGate.allowedVersions, which also holds tags. Capped at the newest entries; see maxPublishedReleases. |
blockedReleases[]BlockedRelease | BlockedReleases lists the consumer release candidates held back by this dependency, with the constraint each places on the contract. Capped at the newest entries; see maxPublishedReleases. |
gateNamestring | GateName is the name of the RolloutGate managed by this dependency. |
RolloutGateSpec
Appears in:
RolloutGateSpec defines the desired state of RolloutGate.
| Field | Description |
|---|---|
rolloutRefLocalObjectReference | |
passingbool | Passing is true if the RolloutGate is passing. |
allowedVersions[]string | AllowedVersions is a list of versions that Rollout can be updated to. |
RolloutGateStatus
Appears in:
RolloutGateStatus defines the observed state of RolloutGate.
RolloutGateStatusSummary
Appears in:
RolloutGateStatusSummary summarizes the status of a gate relevant to this rollout.
| Field | Description |
|---|---|
namestring | Name is the name of the gate. |
passingbool | Passing is true if the gate is passing, false if it is blocking. |
allowedVersions[]string | AllowedVersions is a list of versions that are allowed by the gate. |
messagestring | Message is a message describing the status of the gate. |
bypassGatesbool | BypassGates indicates whether this gate was bypassed for the current deployment. With the rollout.kuberik.com/bypass-gates-only annotation, only the listed gates are marked. |
RolloutScheduleAction
(Alias of string)
Appears in:
RolloutScheduleAction defines the action to take when the schedule is active.
RolloutScheduleSpec
Appears in:
RolloutScheduleSpec defines the desired state of RolloutSchedule.
| Field | Description |
|---|---|
rolloutSelectorLabelSelector | RolloutSelector is a label selector to match Rollouts in the same namespace. |
rules[]ScheduleRule | Rules is a list of schedule rules. The schedule is active if ANY rule matches the current time/date. |
timezonestring | Timezone is the IANA timezone for the schedule (e.g., "America/New_York"). Defaults to "UTC" if not specified. |
actionRolloutScheduleAction | Action defines what to do when the schedule is active. - "Allow": Gate passes when active, blocks when inactive - "Deny": Gate blocks when active, passes when inactive |
RolloutScheduleStatus
Appears in:
RolloutScheduleStatus defines the observed state of RolloutSchedule.
| Field | Description |
|---|---|
activebool | Active indicates if the schedule is currently active (any rule matches). |
activeRules[]string | ActiveRules is a list of rule names that are currently active. |
nextTransitionTime | NextTransition is the timestamp when the active state will next change. |
managedGates[]string | ManagedGates is a list of RolloutGate names being managed by this schedule. |
matchingRolloutsint | MatchingRollouts is the count of rollouts currently matched by the selector. |
conditions[]Condition | Conditions represents the current state of the schedule. |
RolloutSpec
Appears in:
RolloutSpec defines the desired state of Rollout.
| Field | Description |
|---|---|
releaseSourceRefLocalObjectReference | ReleaseSourceRef names a ReleaseSource (kuberik.com, served by release-controller) in the same namespace that provides this Rollout's releases. When set (and the release-controller CRDs are installed) the Rollout reads its releases from the source's ReleaseSlice catalogue. This is the only release path: a Rollout without it gets no releases and reports ReleasesUpdated=False and Ready=False with reason ReleaseSourceRequired. |
releasesImagePolicyLocalObjectReference | Deprecated: ignored; removed in a later version. Releases come from releaseSourceRef; to migrate an existing Flux ImagePolicy, create a ReleaseSource with spec.oci.imagePolicyRef. A Rollout that sets it reports ReleasesImagePolicyIgnored=True. A value type, so Go clients always send "releasesImagePolicy: {}". |
wantedVersionstring | WantedVersion specifies a specific version to deploy, overriding the automatic version selection |
versionHistoryLimitint32 | VersionHistoryLimit defines the maximum number of entries to keep in the deployment history |
availableReleasesRetentionDaysint32 | Deprecated: ignored; retention is ReleaseSource.spec.retention. Removed in a later version. AvailableReleasesRetentionDays defines how many days of available releases to keep based on creation timestamp When history is full, releases older than this retention period may be removed. Defaults to 7 days if not specified. |
availableReleasesMinCountint32 | Deprecated: ignored; retention is ReleaseSource.spec.retention. Removed in a later version. AvailableReleasesMinCount defines the minimum number of available releases to always keep When history is full, at least this many releases will be retained regardless of other criteria. Defaults to 30 if not specified. |
bakeTimeDuration | BakeTime specifies how long to wait after bake starts before marking as successful If no errors happen within the bake time, the rollout is baked successfully. If not specified, no bake time is enforced. |
deployTimeoutDuration | DeployTimeout specifies the maximum time to wait for bake to start before marking as failed If bake doesn't start within deployTimeout (i.e., health checks don't become healthy), the rollout should be marked as failed. If not specified, the rollout will wait indefinitely for bake to start. |
healthCheckSelectorHealthCheckSelectorConfig | HealthCheckSelector specifies how to select HealthChecks for this rollout |
RolloutStatus
Appears in:
RolloutStatus defines the observed state of Rollout.
| Field | Description |
|---|---|
conditions[]Condition | Conditions represents the current state of the rollout process. |
history[]DeploymentHistoryEntry | History tracks the deployment history of this Rollout. Each entry contains the version deployed and the timestamp of the deployment. |
availableReleases[]VersionInfo | Deprecated: ignored; no longer written (cleared on reconcile). Read status.candidates and the ReleaseSlice catalogue instead. Removed in a later version. AvailableReleases is a list of all releases available in the releases repository. |
releaseCandidates[]VersionInfo | Deprecated: ignored; no longer written (cleared on reconcile). Read status.candidates instead. Removed in a later version. ReleaseCandidates is a list of releases that are candidates for the next deployment. These are filtered from AvailableReleases based on deployment history and version ordering. |
gatedReleaseCandidates[]VersionInfo | Deprecated: ignored; no longer written (cleared on reconcile). Read status.candidates (gated field) instead. Removed in a later version. GatedReleaseCandidates is a list of release candidates that have passed through all gates. This shows which versions are actually available for deployment after gate evaluation. |
releaseSourceReleaseSourceStatusRef | ReleaseSource summarises the ReleaseSource this Rollout reads (slices mode only). |
candidates[]ReleaseCandidate | Candidates is the working set in slices mode: the K newest releases newer than the deployed one, plus any release newer than the deployed one that a gate's allowedVersions, the force-deploy or bypass-gates annotation, or spec.wantedVersion names. Newest first. |
gates[]RolloutGateStatusSummary | Gates summarizes the status of each gate relevant to this rollout. |
artifactTypestring | ArtifactType is the media/artifact type of the image extracted from the manifest. This includes OCI artifact types, container image types, and other media types. This field is set once for the entire rollout based on the latest available release. |
sourcestring | Source is the source information extracted from OCI annotations. This typically contains the repository URL or source code location. This field is set once for the entire rollout based on the latest available release. |
titlestring | Title is the title of the image extracted from OCI annotations. This field is set once for the entire rollout based on the latest available release. |
descriptionstring | Description is the description of the image extracted from OCI annotations. This field is set once for the entire rollout based on the latest available release. |
ScheduleRule
Appears in:
ScheduleRule defines a time-based rule. The schedule is active if the current time/date matches this rule.
| Field | Description |
|---|---|
namestring | Name is an optional identifier for this rule |
timeRangeTimeRange | TimeRange restricts the rule to specific times of day |
daysOfWeek[]DayOfWeek | DaysOfWeek restricts the rule to specific days of the week |
dateRangeDateRange | DateRange restricts the rule to specific date range |
TimeRange
Appears in:
TimeRange represents a time range within a day.
| Field | Description |
|---|---|
startstring | Start time in HH:MM format (24-hour) |
endstring | End time in HH:MM format (24-hour) |
TriggeredByInfo
Appears in:
TriggeredByInfo indicates what triggered a deployment.
| Field | Description |
|---|---|
kindstring | Kind indicates the type of trigger: "User" for manual deployments triggered by a user, or "System" for automatic deployments triggered by the rollout controller. |
namestring | Name contains the name of the user or system that triggered the deployment. For user-triggered deployments, this is extracted from the "rollout.kuberik.com/deploy-user" annotation. For system-triggered deployments, this is typically "rollout-controller". |
VersionInfo
Appears in:
VersionInfo represents detailed information about a version.
| Field | Description |
|---|---|
tagstring | Tag is the image tag (e.g., "v1.2.3", "latest"). |
digeststring | Digest is the image digest if available from the ImagePolicy. |
versionstring | Version is the semantic version extracted from OCI annotations if available. |
revisionstring | Revision is the revision information extracted from OCI annotations if available. |
createdTime | Created is the creation timestamp extracted from OCI annotations if available. |
requiresmap[string]string | Requires maps a contract name to what this release requires of that
contract, extracted from com.kuberik.rollout.requires.<contract> OCI
annotations. Values are version constraints as defined by
github.com/Masterminds/semver, applied verbatim — note that a bare version
is an exact match there, not a floor.
RolloutDependency uses these to gate this release on the deployed version of
the Rollout providing each contract.Bounded because it is populated from image annotations, which are outside this controller's trust boundary, and is stored on every release and every history entry. |
metadataUnresolvedbool | MetadataUnresolved is true when this release's OCI manifest could not be read, so Requires and the version fields say nothing about the image. A RolloutDependency blocks such a release rather than reading the absent annotations as "declares no requirement", which would open the gate whenever the registry is unreachable. |
Environment API
Environment
Environment is the Schema for the environments API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specEnvironmentSpec | spec defines the desired state of Environment |
statusEnvironmentStatus | status defines the observed state of Environment |
Definitions
BackendConfig
Appears in:
BackendConfig contains backend-specific configuration
| Field | Description |
|---|---|
typestring | Type specifies the backend to use (e.g., "github") |
projectstring | Project is the project identifier (backend-specific format, e.g., "owner/repo" for GitHub) |
secretstring | Secret is the name of the Kubernetes Secret containing the backend authentication token |
EnvironmentInfo
Appears in:
EnvironmentInfo represents information about an environment’s deployment.
| Field | Description |
|---|---|
environmentstring | Environment is the canonical tier name (dev, test, staging, prod) |
environmentUrlstring | EnvironmentURL is the URL of the actual deployed environment (e.g., dashboard URL) |
history[]DeploymentHistoryEntry | History contains deployment history entries for this environment |
EnvironmentRelationship
Appears in:
EnvironmentRelationship is the deprecated relationship to another environment.
| Field | Description |
|---|---|
environmentstring | Environment is the environment name this environment related to. |
typeRelationshipType | Type is the relationship type. |
EnvironmentSpec
Appears in:
EnvironmentSpec defines the desired state of Environment
| Field | Description |
|---|---|
rolloutRefLocalObjectReference | RolloutRef is a reference to the Rollout that this Environment manages |
namestring | Name is the name of the GitHub deployment (the "kuberik" prefix will be automatically added for GitHub backend if not already present) |
environmentstring | Environment is the tier this Environment belongs to. Tiers have a fixed order, earliest first: dev, test, staging, prod. Each tier accepts the aliases listed below; aliases of one tier are the same environment for wave grouping, upstream lookup and GitHub matching (the GitHub environment name is kept as written here). An Environment is gated on the nearest earlier tier that has registered sites for the same name. |
relationshipEnvironmentRelationship | Relationship is DEPRECATED and ignored: environment order is fixed (dev, test, staging, prod). It is still accepted so that existing manifests keep applying; the Environment reports a Deprecated condition. It will be removed in a later release. |
backendBackendConfig | Backend contains backend-specific configuration |
sitestring | Site identifies where this instance of the environment runs (e.g. a region or cluster name such as "eu-west-1"). Members of the same environment that run in different clusters are told apart by site. When empty, the controller's default site is used (key "site" of the optional kuberik-cluster-info ConfigMap in the controller namespace), and when that is not set either, the site is "default". Only one Environment (across clusters) may own a given deployment name, tier and site; a second one is reported with WaveReady=False, reason DuplicateSite, and posts nothing. |
waveint32 | Wave is the rollout wave of this site within its environment ("prod wave 1"). Waves of one environment roll out in order: wave N starts a version only after every site of wave N-1 baked it. Defaults to 1. |
lockstepbool | Lockstep, when true, stops the wave-1 leader from selecting a new version until every wave of this environment has baked the currently selected one. The wave-1 leader's value governs; a disagreeing member surfaces a LockstepMismatch condition. |
requeueIntervalstring | RequeueInterval specifies how often the controller should reconcile this Environment If not specified, defaults to 1 minute. Must be a valid duration string (e.g., "1m", "30s", "5m"). |
EnvironmentStatus
Appears in:
EnvironmentStatus defines the observed state of Environment.
| Field | Description |
|---|---|
lastStatusChangeTimeTime | LastStatusChangeTime is the last time the status was updated (only updated when status changes) |
currentVersionstring | CurrentVersion is the current version being deployed |
rolloutGateRefLocalObjectReference | RolloutGateRef is a reference to the RolloutGate that was created/updated |
environmentInfos[]EnvironmentInfo | EnvironmentInfos tracks deployment information for each environment. Each environment has environment URL and relationships (not per version). |
waveWaveStatus | Wave is set for Environments with a site and describes their wave state. |
conditions[]Condition | conditions represent the current state of the Environment resource.
Each condition has a unique type and reflects the status of a specific aspect of the resource. Standard condition types include: - "Available": the resource is fully functional - "Progressing": the resource is being created or updated - "Degraded": the resource failed to reach or maintain its desired state The status of each condition is one of True, False, or Unknown. |
RelationshipType
(Alias of string)
Appears in:
RelationshipType is the type of the deprecated spec.relationship.
SiteOwner
Appears in:
SiteOwner identifies the Environment object that owns a site.
| Field | Description |
|---|---|
clusterstring | |
namespacestring | |
namestring |
WaveBlocker
Appears in:
WaveBlocker is the machine-readable form of a WaveReady=False condition. The condition message is display text and may change; these fields are the contract.
| Field | Description |
|---|---|
reasonstring | Reason is the WaveReady reason. |
environmentstring | Environment is the canonical tier of the member waited on or at fault. |
sitestring | Site is the member waited on. |
waitingOnstring | WaitingOn is what the wave waits for. |
outcomestring | Outcome is set when a leader's bake ended badly. |
revisionstring | Revision is the full revision concerned. |
pinnedVersionstring | PinnedVersion is the version the Rollout pins (Pinned). |
selectedVersionstring | SelectedVersion is the tag of the wave's pick (Pinned). |
ownerSiteOwner | Owner is the existing owner of the site (DuplicateSite). |
waves[]int32 | Waves are the waves present (InvalidTopology, wave gap). |
missingWaves[]int32 | MissingWaves are the waves absent from the sequence (InvalidTopology, wave gap). |
names[]string | Names are the alias names registered for one tier (InvalidTopology), the offending name (UnknownTier), or, for DuplicateSite, names[0] is the deployment name the existing owner holds the site for. |
WaveMemberStatus
Appears in:
WaveMemberStatus is one site of a wave as observed in the backend.
| Field | Description |
|---|---|
environmentstring | Environment of the member. |
sitestring | Site of the member. |
waveint32 | Wave of the member. |
revisionstring | Revision of the member's newest deployment. |
bakeStatusstring | BakeStatus of the member's newest deployment. |
deregisteredbool | Deregistered is true when the member was removed and no longer counts. |
WaveRole
(Alias of string)
Appears in:
WaveRole is the role a site plays inside its (environment, wave).
WaveStatus
Appears in:
WaveStatus describes the site/wave view the controller used for the last gate decision.
| Field | Description |
|---|---|
sitestring | Site is the effective site of this Environment (spec or controller default). |
environmentstring | Environment is the environment name this site was registered under in GitHub. Deregistration uses it even after spec.environment changed. |
namestring | Name is the deployment name as written to GitHub (with the kuberik prefix). Deregistration uses it even after spec.name changed. |
waveint32 | Wave is the effective wave of this Environment. |
roleWaveRole | Role is Leader or Follower within (environment, wave). It is also the role recorded on the next GitHub deployment this site creates. |
leaderstring | Leader is the site leading this (environment, wave). |
selectedRevisionstring | SelectedRevision is the revision the leader of this wave currently selected. |
members[]WaveMemberStatus | Members are the registered sites of this environment and of its upstream environment. |
blockerWaveBlocker | Blocker explains why the site is not Ready; nil when WaveReady is True. |
OpenKruise Integration API
RolloutTest
RolloutTest is the Schema for the rollouttests API
| Field | Description |
|---|---|
metadataObjectMeta | metadata is a standard object metadata |
specRolloutTestSpec | spec defines the desired state of RolloutTest |
statusRolloutTestStatus | status defines the observed state of RolloutTest |
Definitions
RolloutTestPhase
(Alias of string)
Appears in:
RolloutTestPhase represents the current phase of a RolloutTest
RolloutTestSpec
Appears in:
RolloutTestSpec defines the desired state of RolloutTest
| Field | Description |
|---|---|
rolloutNamestring | RolloutName is the name of the Rollout to watch. |
stepIndexint32 | StepIndex is the index of the step in the Rollout strategy to execute the test at. |
jobTemplatek8s.io/api/batch/v1.JobSpec | JobTemplate is the template for the Job to run. |
RolloutTestStatus
Appears in:
RolloutTestStatus defines the observed state of RolloutTest.
| Field | Description |
|---|---|
conditions[]Condition | Conditions store the status conditions of the RolloutTest. |
observedCanaryRevisionstring | ObservedCanaryRevision is the canaryRevision from the Rollout that the current job was created for. When the canaryRevision changes, it indicates a new rollout and the old job should be deleted. |
phaseRolloutTestPhase | Phase represents the current phase of the RolloutTest |
jobNamestring | JobName is the name of the Job created for this test |
retryCountint32 | RetryCount is the number of times the job has been retried (from job status) |
activePodsint32 | ActivePods is the number of active pods for the job |
succeededPodsint32 | SucceededPods is the number of succeeded pods for the job |
failedPodsint32 | FailedPods is the number of failed pods for the job |
Release API
ReleaseSlice
ReleaseSlice holds a bounded chunk of a ReleaseSource catalogue. Like
EndpointSlice it has no spec/status. Labelled kuberik.com/release-source,
owned (controller=true) by its ReleaseSource, named <source>-<5-digit index>.
| Field | Description |
|---|---|
metadataObjectMeta | |
sourcestring | Source is the owning ReleaseSource name. Immutable. |
sealedbool | Sealed slices take no new releases. Once true stays true. Always serialised (no omitempty) and defaulted to false so the transition rule also sees true -> false from clients that drop zero values. |
oldestCreatedTime | |
newestCreatedTime | |
releases[]Release | Releases sorted by sequence ascending. |
ReleaseSource
ReleaseSource is the Schema for the releasesources API.
| Field | Description |
|---|---|
metadataObjectMeta | |
specReleaseSourceSpec | |
statusReleaseSourceStatus |
Definitions
AlphabeticalPolicy
Appears in:
AlphabeticalPolicy orders tags alphabetically.
| Field | Description |
|---|---|
orderstring |
ArtifactMetadata
Appears in:
ArtifactMetadata is the artifact-level metadata of the newest release.
| Field | Description |
|---|---|
typestring | |
sourceURLstring | |
titlestring | |
descriptionstring |
NumericalPolicy
Appears in:
NumericalPolicy orders tags numerically.
| Field | Description |
|---|---|
orderstring |
OCISource
Appears in:
OCISource configures an OCI repository source.
| Field | Description |
|---|---|
imagestring | Image is the repository, e.g. ghcr.io/org/app. |
secretRefLocalObjectReference | SecretRef names a kubernetes.io/dockerconfigjson Secret. |
insecurebool | Insecure allows plain HTTP registries. |
filterTagsTagFilter | FilterTags has the Flux ImagePolicy shape. |
policyOrderPolicy | Policy has the Flux ImagePolicy shape. Required with image: release order and admission are defined by it (with imagePolicyRef the ImagePolicy carries it). |
imagePolicyRefLocalObjectReference | ImagePolicyRef reads image, secretRef, filterTags and policy from an existing Flux ImagePolicy and its ImageRepository (spec only); policy and filterTags must not be set with it. |
OrderPolicy
Appears in:
OrderPolicy picks how tags are ordered (Flux ImagePolicy shape). At most one member.
| Field | Description |
|---|---|
semverSemVerPolicy | |
alphabeticalAlphabeticalPolicy | |
numericalNumericalPolicy |
Release
Appears in:
Release is one catalogue entry. It is a superset of rollout-controller’s
VersionInfo (tag, digest, version, revision, created, requires,
metadataUnresolved).
CEL cost: Requires and Metadata sit inside a list with maxItems 1000, so
their rules are written as a single self.all(k, …) over a bounded map
(maxProperties 32 / 8) and string maxLengths are declared on the values'
schema so the apiserver can estimate cost.
| Field | Description |
|---|---|
tagstring | Tag is the deployable reference. Unique per source. |
digeststring | |
versionstring | |
revisionstring | Revision is a git SHA by contract. |
sequenceint64 | Sequence is the admission order. Readers sort by it (not by created). Sequence order equals policy order: incremental releases get max+1.., backfilled releases get min-1.. going down. Never renumbered. |
createdTime | Created is source-provided, else firstSeen (createdObserved=true). |
createdObservedbool | |
firstSeenTime | FirstSeen is when this catalogue first admitted the release. |
requiresmap[string]string | Requires: keys <= 64, values <= 256 (same as VersionInfo.Requires). |
metadataUnresolvedbool | |
urlstring | URL of the release page. |
metadatamap[string]string | Metadata is source-specific and small; OCI v1 leaves it empty. |
ReleaseRef
Appears in:
ReleaseRef identifies the newest release.
| Field | Description |
|---|---|
tagstring | |
createdTime | |
revisionstring |
ReleaseSourceSpec
Appears in:
ReleaseSourceSpec is a discriminated union: exactly one source member must be set. v1 has only oci.
| Field | Description |
|---|---|
ociOCISource | OCI lists tags of an OCI repository. |
intervalDuration | Interval between syncs. Jittered +-10% by the controller. |
suspendbool | Suspend stops syncing while true. |
retentionRetention | Retention controls when whole old slices are dropped. |
ReleaseSourceStatus
Appears in:
ReleaseSourceStatus defines the observed state of ReleaseSource.
| Field | Description |
|---|---|
observedGenerationint64 | |
newestReleaseRef | Newest is the newest release in the catalogue. |
countint32 | Count of releases in the catalogue. |
sliceCountint32 | SliceCount is the number of ReleaseSlices of this source. Slice names are not listed (an unbounded catalogue would overflow any list bound); readers select slices by the kuberik.com/release-source label. |
openSlicestring | OpenSlice is the name of the slice taking new releases ("" if none). |
backfillCompletebool | BackfillComplete is true once the catalogue reaches back to the retention window (or the registry has no older tags). While false the controller keeps walking older tags in policy-descending order. |
nextSliceIndexint32 | |
artifactArtifactMetadata | Artifact metadata of the newest release. |
cursorstring | Cursor is source-opaque (e.g. an ETag). |
lastSyncTimeTime | |
conditions[]Condition | Conditions: Ready, SourceReachable, Syncing. |
Retention
Appears in:
Retention mirrors Rollout.availableReleasesRetentionDays / MinCount.
| Field | Description |
|---|---|
daysint32 | Days after which a release counts as expired. 0 means age never expires anything. |
minCountint32 | MinCount is the number of newest releases always kept. |
SemVerPolicy
Appears in:
SemVerPolicy orders tags by semantic version within a range.
| Field | Description |
|---|---|
rangestring |
TagFilter
Appears in:
TagFilter filters tags by regular expression (Flux ImagePolicy shape).
| Field | Description |
|---|---|
patternstring | Pattern is a regular expression tags must match. |
extractstring | Extract is a capture-group expression applied before ordering. |