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:
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 the auto-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
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
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
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
.
lastUpdate
Date and time of the last IPAddr
status update.
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.
phase
Current phase of the IP address. Possible values: Active
, Failed
,
or Terminating
.
versionIpam
IPAM version used during the last update of the object.
Configuration example:
status:
address: 172.16.48.201
cidr: 172.16.48.201/24
gateway: 172.16.48.1
lastUpdate: "2020-09-16T10:08:07Z"
mac: 0C:C4:7A:A8:B8:18
nameservers:
- 172.18.176.6
phase: Active
versionIpam: v3.0.999-20200807-130909-44151f8