client

Documentation

Index

• func IgnoreErrorCodes(err error, codes ...int) error
• func IgnoreNotFoundError(err error) error
• func IsErrorCode(err error, codes ...int) bool
• type ComputeClient
  • func NewComputeClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (ComputeClient, error)
• type DNSClient
  • func NewDNSClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (DNSClient, error)
• type Factory
  • func NewFactory() Factory
• type IAMClient
  • func NewIAMClient(ctx context.Context, serviceAccount *gcp.ServiceAccount) (IAMClient, error)
  • func NewIAMClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (IAMClient, error)
• type StorageClient
  • func NewStorageClient(ctx context.Context, serviceAccount *gcp.ServiceAccount) (StorageClient, error)
  • func NewStorageClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (StorageClient, error)

Functions

func IgnoreErrorCodes

func IgnoreErrorCodes(err error, codes ...int) error

IgnoreErrorCodes returns nil if the error matches one of the provided HTTP status codes.

func IgnoreNotFoundError

func IgnoreNotFoundError(err error) error

IgnoreNotFoundError returns nil if the error is a NotFound error. Otherwise, it returns the original error.

func IsErrorCode

func IsErrorCode(err error, codes ...int) bool

IsErrorCode checks if the error is of type googleapi.Error and the HTTP status matches one of the provided list of codes.

Types

type ComputeClient

type ComputeClient interface {
	// GetExternalAddresses returns a list of all external IP addresses mapped to the names of their users.
	GetExternalAddresses(ctx context.Context, region string) (map[string][]string, error)
	// GetVPC returns a name of VPC
	GetVPC(ctx context.Context, network string) (*compute.Network, error)
	// GetSubnet returns a subnet info.
	GetSubnet(ctx context.Context, region, subnet string) (*compute.Subnetwork, error)
}

ComputeClient is an interface which must be implemented by GCP compute clients.

func NewComputeClientFromSecretRef

func NewComputeClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (ComputeClient, error)

NewComputeClientFromSecretRef creates a new compute client from the given client and secret reference.

type DNSClient

type DNSClient interface {
	GetManagedZones(ctx context.Context) (map[string]string, error)
	CreateOrUpdateRecordSet(ctx context.Context, managedZone, name, recordType string, rrdatas []string, ttl int64) error
	DeleteRecordSet(ctx context.Context, managedZone, name, recordType string) error
}

DNSClient is an interface which must be implemented by GCP DNS clients.

func NewDNSClientFromSecretRef

func NewDNSClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (DNSClient, error)

NewDNSClientFromSecretRef creates a new DNS client from the given client and secret reference.

type Factory

type Factory interface {
	NewDNSClient(context.Context, client.Client, corev1.SecretReference) (DNSClient, error)
	NewStorageClient(context.Context, client.Client, corev1.SecretReference) (StorageClient, error)
	NewComputeClient(context.Context, client.Client, corev1.SecretReference) (ComputeClient, error)
	NewIAMClient(context.Context, client.Client, corev1.SecretReference) (IAMClient, error)
}

Factory is a factory that can produce clients for various GCP Services.

func NewFactory

func NewFactory() Factory

NewFactory returns a new factory to produce clients for various GCP services.

type IAMClient

type IAMClient interface {
	GetServiceAccount(ctx context.Context, name string) (*iam.ServiceAccount, error)
}

IAMClient is the client interface for the IAM API.

func NewIAMClient

func NewIAMClient(ctx context.Context, serviceAccount *gcp.ServiceAccount) (IAMClient, error)

NewIAMClient returns a new IAM client.

func NewIAMClientFromSecretRef

func NewIAMClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (IAMClient, error)

NewIAMClientFromSecretRef creates a new compute client from the given client and secret reference.

type StorageClient

type StorageClient interface {
	// GCS wrappers
	CreateBucketIfNotExists(ctx context.Context, bucketName, region string) error
	DeleteBucketIfExists(ctx context.Context, bucketName string) error
	DeleteObjectsWithPrefix(ctx context.Context, bucketName, prefix string) error
}

StorageClient is an interface which must be implemented by GCS clients.

func NewStorageClient

func NewStorageClient(ctx context.Context, serviceAccount *gcp.ServiceAccount) (StorageClient, error)

NewStorageClient creates a new storage client from the given serviceAccount.

func NewStorageClientFromSecretRef

func NewStorageClientFromSecretRef(ctx context.Context, c client.Client, secretRef corev1.SecretReference) (StorageClient, error)

NewStorageClientFromSecretRef creates a new storage client from the given <secretRef>.