struct Kubernetes::ResourceClaim

Overview

ResourceClaim describes a request for access to resources in the cluster, for use by workloads. For example, if a workload needs an accelerator device with specific properties, this is how that request is expressed. The status stanza tracks whether this claim has been satisfied and what specific resources have been allocated. This is an alpha type and requires enabling the DynamicResourceAllocation feature gate.

Included Modules

Defined in:

generated/models/io_k8s_api_core_v1.cr
generated/models/io_k8s_api_resource_v1.cr
generated/models/io_k8s_api_resource_v1beta1.cr
generated/models/io_k8s_api_resource_v1beta2.cr

Constructors

Macro Summary

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(pull : ::JSON::PullParser) #

def self.new(*, __pull_for_json_serializable pull : ::JSON::PullParser) #

def self.new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node) #

Macro Detail

macro field(name, type = nil, **options, &block) #

Helper macro for defining fields with automatic camelCase conversion


Instance Method Detail

def api_version : String | Nil #

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


def api_version=(api_version : String | Nil) #

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


def kind : String | Nil #

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


def kind=(kind : String | Nil) #

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


def metadata : ObjectMeta | Nil #

Standard object metadata


def metadata=(metadata : ObjectMeta | Nil) #

Standard object metadata


def name : String | Nil #

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.


def name=(name : String | Nil) #

Name must match the name of one entry in pod.spec.resourceClaims of the Pod where this field is used. It makes that resource available inside a container.


def request : String | Nil #

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.


def request=(request : String | Nil) #

Request is the name chosen for a request in the referenced claim. If empty, everything from the claim is made available, otherwise only the result of this request.


def spec : ResourceClaimSpec | Nil #

Spec describes what is being requested and how to configure it. The spec is immutable.


def spec=(spec : ResourceClaimSpec | Nil) #

Spec describes what is being requested and how to configure it. The spec is immutable.


def status : ResourceClaimStatus | Nil #

Status describes whether the claim is ready to use and what has been allocated.


def status=(status : ResourceClaimStatus | Nil) #

Status describes whether the claim is ready to use and what has been allocated.