sigs.k8s.io/cluster-api-provider-aws@v1.5.5/pkg/cloud/scope/network.go (about)

     1  /*
     2  Copyright 2022 The Kubernetes Authors.
     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 scope
    18  
    19  import (
    20  	infrav1 "sigs.k8s.io/cluster-api-provider-aws/api/v1beta1"
    21  	"sigs.k8s.io/cluster-api-provider-aws/pkg/cloud"
    22  )
    23  
    24  // NetworkScope is the interface for the scope to be used with the network services.
    25  type NetworkScope interface {
    26  	cloud.ClusterScoper
    27  
    28  	// Network returns the cluster network object.
    29  	Network() *infrav1.NetworkStatus
    30  	// VPC returns the cluster VPC.
    31  	VPC() *infrav1.VPCSpec
    32  	// Subnets returns the cluster subnets.
    33  	Subnets() infrav1.Subnets
    34  	// SetSubnets updates the clusters subnets.
    35  	SetSubnets(subnets infrav1.Subnets)
    36  	// CNIIngressRules returns the CNI spec ingress rules.
    37  	CNIIngressRules() infrav1.CNIIngressRules
    38  	// SecurityGroups returns the cluster security groups as a map, it creates the map if empty.
    39  	SecurityGroups() map[infrav1.SecurityGroupRole]infrav1.SecurityGroup
    40  	// SecondaryCidrBlock returns the optional secondary CIDR block to use for pod IPs
    41  	SecondaryCidrBlock() *string
    42  
    43  	// Bastion returns the bastion details for the cluster.
    44  	Bastion() *infrav1.Bastion
    45  }