github.com/tigera/api@v0.0.0-20240320170621-278e89a8c5fb/pkg/apis/projectcalico/v3/networkset.go (about)

     1  // Copyright (c) 2019,2021 Tigera, Inc. All rights reserved.
     2  
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package v3
    16  
    17  import (
    18  	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
    19  )
    20  
    21  const (
    22  	KindNetworkSet     = "NetworkSet"
    23  	KindNetworkSetList = "NetworkSetList"
    24  )
    25  
    26  // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
    27  
    28  // NetworkSetList is a list of NetworkSet objects.
    29  type NetworkSetList struct {
    30  	metav1.TypeMeta `json:",inline"`
    31  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
    32  
    33  	Items []NetworkSet `json:"items" protobuf:"bytes,2,rep,name=items"`
    34  }
    35  
    36  // +genclient
    37  // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
    38  
    39  type NetworkSet struct {
    40  	metav1.TypeMeta   `json:",inline"`
    41  	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
    42  
    43  	Spec NetworkSetSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
    44  }
    45  
    46  // NetworkSetSpec contains the specification for a NetworkSet resource.
    47  type NetworkSetSpec struct {
    48  	// The list of IP networks that belong to this set.
    49  	Nets []string `json:"nets,omitempty" validate:"omitempty,dive,cidr"`
    50  
    51  	// The list of domain names that belong to this set and are honored in egress allow rules
    52  	// only.  Domain names specified here only work to allow egress traffic from the cluster to
    53  	// external destinations.  They don't work to _deny_ traffic to destinations specified by
    54  	// domain name, or to allow ingress traffic from _sources_ specified by domain name.
    55  	AllowedEgressDomains []string `json:"allowedEgressDomains,omitempty" validate:"omitempty,dive,wildname"`
    56  }
    57  
    58  // NewNetworkSet creates a new (zeroed) NetworkSet struct with the TypeMetadata initialised to the current version.
    59  func NewNetworkSet() *NetworkSet {
    60  	return &NetworkSet{
    61  		TypeMeta: metav1.TypeMeta{
    62  			Kind:       KindNetworkSet,
    63  			APIVersion: GroupVersionCurrent,
    64  		},
    65  	}
    66  }