K8sManifestResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Kind v13.5.1-beta.895

interface K8sManifestResource
  extends IResource,
    IResourceWithParent,
    KindClusterResource]],
    IResourceWithWaitSupport {
  applyTimeout: timespan;
  clusterReadyTimeout: timespan;
  crdWaitBehavior: CrdWaitBehavior;
  crdWaitTimeout: timespan;
  fieldManager: string;
  forceConflicts: boolean;
  inlineContent: string;
  isKustomize: boolean;
  readonly manifestPath: string;
  namespace: string;
  recursive: boolean;
  serverSide: boolean;
  withApplyTimeout(timeout: timespan): K8sManifestResource;
  withClusterReadyTimeout(timeout: timespan): K8sManifestResource;
  withCrdWaitBehavior(behavior: CrdWaitBehavior): K8sManifestResource;
  withCrdWaitTimeout(timeout: timespan): K8sManifestResource;
  withFieldManager(fieldManager: string): K8sManifestResource;
  withRecursive(): K8sManifestResource;
  withServerSideApply(forceConflicts?: boolean): K8sManifestResource;
}

30 members

Properties

propertyapplyTimeouttimespanget · set

Gets or sets the maximum time to wait for `kubectl apply` to complete.

propertyclusterReadyTimeouttimespanget · set

Gets or sets the maximum time to wait for the Kubernetes API to become reachable before running `kubectl apply`.

propertycrdWaitBehaviorCrdWaitBehaviorget · set

Gets or sets how CRD wait failures are handled.

propertycrdWaitTimeouttimespanget · set

Gets or sets the maximum time to wait for applied CRDs to reach the `Established` condition.

propertyfieldManagerstringget · set

Gets the field manager name used with server-side apply (maps to `kubectl apply --field-manager`). When `null`, kubectl uses its default (`kubectl`).

propertyforceConflictsbooleanget · set

Gets or sets whether to force conflicts on server-side apply (maps to `kubectl apply --server-side --force-conflicts`). Only meaningful when `ServerSide` is `true`.

propertyinlineContentstringget · set

Gets or sets inline manifest content applied with `kubectl apply -f -`.

propertyisKustomizebooleanget · set

Gets or sets whether this resource represents a Kustomize overlay directory.

propertymanifestPathstringget

Gets the manifest path passed to `kubectl apply`. Accepts an absolute file path, an absolute directory path, or `<inline>` for standard input.

propertynamespacestringget · set

Gets or sets the Kubernetes namespace for the deployment. When `null`, the Helm default namespace is used.

propertyrecursivebooleanget · set

Gets or sets whether to recursively apply manifests in subdirectories (maps to `kubectl apply --recursive`). Only meaningful when `ManifestPath` is a directory.

propertyserverSidebooleanget · set

Gets or sets whether to apply the manifest server-side (maps to `kubectl apply --server-side`). Server-side apply is required for large CRDs that exceed the client-side annotation size limit.

Methods

methodwithApplyTimeoutbuilder

Sets the maximum time to wait for `kubectl apply` to complete.

withApplyTimeout(timeout: timespan): K8sManifestResource

Parameters

timeouttimespan

Returns

K8sManifestResource

methodwithClusterReadyTimeoutbuilder

Sets the maximum time to wait for the Kubernetes API to become reachable before running `kubectl apply`.

withClusterReadyTimeout(timeout: timespan): K8sManifestResource

Parameters

timeouttimespan

Returns

K8sManifestResource

methodwithCrdWaitBehaviorbuilder

Sets whether CRD wait failures fail the manifest resource or are logged as best-effort warnings.

withCrdWaitBehavior(behavior: CrdWaitBehavior): K8sManifestResource

Parameters

behaviorCrdWaitBehavior

Returns

K8sManifestResource

methodwithCrdWaitTimeoutbuilder

Sets the maximum time to wait for applied CRDs to reach the `Established` condition.

withCrdWaitTimeout(timeout: timespan): K8sManifestResource

Parameters

timeouttimespan

Returns

K8sManifestResource

methodwithFieldManagerbuilder

Sets the field manager name passed to `kubectl apply --field-manager`.

withFieldManager(fieldManager: string): K8sManifestResource

Parameters

fieldManagerstring

Returns

K8sManifestResource

methodwithRecursivebuilder

Recursively applies manifests from subdirectories (maps to `kubectl apply --recursive`). Only meaningful when the manifest path is a directory.

withRecursive(): K8sManifestResource

Returns

K8sManifestResource

methodwithServerSideApplybuilder

Applies the manifest server-side (maps to `kubectl apply --server-side`). Required for large CRDs that exceed the client-side annotation size limit.

withServerSideApply(forceConflicts?: boolean): K8sManifestResource

Parameters

forceConflictsbooleanoptional= False

Returns

K8sManifestResource