v1beta1

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 18, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Overview

Package v1beta1 is the v1beta1 version of the API. +kubebuilder:object:generate=true +groupName=networking.gke.io

Index

Constants

View Source 
const (
	// ActionAllow is the Allow Action of GCP Firewall Rule
	ActionAllow Action = "ALLOW"
	// ActionDeny is the Deny Action of GCP Firewall Rule. For now, only Allow is supported.
	ActionDeny Action = "DENY"
	// ProtocolTCP is the TCP protocol.
	ProtocolTCP Protocol = "TCP"
	// ProtocolUDP is the UDP protocol.
	ProtocolUDP Protocol = "UDP"
	// ProtocolICMP is the ICMP protocol.
	ProtocolICMP Protocol = "ICMP"
)
View Source 
const (
	// FirewallRuleConditionEnforced indicates if the firewall rule is enforced.
	FirewallRuleConditionEnforced FirewallRuleConditionType = "Enforced"

	// FirewallRuleReasonInvalid is used when the specified configuration is not valid.
	FirewallRuleReasonInvalid FirewallRuleConditionReason = "Invalid"

	// FirewallRuleReasonSyncError is used if the sync fails due to an error.
	FirewallRuleReasonSyncError FirewallRuleConditionReason = "SyncError"

	// FirewallRuleReasonPending is used when the firewall rule is not synced to
	// GCP and enforced yet.
	FirewallRuleReasonPending FirewallRuleConditionReason = "Pending"

	// FirewallRuleReasonXPNPermissionError is used when the controller does not
	// have permission to configure firewalls in the shared VPC project.
	FirewallRuleReasonXPNPermissionError FirewallRuleConditionReason = "XPNPermissionError"

	// FirewallRuleReasonSynchronized is used if the firewall rule is synchronized
	// to GCP.
	FirewallRuleReasonSynchronized FirewallRuleConditionReason = "Synchronized"
)
View Source 
const GroupName = "networking.gke.io"

GroupName specifies the group name used to register the objects.

Variables

View Source 
var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Deprecated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)
View Source 
var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1beta1"}

GroupVersion specifies the group and the version used to register the objects.

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Action 

type Action string

Action defines the rule action of the firewall rule.

type CIDR 

type CIDR string

CIDR defines a IP block. TODO(sugangli) Modify the validation to include IPv6 CIDRs with FW 3.0 support. +kubebuilder:validation:Pattern=`^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(/(3[0-2]|2[0-9]|1[0-9]|[0-9]))?$`

type FirewallRuleConditionReason 

type FirewallRuleConditionReason string

FirewallRuleConditionReason specifies the reason for the GCE firewall rule to be in the specified state.

type FirewallRuleConditionType 

type FirewallRuleConditionType string

FirewallRuleConditionType describes a state of a GCE firewall rule.

type GCPFirewall 

type GCPFirewall struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	// Spec is the desired configuration for GCP firewall
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	Spec GCPFirewallSpec `json:"spec,omitempty"`

	// Status is the runtime status of this GCP firewall
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
	// +kubebuilder:default={conditions: {{type: "Enforced", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}}}
	Status GCPFirewallStatus `json:"status,omitempty"`
}

GCPFirewall describes a GCP firewall spec that can be used to configure GCE firewalls. A GCPFirewallSpec will correspond 1:1 with a GCE firewall rule.

func (*GCPFirewall) DeepCopy 

func (in *GCPFirewall) DeepCopy() *GCPFirewall

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPFirewall.

func (*GCPFirewall) DeepCopyInto 

func (in *GCPFirewall) DeepCopyInto(out *GCPFirewall)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GCPFirewall) DeepCopyObject 

func (in *GCPFirewall) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GCPFirewallIngress 

type GCPFirewallIngress struct {
	// Source describes a peer to allow traffic from.
	// +optional
	Source *IngressSource `json:"source,omitempty"`
	//  Destination specifies the target of the firewall rule. If this field is empty,
	// this rule allows traffic from specified sources to all kubernetes cluster entities.
	// +optional
	Destination *IngressDestination `json:"destination,omitempty"`
}

GCPFirewallIngress describes a source and a destination for the ingress firewall rule.

func (*GCPFirewallIngress) DeepCopy 

func (in *GCPFirewallIngress) DeepCopy() *GCPFirewallIngress

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPFirewallIngress.

func (*GCPFirewallIngress) DeepCopyInto 

func (in *GCPFirewallIngress) DeepCopyInto(out *GCPFirewallIngress)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPFirewallList 

type GCPFirewallList struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	metav1.ListMeta `json:"metadata,omitempty"`

	// Items is a list of GCP Firewalls.
	Items []GCPFirewall `json:"items"`
}

GCPFirewallList contains a list of GCPFirewall resources.

func (*GCPFirewallList) DeepCopy 

func (in *GCPFirewallList) DeepCopy() *GCPFirewallList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPFirewallList.

func (*GCPFirewallList) DeepCopyInto 

func (in *GCPFirewallList) DeepCopyInto(out *GCPFirewallList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GCPFirewallList) DeepCopyObject 

func (in *GCPFirewallList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type GCPFirewallSpec 

type GCPFirewallSpec struct {
	// Rule action of the firewall rule. Only allow action is supported. If not
	// specified, defaults to ALLOW.
	// +optional
	// +kubebuilder:validation:Enum=ALLOW
	// +kubebuilder:default=ALLOW
	Action Action `json:"action"`

	// If set to true, the GCPFirewall is not synced by the controller.
	Disabled bool `json:"disabled,omitempty"`

	// List of protocol/ ports which needs to be selected by this rule.
	// If this field is empty or missing, this rule matches all protocol/ ports.
	// If this field is present and contains at least one item, then this rule
	// allows traffic only if the traffic matches at least one port in the list.
	// +optional
	Ports []ProtocolPort `json:"ports,omitempty"`

	// A collection of sources and destinations to determine which ingress traffic is allowed.
	// If source is nil or empty, the traffic is allowed from all sources (0.0.0.0/0).
	// If destination is nil or empty, the traffic is allowed to all kubernetes cluster entities
	// (nodes, pods and services) from the specified sources.
	// If both are nil, the traffic is allowed from all sources (0.0.00/0) to the cluster entities.
	// +optional
	Ingress *GCPFirewallIngress `json:"ingress,omitempty"`
}

GCPFirewallSpec provides the specification of a GCPFirewall. The firewall rule apply to the cluster associated targets (network tags or secure tags) which are deduced by the controller. As a result, the specified rule applies to ALL nodes and pods in the cluster.

func (*GCPFirewallSpec) DeepCopy 

func (in *GCPFirewallSpec) DeepCopy() *GCPFirewallSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPFirewallSpec.

func (*GCPFirewallSpec) DeepCopyInto 

func (in *GCPFirewallSpec) DeepCopyInto(out *GCPFirewallSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPFirewallStatus 

type GCPFirewallStatus struct {
	// Type specifies the underlying GCE firewall implementation type.
	// Takes one of the values from [VPC, REGIONAL, GLOBAL]
	// +optional
	// +kubebuilder:validation:Enum=VPC;REGIONAL;GLOBAL
	Type string `json:"type,omitempty"`

	// Resource link for the GCE firewall rule. In case of FW 3.0, this is the GCE
	// Network Firewall Policy resource.
	// +optional
	ResourceURL string `json:"resourceURL"`

	// Priority of the GCP firewall rule.
	// +optional
	Priority uint32 `json:"priority"`

	// Conditions describe the current condition of the firewall rule.
	// +optional
	// +listType=map
	// +listMapKey=type
	// +kubebuilder:validation:MaxItems=8
	// +kubebuilder:default={{type: "Enforced", status: "Unknown", reason:"Pending", message:"Waiting for controller", lastTransitionTime: "1970-01-01T00:00:00Z"}}
	Conditions []metav1.Condition `json:"conditions"`
}

GCPFirewallStatus is the runtime status of a GCP firewall

func (*GCPFirewallStatus) DeepCopy 

func (in *GCPFirewallStatus) DeepCopy() *GCPFirewallStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPFirewallStatus.

func (*GCPFirewallStatus) DeepCopyInto 

func (in *GCPFirewallStatus) DeepCopyInto(out *GCPFirewallStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressDestination 

type IngressDestination struct {
	// IPBlocks specify the set of destination CIDRs that the rule applies to. If this field
	// is present and contains at least one item, this rule allows traffic only if
	// the traffic matches at least one item in the list. If this field is empty,
	// this rule allows all destinations.
	// Valid example list items are "192.168.1.1/24" or "2001:db9::/64".
	// +optional
	// +kubebuilder:validation:MinItems=1
	// +kubebuilder:validation:MaxItems=256
	IPBlocks []CIDR `json:"ipBlocks,omitempty"`
}

IngressDestination specifies the target of the firewall rules. The destination entities specified are ANDed with GCE node network tags of the kubernetes cluster. In other words, the traffic is allowed to a destination IP address only if it belongs to one of the cluster nodes.

func (*IngressDestination) DeepCopy 

func (in *IngressDestination) DeepCopy() *IngressDestination

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressDestination.

func (*IngressDestination) DeepCopyInto 

func (in *IngressDestination) DeepCopyInto(out *IngressDestination)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IngressSource 

type IngressSource struct {
	// IPBlocks specify the set of source CIDR ranges that the rule applies to. If this field
	// is present and contains at least one item, this rule allows traffic only if
	// the traffic matches at least one item in the list. If this field is empty,
	// this rule allows all sources.
	// Valid example list items are "192.168.1.1/24" or "2001:db9::/64".
	// +optional
	// +kubebuilder:validation:MinItems=1
	// +kubebuilder:validation:MaxItems=256
	IPBlocks []CIDR `json:"ipBlocks,omitempty"`
}

IngressSource specifies the source of the firewall rules.

func (*IngressSource) DeepCopy 

func (in *IngressSource) DeepCopy() *IngressSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IngressSource.

func (*IngressSource) DeepCopyInto 

func (in *IngressSource) DeepCopyInto(out *IngressSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Protocol 

type Protocol string

Protocol defines network protocols supported for GCP firewall.

type ProtocolPort 

type ProtocolPort struct {
	// The protocol which the traffic must match.
	// +kubebuilder:validation:Enum=TCP;UDP;ICMP;SCTP;AH;ESP
	Protocol Protocol `json:"protocol"`

	// StartPort is the starting port of the port range that is selected on the
	// firewall rule targets for the specified protocol. If EndPort is not
	// specified, this is the only port selected.
	// If StartPort is not provided, all ports are matched.
	// +optional
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=65535
	StartPort *int32 `json:"startPort,omitempty"`

	// EndPort is the last port of the port range that is selected on the firewall
	// rule targets. If StartPort is not specified or greater than this value, then
	// this field is ignored.
	// +optional
	// +kubebuilder:validation:Minimum=1
	// +kubebuilder:validation:Maximum=65535
	EndPort *int32 `json:"endPort,omitempty"`
}

ProtocolPort describes the protocol and ports to allow traffic on.

func (*ProtocolPort) DeepCopy 

func (in *ProtocolPort) DeepCopy() *ProtocolPort

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProtocolPort.

func (*ProtocolPort) DeepCopyInto 

func (in *ProtocolPort) DeepCopyInto(out *ProtocolPort)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.