cloud

package

v1.9.0 Latest Latest Go to latest Published: Mar 19, 2025 License: Apache-2.0 Imports: 6 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kubernetes-sigs/cluster-api-provider-gcp

Documentation ¶

Overview ¶

Package cloud implement cloud resources lifecycle.

Constants ¶

View Source

const (
	// DefaultNumRegionsPerZone is the default number of zones per region.
	DefaultNumRegionsPerZone = 3
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client interface {
	Cloud() Cloud
	NetworkCloud() Cloud
}

Client is an interface which can get cloud client.

type Cloud ¶

type Cloud = cloud.Cloud

Cloud alias for cloud.Cloud interface.

type Cluster ¶

type Cluster interface {
	ClusterGetter
	ClusterSetter
}

Cluster is an interface which can get and set cluster information.

type ClusterGetter ¶

type ClusterGetter interface {
	Client
	Project() string
	Region() string
	Name() string
	Namespace() string
	NetworkName() string
	NetworkProject() string
	IsSharedVpc() bool
	Network() *infrav1.Network
	AdditionalLabels() infrav1.Labels
	FailureDomains() clusterv1.FailureDomains
	ControlPlaneEndpoint() clusterv1.APIEndpoint
	ResourceManagerTags() infrav1.ResourceManagerTags
	LoadBalancer() infrav1.LoadBalancerSpec
}

ClusterGetter is an interface which can get cluster information.

type ClusterSetter ¶

type ClusterSetter interface {
	SetControlPlaneEndpoint(endpoint clusterv1.APIEndpoint)
}

ClusterSetter is an interface which can set cluster information.

type Machine ¶

type Machine interface {
	MachineGetter
	MachineSetter
}

Machine is an interface which can get and set machine information.

type MachineGetter ¶

type MachineGetter interface {
	Client
	Name() string
	Namespace() string
	Zone() string
	Project() string
	Role() string
	IsControlPlane() bool
	ControlPlaneGroupName() string
	GetInstanceID() *string
	GetProviderID() string
	GetBootstrapData() (string, error)
	GetInstanceStatus() *infrav1.InstanceStatus
}

MachineGetter is an interface which can get machine information.

type MachineSetter ¶

type MachineSetter interface {
	SetProviderID()
	SetInstanceStatus(v infrav1.InstanceStatus)
	SetFailureMessage(v error)
	SetFailureReason(v string)
	SetAnnotation(key, value string)
	SetAddresses(addressList []corev1.NodeAddress)
}

MachineSetter is an interface which can set machine information.

type Reconciler ¶

type Reconciler interface {
	Reconcile(ctx context.Context) error
	Delete(ctx context.Context) error
}

Reconciler is a generic interface used by components offering a type of service.

type ReconcilerWithResult ¶ added in v1.3.0

type ReconcilerWithResult interface {
	Reconcile(ctx context.Context) (ctrl.Result, error)
	Delete(ctx context.Context) (ctrl.Result, error)
}

ReconcilerWithResult is a generic interface used by components offering a type of service.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gcperrors Package gcperrors implements gcp errors types.	Package gcperrors implements gcp errors types.
providerid Package providerid implements functionality for creating kubernetes provider ids for nodes.	Package providerid implements functionality for creating kubernetes provider ids for nodes.
scope Package scope implements scope types.	Package scope implements scope types.
services
compute/firewalls Package firewalls implements reconciler for cluster firwall components.	Package firewalls implements reconciler for cluster firwall components.
compute/instances Package instances implements reconciler for machine instance components.	Package instances implements reconciler for machine instance components.
compute/loadbalancers Package loadbalancers implements reconciler for cluster control-plane loadbalancer components.	Package loadbalancers implements reconciler for cluster control-plane loadbalancer components.
compute/networks Package networks implements reconciler for cluster networking components.	Package networks implements reconciler for cluster networking components.
compute/subnets Package subnets implements reconciler for subnetworks.	Package subnets implements reconciler for subnetworks.
container/clusters Package clusters implements reconciler for GKE cluster components.	Package clusters implements reconciler for GKE cluster components.
container/nodepools Package nodepools implements reconciler for GKE node pool components.	Package nodepools implements reconciler for GKE node pool components.
shared Package shared implements functionality that is shared across different services.	Package shared implements functionality that is shared across different services.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL