securitygroup

Documentation

Index

• Constants
• type Scope
• type Service
  • func NewService(sgScope Scope) *Service
  • func NewServiceWithRoles(sgScope Scope, roles []infrav1.SecurityGroupRole) *Service
  • func (s *Service) DeleteSecurityGroups() error
  • func (s *Service) ReconcileSecurityGroups() error

Constants

const (
	// IPProtocolTCP is how EC2 represents the TCP protocol in ingress rules.
	IPProtocolTCP = "tcp"

	// IPProtocolUDP is how EC2 represents the UDP protocol in ingress rules.
	IPProtocolUDP = "udp"

	// IPProtocolICMP is how EC2 represents the ICMP protocol in ingress rules.
	IPProtocolICMP = "icmp"

	// IPProtocolICMPv6 is how EC2 represents the ICMPv6 protocol in ingress rules.
	IPProtocolICMPv6 = "58"
)

Types

type Scope

type Scope interface {
	cloud.ClusterScoper

	// Network returns the cluster network object.
	Network() *infrav1.NetworkStatus

	// SecurityGroups returns the cluster security groups as a map, it creates the map if empty.
	SecurityGroups() map[infrav1.SecurityGroupRole]infrav1.SecurityGroup

	// SecurityGroupOverrides returns the security groups that are overridden in the cluster spec
	SecurityGroupOverrides() map[infrav1.SecurityGroupRole]string

	// VPC returns the cluster VPC.
	VPC() *infrav1.VPCSpec

	// CNIIngressRules returns the CNI spec ingress rules.
	CNIIngressRules() infrav1.CNIIngressRules

	// Bastion returns the bastion details for the cluster.
	Bastion() *infrav1.Bastion
}

Scope is a scope for use with the security group reconciling service.

type Service

type Service struct {
	EC2Client ec2iface.EC2API
	// contains filtered or unexported fields
}

Service holds a collection of interfaces. The interfaces are broken down like this to group functions together. One alternative is to have a large list of functions from the ec2 client.

func NewService

func NewService(sgScope Scope) *Service

NewService returns a new service given the api clients.

func NewServiceWithRoles

func NewServiceWithRoles(sgScope Scope, roles []infrav1.SecurityGroupRole) *Service

NewServiceWithRoles returns a new service given the api clients with a defined set of roles.

func (*Service) DeleteSecurityGroups

func (s *Service) DeleteSecurityGroups() error

DeleteSecurityGroups will delete a service's security groups.

func (*Service) ReconcileSecurityGroups

func (s *Service) ReconcileSecurityGroups() error

ReconcileSecurityGroups will reconcile security groups against the Service object.