remoteclient

Documentation

Index

• type Builder
  • func NewBuilder(c client.Client, cd *hivev1.ClusterDeployment, controllerName string) Builder

Types

type Builder

type Builder interface {
	// Build will return a static kubeclient for the remote cluster.
	Build() (client.Client, error)

	// BuildDynamic will return a dynamic kubeclient for the remote cluster.
	BuildDynamic() (dynamic.Interface, error)

	// Unreachable returns true if Hive has not been able to reach the remote cluster.
	// Note that this function will not attempt to reach the remote cluster. It only checks the current conditions on
	// the ClusterDeployment to determine if the remote cluster is reachable.
	Unreachable() bool

	// APIURL returns the API URL used to connect to the remote cluster.
	APIURL() (string, error)

	// RESTConfig returns the config for a REST client that connects to the remote cluster.
	RESTConfig() (*rest.Config, error)

	// UsePrimaryAPIURL will use the primary API URL. If there is an API URL override, then that is the primary.
	// Otherwise, the primary is the default API URL.
	UsePrimaryAPIURL() Builder

	// UseSecondaryAPIURL will use the secondary API URL. If there is an API URL override, then the initial API URL
	// is the secondary.
	UseSecondaryAPIURL() Builder
}

Builder is used to build API clients to the remote cluster

func NewBuilder

func NewBuilder(c client.Client, cd *hivev1.ClusterDeployment, controllerName string) Builder

NewBuilder creates a new Builder for creating a client to connect to the remote cluster associated with the specified ClusterDeployment. The controllerName is needed for metrics.