@soft-stech/fleet
Version:
1,186 lines (1,185 loc) • 51.7 kB
TypeScript
import { IObjectMeta } from "@soft-stech/apimachinery/apis/meta/v1/ObjectMeta";
import { Model, ModelData } from "@soft-stech/base";
/**
* Bundle contains the resources of an application and its deployment options.
* It will be deployed as a Helm chart to target clusters.
*
*
* When a GitRepo is scanned it will produce one or more bundles. Bundles are
* a collection of resources that get deployed to one or more cluster(s). Bundle is the
* fundamental deployment unit used in Fleet. The contents of a Bundle may be
* Kubernetes manifests, Kustomize configuration, or Helm charts. Regardless
* of the source the contents are dynamically rendered into a Helm chart by
* the agent and installed into the downstream cluster as a Helm release.
*/
export interface IBundle {
/**
* 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
*/
"apiVersion": "fleet.cattle.io/v1alpha1";
/**
* 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
*/
"kind": "Bundle";
"metadata"?: IObjectMeta;
"spec"?: {
/**
* ContentsID stores the contents id when deploying contents using an OCI registry.
*/
"contentsId"?: string;
/**
* CorrectDrift specifies how drift correction should work.
*/
"correctDrift"?: {
/**
* Enabled correct drift if true.
*/
"enabled"?: boolean;
/**
* Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.
*/
"force"?: boolean;
/**
* KeepFailHistory keeps track of failed rollbacks in the helm history.
*/
"keepFailHistory"?: boolean;
};
/**
* DefaultNamespace is the namespace to use for resources that do not
* specify a namespace. This field is not used to enforce or lock down
* the deployment to a specific namespace.
*/
"defaultNamespace"?: string;
/**
* DeleteCRDResources deletes CRDs. Warning! this will also delete all your Custom Resources.
*/
"deleteCRDResources"?: boolean;
/**
* DeleteNamespace can be used to delete the deployed namespace when removing the bundle
*/
"deleteNamespace"?: boolean;
/**
* DependsOn refers to the bundles which must be ready before this bundle can be deployed.
*/
"dependsOn"?: Array<{
/**
* Name of the bundle.
*/
"name"?: string;
/**
* Selector matching bundle's labels.
*/
"selector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
}>;
/**
* Diff can be used to ignore the modified state of objects which are amended at runtime.
*/
"diff"?: {
/**
* ComparePatches match a resource and remove fields from the check for modifications.
*/
"comparePatches"?: Array<{
/**
* APIVersion is the apiVersion of the resource to match.
*/
"apiVersion"?: string;
/**
* JSONPointers ignore diffs at a certain JSON path.
*/
"jsonPointers"?: Array<string>;
/**
* Kind is the kind of the resource to match.
*/
"kind"?: string;
/**
* Name is the name of the resource to match.
*/
"name"?: string;
/**
* Namespace is the namespace of the resource to match.
*/
"namespace"?: string;
/**
* Operations remove a JSON path from the resource.
*/
"operations"?: Array<{
/**
* Op is usually "remove"
*/
"op"?: string;
/**
* Path is the JSON path to remove.
*/
"path"?: string;
/**
* Value is usually empty.
*/
"value"?: string;
}>;
}>;
};
/**
* ForceSyncGeneration is used to force a redeployment
*/
"forceSyncGeneration"?: number;
/**
* Helm options for the deployment, like the chart name, repo and values.
*/
"helm"?: {
/**
* Atomic sets the --atomic flag when Helm is performing an upgrade
*/
"atomic"?: boolean;
/**
* Chart can refer to any go-getter URL or OCI registry based helm
* chart URL. The chart will be downloaded.
*/
"chart"?: string;
/**
* DisableDNS can be used to customize Helm's EnableDNS option, which Fleet sets to `true` by default.
*/
"disableDNS"?: boolean;
/**
* DisableDependencyUpdate allows skipping chart dependencies update
*/
"disableDependencyUpdate"?: boolean;
/**
* DisablePreProcess disables template processing in values
*/
"disablePreProcess"?: boolean;
/**
* Force allows to override immutable resources. This could be dangerous.
*/
"force"?: boolean;
/**
* MaxHistory limits the maximum number of revisions saved per release by Helm.
*/
"maxHistory"?: number;
/**
* ReleaseName sets a custom release name to deploy the chart as. If
* not specified a release name will be generated by combining the
* invoking GitRepo.name + GitRepo.path.
* @maxLength 53
* @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
*/
"releaseName"?: string;
/**
* Repo is the name of the HTTPS helm repo to download the chart from.
*/
"repo"?: string;
/**
* SkipSchemaValidation allows skipping schema validation against the chart values
*/
"skipSchemaValidation"?: boolean;
/**
* TakeOwnership makes helm skip the check for its own annotations
*/
"takeOwnership"?: boolean;
/**
* TimeoutSeconds is the time to wait for Helm operations.
*/
"timeoutSeconds"?: number;
/**
* Values passed to Helm. It is possible to specify the keys and values
* as go template strings.
*/
"values"?: {};
/**
* ValuesFiles is a list of files to load values from.
*/
"valuesFiles"?: Array<string>;
/**
* ValuesFrom loads the values from configmaps and secrets.
*/
"valuesFrom"?: Array<{
/**
* The reference to a config map with release values.
*/
"configMapKeyRef"?: {
"key"?: string;
/**
* Name of a resource in the same namespace as the referent.
*/
"name"?: string;
"namespace"?: string;
};
/**
* The reference to a secret with release values.
*/
"secretKeyRef"?: {
"key"?: string;
/**
* Name of a resource in the same namespace as the referent.
*/
"name"?: string;
"namespace"?: string;
};
}>;
/**
* Version of the chart to download
*/
"version"?: string;
/**
* WaitForJobs if set and timeoutSeconds provided, will wait until all
* Jobs have been completed before marking the GitRepo as ready. It
* will wait for as long as timeoutSeconds
*/
"waitForJobs"?: boolean;
};
/**
* IgnoreOptions can be used to ignore fields when monitoring the bundle.
*/
"ignore"?: {
/**
* Conditions is a list of conditions to be ignored when monitoring the Bundle.
*/
"conditions"?: Array<Record<string, string>>;
};
/**
* KeepResources can be used to keep the deployed resources when removing the bundle
*/
"keepResources"?: boolean;
/**
* Kustomize options for the deployment, like the dir containing the
* kustomization.yaml file.
*/
"kustomize"?: {
/**
* Dir points to a custom folder for kustomize resources. This folder must contain
* a kustomization.yaml file.
*/
"dir"?: string;
};
/**
* TargetNamespace if present will assign all resource to this
* namespace and if any cluster scoped resource exists the deployment
* will fail.
*/
"namespace"?: string;
/**
* NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.
*/
"namespaceAnnotations"?: Record<string, string>;
/**
* NamespaceLabels are labels that will be appended to the namespace created by Fleet.
*/
"namespaceLabels"?: Record<string, string>;
/**
* Paused if set to true, will stop any BundleDeployments from being updated. It will be marked as out of sync.
*/
"paused"?: boolean;
/**
* Resources contains the resources that were read from the bundle's
* path. This includes the content of downloaded helm charts.
*/
"resources"?: Array<{
/**
* The content of the resource, can be compressed.
*/
"content"?: string;
/**
* Encoding is either empty or "base64+gz".
*/
"encoding"?: string;
/**
* Name of the resource, can include the bundle's internal path.
*/
"name"?: string;
}>;
/**
* RolloutStrategy controls the rollout of bundles, by defining
* partitions, canaries and percentages for cluster availability.
*/
"rolloutStrategy"?: {
/**
* A number or percentage of how to automatically partition clusters if no
* specific partitioning strategy is configured.
* default: 25%
*/
"autoPartitionSize"?: number | string;
/**
* A number or percentage of clusters that can be unavailable during an update
* of a bundle. This follows the same basic approach as a deployment rollout
* strategy. Once the number of clusters meets unavailable state update will be
* paused. Default value is 100% which doesn't take effect on update.
* default: 100%
*/
"maxUnavailable"?: number | string;
/**
* A number or percentage of cluster partitions that can be unavailable during
* an update of a bundle.
* default: 0
*/
"maxUnavailablePartitions"?: number | string;
/**
* A list of definitions of partitions. If any target clusters do not match
* the configuration they are added to partitions at the end following the
* autoPartitionSize.
*/
"partitions"?: Array<{
/**
* A cluster group name to include in this partition
*/
"clusterGroup"?: string;
/**
* Selector matching cluster group labels to include in this partition
*/
"clusterGroupSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
/**
* ClusterName is the name of a cluster to include in this partition
*/
"clusterName"?: string;
/**
* Selector matching cluster labels to include in this partition
*/
"clusterSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
/**
* A number or percentage of clusters that can be unavailable in this
* partition before this partition is treated as done.
* default: 10%
*/
"maxUnavailable"?: number | string;
/**
* A user-friendly name given to the partition used for Display (optional).
*/
"name"?: string;
}>;
};
/**
* ServiceAccount which will be used to perform this deployment.
*/
"serviceAccount"?: string;
/**
* TargetRestrictions is an allow list, which controls if a bundledeployment is created for a target.
*/
"targetRestrictions"?: Array<{
"clusterGroup"?: string;
/**
* A label selector is a label query over a set of resources. The result of matchLabels and
* matchExpressions are ANDed. An empty label selector matches all objects. A null
* label selector matches no objects.
*/
"clusterGroupSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
"clusterName"?: string;
/**
* A label selector is a label query over a set of resources. The result of matchLabels and
* matchExpressions are ANDed. An empty label selector matches all objects. A null
* label selector matches no objects.
*/
"clusterSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
"name"?: string;
}>;
/**
* Targets refer to the clusters which will be deployed to.
* Targets are evaluated in order and the first one to match is used.
*/
"targets"?: Array<{
/**
* ClusterGroup to match a specific cluster group by name.
*/
"clusterGroup"?: string;
/**
* ClusterGroupSelector is a selector to match cluster groups.
*/
"clusterGroupSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
/**
* ClusterName to match a specific cluster by name that will be
* selected
*/
"clusterName"?: string;
/**
* ClusterSelector is a selector to match clusters. The structure is
* the standard metav1.LabelSelector format. If clusterGroupSelector or
* clusterGroup is specified, clusterSelector will be used only to
* further refine the selection after clusterGroupSelector and
* clusterGroup is evaluated.
*/
"clusterSelector"?: {
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
"matchExpressions"?: Array<{
/**
* key is the label key that the selector applies to.
*/
"key": string;
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
"operator": string;
/**
* values is an array of string values. If the operator is In or NotIn,
* the values array must be non-empty. If the operator is Exists or DoesNotExist,
* the values array must be empty. This array is replaced during a strategic
* merge patch.
*/
"values"?: Array<string>;
}>;
/**
* matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
* map is equivalent to an element of matchExpressions, whose key field is "key", the
* operator is "In", and the values array contains only "value". The requirements are ANDed.
*/
"matchLabels"?: Record<string, string>;
};
/**
* CorrectDrift specifies how drift correction should work.
*/
"correctDrift"?: {
/**
* Enabled correct drift if true.
*/
"enabled"?: boolean;
/**
* Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.
*/
"force"?: boolean;
/**
* KeepFailHistory keeps track of failed rollbacks in the helm history.
*/
"keepFailHistory"?: boolean;
};
/**
* DefaultNamespace is the namespace to use for resources that do not
* specify a namespace. This field is not used to enforce or lock down
* the deployment to a specific namespace.
*/
"defaultNamespace"?: string;
/**
* DeleteCRDResources deletes CRDs. Warning! this will also delete all your Custom Resources.
*/
"deleteCRDResources"?: boolean;
/**
* DeleteNamespace can be used to delete the deployed namespace when removing the bundle
*/
"deleteNamespace"?: boolean;
/**
* Diff can be used to ignore the modified state of objects which are amended at runtime.
*/
"diff"?: {
/**
* ComparePatches match a resource and remove fields from the check for modifications.
*/
"comparePatches"?: Array<{
/**
* APIVersion is the apiVersion of the resource to match.
*/
"apiVersion"?: string;
/**
* JSONPointers ignore diffs at a certain JSON path.
*/
"jsonPointers"?: Array<string>;
/**
* Kind is the kind of the resource to match.
*/
"kind"?: string;
/**
* Name is the name of the resource to match.
*/
"name"?: string;
/**
* Namespace is the namespace of the resource to match.
*/
"namespace"?: string;
/**
* Operations remove a JSON path from the resource.
*/
"operations"?: Array<{
/**
* Op is usually "remove"
*/
"op"?: string;
/**
* Path is the JSON path to remove.
*/
"path"?: string;
/**
* Value is usually empty.
*/
"value"?: string;
}>;
}>;
};
/**
* DoNotDeploy if set to true, will not deploy to this target.
*/
"doNotDeploy"?: boolean;
/**
* ForceSyncGeneration is used to force a redeployment
*/
"forceSyncGeneration"?: number;
/**
* Helm options for the deployment, like the chart name, repo and values.
*/
"helm"?: {
/**
* Atomic sets the --atomic flag when Helm is performing an upgrade
*/
"atomic"?: boolean;
/**
* Chart can refer to any go-getter URL or OCI registry based helm
* chart URL. The chart will be downloaded.
*/
"chart"?: string;
/**
* DisableDNS can be used to customize Helm's EnableDNS option, which Fleet sets to `true` by default.
*/
"disableDNS"?: boolean;
/**
* DisableDependencyUpdate allows skipping chart dependencies update
*/
"disableDependencyUpdate"?: boolean;
/**
* DisablePreProcess disables template processing in values
*/
"disablePreProcess"?: boolean;
/**
* Force allows to override immutable resources. This could be dangerous.
*/
"force"?: boolean;
/**
* MaxHistory limits the maximum number of revisions saved per release by Helm.
*/
"maxHistory"?: number;
/**
* ReleaseName sets a custom release name to deploy the chart as. If
* not specified a release name will be generated by combining the
* invoking GitRepo.name + GitRepo.path.
* @maxLength 53
* @pattern ^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$
*/
"releaseName"?: string;
/**
* Repo is the name of the HTTPS helm repo to download the chart from.
*/
"repo"?: string;
/**
* SkipSchemaValidation allows skipping schema validation against the chart values
*/
"skipSchemaValidation"?: boolean;
/**
* TakeOwnership makes helm skip the check for its own annotations
*/
"takeOwnership"?: boolean;
/**
* TimeoutSeconds is the time to wait for Helm operations.
*/
"timeoutSeconds"?: number;
/**
* Values passed to Helm. It is possible to specify the keys and values
* as go template strings.
*/
"values"?: {};
/**
* ValuesFiles is a list of files to load values from.
*/
"valuesFiles"?: Array<string>;
/**
* ValuesFrom loads the values from configmaps and secrets.
*/
"valuesFrom"?: Array<{
/**
* The reference to a config map with release values.
*/
"configMapKeyRef"?: {
"key"?: string;
/**
* Name of a resource in the same namespace as the referent.
*/
"name"?: string;
"namespace"?: string;
};
/**
* The reference to a secret with release values.
*/
"secretKeyRef"?: {
"key"?: string;
/**
* Name of a resource in the same namespace as the referent.
*/
"name"?: string;
"namespace"?: string;
};
}>;
/**
* Version of the chart to download
*/
"version"?: string;
/**
* WaitForJobs if set and timeoutSeconds provided, will wait until all
* Jobs have been completed before marking the GitRepo as ready. It
* will wait for as long as timeoutSeconds
*/
"waitForJobs"?: boolean;
};
/**
* IgnoreOptions can be used to ignore fields when monitoring the bundle.
*/
"ignore"?: {
/**
* Conditions is a list of conditions to be ignored when monitoring the Bundle.
*/
"conditions"?: Array<Record<string, string>>;
};
/**
* KeepResources can be used to keep the deployed resources when removing the bundle
*/
"keepResources"?: boolean;
/**
* Kustomize options for the deployment, like the dir containing the
* kustomization.yaml file.
*/
"kustomize"?: {
/**
* Dir points to a custom folder for kustomize resources. This folder must contain
* a kustomization.yaml file.
*/
"dir"?: string;
};
/**
* Name of target. This value is largely for display and logging. If
* not specified a default name of the format "target000" will be used
*/
"name"?: string;
/**
* TargetNamespace if present will assign all resource to this
* namespace and if any cluster scoped resource exists the deployment
* will fail.
*/
"namespace"?: string;
/**
* NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.
*/
"namespaceAnnotations"?: Record<string, string>;
/**
* NamespaceLabels are labels that will be appended to the namespace created by Fleet.
*/
"namespaceLabels"?: Record<string, string>;
/**
* ServiceAccount which will be used to perform this deployment.
*/
"serviceAccount"?: string;
/**
* YAML options, if using raw YAML these are names that map to
* overlays/{name} files that will be used to replace or patch a resource.
*/
"yaml"?: {
/**
* Overlays is a list of names that maps to folders in "overlays/".
* If you wish to customize the file ./subdir/resource.yaml then a file
* ./overlays/myoverlay/subdir/resource.yaml will replace the base
* file.
* A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file.
*/
"overlays"?: Array<string>;
};
}>;
/**
* YAML options, if using raw YAML these are names that map to
* overlays/{name} files that will be used to replace or patch a resource.
*/
"yaml"?: {
/**
* Overlays is a list of names that maps to folders in "overlays/".
* If you wish to customize the file ./subdir/resource.yaml then a file
* ./overlays/myoverlay/subdir/resource.yaml will replace the base
* file.
* A file named ./overlays/myoverlay/subdir/resource_patch.yaml will patch the base file.
*/
"overlays"?: Array<string>;
};
};
"status"?: {
/**
* Conditions is a list of Wrangler conditions that describe the state
* of the bundle.
*/
"conditions"?: Array<{
/**
* Last time the condition transitioned from one status to another.
*/
"lastTransitionTime"?: string;
/**
* The last time this condition was updated.
*/
"lastUpdateTime"?: string;
/**
* Human-readable message indicating details about last transition
*/
"message"?: string;
/**
* The reason for the condition's last transition.
*/
"reason"?: string;
/**
* Status of the condition, one of True, False, Unknown.
*/
"status": string;
/**
* Type of cluster condition.
*/
"type": string;
}>;
/**
* Display contains the number of ready, desiredready clusters and a
* summary state for the bundle's resources.
*/
"display"?: {
/**
* ReadyClusters is a string in the form "%d/%d", that describes the
* number of clusters that are ready vs. the number of clusters desired
* to be ready.
*/
"readyClusters"?: string;
/**
* State is a summary state for the bundle, calculated over the non-ready resources.
*/
"state"?: string;
};
/**
* MaxNew is always 50. A bundle change can only stage 50
* bundledeployments at a time.
*/
"maxNew"?: number;
/**
* MaxUnavailable is the maximum number of unavailable deployments. See
* rollout configuration.
*/
"maxUnavailable"?: number;
/**
* MaxUnavailablePartitions is the maximum number of unavailable
* partitions. The rollout configuration defines a maximum number or
* percentage of unavailable partitions.
*/
"maxUnavailablePartitions"?: number;
/**
* NewlyCreated is the number of bundle deployments that have been created,
* not updated.
*/
"newlyCreated"?: number;
/**
* ObservedGeneration is the current generation of the bundle.
*/
"observedGeneration"?: number;
/**
* OCIReference is the OCI reference used to store contents, this is
* only for informational purposes.
*/
"ociReference"?: string;
/**
* PartitionStatus lists the status of each partition.
*/
"partitions"?: Array<{
/**
* Count is the number of clusters in the partition.
*/
"count"?: number;
/**
* MaxUnavailable is the maximum number of unavailable clusters in the partition.
*/
"maxUnavailable"?: number;
/**
* Name is the name of the partition.
*/
"name"?: string;
/**
* Summary is a summary state for the partition, calculated over its non-ready resources.
*/
"summary"?: {
/**
* DesiredReady is the number of bundle deployments that should be
* ready.
*/
"desiredReady"?: number;
/**
* ErrApplied is the number of bundle deployments that have been synced
* from the Fleet controller and the downstream cluster, but with some
* errors when deploying the bundle.
*/
"errApplied"?: number;
/**
* Modified is the number of bundle deployments that have been deployed
* and for which all resources are ready, but where some changes from the
* Git repository have not yet been synced.
*/
"modified"?: number;
/**
* NonReadyClusters is a list of states, which is filled for a bundle
* that is not ready.
*/
"nonReadyResources"?: Array<{
/**
* State is the state of the resource, like e.g. "NotReady" or "ErrApplied".
*/
"bundleState"?: string;
/**
* Message contains information why the bundle is not ready.
*/
"message"?: string;
/**
* ModifiedStatus lists the state for each modified resource.
*/
"modifiedStatus"?: Array<{
"apiVersion"?: string;
"delete"?: boolean;
"kind"?: string;
"missing"?: boolean;
"name"?: string;
"namespace"?: string;
"patch"?: string;
}>;
/**
* Name is the name of the resource.
*/
"name"?: string;
/**
* NonReadyStatus lists the state for each non-ready resource.
*/
"nonReadyStatus"?: Array<{
"apiVersion"?: string;
"kind"?: string;
"name"?: string;
"namespace"?: string;
"summary"?: {
"error"?: boolean;
"message"?: Array<string>;
"state"?: string;
"transitioning"?: boolean;
};
/**
* UID is a type that holds unique ID values, including UUIDs. Because we
* don't ONLY use UUIDs, this is an alias to string. Being a type captures
* intent and helps make sure that UIDs and names do not get conflated.
*/
"uid"?: string;
}>;
}>;
/**
* NotReady is the number of bundle deployments that have been deployed
* where some resources are not ready.
*/
"notReady"?: number;
/**
* OutOfSync is the number of bundle deployments that have been synced
* from Fleet controller, but not yet by the downstream agent.
*/
"outOfSync"?: number;
/**
* Pending is the number of bundle deployments that are being processed
* by Fleet controller.
*/
"pending"?: number;
/**
* Ready is the number of bundle deployments that have been deployed
* where all resources are ready.
*/
"ready"?: number;
/**
* WaitApplied is the number of bundle deployments that have been
* synced from Fleet controller and downstream cluster, but are waiting
* to be deployed.
*/
"waitApplied"?: number;
};
/**
* Unavailable is the number of unavailable clusters in the partition.
*/
"unavailable"?: number;
}>;
/**
* ResourceKey lists resources, which will likely be deployed. The
* actual list of resources on a cluster might differ, depending on the
* helm chart, value templating, etc..
*/
"resourceKey"?: Array<{
/**
* APIVersion is the k8s api version of the resource.
*/
"apiVersion"?: string;
/**
* Kind is the k8s api kind of the resource.
*/
"kind"?: string;
/**
* Name is the name of the resource.
*/
"name"?: string;
/**
* Namespace is the namespace of the resource.
*/
"namespace"?: string;
}>;
/**
* ResourcesSHA256Sum corresponds to the JSON serialization of the .Spec.Resources field
*/
"resourcesSha256Sum"?: string;
/**
* Summary contains the number of bundle deployments in each state and
* a list of non-ready resources.
*/
"summary"?: {
/**
* DesiredReady is the number of bundle deployments that should be
* ready.
*/
"desiredReady"?: number;
/**
* ErrApplied is the number of bundle deployments that have been synced
* from the Fleet controller and the downstream cluster, but with some
* errors when deploying the bundle.
*/
"errApplied"?: number;
/**
* Modified is the number of bundle deployments that have been deployed
* and for which all resources are ready, but where some changes from the
* Git repository have not yet been synced.
*/
"modified"?: number;
/**
* NonReadyClusters is a list of states, which is filled for a bundle
* that is not ready.
*/
"nonReadyResources"?: Array<{
/**
* State is the state of the resource, like e.g. "NotReady" or "ErrApplied".
*/
"bundleState"?: string;
/**
* Message contains information why the bundle is not ready.
*/
"message"?: string;
/**
* ModifiedStatus lists the state for each modified resource.
*/
"modifiedStatus"?: Array<{
"apiVersion"?: string;
"delete"?: boolean;
"kind"?: string;
"missing"?: boolean;
"name"?: string;
"namespace"?: string;
"patch"?: string;
}>;
/**
* Name is the name of the resource.
*/
"name"?: string;
/**
* NonReadyStatus lists the state for each non-ready resource.
*/
"nonReadyStatus"?: Array<{
"apiVersion"?: string;
"kind"?: string;
"name"?: string;
"namespace"?: string;
"summary"?: {
"error"?: boolean;
"message"?: Array<string>;
"state"?: string;
"transitioning"?: boolean;
};
/**
* UID is a type that holds unique ID values, including UUIDs. Because we
* don't ONLY use UUIDs, this is an alias to string. Being a type captures
* intent and helps make sure that UIDs and names do not get conflated.
*/
"uid"?: string;
}>;
}>;
/**
* NotReady is the number of bundle deployments that have been deployed
* where some resources are not ready.
*/
"notReady"?: number;
/**
* OutOfSync is the number of bundle deployments that have been synced
* from Fleet controller, but not yet by the downstream agent.
*/
"outOfSync"?: number;
/**
* Pending is the number of bundle deployments that are being processed
* by Fleet controller.
*/
"pending"?: number;
/**
* Ready is the number of bundle deployments that have been deployed
* where all resources are ready.
*/
"ready"?: number;
/**