provider

package

v1.11.0 Latest Latest Go to latest Published: Jan 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/virtual-kubelet/virtual-kubelet

Links

Open Source Insights

README ¶

Follow these steps to be accepted as a provider within the Virtual Kubelet repo.

Replicate the life-cycle of a pod for example creation and deletion of a pod and how that maps to your service.
Create a new provider folder with a descriptive name and the necessary code.
When committing your code add a README.md, helm chart, dockerfile and specify a maintainer of the provider.
Within the PR itself add a justification for why the provider should be accepted, as well as customer use cases if applicable.

Some providers are translations of Virtual Kubelet to allow others to adapt their service or applications that are written in other languages.

Documentation ¶

Index ¶

Constants
Variables
type InitConfig
type InitFunc
type OperatingSystems
- func (o OperatingSystems) Names() []string
type Provider
type Store
- func NewStore() *Store

Constants ¶

View Source

const (
	// OperatingSystemLinux is the configuration value for defining Linux.
	OperatingSystemLinux = "linux"
	// OperatingSystemWindows is the configuration value for defining Windows.
	OperatingSystemWindows = "windows"
)

Variables ¶

View Source

var (
	// ValidOperatingSystems defines the group of operating systems
	// that can be used as a kubelet node.
	ValidOperatingSystems = OperatingSystems{
		OperatingSystemLinux:   true,
		OperatingSystemWindows: true,
	}
)

Functions ¶

This section is empty.

Types ¶

type InitConfig ¶

type InitConfig struct {
	ConfigPath        string
	NodeName          string
	OperatingSystem   string
	InternalIP        string
	DaemonPort        int32
	KubeClusterDomain string
	ResourceManager   *manager.ResourceManager
}

InitConfig is the config passed to initialize a registered provider.

type InitFunc ¶

type InitFunc func(InitConfig) (Provider, error) //nolint:golint

type OperatingSystems ¶

type OperatingSystems map[string]bool //nolint:golint

func (OperatingSystems) Names ¶

func (o OperatingSystems) Names() []string

type Provider ¶

type Provider interface {
	nodeutil.Provider
	// ConfigureNode enables a provider to configure the node object that
	// will be used for Kubernetes.
	ConfigureNode(context.Context, *v1.Node)
}

Provider wraps the core provider type with an extra function needed to bootstrap the node

type Store ¶

type Store struct {
	// contains filtered or unexported fields
}

Store is used for registering/fetching providers

func NewStore ¶

func NewStore() *Store

func (*Store) Exists ¶

func (s *Store) Exists(name string) bool

Exists returns if there is an init function registered under the provided name

func (*Store) Get ¶

func (s *Store) Get(name string) InitFunc

Get gets the registered init func for the given name The returned function may be nil if the given name is not registered.

func (*Store) List ¶

func (s *Store) List() []string

List lists all the registered providers

func (*Store) Register ¶

func (s *Store) Register(name string, f InitFunc) error

Register registers a providers init func by name

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
mock

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