registry

README

Cloud Provider Registry

This package enables cloud providers to embed themselves into the Karpenter binary without bundling all cloud providers simultaneously. We use mutually exclusive go build tags to register the cloud provider into the import tree. The default implementation is a neutral "mock" cloud provider that implements no-op behavior.

Add your cloud provider in this directory:

// +build <YOUR_PROVIDER_NAME>
import (
	"github.com/aws/karpenter/pkg/cloudprovider/<YOUR_PROVIDER_NAME>"
)

func NewCloudProvider() cloudprovider.CloudProvider {
	return <YOUR_PROVIDER_NAME>.NewCloudProvider()
}

Build your customized binary

CLOUD_PROVIDER=<YOUR_PROVIDER_NAME> make apply

Add a negative flag to mock.go

// +build !<YOUR_PROVIDER_NAME>

Documentation

Index

• func NewCloudProvider(ctx context.Context, options cloudprovider.Options) cloudprovider.CloudProvider
• func RegisterOrDie(ctx context.Context, cloudProvider cloudprovider.CloudProvider)

Functions

func NewCloudProvider

func NewCloudProvider(ctx context.Context, options cloudprovider.Options) cloudprovider.CloudProvider

func RegisterOrDie

func RegisterOrDie(ctx context.Context, cloudProvider cloudprovider.CloudProvider)

RegisterOrDie populates supported instance types, zones, operating systems, architectures, and validation logic. This operation should only be called once at startup time. Typically, this call is made by NewCloudProvider(), but must be called if the cloud provider is constructed manually (e.g. tests).