@soft-stech/fleet
Version:
762 lines (761 loc) • 31.5 kB
JavaScript
import { z } from "zod";
import { iObjectMetaSchema } from "@soft-stech/apimachinery/apis/meta/v1/ObjectMeta.schema";
/**
* BundleDeployment is used internally by Fleet and should not be used directly.
* When a Bundle is deployed to a cluster an instance of a Bundle is called a
* BundleDeployment. A BundleDeployment represents the state of that Bundle on
* a specific cluster with its cluster-specific customizations. The Fleet agent
* is only aware of BundleDeployment resources that are created for the cluster
* the agent is managing.
*/
export const IBundleDeploymentSchema = z.object({
/**
* 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: z.literal("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: z.literal("BundleDeployment"),
metadata: iObjectMetaSchema.optional(),
spec: z
.object({
/**
* CorrectDrift specifies how drift correction should work.
*/
correctDrift: z
.object({
/**
* Enabled correct drift if true.
*/
enabled: z.boolean().optional(),
/**
* Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.
*/
force: z.boolean().optional(),
/**
* KeepFailHistory keeps track of failed rollbacks in the helm history.
*/
keepFailHistory: z.boolean().optional()
})
.optional(),
/**
* DependsOn refers to the bundles which must be ready before this bundle can be deployed.
*/
dependsOn: z
.array(z.object({
/**
* Name of the bundle.
*/
name: z.string().optional(),
/**
* Selector matching bundle's labels.
*/
selector: z
.object({
/**
* matchExpressions is a list of label selector requirements. The requirements are ANDed.
*/
matchExpressions: z
.array(z.object({
/**
* key is the label key that the selector applies to.
*/
key: z.string(),
/**
* operator represents a key's relationship to a set of values.
* Valid operators are In, NotIn, Exists and DoesNotExist.
*/
operator: z.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: z.array(z.string()).optional()
}))
.optional(),
/**
* 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: z.record(z.string(), z.string()).optional()
})
.optional()
}))
.optional(),
/**
* DeploymentID is the ID of the currently applied deployment.
*/
deploymentID: z.string().optional(),
/**
* OCIContents is true when this deployment's contents is stored in an oci registry
*/
ociContents: z.boolean().optional(),
/**
* Options are the deployment options, that are currently applied.
*/
options: z
.object({
/**
* CorrectDrift specifies how drift correction should work.
*/
correctDrift: z
.object({
/**
* Enabled correct drift if true.
*/
enabled: z.boolean().optional(),
/**
* Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.
*/
force: z.boolean().optional(),
/**
* KeepFailHistory keeps track of failed rollbacks in the helm history.
*/
keepFailHistory: z.boolean().optional()
})
.optional(),
/**
* 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: z.string().optional(),
/**
* DeleteCRDResources deletes CRDs. Warning! this will also delete all your Custom Resources.
*/
deleteCRDResources: z.boolean().optional(),
/**
* DeleteNamespace can be used to delete the deployed namespace when removing the bundle
*/
deleteNamespace: z.boolean().optional(),
/**
* Diff can be used to ignore the modified state of objects which are amended at runtime.
*/
diff: z
.object({
/**
* ComparePatches match a resource and remove fields from the check for modifications.
*/
comparePatches: z
.array(z.object({
/**
* APIVersion is the apiVersion of the resource to match.
*/
apiVersion: z.string().optional(),
/**
* JSONPointers ignore diffs at a certain JSON path.
*/
jsonPointers: z.array(z.string()).optional(),
/**
* Kind is the kind of the resource to match.
*/
kind: z.string().optional(),
/**
* Name is the name of the resource to match.
*/
name: z.string().optional(),
/**
* Namespace is the namespace of the resource to match.
*/
namespace: z.string().optional(),
/**
* Operations remove a JSON path from the resource.
*/
operations: z
.array(z.object({
/**
* Op is usually "remove"
*/
op: z.string().optional(),
/**
* Path is the JSON path to remove.
*/
path: z.string().optional(),
/**
* Value is usually empty.
*/
value: z.string().optional()
}))
.optional()
}))
.optional()
})
.optional(),
/**
* ForceSyncGeneration is used to force a redeployment
*/
forceSyncGeneration: z.number().optional(),
/**
* Helm options for the deployment, like the chart name, repo and values.
*/
helm: z
.object({
/**
* Atomic sets the --atomic flag when Helm is performing an upgrade
*/
atomic: z.boolean().optional(),
/**
* Chart can refer to any go-getter URL or OCI registry based helm
* chart URL. The chart will be downloaded.
*/
chart: z.string().optional(),
/**
* DisableDNS can be used to customize Helm's EnableDNS option, which Fleet sets to `true` by default.
*/
disableDNS: z.boolean().optional(),
/**
* DisableDependencyUpdate allows skipping chart dependencies update
*/
disableDependencyUpdate: z.boolean().optional(),
/**
* DisablePreProcess disables template processing in values
*/
disablePreProcess: z.boolean().optional(),
/**
* Force allows to override immutable resources. This could be dangerous.
*/
force: z.boolean().optional(),
/**
* MaxHistory limits the maximum number of revisions saved per release by Helm.
*/
maxHistory: z.number().optional(),
/**
* 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: z
.string()
.max(53)
.regex(/^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$/)
.optional(),
/**
* Repo is the name of the HTTPS helm repo to download the chart from.
*/
repo: z.string().optional(),
/**
* SkipSchemaValidation allows skipping schema validation against the chart values
*/
skipSchemaValidation: z.boolean().optional(),
/**
* TakeOwnership makes helm skip the check for its own annotations
*/
takeOwnership: z.boolean().optional(),
/**
* TimeoutSeconds is the time to wait for Helm operations.
*/
timeoutSeconds: z.number().optional(),
/**
* Values passed to Helm. It is possible to specify the keys and values
* as go template strings.
*/
values: z.object({}).optional(),
/**
* ValuesFiles is a list of files to load values from.
*/
valuesFiles: z.array(z.string()).optional(),
/**
* ValuesFrom loads the values from configmaps and secrets.
*/
valuesFrom: z
.array(z.object({
/**
* The reference to a config map with release values.
*/
configMapKeyRef: z
.object({
key: z.string().optional(),
/**
* Name of a resource in the same namespace as the referent.
*/
name: z.string().optional(),
namespace: z.string().optional()
})
.optional(),
/**
* The reference to a secret with release values.
*/
secretKeyRef: z
.object({
key: z.string().optional(),
/**
* Name of a resource in the same namespace as the referent.
*/
name: z.string().optional(),
namespace: z.string().optional()
})
.optional()
}))
.optional(),
/**
* Version of the chart to download
*/
version: z.string().optional(),
/**
* 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: z.boolean().optional()
})
.optional(),
/**
* IgnoreOptions can be used to ignore fields when monitoring the bundle.
*/
ignore: z
.object({
/**
* Conditions is a list of conditions to be ignored when monitoring the Bundle.
*/
conditions: z.array(z.record(z.string(), z.string())).optional()
})
.optional(),
/**
* KeepResources can be used to keep the deployed resources when removing the bundle
*/
keepResources: z.boolean().optional(),
/**
* Kustomize options for the deployment, like the dir containing the
* kustomization.yaml file.
*/
kustomize: z
.object({
/**
* Dir points to a custom folder for kustomize resources. This folder must contain
* a kustomization.yaml file.
*/
dir: z.string().optional()
})
.optional(),
/**
* TargetNamespace if present will assign all resource to this
* namespace and if any cluster scoped resource exists the deployment
* will fail.
*/
namespace: z.string().optional(),
/**
* NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.
*/
namespaceAnnotations: z.record(z.string(), z.string()).optional(),
/**
* NamespaceLabels are labels that will be appended to the namespace created by Fleet.
*/
namespaceLabels: z.record(z.string(), z.string()).optional(),
/**
* ServiceAccount which will be used to perform this deployment.
*/
serviceAccount: z.string().optional(),
/**
* 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: z
.object({
/**
* 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: z.array(z.string()).optional()
})
.optional()
})
.optional(),
/**
* Paused if set to true, will stop any BundleDeployments from being
* updated. If true, BundleDeployments will be marked as out of sync
* when changes are detected.
*/
paused: z.boolean().optional(),
/**
* StagedDeploymentID is the ID of the staged deployment.
*/
stagedDeploymentID: z.string().optional(),
/**
* StagedOptions are the deployment options, that are staged for
* the next deployment.
*/
stagedOptions: z
.object({
/**
* CorrectDrift specifies how drift correction should work.
*/
correctDrift: z
.object({
/**
* Enabled correct drift if true.
*/
enabled: z.boolean().optional(),
/**
* Force helm rollback with --force option will be used if true. This will try to recreate all resources in the release.
*/
force: z.boolean().optional(),
/**
* KeepFailHistory keeps track of failed rollbacks in the helm history.
*/
keepFailHistory: z.boolean().optional()
})
.optional(),
/**
* 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: z.string().optional(),
/**
* DeleteCRDResources deletes CRDs. Warning! this will also delete all your Custom Resources.
*/
deleteCRDResources: z.boolean().optional(),
/**
* DeleteNamespace can be used to delete the deployed namespace when removing the bundle
*/
deleteNamespace: z.boolean().optional(),
/**
* Diff can be used to ignore the modified state of objects which are amended at runtime.
*/
diff: z
.object({
/**
* ComparePatches match a resource and remove fields from the check for modifications.
*/
comparePatches: z
.array(z.object({
/**
* APIVersion is the apiVersion of the resource to match.
*/
apiVersion: z.string().optional(),
/**
* JSONPointers ignore diffs at a certain JSON path.
*/
jsonPointers: z.array(z.string()).optional(),
/**
* Kind is the kind of the resource to match.
*/
kind: z.string().optional(),
/**
* Name is the name of the resource to match.
*/
name: z.string().optional(),
/**
* Namespace is the namespace of the resource to match.
*/
namespace: z.string().optional(),
/**
* Operations remove a JSON path from the resource.
*/
operations: z
.array(z.object({
/**
* Op is usually "remove"
*/
op: z.string().optional(),
/**
* Path is the JSON path to remove.
*/
path: z.string().optional(),
/**
* Value is usually empty.
*/
value: z.string().optional()
}))
.optional()
}))
.optional()
})
.optional(),
/**
* ForceSyncGeneration is used to force a redeployment
*/
forceSyncGeneration: z.number().optional(),
/**
* Helm options for the deployment, like the chart name, repo and values.
*/
helm: z
.object({
/**
* Atomic sets the --atomic flag when Helm is performing an upgrade
*/
atomic: z.boolean().optional(),
/**
* Chart can refer to any go-getter URL or OCI registry based helm
* chart URL. The chart will be downloaded.
*/
chart: z.string().optional(),
/**
* DisableDNS can be used to customize Helm's EnableDNS option, which Fleet sets to `true` by default.
*/
disableDNS: z.boolean().optional(),
/**
* DisableDependencyUpdate allows skipping chart dependencies update
*/
disableDependencyUpdate: z.boolean().optional(),
/**
* DisablePreProcess disables template processing in values
*/
disablePreProcess: z.boolean().optional(),
/**
* Force allows to override immutable resources. This could be dangerous.
*/
force: z.boolean().optional(),
/**
* MaxHistory limits the maximum number of revisions saved per release by Helm.
*/
maxHistory: z.number().optional(),
/**
* 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: z
.string()
.max(53)
.regex(/^[a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*$/)
.optional(),
/**
* Repo is the name of the HTTPS helm repo to download the chart from.
*/
repo: z.string().optional(),
/**
* SkipSchemaValidation allows skipping schema validation against the chart values
*/
skipSchemaValidation: z.boolean().optional(),
/**
* TakeOwnership makes helm skip the check for its own annotations
*/
takeOwnership: z.boolean().optional(),
/**
* TimeoutSeconds is the time to wait for Helm operations.
*/
timeoutSeconds: z.number().optional(),
/**
* Values passed to Helm. It is possible to specify the keys and values
* as go template strings.
*/
values: z.object({}).optional(),
/**
* ValuesFiles is a list of files to load values from.
*/
valuesFiles: z.array(z.string()).optional(),
/**
* ValuesFrom loads the values from configmaps and secrets.
*/
valuesFrom: z
.array(z.object({
/**
* The reference to a config map with release values.
*/
configMapKeyRef: z
.object({
key: z.string().optional(),
/**
* Name of a resource in the same namespace as the referent.
*/
name: z.string().optional(),
namespace: z.string().optional()
})
.optional(),
/**
* The reference to a secret with release values.
*/
secretKeyRef: z
.object({
key: z.string().optional(),
/**
* Name of a resource in the same namespace as the referent.
*/
name: z.string().optional(),
namespace: z.string().optional()
})
.optional()
}))
.optional(),
/**
* Version of the chart to download
*/
version: z.string().optional(),
/**
* 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: z.boolean().optional()
})
.optional(),
/**
* IgnoreOptions can be used to ignore fields when monitoring the bundle.
*/
ignore: z
.object({
/**
* Conditions is a list of conditions to be ignored when monitoring the Bundle.
*/
conditions: z.array(z.record(z.string(), z.string())).optional()
})
.optional(),
/**
* KeepResources can be used to keep the deployed resources when removing the bundle
*/
keepResources: z.boolean().optional(),
/**
* Kustomize options for the deployment, like the dir containing the
* kustomization.yaml file.
*/
kustomize: z
.object({
/**
* Dir points to a custom folder for kustomize resources. This folder must contain
* a kustomization.yaml file.
*/
dir: z.string().optional()
})
.optional(),
/**
* TargetNamespace if present will assign all resource to this
* namespace and if any cluster scoped resource exists the deployment
* will fail.
*/
namespace: z.string().optional(),
/**
* NamespaceAnnotations are annotations that will be appended to the namespace created by Fleet.
*/
namespaceAnnotations: z.record(z.string(), z.string()).optional(),
/**
* NamespaceLabels are labels that will be appended to the namespace created by Fleet.
*/
namespaceLabels: z.record(z.string(), z.string()).optional(),
/**
* ServiceAccount which will be used to perform this deployment.
*/
serviceAccount: z.string().optional(),
/**
* 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: z
.object({
/**
* 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: z.array(z.string()).optional()
})
.optional()
})
.optional()
})
.optional(),
status: z
.object({
appliedDeploymentID: z.string().optional(),
conditions: z
.array(z.object({
/**
* Last time the condition transitioned from one status to another.
*/
lastTransitionTime: z.string().optional(),
/**
* The last time this condition was updated.
*/
lastUpdateTime: z.string().optional(),
/**
* Human-readable message indicating details about last transition
*/
message: z.string().optional(),
/**
* The reason for the condition's last transition.
*/
reason: z.string().optional(),
/**
* Status of the condition, one of True, False, Unknown.
*/
status: z.string(),
/**
* Type of cluster condition.
*/
type: z.string()
}))
.optional(),
display: z
.object({
deployed: z.string().optional(),
monitored: z.string().optional(),
state: z.string().optional()
})
.optional(),
modifiedStatus: z
.array(z.object({
apiVersion: z.string().optional(),
delete: z.boolean().optional(),
kind: z.string().optional(),
missing: z.boolean().optional(),
name: z.string().optional(),
namespace: z.string().optional(),
patch: z.string().optional()
}))
.optional(),
nonModified: z.boolean().optional(),
nonReadyStatus: z
.array(z.object({
apiVersion: z.string().optional(),
kind: z.string().optional(),
name: z.string().optional(),
namespace: z.string().optional(),
summary: z
.object({
error: z.boolean().optional(),
message: z.array(z.string()).optional(),
state: z.string().optional(),
transitioning: z.boolean().optional()
})
.optional(),
/**
* 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: z.string().optional()
}))
.optional(),
ready: z.boolean().optional(),
release: z.string().optional(),
/**
* Resources lists the metadata of resources that were deployed
* according to the helm release history.
*/
resources: z
.array(z.object({
apiVersion: z.string().optional(),
/**
*
* @format date-time
*/
createdAt: z.iso.datetime().optional().nullable(),
kind: z.string().optional(),
name: z.string().optional(),
namespace: z.string().optional()
}))
.optional(),
syncGeneration: z.number().optional()
})
.optional()
});