kubernetes-models
Version:
41 lines (40 loc) • 2.29 kB
TypeScript
import { ModelData, Model } from "@kubernetes-models/base";
/**
* PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
*
* It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
*/
export interface IPodResourceClaim {
/**
* Name uniquely identifies this resource claim inside the pod. This must be a DNS_LABEL.
*/
"name": string;
/**
* ResourceClaimName is the name of a ResourceClaim object in the same namespace as this pod.
*
* Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
*/
"resourceClaimName"?: string;
/**
* ResourceClaimTemplateName is the name of a ResourceClaimTemplate object in the same namespace as this pod.
*
* The template will be used to create a new ResourceClaim, which will be bound to this pod. When this pod is deleted, the ResourceClaim will also be deleted. The pod name and resource name, along with a generated component, will be used to form a unique name for the ResourceClaim, which will be recorded in pod.status.resourceClaimStatuses.
*
* This field is immutable and no changes will be made to the corresponding ResourceClaim by the control plane after creating the ResourceClaim.
*
* Exactly one of ResourceClaimName and ResourceClaimTemplateName must be set.
*/
"resourceClaimTemplateName"?: string;
}
/**
* PodResourceClaim references exactly one ResourceClaim, either directly or by naming a ResourceClaimTemplate which is then turned into a ResourceClaim for the pod.
*
* It adds a name to it that uniquely identifies the ResourceClaim inside the Pod. Containers that need access to the ResourceClaim reference it with this name.
*/
export declare class PodResourceClaim extends Model<IPodResourceClaim> implements IPodResourceClaim {
"name": string;
"resourceClaimName"?: string;
"resourceClaimTemplateName"?: string;
constructor(data?: ModelData<IPodResourceClaim>);
}
export { IPodResourceClaim as IIoK8sApiCoreV1PodResourceClaim, PodResourceClaim as IoK8sApiCoreV1PodResourceClaim };