package
1.8.0-alpha.1
Repository: https://github.com/bentheelder/kubernetes.git
Documentation: pkg.go.dev

# README

Deprecation Notice: This directory has entered maintenance mode and will not be accepting new providers. Cloud Providers in this directory will continue to be actively developed or maintained and supported at their current level of support as a longer-term solution evolves.

Overview:

The mechanism for supporting cloud providers is currently in transition: the original method of implementing cloud provider-specific functionality within the main kubernetes tree (here) is no longer advised; however, the proposed solution is still in development.

Guidance for potential cloud providers:

  • Support for cloud providers is currently in a state of flux. Background information on motivation and the proposal for improving is in the github proposal.
  • In support of this plan, a new cloud-controller-manager binary was added in 1.6. This was the first of several steps (see the proposal for more information).
  • Attempts to contribute new cloud providers or (to a lesser extent) persistent volumes to the core repo will likely meet with some pushback from reviewers/approvers.
  • It is understood that this is an unfortunate situation in which 'the old way is no longer supported but the new way is not ready yet', but the initial path is unsustainable, and contributors are encouraged to participate in the implementation of the proposed long-term solution, as there is risk that PRs for new cloud providers here will not be approved.
  • Though the fully productized support envisioned in the proposal is still 2 - 3 releases out, the foundational work is underway, and a motivated cloud provider could accomplish the work in a forward-looking way. Contributors are encouraged to assist with the implementation of the design outlined in the proposal.

Some additional context on status / direction:

  • 1.6 added a new cloud-controller-manager binary that may be used for testing the new out-of-core cloudprovider flow.
  • Setting cloud-provider=external allows for creation of a separate controller-manager binary
  • 1.7 adds extensible admission control, further enabling topology customization.

# Packages

No description provided by the author

# Functions

CloudProviders returns the name of all registered cloud providers in a string slice.
GetCloudProvider creates an instance of the named cloud provider, or nil if the name is unknown.
GetInstanceProviderID builds a ProviderID for a node in a cloud.
TODO(#6812): Use a shorter name that's less likely to be longer than cloud providers' name length limits.
InitCloudProvider creates an instance of the named cloud provider.
IsCloudProvider returns true if name corresponds to an already registered cloud provider.
Detects if the string is an external cloud provider.
RegisterCloudProvider registers a cloudprovider.Factory by name.

# Variables

No description provided by the author
No description provided by the author

# Structs

Route is a representation of an advanced routing rule.
Zone represents the location of a particular machine.

# Interfaces

Clusters is an abstract, pluggable interface for clusters of containers.
Instances is an abstract, pluggable interface for sets of instances.
Interface is an abstract, pluggable interface for cloud providers.
LoadBalancer is an abstract, pluggable interface for load balancers.
Routes is an abstract, pluggable interface for advanced routing rules.
Zones is an abstract, pluggable interface for zone enumeration.

# Type aliases

Factory is a function that returns a cloudprovider.Interface.