Start is the first GroupTag index in the segment (inclusive).
Group Tag Pool Setup#
Workflows → GTPSGroup Tag Pool Setups
The GroupTagPoolSetup workflow resizes the global and local Group Tag IndexAllocationPool resources (group-tag-pool-global and group-tag-pool-local) that allocate Group Tag IDs.
The workflow accepts one or more groupTagPoolSegments and supports segment types Global, Local, and Reserved. Segments can be specified with either end or size (or both when consistent).
During validation and dry-run, the workflow enforces platform limits and rejects invalid layouts:
- D2/D3-capable deployments use an allocatable range of
[1,127]. - D4/D5-only deployments use an allocatable range of
[1,16383]. - Group Tag ID
0remains reserved for no-group-tag and is not allocatable. - Overlapping segments are rejected.
- Changes that would invalidate existing allocations are rejected.
Use this workflow when changing pool boundaries or reserving portions of the Group Tag ID space for future use.
Dependencies#
The IndexAllocationPool resources named group-tag-pool-global and group-tag-pool-local must exist in the target namespace.
Referenced resources#
GroupTag#
The workflow updates the ID allocation pools used by GroupTag resources.
Examples#
apiVersion: microsegmentation.eda.nokia.com/v1alpha1
kind: GroupTagPoolSetup
metadata:
name: setup-d2d3-with-reserved
namespace: eda
spec:
has7220IxrD2D3: true
has7220IxrD4D5: false
globalGroupTagPool: group-tag-pool-global
localGroupTagPool: group-tag-pool-local
groupTagPoolSegments:
- start: 1
size: 64
type: Global
- start: 65
size: 44
type: Local
- start: 109
size: 19
type: Reserved
cat << 'EOF' | kubectl apply -f -
apiVersion: microsegmentation.eda.nokia.com/v1alpha1
kind: GroupTagPoolSetup
metadata:
name: setup-d2d3-with-reserved
namespace: eda
spec:
has7220IxrD2D3: true
has7220IxrD4D5: false
globalGroupTagPool: group-tag-pool-global
localGroupTagPool: group-tag-pool-local
groupTagPoolSegments:
- start: 1
size: 64
type: Global
- start: 65
size: 44
type: Local
- start: 109
size: 19
type: Reserved
EOF
Custom Resource Definition#
To browse the Custom Resource Definition go to crd.eda.dev.
GroupTagPoolSetup
SPEC
GroupTagPoolSetupSpec defines the desired layout for the global, local, and (optional) reserved GroupTag ranges. Segments are specified explicitly with start and end/size. Global and Local segments are optional; when omitted the workflow preserves the existing pool sizes. Run during a maintenance window. The workflow refuses to apply ranges that would invalidate existing GroupTag allocations.
-
GlobalGroupTagPool is the IndexAllocationPool from which GroupTag IDs in the global range are allocated. The workflow can resize this pool.
-
GroupTagPoolSegments is the list of desired GroupTag segments. Each segment specifies a start index and either an end or a size, along with its type (Global, Local, or Reserved). Global and Local segments are optional; when omitted the workflow preserves existing pool sizes.
-
GroupTagSegment describes a contiguous range of GroupTag indices by start index and either an explicit end or a size. At least one of End or Size must be set. If both are set, they must satisfy: end = start + size - 1.
-
End is the last GroupTag index in the segment (inclusive). Mutually exclusive with Size; at least one must be set.
format: int64range: >= 1 -
Size is the number of IDs in the segment. Mutually exclusive with End; at least one must be set.
format: int64range: >= 1 - format: int64range: >= 1
-
Type identifies the role of this segment (Global, Local, or Reserved).
enum: "Global", "Local", "Reserved"
-
-
-
Has7220IxrD2D3 is true when the network includes Nokia 7220 IXR D2 or D3 systems. When true, group tag index ranges are validated against a maximum of 127.
-
Has7220IxrD4D5 is true when the network includes Nokia 7220 IXR D4 or D5 systems. When true and D2/D3 is false, group tag index ranges are validated against a maximum of 16383.
-
LocalGroupTagPool is the IndexAllocationPool from which GroupTag IDs in the local range are allocated. The workflow can resize this pool. IndexAllocationPool CR to resize.
-
Prompts controls when the workflow pauses for user confirmation. When AfterDryrun is included, the user is prompted after the dry-run comparison shows changes but before the transaction is applied.
STATUS
GroupTagPoolSetupStatus defines the observed outcome of a GroupTagPoolSetup run.
-
AppliedLayout records the layout the workflow most recently computed and (in Success/NoOp cases) successfully applied.
-
GroupTagPoolSegments is the list of resolved segments with fully computed start, end, and size values.
-
GroupTagSegment describes a contiguous range of GroupTag indices by start index and either an explicit end or a size. At least one of End or Size must be set. If both are set, they must satisfy: end = start + size - 1.
-
End is the last GroupTag index in the segment (inclusive). Mutually exclusive with Size; at least one must be set.
format: int64range: >= 1 -
Size is the number of IDs in the segment. Mutually exclusive with End; at least one must be set.
format: int64range: >= 1 -
Start is the first GroupTag index in the segment (inclusive).
format: int64range: >= 1 -
Type identifies the role of this segment (Global, Local, or Reserved).
enum: "Global", "Local", "Reserved"
-
-
-
-
ConflictingAllocations lists existing GroupTag allocations that the requested layout would invalidate. Non-empty when Result is "Failed" with reason E1 (refuse rather than orphan).
-
ConflictingAllocation identifies a single existing allocation whose index is incompatible with the requested layout.
-
Index is the GroupTag index that conflicts with the new layout.
format: int64 -
Pool is the name of the pool whose new range conflicts with the allocation: typically "global" or "local".
-
Reason explains why the index conflicts: "out-of-range", "in-reserved-range", "in-global-range", or "in-local-range".
-
-
-
Result reports the high-level outcome of the most recent run: "Success" (transaction applied), "NoOp" (computed layout already matched the live state, no transaction applied), or "Failed".