IPaddr¶
This section describes the IPaddr
resource used in Mirantis
Container Cloud API. The IPAddr
object describes an IP address
and contains all information about the associated MAC address.
For demonstration purposes, the Container Cloud IPaddr
custom resource (CR) is split into the following major sections:
IPaddr metadata¶
The Container Cloud IPaddr
CR contains the following fields:
apiVersion
API version of the object that is
ipam.mirantis.com/v1alpha1
kind
Object type that is
IPaddr
metadata
The
metadata
field contains the following subfields:name
Name of the
IPaddr
object in theauto-XX-XX-XX-XX-XX-XX
format where XX-XX-XX-XX-XX-XX is the associated MAC address
namespace
Project in which the
IPaddr
object was created
labels
Key-value pairs that are attached to the object:
ipam/IP
IPv4 address
ipam/IpamHostID
Unique ID of the associated
IpamHost
object
ipam/MAC
MAC address
ipam/SubnetID
Unique ID of the
Subnet
object
ipam/UID
Unique ID of the
IPAddr
object
Warning
Labels and annotations that are not documented in this API Reference are generated automatically by Container Cloud. Do not modify them using the Container Cloud API.
Configuration example:
apiVersion: ipam.mirantis.com/v1alpha1
kind: IPaddr
metadata:
name: auto-0c-c4-7a-a8-b8-18
namespace: default
labels:
ipam/IP: 172.16.48.201
ipam/IpamHostID: 848b59cf-f804-11ea-88c8-0242c0a85b02
ipam/MAC: 0C-C4-7A-A8-B8-18
ipam/SubnetID: 572b38de-f803-11ea-88c8-0242c0a85b02
ipam/UID: 84925cac-f804-11ea-88c8-0242c0a85b02
IPAddr spec¶
The spec
object field of the IPAddr
resource contains the associated
MAC address and the reference to the Subnet
object:
mac
MAC address in the
XX:XX:XX:XX:XX:XX
format
subnetRef
Reference to the
Subnet
resource in the<subnetProjectName>/<subnetName>
format
Configuration example:
spec:
mac: 0C:C4:7A:A8:B8:18
subnetRef: default/kaas-mgmt
IPAddr status¶
The status
object field of the IPAddr
resource reflects the actual
state of the IPAddr
object. In contains the following fields:
address
IP address.
cidr
IPv4 CIDR for the
Subnet
.
gateway
Gateway address for the
Subnet
.
mac
MAC address in the
XX:XX:XX:XX:XX:XX
format.
nameservers
List of the IP addresses of name servers of the
Subnet
. Each element of the list is a single address, for example, 172.18.176.6.
state
Since 2.23.0Message that reflects the current status of the resource. The list of possible values includes the following:
OK
- object is operational.ERR
- object is non-operational. This status has a detailed description in themessages
list.TERM
- object was deleted and is terminating.
messages
Since 2.23.0List of error or warning messages if the object state is
ERR
.
objCreated
Date, time, and IPAM version of the resource creation.
objStatusUpdated
Date, time, and IPAM version of the last update of the
status
field in the resource.
objUpdated
Date, time, and IPAM version of the last resource update.
phase
Deprecated since Container Cloud 2.23.0 and will be removed in one of the following releases in favor of
state
. Possible values:Active
,Failed
, orTerminating
.
Configuration example:
status:
address: 172.16.48.201
cidr: 172.16.48.201/24
gateway: 172.16.48.1
objCreated: 2021-10-21T19:09:32Z by v5.1.0-20210930-121522-f5b2af8
objStatusUpdated: 2021-10-21T19:14:18.748114886Z by v5.1.0-20210930-121522-f5b2af8
objUpdated: 2021-10-21T19:09:32.606968024Z by v5.1.0-20210930-121522-f5b2af8
mac: 0C:C4:7A:A8:B8:18
nameservers:
- 172.18.176.6
state: OK
phase: Active