github.com/projectcalico/api@v0.0.0-20231218190037-9183ab93f33e/pkg/apis/projectcalico/v3/profile.go (about)

     1  // Copyright (c) 2017,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  	KindProfile     = "Profile"
    23  	KindProfileList = "ProfileList"
    24  )
    25  
    26  // +genclient:nonNamespaced
    27  // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
    28  
    29  // ProfileList is a list of Profile objects.
    30  type ProfileList struct {
    31  	metav1.TypeMeta `json:",inline"`
    32  	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
    33  
    34  	Items []Profile `json:"items" protobuf:"bytes,2,rep,name=items"`
    35  }
    36  
    37  // +genclient
    38  // +genclient:nonNamespaced
    39  // +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
    40  
    41  type Profile struct {
    42  	metav1.TypeMeta   `json:",inline"`
    43  	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
    44  
    45  	Spec ProfileSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
    46  }
    47  
    48  // ProfileSpec contains the specification for a security Profile resource.
    49  type ProfileSpec struct {
    50  	// The ordered set of ingress rules.  Each rule contains a set of packet match criteria and
    51  	// a corresponding action to apply.
    52  	Ingress []Rule `json:"ingress,omitempty" validate:"omitempty,dive"`
    53  	// The ordered set of egress rules.  Each rule contains a set of packet match criteria and
    54  	// a corresponding action to apply.
    55  	Egress []Rule `json:"egress,omitempty" validate:"omitempty,dive"`
    56  	// An option set of labels to apply to each endpoint (in addition to their own labels)
    57  	// referencing this profile.  If labels configured on the endpoint have keys matching those
    58  	// labels inherited from the profile, the endpoint label values take precedence.
    59  	LabelsToApply map[string]string `json:"labelsToApply,omitempty" validate:"omitempty,labels"`
    60  }
    61  
    62  // NewProfile creates a new (zeroed) Profile struct with the TypeMetadata initialised to the current
    63  // version.
    64  func NewProfile() *Profile {
    65  	return &Profile{
    66  		TypeMeta: metav1.TypeMeta{
    67  			Kind:       KindProfile,
    68  			APIVersion: GroupVersionCurrent,
    69  		},
    70  	}
    71  }