k8c.io/api/v3@v3.0.0-20230904060738-b0a93889c0b6/pkg/apis/kubermatic/v1/ipam_allocation.go (about)

     1  /*
     2  Copyright 2023 The Kubermatic Kubernetes Platform contributors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package v1
    18  
    19  import (
    20  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    21  )
    22  
    23  // +genclient
    24  // +kubebuilder:resource:scope=Cluster
    25  // +kubebuilder:object:generate=true
    26  // +kubebuilder:object:root=true
    27  // +kubebuilder:printcolumn:JSONPath=".spec.cluster.name",name="Cluster",type="string"
    28  // +kubebuilder:printcolumn:JSONPath=".metadata.creationTimestamp",name="Age",type="date"
    29  
    30  // IPAMAllocation is the object representing an allocation from an IPAMPool
    31  // made for a particular KKP user cluster.
    32  type IPAMAllocation struct {
    33  	metav1.TypeMeta   `json:",inline"`
    34  	metav1.ObjectMeta `json:"metadata,omitempty"`
    35  
    36  	Spec IPAMAllocationSpec `json:"spec,omitempty"`
    37  }
    38  
    39  // IPAMAllocationSpec specifies an allocation from an IPAMPool
    40  // made for a particular KKP user cluster.
    41  type IPAMAllocationSpec struct {
    42  	// Cluster is the reference to the cluster that this Constraint belongs to.
    43  	Cluster ClusterReference `json:"cluster"`
    44  	// Type is the allocation type that is being used.
    45  	Type IPAMPoolAllocationType `json:"type"`
    46  	// DC is the datacenter of the allocation.
    47  	DC string `json:"dc"`
    48  	// CIDR is the CIDR that is being used for the allocation.
    49  	// Set when "type=prefix".
    50  	CIDR SubnetCIDR `json:"cidr,omitempty"`
    51  	// Addresses are the IP address ranges that are being used for the allocation.
    52  	// Set when "type=range".
    53  	Addresses []string `json:"addresses,omitempty"`
    54  }
    55  
    56  // +kubebuilder:object:generate=true
    57  // +kubebuilder:object:root=true
    58  
    59  type IPAMAllocationList struct {
    60  	metav1.TypeMeta `json:",inline"`
    61  	metav1.ListMeta `json:"metadata,omitempty"`
    62  
    63  	Items []IPAMAllocation `json:"items"`
    64  }