@kubernetes-models/flux-cd
Version:
132 lines (131 loc) • 6.4 kB
TypeScript
import { IComGithubFluxcdKustomizeControllerApiV1beta1Decryption } from "./Decryption.js";
import { IComGithubFluxcdPkgApisMetaNamespacedObjectReference } from "../../github.com/fluxcd/pkg/apis/meta/NamespacedObjectReference.js";
import { IComGithubFluxcdPkgApisMetaNamespacedObjectKindReference } from "../../github.com/fluxcd/pkg/apis/meta/NamespacedObjectKindReference.js";
import { IComGithubFluxcdPkgApisKustomizeImage } from "../../github.com/fluxcd/pkg/apis/kustomize/Image.js";
import { IComGithubFluxcdKustomizeControllerApiV1beta1KubeConfig } from "./KubeConfig.js";
import { IComGithubFluxcdPkgApisKustomizePatch } from "../../github.com/fluxcd/pkg/apis/kustomize/Patch.js";
import { IComGithubFluxcdPkgApisKustomizeJSON6902Patch } from "../../github.com/fluxcd/pkg/apis/kustomize/JSON6902Patch.js";
import { IIoK8sApiextensionsApiserverPkgApisApiextensionsV1JSON } from "kubernetes-models/apiextensions.k8s.io/v1/JSON";
import { IComGithubFluxcdKustomizeControllerApiV1beta1PostBuild } from "./PostBuild.js";
import { IComGithubFluxcdKustomizeControllerApiV1beta1CrossNamespaceSourceReference } from "./CrossNamespaceSourceReference.js";
import { ModelData, Model } from "@kubernetes-models/base";
/**
* KustomizationSpec defines the desired state of a kustomization.
*/
export interface IKustomizationSpec {
/**
* Decrypt Kubernetes secrets before applying them on the cluster.
*/
"decryption"?: IComGithubFluxcdKustomizeControllerApiV1beta1Decryption;
/**
* DependsOn may contain a meta.NamespacedObjectReference slice
* with references to Kustomization resources that must be ready before this
* Kustomization can be reconciled.
*/
"dependsOn"?: Array<IComGithubFluxcdPkgApisMetaNamespacedObjectReference>;
/**
* Force instructs the controller to recreate resources
* when patching fails due to an immutable field change.
*/
"force"?: boolean;
/**
* A list of resources to be included in the health assessment.
*/
"healthChecks"?: Array<IComGithubFluxcdPkgApisMetaNamespacedObjectKindReference>;
/**
* Images is a list of (image name, new name, new tag or digest)
* for changing image names, tags or digests. This can also be achieved with a
* patch, but this operator is simpler to specify.
*/
"images"?: Array<IComGithubFluxcdPkgApisKustomizeImage>;
"interval": string;
/**
* The KubeConfig for reconciling the Kustomization on a remote cluster.
* When specified, KubeConfig takes precedence over ServiceAccountName.
*/
"kubeConfig"?: IComGithubFluxcdKustomizeControllerApiV1beta1KubeConfig;
/**
* Strategic merge and JSON patches, defined as inline YAML objects,
* capable of targeting objects based on kind, label and annotation selectors.
*/
"patches"?: Array<IComGithubFluxcdPkgApisKustomizePatch>;
/**
* JSON 6902 patches, defined as inline YAML objects.
*/
"patchesJson6902"?: Array<IComGithubFluxcdPkgApisKustomizeJSON6902Patch>;
/**
* Strategic merge patches, defined as inline YAML objects.
*/
"patchesStrategicMerge"?: Array<IIoK8sApiextensionsApiserverPkgApisApiextensionsV1JSON>;
/**
* Path to the directory containing the kustomization.yaml file, or the
* set of plain YAMLs a kustomization.yaml should be generated for.
* Defaults to 'None', which translates to the root path of the SourceRef.
*/
"path"?: string;
/**
* PostBuild describes which actions to perform on the YAML manifest
* generated by building the kustomize overlay.
*/
"postBuild"?: IComGithubFluxcdKustomizeControllerApiV1beta1PostBuild;
/**
* Prune enables garbage collection.
*/
"prune": boolean;
"retryInterval"?: string;
/**
* The name of the Kubernetes service account to impersonate
* when reconciling this Kustomization.
*/
"serviceAccountName"?: string;
/**
* Reference of the source where the kustomization file is.
*/
"sourceRef": IComGithubFluxcdKustomizeControllerApiV1beta1CrossNamespaceSourceReference;
/**
* This flag tells the controller to suspend subsequent kustomize executions,
* it does not apply to already started executions. Defaults to false.
*/
"suspend"?: boolean;
/**
* TargetNamespace sets or overrides the namespace in the
* kustomization.yaml file.
*/
"targetNamespace"?: string;
"timeout"?: string;
/**
* Validate the Kubernetes objects before applying them on the cluster.
* The validation strategy can be 'client' (local dry-run), 'server'
* (APIServer dry-run) or 'none'.
* When 'Force' is 'true', validation will fallback to 'client' if set to
* 'server' because server-side validation is not supported in this scenario.
*/
"validation"?: "none" | "client" | "server";
}
/**
* KustomizationSpec defines the desired state of a kustomization.
*/
export declare class KustomizationSpec extends Model<IKustomizationSpec> implements IKustomizationSpec {
"decryption"?: IComGithubFluxcdKustomizeControllerApiV1beta1Decryption;
"dependsOn"?: Array<IComGithubFluxcdPkgApisMetaNamespacedObjectReference>;
"force"?: boolean;
"healthChecks"?: Array<IComGithubFluxcdPkgApisMetaNamespacedObjectKindReference>;
"images"?: Array<IComGithubFluxcdPkgApisKustomizeImage>;
"interval": string;
"kubeConfig"?: IComGithubFluxcdKustomizeControllerApiV1beta1KubeConfig;
"patches"?: Array<IComGithubFluxcdPkgApisKustomizePatch>;
"patchesJson6902"?: Array<IComGithubFluxcdPkgApisKustomizeJSON6902Patch>;
"patchesStrategicMerge"?: Array<IIoK8sApiextensionsApiserverPkgApisApiextensionsV1JSON>;
"path"?: string;
"postBuild"?: IComGithubFluxcdKustomizeControllerApiV1beta1PostBuild;
"prune": boolean;
"retryInterval"?: string;
"serviceAccountName"?: string;
"sourceRef": IComGithubFluxcdKustomizeControllerApiV1beta1CrossNamespaceSourceReference;
"suspend"?: boolean;
"targetNamespace"?: string;
"timeout"?: string;
"validation"?: "none" | "client" | "server";
constructor(data?: ModelData<IKustomizationSpec>);
}
export type { IKustomizationSpec as IComGithubFluxcdKustomizeControllerApiV1beta1KustomizationSpec, KustomizationSpec as ComGithubFluxcdKustomizeControllerApiV1beta1KustomizationSpec };