Skip to content

tinkerbell.v1alpha1.hardware

"Hardware is the Schema for the Hardware API."

Index

Fields

fn new

new(name)

new returns an instance of Hardware

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"HardwareSpec defines the desired state of Hardware."

fn spec.withAgentID

withAgentID(agentID)

"AgentID is the unique identifier an Agent uses that is associated with this Hardware.\nThis is used to identify Hardware during the discovery and enrollment process.\nIt is typically the MAC address of the primary network interface."

fn spec.withDisks

withDisks(disks)

fn spec.withDisksMixin

withDisksMixin(disks)

Note: This function appends passed data to existing values

fn spec.withInterfaces

withInterfaces(interfaces)

fn spec.withInterfacesMixin

withInterfacesMixin(interfaces)

Note: This function appends passed data to existing values

fn spec.withReferences

withReferences(references)

"References allows for linking custom resource objects of any kind to this Hardware object.\nThese are available in Templates for templating. They are referenced by the name of the reference.\nFor example, given a reference with the name \"lvm\", you can access it in a template with .references.lvm."

fn spec.withReferencesMixin

withReferencesMixin(references)

"References allows for linking custom resource objects of any kind to this Hardware object.\nThese are available in Templates for templating. They are referenced by the name of the reference.\nFor example, given a reference with the name \"lvm\", you can access it in a template with .references.lvm."

Note: This function appends passed data to existing values

fn spec.withResources

withResources(resources)

"Resources represents known resources that are available on a machine.\nResources may be used for scheduling by orchestrators."

fn spec.withResourcesMixin

withResourcesMixin(resources)

"Resources represents known resources that are available on a machine.\nResources may be used for scheduling by orchestrators."

Note: This function appends passed data to existing values

fn spec.withTinkVersion

withTinkVersion(tinkVersion)

fn spec.withUserData

withUserData(userData)

"UserData is the user data to configure in the hardware's\nmetadata"

fn spec.withVendorData

withVendorData(vendorData)

"VendorData is the vendor data to configure in the hardware's\nmetadata"

obj spec.auto

"Auto is the configuration for the automatic capabilities."

fn spec.auto.withEnrollmentEnabled

withEnrollmentEnabled(enrollmentEnabled)

"EnrollmentEnabled enables automatic enrollment of the Hardware.\nWhen set to true, auto enrollment will create Workflows for this Hardware."

obj spec.bmcRef

"BMCRef contains a relation to a BMC state management type in the same\nnamespace as the Hardware. This may be used for BMC management by\norchestrators."

fn spec.bmcRef.withApiGroup

withApiGroup(apiGroup)

"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required."

fn spec.bmcRef.withKind

withKind(kind)

"Kind is the type of resource being referenced"

fn spec.bmcRef.withName

withName(name)

"Name is the name of resource being referenced"

obj spec.disks

fn spec.disks.withDevice

withDevice(device)

obj spec.interfaces

fn spec.interfaces.withDisableDhcp

withDisableDhcp(disableDhcp)

"DisableDHCP disables DHCP for this interface."

obj spec.interfaces.dhcp

"DHCP configuration."

fn spec.interfaces.dhcp.withArch

withArch(arch)

fn spec.interfaces.dhcp.withBoot_file_name

withBoot_file_name(boot_file_name)

"BootFileName is the boot file name (DHCP option 67).\nUsed for explicit boot file configuration, required by some network boot clients\nlike NVIDIA NVOS switches.\nIf specified, TFTPServerName must also be specified."

fn spec.interfaces.dhcp.withClassless_static_routes

withClassless_static_routes(classless_static_routes)

"ClasslessStaticRoutes defines static routes to be sent via DHCP option 121 (RFC 3442)."

fn spec.interfaces.dhcp.withClassless_static_routesMixin

withClassless_static_routesMixin(classless_static_routes)

"ClasslessStaticRoutes defines static routes to be sent via DHCP option 121 (RFC 3442)."

Note: This function appends passed data to existing values

fn spec.interfaces.dhcp.withDomain_name

withDomain_name(domain_name)

fn spec.interfaces.dhcp.withHostname

withHostname(hostname)

fn spec.interfaces.dhcp.withIface_name

withIface_name(iface_name)

fn spec.interfaces.dhcp.withLease_time

withLease_time(lease_time)

fn spec.interfaces.dhcp.withMac

withMac(mac)

fn spec.interfaces.dhcp.withName_servers

withName_servers(name_servers)

fn spec.interfaces.dhcp.withName_serversMixin

withName_serversMixin(name_servers)

Note: This function appends passed data to existing values

fn spec.interfaces.dhcp.withTftp_server_name

withTftp_server_name(tftp_server_name)

"TFTPServerName is the TFTP server name or IP address (DHCP option 66).\nUsed for explicit TFTP server configuration, required by some network boot clients\nlike NVIDIA NVOS switches.\nIf specified, BootFileName must also be specified."

fn spec.interfaces.dhcp.withTime_servers

withTime_servers(time_servers)

fn spec.interfaces.dhcp.withTime_serversMixin

withTime_serversMixin(time_servers)

Note: This function appends passed data to existing values

fn spec.interfaces.dhcp.withUefi

withUefi(uefi)

fn spec.interfaces.dhcp.withVlan_id

withVlan_id(vlan_id)

"validation pattern for VLANDID is a string number between 0-4096"

obj spec.interfaces.dhcp.classless_static_routes

"ClasslessStaticRoutes defines static routes to be sent via DHCP option 121 (RFC 3442)."

fn spec.interfaces.dhcp.classless_static_routes.withDestination_descriptor

withDestination_descriptor(destination_descriptor)

"DestinationDescriptor is the network address and prefix length.\nThe format is \"network/prefixlength\", e.g., \"192.168.1.0/24\" or \"10.0.0.0/8\"."

fn spec.interfaces.dhcp.classless_static_routes.withRouter

withRouter(router)

"Router is the IP address of the router for this route."

obj spec.interfaces.dhcp.ip

"IP configuration."

fn spec.interfaces.dhcp.ip.withAddress

withAddress(address)

fn spec.interfaces.dhcp.ip.withFamily

withFamily(family)

fn spec.interfaces.dhcp.ip.withGateway

withGateway(gateway)

fn spec.interfaces.dhcp.ip.withNetmask

withNetmask(netmask)

obj spec.interfaces.isoboot

"Isoboot configuration."

fn spec.interfaces.isoboot.withSourceISO

withSourceISO(sourceISO)

"SourceISO is the source url where HookOS, an Operating System Installation Environment (OSIE), ISO lives.\nIt must be a valid url.URL{} object and must have a url.URL{}.Scheme of HTTP or HTTPS."

obj spec.interfaces.netboot

"Netboot configuration."

fn spec.interfaces.netboot.withAllowPXE

withAllowPXE(allowPXE)

fn spec.interfaces.netboot.withAllowWorkflow

withAllowWorkflow(allowWorkflow)

obj spec.interfaces.netboot.ipxe

"IPXE configuration."

fn spec.interfaces.netboot.ipxe.withBinary

withBinary(binary)

"Binary, when defined, overrides Smee's default mapping of architecture to iPXE binary.\nThe following binary names are supported:\n- undionly.kpxe\n- ipxe.efi\n- snp-arm64.efi\n- snp-x86_64.efi\nSee the iPXE Architecture Mapping documentation for more details."

fn spec.interfaces.netboot.ipxe.withContents

withContents(contents)

fn spec.interfaces.netboot.ipxe.withUrl

withUrl(url)

obj spec.interfaces.netboot.osie

"OSIE configuration."

fn spec.interfaces.netboot.osie.withBaseURL

withBaseURL(baseURL)

fn spec.interfaces.netboot.osie.withInitrd

withInitrd(initrd)

fn spec.interfaces.netboot.osie.withKernel

withKernel(kernel)

obj spec.metadata

fn spec.metadata.withBonding_mode

withBonding_mode(bonding_mode)

fn spec.metadata.withState

withState(state)

obj spec.metadata.custom

fn spec.metadata.custom.withPrivate_subnets

withPrivate_subnets(private_subnets)

fn spec.metadata.custom.withPrivate_subnetsMixin

withPrivate_subnetsMixin(private_subnets)

Note: This function appends passed data to existing values

obj spec.metadata.custom.preinstalled_operating_system_version

fn spec.metadata.custom.preinstalled_operating_system_version.withDistro

withDistro(distro)

fn spec.metadata.custom.preinstalled_operating_system_version.withImage_tag

withImage_tag(image_tag)

fn spec.metadata.custom.preinstalled_operating_system_version.withOs_slug

withOs_slug(os_slug)

fn spec.metadata.custom.preinstalled_operating_system_version.withSlug

withSlug(slug)

fn spec.metadata.custom.preinstalled_operating_system_version.withVersion

withVersion(version)

obj spec.metadata.facility

fn spec.metadata.facility.withFacility_code

withFacility_code(facility_code)

fn spec.metadata.facility.withPlan_slug

withPlan_slug(plan_slug)

fn spec.metadata.facility.withPlan_version_slug

withPlan_version_slug(plan_version_slug)

obj spec.metadata.instance

fn spec.metadata.instance.withAllow_pxe

withAllow_pxe(allow_pxe)

fn spec.metadata.instance.withAlways_pxe

withAlways_pxe(always_pxe)

fn spec.metadata.instance.withCrypted_root_password

withCrypted_root_password(crypted_root_password)

fn spec.metadata.instance.withHostname

withHostname(hostname)

fn spec.metadata.instance.withId

withId(id)

fn spec.metadata.instance.withIps

withIps(ips)

fn spec.metadata.instance.withIpsMixin

withIpsMixin(ips)

Note: This function appends passed data to existing values

fn spec.metadata.instance.withIpxe_script_url

withIpxe_script_url(ipxe_script_url)

fn spec.metadata.instance.withNetwork_ready

withNetwork_ready(network_ready)

fn spec.metadata.instance.withRescue

withRescue(rescue)

fn spec.metadata.instance.withSsh_keys

withSsh_keys(ssh_keys)

fn spec.metadata.instance.withSsh_keysMixin

withSsh_keysMixin(ssh_keys)

Note: This function appends passed data to existing values

fn spec.metadata.instance.withState

withState(state)

fn spec.metadata.instance.withTags

withTags(tags)

fn spec.metadata.instance.withTagsMixin

withTagsMixin(tags)

Note: This function appends passed data to existing values

fn spec.metadata.instance.withUserdata

withUserdata(userdata)

obj spec.metadata.instance.ips

fn spec.metadata.instance.ips.withAddress

withAddress(address)

fn spec.metadata.instance.ips.withFamily

withFamily(family)

fn spec.metadata.instance.ips.withGateway

withGateway(gateway)

fn spec.metadata.instance.ips.withManagement

withManagement(management)

fn spec.metadata.instance.ips.withNetmask

withNetmask(netmask)

fn spec.metadata.instance.ips.withPublic

withPublic(public)

obj spec.metadata.instance.operating_system

fn spec.metadata.instance.operating_system.withDistro

withDistro(distro)

fn spec.metadata.instance.operating_system.withImage_tag

withImage_tag(image_tag)

fn spec.metadata.instance.operating_system.withOs_slug

withOs_slug(os_slug)

fn spec.metadata.instance.operating_system.withSlug

withSlug(slug)

fn spec.metadata.instance.operating_system.withVersion

withVersion(version)

obj spec.metadata.instance.storage

fn spec.metadata.instance.storage.withDisks

withDisks(disks)

fn spec.metadata.instance.storage.withDisksMixin

withDisksMixin(disks)

Note: This function appends passed data to existing values

fn spec.metadata.instance.storage.withFilesystems

withFilesystems(filesystems)

fn spec.metadata.instance.storage.withFilesystemsMixin

withFilesystemsMixin(filesystems)

Note: This function appends passed data to existing values

fn spec.metadata.instance.storage.withRaid

withRaid(raid)

fn spec.metadata.instance.storage.withRaidMixin

withRaidMixin(raid)

Note: This function appends passed data to existing values

obj spec.metadata.instance.storage.disks

fn spec.metadata.instance.storage.disks.withDevice

withDevice(device)

fn spec.metadata.instance.storage.disks.withPartitions

withPartitions(partitions)

fn spec.metadata.instance.storage.disks.withPartitionsMixin

withPartitionsMixin(partitions)

Note: This function appends passed data to existing values

fn spec.metadata.instance.storage.disks.withWipe_table

withWipe_table(wipe_table)

obj spec.metadata.instance.storage.disks.partitions

fn spec.metadata.instance.storage.disks.partitions.withLabel

withLabel(label)

fn spec.metadata.instance.storage.disks.partitions.withNumber

withNumber(number)

fn spec.metadata.instance.storage.disks.partitions.withSize

withSize(size)

fn spec.metadata.instance.storage.disks.partitions.withStart

withStart(start)

fn spec.metadata.instance.storage.disks.partitions.withType_guid

withType_guid(type_guid)

obj spec.metadata.instance.storage.filesystems

obj spec.metadata.instance.storage.filesystems.mount

fn spec.metadata.instance.storage.filesystems.mount.withDevice

withDevice(device)

fn spec.metadata.instance.storage.filesystems.mount.withFiles

withFiles(files)

fn spec.metadata.instance.storage.filesystems.mount.withFilesMixin

withFilesMixin(files)

Note: This function appends passed data to existing values

fn spec.metadata.instance.storage.filesystems.mount.withFormat

withFormat(format)

fn spec.metadata.instance.storage.filesystems.mount.withPoint

withPoint(point)

obj spec.metadata.instance.storage.filesystems.mount.create

fn spec.metadata.instance.storage.filesystems.mount.create.withForce

withForce(force)

fn spec.metadata.instance.storage.filesystems.mount.create.withOptions

withOptions(options)

fn spec.metadata.instance.storage.filesystems.mount.create.withOptionsMixin

withOptionsMixin(options)

Note: This function appends passed data to existing values

obj spec.metadata.instance.storage.filesystems.mount.files

fn spec.metadata.instance.storage.filesystems.mount.files.withContents

withContents(contents)

fn spec.metadata.instance.storage.filesystems.mount.files.withGid

withGid(gid)

fn spec.metadata.instance.storage.filesystems.mount.files.withMode

withMode(mode)

fn spec.metadata.instance.storage.filesystems.mount.files.withPath

withPath(path)

fn spec.metadata.instance.storage.filesystems.mount.files.withUid

withUid(uid)

obj spec.metadata.instance.storage.raid

fn spec.metadata.instance.storage.raid.withDevices

withDevices(devices)

fn spec.metadata.instance.storage.raid.withDevicesMixin

withDevicesMixin(devices)

Note: This function appends passed data to existing values

fn spec.metadata.instance.storage.raid.withLevel

withLevel(level)

fn spec.metadata.instance.storage.raid.withName

withName(name)

fn spec.metadata.instance.storage.raid.withSpare

withSpare(spare)

obj spec.metadata.manufacturer

fn spec.metadata.manufacturer.withId

withId(id)

fn spec.metadata.manufacturer.withSlug

withSlug(slug)