- description:Time duration since creation of Metal3IPAddress
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1alpha1
schema:
openAPIV3Schema:
description:IPAddress is the Schema for the ipaddresses API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:IPAddressSpec defines the desired state of IPAddress.
- description:Time duration since creation of Metal3IPClaim
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1alpha1
schema:
openAPIV3Schema:
description:IPClaim is the Schema for the ipclaims API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:IPClaimSpec defines the desired state of IPClaim.
properties:
pool:
description:Pool is the IPPool this was generated from.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
required:
- pool
type:object
status:
description:IPClaimStatus defines the observed state of IPClaim.
properties:
address:
description:Address is the IPAddress that was generated for this
claim.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
errorMessage:
description:ErrorMessage contains the error message
- description:Time duration since creation of Metal3IPPool
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1alpha1
schema:
openAPIV3Schema:
description:IPPool is the Schema for the ippools API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:IPPoolSpec defines the desired state of IPPool.
properties:
clusterName:
description:ClusterName is the name of the Cluster this object belongs
to.
type:string
dnsServers:
description:DNSServers is the list of dns servers
items:
description:IPAddress is used for validation of an IP address.
description:Metal3Cluster is the Schema for the metal3clusters API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3ClusterSpec defines the desired state of Metal3Cluster.
properties:
controlPlaneEndpoint:
description:ControlPlaneEndpoint represents the endpoint used to
communicate with the control plane.
properties:
host:
description:Host is the hostname on which the API server is serving.
type:string
port:
description:Port is the port on which the API server is serving.
type:integer
required:
- host
- port
type:object
noCloudProvider:
description:Determines if the cluster is not to be deployed with
an external cloud provider. If set to true, CAPM3 will use node
labels to set providerID on the kubernetes nodes. If set to false,
providerID is set on nodes by other entities and CAPM3 uses the
value of the providerID on the m3m resource.
type:boolean
type:object
status:
description:Metal3ClusterStatus defines the observed state of Metal3Cluster.
properties:
conditions:
description:Conditions defines current service state of the Metal3Cluster.
items:
description:Condition defines an observation of a Cluster API resource
operational state.
properties:
lastTransitionTime:
description:Last time the condition transitioned from one status
to another. This should be when the underlying condition changed.
If that is not known, then using the time when the API field
changed is acceptable.
format:date-time
type:string
message:
description:A human readable message indicating details about
the transition. This field may be empty.
type:string
reason:
description:The reason for the condition's last transition
in CamelCase. The specific API may choose whether or not this
field is considered a guaranteed API. This field may not be
empty.
type:string
severity:
description:Severity provides an explicit classification of
Reason code, so the users or machines can immediately understand
the current situation and act accordingly. The Severity field
MUST be set only when Status=False.
type:string
status:
description:Status of the condition, one of True, False, Unknown.
type:string
type:
description:Type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important.
type:string
required:
- lastTransitionTime
- status
- type
type:object
type:array
failureMessage:
description:FailureMessage indicates that there is a fatal problem
reconciling the state, and will be set to a descriptive error message.
type:string
failureReason:
description:FailureReason indicates that there is a fatal problem
reconciling the state, and will be set to a token value suitable
for programmatic interpretation.
type:string
lastUpdated:
description:LastUpdated identifies when this status was last observed.
format:date-time
type:string
ready:
description:Ready denotes that the Metal3 cluster (infrastructure)
is ready. In Baremetal case, it does not mean anything for now as
noinfrastructure steps need to be performed. Required by Cluster
API. Set to True by the metal3Cluster controller after creation.
- description:Time duration since creation of Metal3DataClaim
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:Metal3DataClaim is the Schema for the metal3datas API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3DataClaimSpec defines the desired state of Metal3DataClaim.
properties:
template:
description:Template is the Metal3DataTemplate this was generated
for.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
required:
- template
type:object
status:
description:Metal3DataClaimStatus defines the observed state of Metal3DataClaim.
properties:
errorMessage:
description:ErrorMessage contains the error message
type:string
renderedData:
description:RenderedData references the Metal3Data when ready
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
- description:Time duration since creation of Metal3Data
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:Metal3Data is the Schema for the metal3datas API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3DataSpec defines the desired state of Metal3Data.
properties:
claim:
description:DataClaim points to the Metal3DataClaim the Metal3Data
was created for.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
index:
description:Index stores the index value of this instance in the
Metal3DataTemplate.
type:integer
metaData:
description:MetaData points to the rendered MetaData secret.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
networkData:
description:NetworkData points to the rendered NetworkData secret.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
template:
description:DataTemplate is the Metal3DataTemplate this was generated
from.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
templateReference:
description:TemplateReference refers to the Template the Metal3MachineTemplate
refers to. It can be matched against the key or it may also point
to the name of the template Metal3Data refers to
type:string
required:
- claim
- template
type:object
status:
description:Metal3DataStatus defines the observed state of Metal3Data.
properties:
errorMessage:
description:ErrorMessage contains the error message
type:string
ready:
description:Ready is a flag set to True if the secrets were rendered
- description:Time duration since creation of Metal3DataTemplate
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:Metal3DataTemplate is the Schema for the metal3datatemplates
API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3DataTemplateSpec defines the desired state of Metal3DataTemplate.
properties:
clusterName:
description:ClusterName is the name of the Cluster this object belongs
to.
minLength:1
type:string
metaData:
description:MetaData contains the information needed to generate
the metadata secret
properties:
dnsServersFromIPPool:
description:DNSServersFromPool is the list of metadata items
to be rendered as dns servers.
items:
properties:
apiGroup:
description:APIGroup is the api group of the IP pool.
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
kind:
description:Kind is the kind of the IP pool
type:string
name:
description:Name is the name of the IP pool used to fetch
the value to set in the metadata map for cloud-init
type:string
required:
- apiGroup
- key
- kind
- name
type:object
type:array
fromAnnotations:
description:FromAnnotations is the list of metadata items to
be fetched from object Annotations
items:
description:MetaDataFromAnnotation contains the information
to fetch an annotation content, if the label does not exist,
it is rendered as empty string.
properties:
annotation:
description:Annotation is the key of the Annotation to
fetch
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
object:
description:Object is the type of the object from which
we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- annotation
- key
- object
type:object
type:array
fromHostInterfaces:
description:FromHostInterfaces is the list of metadata items
to be rendered as MAC addresses of the host interfaces.
items:
description:MetaDataHostInterface contains the information
to render the object name.
properties:
interface:
description:Interface is the name of the interface in the
BareMetalHost Status Hardware Details list of interfaces
from which to fetch the MAC address.
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
required:
- interface
- key
type:object
type:array
fromLabels:
description:FromLabels is the list of metadata items to be fetched
from object labels
items:
description:MetaDataFromLabel contains the information to fetch
a label content, if the label does not exist, it is rendered
as empty string.
properties:
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
label:
description:Label is the key of the label to fetch
type:string
object:
description:Object is the type of the object from which
we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- key
- label
- object
type:object
type:array
gatewaysFromIPPool:
description:GatewaysFromPool is the list of metadata items to
be rendered as gateway addresses.
items:
properties:
apiGroup:
description:APIGroup is the api group of the IP pool.
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
kind:
description:Kind is the kind of the IP pool
type:string
name:
description:Name is the name of the IP pool used to fetch
the value to set in the metadata map for cloud-init
type:string
required:
- apiGroup
- key
- kind
- name
type:object
type:array
indexes:
description:Indexes is the list of metadata items to be rendered
from the index of the Metal3Data
items:
description:MetaDataIndex contains the information to render
the index.
properties:
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
offset:
description:Offset is the offset to apply to the index
when rendering it
type:integer
prefix:
description:Prefix is the prefix string
type:string
step:
default:1
description:Step is the multiplier of the index
type:integer
suffix:
description:Suffix is the suffix string
type:string
required:
- key
type:object
type:array
ipAddressesFromIPPool:
description:IPAddressesFromPool is the list of metadata items
to be rendered as ip addresses.
items:
properties:
apiGroup:
description:APIGroup is the api group of the IP pool.
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
kind:
description:Kind is the kind of the IP pool
type:string
name:
description:Name is the name of the IP pool used to fetch
the value to set in the metadata map for cloud-init
type:string
required:
- apiGroup
- key
- kind
- name
type:object
type:array
namespaces:
description:Namespaces is the list of metadata items to be rendered
from the namespace
items:
description:MetaDataNamespace contains the information to render
the namespace.
properties:
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
required:
- key
type:object
type:array
objectNames:
description:ObjectNames is the list of metadata items to be rendered
from the name of objects.
items:
description:MetaDataObjectName contains the information to
render the object name.
properties:
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
object:
description:Object is the type of the object from which
we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- key
- object
type:object
type:array
prefixesFromIPPool:
description:PrefixesFromPool is the list of metadata items to
be rendered as network prefixes.
items:
properties:
apiGroup:
description:APIGroup is the api group of the IP pool.
type:string
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
kind:
description:Kind is the kind of the IP pool
type:string
name:
description:Name is the name of the IP pool used to fetch
the value to set in the metadata map for cloud-init
type:string
required:
- apiGroup
- key
- kind
- name
type:object
type:array
strings:
description:Strings is the list of metadata items to be rendered
from strings
items:
description:MetaDataString contains the information to render
the string.
properties:
key:
description:Key will be used as the key to set in the metadata
map for cloud-init
type:string
value:
description:Value is the string to render.
type:string
required:
- key
- value
type:object
type:array
type:object
networkData:
description:NetworkData contains the information needed to generate
the networkdata secret
properties:
links:
description:Links is a structure containing lists of different
types objects
properties:
bonds:
description:Bonds contains a list of Bond links
items:
description:NetworkDataLinkBond represents a bond link
object.
properties:
bondLinks:
description:BondLinks is the list of links that are
part of the bond.
items:
type:string
type:array
bondMode:
description:BondMode is the mode of bond used. It can
be one of balance-rr, active-backup, balance-xor,
broadcast, balance-tlb, balance-alb, 802.3ad
enum:
- balance-rr
- active-backup
- balance-xor
- broadcast
- balance-tlb
- balance-alb
- 802.3ad
type:string
bondXmitHashPolicy:
description:Selects the transmit hash policy used for
port selection in balance-xor and 802.3ad modes
enum:
- layer2
- layer3+4
- layer2+3
type:string
id:
description:Id is the ID of the interface (used for
naming)
type:string
macAddress:
description:MACAddress is the MAC address of the interface,
containing the object used to render it.
properties:
fromAnnotation:
description:FromAnnotation references an object
Annotation to retrieve the MAC address from
properties:
annotation:
description:Annotation is the key of the Annotation
to fetch
type:string
object:
description:Object is the type of the object
from which we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- annotation
- object
type:object
fromHostInterface:
description:FromHostInterface contains the name
of the interface in the BareMetalHost Introspection
details from which to fetch the MAC address
type:string
string:
description:String contains the MAC address given
as a string
type:string
type:object
mtu:
default:1500
description:MTU is the MTU of the interface
maximum:9000
type:integer
required:
- bondMode
- id
- macAddress
type:object
type:array
ethernets:
description:Ethernets contains a list of Ethernet links
items:
description:NetworkDataLinkEthernet represents an ethernet
link object.
properties:
id:
description:Id is the ID of the interface (used for
naming)
type:string
macAddress:
description:MACAddress is the MAC address of the interface,
containing the object used to render it.
properties:
fromAnnotation:
description:FromAnnotation references an object
Annotation to retrieve the MAC address from
properties:
annotation:
description:Annotation is the key of the Annotation
to fetch
type:string
object:
description:Object is the type of the object
from which we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- annotation
- object
type:object
fromHostInterface:
description:FromHostInterface contains the name
of the interface in the BareMetalHost Introspection
details from which to fetch the MAC address
type:string
string:
description:String contains the MAC address given
as a string
type:string
type:object
mtu:
default:1500
description:MTU is the MTU of the interface
maximum:9000
type:integer
type:
description:'Type is the type of the ethernet link.
It can be one of:bridge, dvs, hw_veb, hyperv, ovs,
tap, vhostuser, vif, phy'
enum:
- bridge
- dvs
- hw_veb
- hyperv
- ovs
- tap
- vhostuser
- vif
- phy
type:string
required:
- id
- macAddress
- type
type:object
type:array
vlans:
description:Vlans contains a list of Vlan links
items:
description:NetworkDataLinkVlan represents a vlan link
object.
properties:
id:
description:Id is the ID of the interface (used for
naming)
type:string
macAddress:
description:MACAddress is the MAC address of the interface,
containing the object used to render it.
properties:
fromAnnotation:
description:FromAnnotation references an object
Annotation to retrieve the MAC address from
properties:
annotation:
description:Annotation is the key of the Annotation
to fetch
type:string
object:
description:Object is the type of the object
from which we retrieve the name
enum:
- machine
- metal3machine
- baremetalhost
type:string
required:
- annotation
- object
type:object
fromHostInterface:
description:FromHostInterface contains the name
of the interface in the BareMetalHost Introspection
details from which to fetch the MAC address
type:string
string:
description:String contains the MAC address given
as a string
type:string
type:object
mtu:
default:1500
description:MTU is the MTU of the interface
maximum:9000
type:integer
vlanID:
description:VlanID is the Vlan ID
maximum:4096
type:integer
vlanLink:
description:VlanLink is the name of the link on which
the vlan should be added
type:string
required:
- id
- macAddress
- vlanID
- vlanLink
type:object
type:array
type:object
networks:
description:Networks is a structure containing lists of different
types objects
properties:
ipv4:
description:IPv4 contains a list of IPv4 static allocations
items:
description:NetworkDataIPv4 represents an ipv4 static network
object.
properties:
fromPoolRef:
description:FromPoolRef is a reference to a IP pool
to allocate an address from.
properties:
apiGroup:
description:APIGroup is the group for the resource
being referenced. If APIGroup is not specified,
the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.
type:string
kind:
description:Kind is the type of resource being
referenced
type:string
name:
description:Name is the name of resource being
referenced
type:string
required:
- kind
- name
type:object
x-kubernetes-map-type:atomic
id:
description:ID is the network ID (name)
type:string
ipAddressFromIPPool:
description:IPAddressFromIPPool contains the name of
the IP pool to use to get an ip address
type:string
link:
description:Link is the link on which the network applies
description:Metal3Machine is the Schema for the metal3machines API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3MachineSpec defines the desired state of Metal3Machine.
properties:
automatedCleaningMode:
description:When set to disabled, automated cleaning of host disks
will be skipped during provisioning and deprovisioning.
enum:
- metadata
- disabled
type:string
dataTemplate:
description:MetadataTemplate is a reference to a Metal3DataTemplate
object containing a template of metadata to be rendered. Metadata
keys defined in the metadataTemplate take precedence over keys defined
in metadata field.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
hostSelector:
description:HostSelector specifies matching criteria for labels on
BareMetalHosts. This is used to limit the set of BareMetalHost objects
considered for claiming for a metal3machine.
properties:
matchExpressions:
description:Label match expressions that must be true on a chosen
BareMetalHost
items:
properties:
key:
type:string
operator:
description:Operator represents a key/field's relationship
to value(s). See labels.Requirement and fields.Requirement
for more details.
type:string
values:
items:
type:string
type:array
required:
- key
- operator
- values
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:Key/value pairs of labels that must exist on a chosen
BareMetalHost
type:object
type:object
image:
description:Image is the image to be provisioned.
properties:
checksum:
description:Checksum is a md5sum, sha256sum or sha512sum value
or a URL to retrieve one.
type:string
checksumType:
description:ChecksumType is the checksum algorithm for the image.
e.g md5, sha256, sha512
enum:
- md5
- sha256
- sha512
type:string
format:
description:DiskFormat contains the image disk format.
enum:
- raw
- qcow2
- vdi
- vmdk
- live-iso
type:string
url:
description:URL is a location of an image to deploy.
type:string
required:
- checksum
- url
type:object
metaData:
description:MetaData is an object storing the reference to the secret
containing the Metadata given by the user.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
networkData:
description:NetworkData is an object storing the reference to the
secret containing the network data given by the user.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
providerID:
description:ProviderID will be the Metal3 machine in ProviderID format
(metal3://<bmh-uuid>)
type:string
userData:
description:UserData references the Secret that holds user data needed
by the bare metal operator. The Namespace is optional; it will default
to the metal3machine's namespace if not specified.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
required:
- image
type:object
status:
description:Metal3MachineStatus defines the observed state of Metal3Machine.
properties:
addresses:
description:Addresses is a list of addresses assigned to the machine.
This field is copied from the infrastructure provider reference.
items:
description:MachineAddress contains information for the node's
address.
properties:
address:
description:The machine address.
type:string
type:
description:Machine address type, one of Hostname, ExternalIP,
InternalIP, ExternalDNS or InternalDNS.
type:string
required:
- address
- type
type:object
type:array
conditions:
description:Conditions defines current service state of the Metal3Machine.
items:
description:Condition defines an observation of a Cluster API resource
operational state.
properties:
lastTransitionTime:
description:Last time the condition transitioned from one status
to another. This should be when the underlying condition changed.
If that is not known, then using the time when the API field
changed is acceptable.
format:date-time
type:string
message:
description:A human readable message indicating details about
the transition. This field may be empty.
type:string
reason:
description:The reason for the condition's last transition
in CamelCase. The specific API may choose whether or not this
field is considered a guaranteed API. This field may not be
empty.
type:string
severity:
description:Severity provides an explicit classification of
Reason code, so the users or machines can immediately understand
the current situation and act accordingly. The Severity field
MUST be set only when Status=False.
type:string
status:
description:Status of the condition, one of True, False, Unknown.
type:string
type:
description:Type of condition in CamelCase or in foo.example.com/CamelCase.
Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important.
type:string
required:
- lastTransitionTime
- status
- type
type:object
type:array
failureMessage:
description:"FailureMessage will be set in the event that there is
a terminal problem reconciling the metal3machine and will contain
a more verbose string suitable for logging and human consumption.
\n This field should not be set for transitive errors that a controller
faces that are expected to be fixed automatically over time (like
service outages), but instead indicate that something is fundamentally
wrong with the metal3machine's spec or the configuration of the
controller, and that manual intervention is required. Examples of
terminal errors would be invalid combinations of settings in the
spec, values that are unsupported by the controller, or the responsible
controller itself being critically misconfigured. \n Any transient
errors that occur during the reconciliation of metal3machines can
be added as events to the metal3machine object and/or logged in
the controller's output."
type:string
failureReason:
description:"FailureReason will be set in the event that there is
a terminal problem reconciling the metal3machine and will contain
a succinct value suitable for machine interpretation. \n This field
should not be set for transitive errors that a controller faces
that are expected to be fixed automatically over time (like service
outages), but instead indicate that something is fundamentally wrong
with the metal3machine's spec or the configuration of the controller,
and that manual intervention is required. Examples of terminal errors
would be invalid combinations of settings in the spec, values that
are unsupported by the controller, or the responsible controller
itself being critically misconfigured. \n Any transient errors that
occur during the reconciliation of metal3machines can be added as
events to the metal3machine object and/or logged in the controller's
output."
type:string
lastUpdated:
description:LastUpdated identifies when this status was last observed.
format:date-time
type:string
metaData:
description:MetaData is an object storing the reference to the secret
containing the Metadata used to deploy the BareMetalHost.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
networkData:
description:NetworkData is an object storing the reference to the
secret containing the network data used to deploy the BareMetalHost.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
phase:
description:Phase represents the current phase of machine actuation.
E.g. Pending, Running, Terminating, Failed etc.
type:string
ready:
description: 'Ready is the state of the metal3. TODO :Document the
variable : mhrivnak:" it would be good to document what this means,
how to interpret it, under what circumstances the value changes,
etc."'
type:boolean
renderedData:
description:RenderedData is a reference to a rendered Metal3Data
object containing the references to metaData and networkData secrets.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead of
an entire object, this string should contain a valid JSON/Go
field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container within
a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that triggered
the event) or if no container name is specified "spec.containers[2]"
(container with index 2 in this pod). This syntax is chosen
only to have some well-defined way of referencing a part of
an object. TODO:this design is not final and this field is
subject to change in the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
userData:
description:UserData references the Secret that holds user data needed
by the bare metal operator. The Namespace is optional; it will default
to the metal3machine's namespace if not specified.
properties:
name:
description:name is unique within a namespace to reference a
secret resource.
type:string
namespace:
description:namespace defines the space within which the secret
- description:Time duration since creation of Metal3MachineTemplate
jsonPath:.metadata.creationTimestamp
name:Age
type:date
name:v1beta1
schema:
openAPIV3Schema:
description:Metal3MachineTemplate is the Schema for the metal3machinetemplates
API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3MachineTemplateSpec defines the desired state of Metal3MachineTemplate.
properties:
nodeReuse:
default:false
description:When set to True, CAPM3 Machine controller will pick
the same pool of BMHs' that were released during the upgrade operation.
type:boolean
template:
description:Metal3MachineTemplateResource describes the data needed
to create a Metal3Machine from a template.
properties:
spec:
description:Spec is the specification of the desired behavior
of the machine.
properties:
automatedCleaningMode:
description:When set to disabled, automated cleaning of host
disks will be skipped during provisioning and deprovisioning.
enum:
- metadata
- disabled
type:string
dataTemplate:
description:MetadataTemplate is a reference to a Metal3DataTemplate
object containing a template of metadata to be rendered.
Metadata keys defined in the metadataTemplate take precedence
over keys defined in metadata field.
properties:
apiVersion:
description:API version of the referent.
type:string
fieldPath:
description:'If referring to a piece of an object instead
of an entire object, this string should contain a valid
JSON/Go field access statement, such as desiredState.manifest.containers[2].
For example, if the object reference is to a container
within a pod, this would take on a value like:"spec.containers{name}"
(where "name" refers to the name of the container that
triggered the event) or if no container name is specified
"spec.containers[2]"(container with index 2 in this
pod). This syntax is chosen only to have some well-defined
way of referencing a part of an object. TODO:this design
is not final and this field is subject to change in
the future.'
type:string
kind:
description: 'Kind of the referent. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type:string
name:
description: 'Name of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
type:string
namespace:
description: 'Namespace of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
type:string
resourceVersion:
description:'Specific resourceVersion to which this reference
is made, if any. More info:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency'
type:string
uid:
description: 'UID of the referent. More info:https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids'
type:string
type:object
x-kubernetes-map-type:atomic
hostSelector:
description:HostSelector specifies matching criteria for
labels on BareMetalHosts. This is used to limit the set
of BareMetalHost objects considered for claiming for a metal3machine.
properties:
matchExpressions:
description:Label match expressions that must be true
ona chosen BareMetalHost
items:
properties:
key:
type:string
operator:
description:Operator represents a key/field's relationship
to value(s). See labels.Requirement and fields.Requirement
for more details.
type:string
values:
items:
type:string
type:array
required:
- key
- operator
- values
type:object
type:array
matchLabels:
additionalProperties:
type:string
description:Key/value pairs of labels that must exist
ona chosen BareMetalHost
type:object
type:object
image:
description:Image is the image to be provisioned.
properties:
checksum:
description:Checksum is a md5sum, sha256sum or sha512sum
value or a URL to retrieve one.
type:string
checksumType:
description:ChecksumType is the checksum algorithm for
the image. e.g md5, sha256, sha512
enum:
- md5
- sha256
- sha512
type:string
format:
description:DiskFormat contains the image disk format.
enum:
- raw
- qcow2
- vdi
- vmdk
- live-iso
type:string
url:
description:URL is a location of an image to deploy.
type:string
required:
- checksum
- url
type:object
metaData:
description:MetaData is an object storing the reference to
the secret containing the Metadata given by the user.
properties:
name:
description:name is unique within a namespace to reference
a secret resource.
type:string
namespace:
description:namespace defines the space within which
the secret name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
networkData:
description:NetworkData is an object storing the reference
to the secret containing the network data given by the user.
properties:
name:
description:name is unique within a namespace to reference
a secret resource.
type:string
namespace:
description:namespace defines the space within which
the secret name must be unique.
type:string
type:object
x-kubernetes-map-type:atomic
providerID:
description:ProviderID will be the Metal3 machine in ProviderID
format (metal3://<bmh-uuid>)
type:string
userData:
description:UserData references the Secret that holds user
data needed by the bare metal operator. The Namespace is
optional; it will default to the metal3machine's namespace
if not specified.
properties:
name:
description:name is unique within a namespace to reference
a secret resource.
type:string
namespace:
description:namespace defines the space within which
- description:How many times remediation controller should attempt to remediate
the host
jsonPath:.spec.strategy.retryLimit
name:Retry limit
type:string
- description:How many times remediation controller has tried to remediate the
node
jsonPath:.status.retryCount
name:Retry count
type:string
- description:Timestamp of the last remediation attempt
jsonPath:.status.lastRemediated
name:Last Remediated
type:string
- description:Type of the remediation strategy
jsonPath:.spec.strategy.type
name:Strategy
type:string
- description:Phase of the remediation
jsonPath:.status.phase
name:Phase
type:string
name:v1beta1
schema:
openAPIV3Schema:
description:Metal3Remediation is the Schema for the metal3remediations API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3RemediationSpec defines the desired state of Metal3Remediation.
properties:
strategy:
description:Strategy field defines remediation strategy.
properties:
retryLimit:
description:Sets maximum number of remediation retries.
type:integer
timeout:
description:Sets the timeout between remediation retries.
type:string
type:
description:Type of remediation.
type:string
type:object
type:object
status:
description:Metal3RemediationStatus defines the observed state of Metal3Remediation.
properties:
lastRemediated:
description:LastRemediated identifies when the host was last remediated
format:date-time
type:string
phase:
description:Phase represents the current phase of machine remediation.
E.g. Pending, Running, Done etc.
type:string
retryCount:
description:RetryCount can be used as a counter during the remediation.
description:Metal3RemediationTemplate is the Schema for the metal3remediationtemplates
API.
properties:
apiVersion:
description:'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'
type:string
kind:
description:'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'
type:string
metadata:
type:object
spec:
description:Metal3RemediationTemplateSpec defines the desired state of
Metal3RemediationTemplate.
properties:
template:
description:Metal3RemediationTemplateResource describes the data
needed to create a Metal3Remediation from a template.
properties:
spec:
description:Spec is the specification of the desired behavior
of the Metal3Remediation.
properties:
strategy:
description:Strategy field defines remediation strategy.
properties:
retryLimit:
description:Sets maximum number of remediation retries.
type:integer
timeout:
description:Sets the timeout between remediation retries.
type:string
type:
description:Type of remediation.
type:string
type:object
type:object
required:
- spec
type:object
required:
- template
type:object
status:
description:Metal3RemediationTemplateStatus defines the observed state
of Metal3RemediationTemplate.
properties:
status:
description:Metal3RemediationStatus defines the observed state of
Metal3Remediation
properties:
lastRemediated:
description:LastRemediated identifies when the host was last
remediated
format:date-time
type:string
phase:
description:Phase represents the current phase of machine remediation.
E.g. Pending, Running, Done etc.
type:string
retryCount:
description:RetryCount can be used as a counter during the remediation.
