IPAM

Packages:

• ipam.ironcore.dev/v1alpha1

ipam.ironcore.dev/v1alpha1

Package v1alpha1 is the v1alpha1 version of the API.

Resource Types:

• Prefix
• PrefixAllocation

Prefix

Prefix is the Schema for the prefixes API

Field	Description
apiVersion string	ipam.ironcore.dev/v1alpha1
kind string	Prefix
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PrefixSpec	ipFamily Kubernetes core/v1.IPFamily IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred. prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix Prefix is the prefix to allocate for this Prefix. prefixLength int32 PrefixLength is the length of prefix to allocate for this Prefix. parentRef Kubernetes core/v1.LocalObjectReference ParentRef references the parent to allocate the Prefix from. If ParentRef and ParentSelector is empty, the Prefix is considered a root prefix and thus allocated by itself. parentSelector Kubernetes meta/v1.LabelSelector ParentSelector is the LabelSelector to use for determining the parent for this Prefix.
status PrefixStatus

PrefixAllocation

PrefixAllocation is the Schema for the prefixallocations API

Field	Description
apiVersion string	ipam.ironcore.dev/v1alpha1
kind string	PrefixAllocation
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PrefixAllocationSpec	ipFamily Kubernetes core/v1.IPFamily IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred. prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix Prefix is the prefix to allocate for this Prefix. prefixLength int32 PrefixLength is the length of prefix to allocate for this Prefix. prefixRef Kubernetes core/v1.LocalObjectReference PrefixRef references the prefix to allocate from. prefixSelector Kubernetes meta/v1.LabelSelector PrefixSelector selects the prefix to allocate from.
status PrefixAllocationStatus

PrefixAllocationPhase (string alias)

(Appears on:PrefixAllocationStatus)

PrefixAllocationPhase is a phase a PrefixAllocation can be in.

Value	Description
"Allocated"	PrefixAllocationPhaseAllocated marks a PrefixAllocation as allocated by a Prefix.
"Failed"	PrefixAllocationPhaseFailed marks a PrefixAllocation as failed.
"Pending"	PrefixAllocationPhasePending marks a PrefixAllocation as waiting for allocation.

PrefixAllocationSpec

(Appears on:PrefixAllocation)

PrefixAllocationSpec defines the desired state of PrefixAllocation

Field	Description
ipFamily Kubernetes core/v1.IPFamily	IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred.
prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix	Prefix is the prefix to allocate for this Prefix.
prefixLength int32	PrefixLength is the length of prefix to allocate for this Prefix.
prefixRef Kubernetes core/v1.LocalObjectReference	PrefixRef references the prefix to allocate from.
prefixSelector Kubernetes meta/v1.LabelSelector	PrefixSelector selects the prefix to allocate from.

PrefixAllocationStatus

(Appears on:PrefixAllocation)

PrefixAllocationStatus is the status of a PrefixAllocation.

Field	Description
prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix	Prefix is the allocated prefix, if any
phase PrefixAllocationPhase	Phase is the phase of the PrefixAllocation.
lastPhaseTransitionTime Kubernetes meta/v1.Time	LastPhaseTransitionTime is the last time the Phase changed values.

PrefixPhase (string alias)

(Appears on:PrefixStatus)

PrefixPhase is a phase a Prefix can be in.

Value	Description
"Allocated"	PrefixPhaseAllocated marks a prefix as allocated.
"Pending"	PrefixPhasePending marks a prefix as waiting for allocation.

PrefixSpec

(Appears on:Prefix, PrefixTemplateSpec)

PrefixSpec defines the desired state of Prefix

Field	Description
ipFamily Kubernetes core/v1.IPFamily	IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred.
prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix	Prefix is the prefix to allocate for this Prefix.
prefixLength int32	PrefixLength is the length of prefix to allocate for this Prefix.
parentRef Kubernetes core/v1.LocalObjectReference	ParentRef references the parent to allocate the Prefix from. If ParentRef and ParentSelector is empty, the Prefix is considered a root prefix and thus allocated by itself.
parentSelector Kubernetes meta/v1.LabelSelector	ParentSelector is the LabelSelector to use for determining the parent for this Prefix.

PrefixStatus

(Appears on:Prefix)

PrefixStatus defines the observed state of Prefix

Field	Description
phase PrefixPhase	Phase is the PrefixPhase of the Prefix.
lastPhaseTransitionTime Kubernetes meta/v1.Time	LastPhaseTransitionTime is the last time the Phase changed values.
used []github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix	Used is a list of used prefixes.

PrefixTemplateSpec

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec PrefixSpec	ipFamily Kubernetes core/v1.IPFamily IPFamily is the IPFamily of the prefix. If unset but Prefix is set, this can be inferred. prefix github.com/ironcore-dev/ironcore/api/common/v1alpha1.IPPrefix Prefix is the prefix to allocate for this Prefix. prefixLength int32 PrefixLength is the length of prefix to allocate for this Prefix. parentRef Kubernetes core/v1.LocalObjectReference ParentRef references the parent to allocate the Prefix from. If ParentRef and ParentSelector is empty, the Prefix is considered a root prefix and thus allocated by itself. parentSelector Kubernetes meta/v1.LabelSelector ParentSelector is the LabelSelector to use for determining the parent for this Prefix.

---

Generated with gen-crd-api-reference-docs