v1alpha1

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 16, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the client v1alpha1 API group +kubebuilder:object:generate=true +groupName=config.tanzu.vmware.com

Index

Constants

View Source 
const (
	// FeatureCli allows a feature to be set at the CLI level (globally) rather than for a single plugin
	FeatureCli string = "cli"
	// EditionStandard refers to the standard edition
	// Edition value (in config) affects branding and cluster creation
	EditionStandard = "tkg"
	// EditionCommunity refers to the community edition
	EditionCommunity = "tce"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "config.tanzu.vmware.com", Version: "v1alpha1"}

	// GroupVersionKind has information about group, version and kind of this object.
	GroupVersionKind = GroupVersion.WithKind("ClientConfig")

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

Types

type CLIOptions 

type CLIOptions struct {
	// Repositories are the plugin repositories.
	Repositories []PluginRepository `json:"repositories,omitempty" yaml:"repositories,omitempty"`
	// DiscoverySources determines from where to discover stand-alone plugins
	DiscoverySources []PluginDiscovery `json:"discoverySources,omitempty" yaml:"discoverySources,omitempty"`
	// UnstableVersionSelector determined which version tags are allowed
	UnstableVersionSelector VersionSelectorLevel `json:"unstableVersionSelector,omitempty" yaml:"unstableVersionSelector,omitempty"`
	// Deprecated: Edition has been deprecated and will be removed from future version
	// Edition
	Edition EditionSelector `json:"edition,omitempty" yaml:"edition,omitempty"`
	// Deprecated: BOMRepo has been deprecated and will be removed from future version
	// BOMRepo is the root repository URL used to resolve the compatibiilty file
	// and bill of materials. An example URL is projects.registry.vmware.com/tkg.
	BOMRepo string `json:"bomRepo,omitempty" yaml:"bomRepo,omitempty"`
	// Deprecated: CompatibilityFilePath has been deprecated and will be removed from future version
	// CompatibilityFilePath is the path, from the BOM repo, to download and access the compatibility file.
	// the compatibility file is used for resolving the bill of materials for creating clusters.
	CompatibilityFilePath string `json:"compatibilityFilePath,omitempty" yaml:"compatibilityFilePath,omitempty"`
}

CLIOptions are options for the CLI.

func (*CLIOptions) DeepCopy 

func (in *CLIOptions) DeepCopy() *CLIOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CLIOptions.

func (*CLIOptions) DeepCopyInto 

func (in *CLIOptions) DeepCopyInto(out *CLIOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClientConfig 

type ClientConfig struct {
	metav1.TypeMeta   `json:",omitempty" yaml:",omitempty"`
	metav1.ObjectMeta `json:",omitempty" yaml:",omitempty"`
	// KnownServers available.
	// Deprecation targeted for a future version. Superseded by KnownContexts.
	KnownServers []*Server `json:"servers,omitempty" yaml:"servers,omitempty"`

	// CurrentServer in use.
	// Deprecation targeted for a future version. Superseded by CurrentContext.
	CurrentServer string `json:"current,omitempty" yaml:"current,omitempty"`

	// KnownContexts available.
	KnownContexts []*Context `json:"contexts,omitempty" yaml:"contexts,omitempty"`

	// CurrentContext for every type.
	CurrentContext map[cliapi.Target]string `json:"currentContext,omitempty" yaml:"currentContext,omitempty"`

	// ClientOptions are client specific options like feature flags, environment variables, repositories, discoverySources, etc.
	ClientOptions *ClientOptions `json:"clientOptions,omitempty" yaml:"clientOptions,omitempty"`
}

ClientConfig is the Schema for the configs API

func (*ClientConfig) DeepCopy 

func (in *ClientConfig) DeepCopy() *ClientConfig

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConfig.

func (*ClientConfig) DeepCopyInto 

func (in *ClientConfig) DeepCopyInto(out *ClientConfig)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClientConfig) DeepCopyObject 

func (in *ClientConfig) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*ClientConfig) GetAllCurrentContextsList added in v0.0.2 

func (c *ClientConfig) GetAllCurrentContextsList() ([]string, error)

GetAllCurrentContextsList returns all current context names as list

func (*ClientConfig) GetAllCurrentContextsMap added in v0.0.2 

func (c *ClientConfig) GetAllCurrentContextsMap() (map[cliapi.Target]*Context, error)

GetAllCurrentContextsMap returns all current context per Target

func (*ClientConfig) GetContext 

func (c *ClientConfig) GetContext(name string) (*Context, error)

GetContext by name.

func (*ClientConfig) GetCurrentContext 

func (c *ClientConfig) GetCurrentContext(target cliapi.Target) (*Context, error)

GetCurrentContext returns the current context for the given type.

func (*ClientConfig) GetCurrentServer 

func (c *ClientConfig) GetCurrentServer() (*Server, error)

GetCurrentServer returns the current server. Deprecation targeted for a future version. Use GetCurrentContext() instead.

func (*ClientConfig) GetEnvConfigurations 

func (c *ClientConfig) GetEnvConfigurations() map[string]string

GetEnvConfigurations returns a map of environment variables to values it returns nil if configuration is not yet defined

func (*ClientConfig) HasContext 

func (c *ClientConfig) HasContext(name string) bool

HasContext tells whether the Context by the given name exists.

func (*ClientConfig) HasServer 

func (c *ClientConfig) HasServer(name string) bool

HasServer tells whether the Server by the given name exists.

func (*ClientConfig) IsConfigFeatureActivated 

func (c *ClientConfig) IsConfigFeatureActivated(featurePath string) (bool, error)

IsConfigFeatureActivated return true if the feature is activated, false if not. An error if the featurePath is malformed

func (*ClientConfig) SetCurrentContext 

func (c *ClientConfig) SetCurrentContext(target cliapi.Target, ctxName string) error

SetCurrentContext sets the current context for the given target.

func (*ClientConfig) SetEditionSelector 

func (c *ClientConfig) SetEditionSelector(edition EditionSelector)

SetEditionSelector indicates the edition of tanzu to be run EditionStandard is the default, EditionCommunity is also available. These values affect branding and cluster creation

func (*ClientConfig) SetUnstableVersionSelector 

func (c *ClientConfig) SetUnstableVersionSelector(f VersionSelectorLevel)

SetUnstableVersionSelector will help determine the unstable versions supported In order of restrictiveness: "all" -> "alpha" -> "experimental" -> "none" none: return stable versions only. the default for both the config and the old flag. alpha: only versions tagged with -alpha experimental: all pre-release versions without +build semver data all: return all unstable versions.

func (*ClientConfig) SplitFeaturePath 

func (c *ClientConfig) SplitFeaturePath(featurePath string) (string, string, error)

SplitFeaturePath splits a feature's path into the pluginName and the featureName For example "features.management-cluster.dual-stack" returns "management-cluster", "dual-stack" An error results from a malformed path, including any path that does not start with "features."

type ClientConfigList 

type ClientConfigList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ClientConfig `json:"items"`
}

ClientConfigList contains a list of ClientConfig

func (*ClientConfigList) DeepCopy 

func (in *ClientConfigList) DeepCopy() *ClientConfigList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientConfigList.

func (*ClientConfigList) DeepCopyInto 

func (in *ClientConfigList) DeepCopyInto(out *ClientConfigList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ClientConfigList) DeepCopyObject 

func (in *ClientConfigList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ClientOptions 

type ClientOptions struct {
	// CLI options specific to the CLI.
	CLI      *CLIOptions           `json:"cli,omitempty" yaml:"cli,omitempty"`
	Features map[string]FeatureMap `json:"features,omitempty" yaml:"features,omitempty"`
	Env      map[string]string     `json:"env,omitempty" yaml:"env,omitempty"`
}

ClientOptions are the client specific options.

func (*ClientOptions) DeepCopy 

func (in *ClientOptions) DeepCopy() *ClientOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClientOptions.

func (*ClientOptions) DeepCopyInto 

func (in *ClientOptions) DeepCopyInto(out *ClientOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterServer 

type ClusterServer struct {
	// Endpoint for the login.
	Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`

	// Path to the kubeconfig.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`

	// The kubernetes context to use (if required), defaults to current.
	Context string `json:"context,omitempty" yaml:"context,omitempty"`

	// Denotes whether this server is a management cluster or not (workload cluster).
	IsManagementCluster bool `json:"isManagementCluster,omitempty" yaml:"isManagementCluster,omitempty"`
}

ClusterServer contains the configuration for a kubernetes cluster (kubeconfig).

func (*ClusterServer) DeepCopy 

func (in *ClusterServer) DeepCopy() *ClusterServer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterServer.

func (*ClusterServer) DeepCopyInto 

func (in *ClusterServer) DeepCopyInto(out *ClusterServer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConfigMetadata added in v0.0.2 

type ConfigMetadata struct {
	// PatchStrategy patch strategy to determine merge of nodes in config file. Two ways of patch strategies are merge and replace
	PatchStrategy map[string]string `json:"patchStrategy,omitempty" yaml:"patchStrategy,omitempty" mapstructure:"patchStrategy,omitempty"`
	// Settings related to config
	Settings map[string]string `json:"settings,omitempty" yaml:"settings,omitempty" mapstructure:"settings,omitempty"`
}

ConfigMetadata to store any config related metadata or settings

func (*ConfigMetadata) DeepCopy added in v0.0.2 

func (in *ConfigMetadata) DeepCopy() *ConfigMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConfigMetadata.

func (*ConfigMetadata) DeepCopyInto added in v0.0.2 

func (in *ConfigMetadata) DeepCopyInto(out *ConfigMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Context 

type Context struct {
	// Name of the context.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// Target of the context.
	Target cliapi.Target `json:"target,omitempty" yaml:"target,omitempty"`

	// GlobalOpts if the context is a global control plane (e.g., TMC).
	GlobalOpts *GlobalServer `json:"globalOpts,omitempty" yaml:"globalOpts,omitempty"`

	// ClusterOpts if the context is a kubernetes cluster.
	ClusterOpts *ClusterServer `json:"clusterOpts,omitempty" yaml:"clusterOpts,omitempty"`

	// DiscoverySources determines from where to discover plugins
	// associated with this context.
	DiscoverySources []PluginDiscovery `json:"discoverySources,omitempty" yaml:"discoverySources,omitempty"`
}

Context configuration for a control plane. This can one of the following, 1. Kubernetes Cluster 2. Tanzu Mission Control endpoint

func (*Context) DeepCopy 

func (in *Context) DeepCopy() *Context

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Context.

func (*Context) DeepCopyInto 

func (in *Context) DeepCopyInto(out *Context)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Context) IsManagementCluster 

func (c *Context) IsManagementCluster() bool

IsManagementCluster tells if the context is for a management cluster.

type EditionSelector 

type EditionSelector string

EditionSelector allows selecting edition versions based on config file

type EnvMap 

type EnvMap map[string]string

EnvMap is simply a hash table, but needs an explicit type to be an object in another hash map (cf ClientOptions.Env)

func (EnvMap) DeepCopy 

func (in EnvMap) DeepCopy() EnvMap

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EnvMap.

func (EnvMap) DeepCopyInto 

func (in EnvMap) DeepCopyInto(out *EnvMap)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FeatureMap 

type FeatureMap map[string]string

FeatureMap is simply a hash table, but needs an explicit type to be an object in another hash map (cf ClientOptions.Features)

func (FeatureMap) DeepCopy 

func (in FeatureMap) DeepCopy() FeatureMap

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FeatureMap.

func (FeatureMap) DeepCopyInto 

func (in FeatureMap) DeepCopyInto(out *FeatureMap)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPDiscovery 

type GCPDiscovery struct {
	// Name is a name of the discovery
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Bucket is a Google Cloud Storage bucket.
	// E.g., tanzu-cli
	Bucket string `json:"bucket,omitempty" yaml:"bucket,omitempty"`
	// BasePath is a URI path that is prefixed to the object name/path.
	// E.g., plugins/cluster
	ManifestPath string `json:"manifestPath,omitempty" yaml:"manifestPath,omitempty"`
}

GCPDiscovery provides a plugin discovery mechanism via a Google Cloud Storage bucket with a manifest.yaml file.

func (*GCPDiscovery) DeepCopy 

func (in *GCPDiscovery) DeepCopy() *GCPDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPDiscovery.

func (*GCPDiscovery) DeepCopyInto 

func (in *GCPDiscovery) DeepCopyInto(out *GCPDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCPPluginRepository 

type GCPPluginRepository struct {
	// Name of the repository.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// BucketName is the name of the bucket.
	BucketName string `json:"bucketName,omitempty" yaml:"bucketName,omitempty"`

	// RootPath within the bucket.
	RootPath string `json:"rootPath,omitempty" yaml:"rootPath,omitempty"`
}

GCPPluginRepository is a plugin repository that utilizes GCP cloud storage.

func (*GCPPluginRepository) DeepCopy 

func (in *GCPPluginRepository) DeepCopy() *GCPPluginRepository

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCPPluginRepository.

func (*GCPPluginRepository) DeepCopyInto 

func (in *GCPPluginRepository) DeepCopyInto(out *GCPPluginRepository)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GenericRESTDiscovery 

type GenericRESTDiscovery struct {
	// Name is a name of the discovery
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Endpoint is the REST API server endpoint.
	// E.g., api.my-domain.local
	Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`
	// BasePath is the base URL path of the plugin discovery API.
	// E.g., /v1alpha1/cli/plugins
	BasePath string `json:"basePath,omitempty" yaml:"basePath,omitempty"`
}

GenericRESTDiscovery provides a plugin discovery mechanism via any REST API endpoint. The fully qualified list URL is constructed as `https://{Endpoint}/{BasePath}` and the get plugin URL is constructed as . `https://{Endpoint}/{BasePath}/{Plugin}`.

func (*GenericRESTDiscovery) DeepCopy 

func (in *GenericRESTDiscovery) DeepCopy() *GenericRESTDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GenericRESTDiscovery.

func (*GenericRESTDiscovery) DeepCopyInto 

func (in *GenericRESTDiscovery) DeepCopyInto(out *GenericRESTDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GlobalServer 

type GlobalServer struct {
	// Endpoint for the server.
	Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`

	// Auth for the global server.
	Auth GlobalServerAuth `json:"auth,omitempty" yaml:"auth,omitempty"`
}

GlobalServer is the configuration for a global server.

func (*GlobalServer) DeepCopy 

func (in *GlobalServer) DeepCopy() *GlobalServer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalServer.

func (*GlobalServer) DeepCopyInto 

func (in *GlobalServer) DeepCopyInto(out *GlobalServer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GlobalServerAuth 

type GlobalServerAuth struct {
	// Issuer url for IDP, compliant with OIDC Metadata Discovery.
	Issuer string `json:"issuer,omitempty" yaml:"issuer,omitempty"`

	// UserName is the authorized user the token is assigned to.
	UserName string `json:"userName,omitempty" yaml:"userName,omitempty"`

	// Permissions are roles assigned to the user.
	Permissions []string `json:"permissions,omitempty" yaml:"permissions,omitempty"`

	// AccessToken is the current access token based on the context.
	AccessToken string `json:"accessToken,omitempty" yaml:"accessToken,omitempty"`

	// IDToken is the current id token based on the context scoped to the CLI.
	IDToken string `json:"IDToken,omitempty" yaml:"IDToken,omitempty"`

	// RefreshToken will be stored only in case of api-token login flow.
	RefreshToken string `json:"refresh_token,omitempty" yaml:"refresh_token,omitempty"`

	// Expiration times of the token.
	Expiration metav1.Time `json:"expiration,omitempty" yaml:"expiration,omitempty"`

	// Type of the token (user or client).
	Type string `json:"type" yaml:"type,omitempty"`
}

GlobalServerAuth is authentication for a global server.

func (*GlobalServerAuth) DeepCopy 

func (in *GlobalServerAuth) DeepCopy() *GlobalServerAuth

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GlobalServerAuth.

func (*GlobalServerAuth) DeepCopyInto 

func (in *GlobalServerAuth) DeepCopyInto(out *GlobalServerAuth)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type KubernetesDiscovery 

type KubernetesDiscovery struct {
	// Name is a name of the discovery
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Path to the kubeconfig.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`
	// The context to use (if required), defaults to current.
	Context string `json:"context,omitempty" yaml:"context,omitempty"`
	// Version of the CLIPlugins API to query.
	// E.g., v1alpha1
	Version string `json:"version,omitempty" yaml:"version,omitempty"`
}

KubernetesDiscovery provides a plugin discovery mechanism via the Kubernetes API server.

func (*KubernetesDiscovery) DeepCopy 

func (in *KubernetesDiscovery) DeepCopy() *KubernetesDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new KubernetesDiscovery.

func (*KubernetesDiscovery) DeepCopyInto 

func (in *KubernetesDiscovery) DeepCopyInto(out *KubernetesDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LocalDiscovery 

type LocalDiscovery struct {
	// Name is a name of the discovery
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Path is a local path pointing to directory
	// containing YAML files, each of which contains single
	// CLIPlugin API resource.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`
}

LocalDiscovery is a artifact discovery endpoint utilizing a local host OS.

func (*LocalDiscovery) DeepCopy 

func (in *LocalDiscovery) DeepCopy() *LocalDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new LocalDiscovery.

func (*LocalDiscovery) DeepCopyInto 

func (in *LocalDiscovery) DeepCopyInto(out *LocalDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ManagementClusterServer 

type ManagementClusterServer struct {
	// Endpoint for the login.
	Endpoint string `json:"endpoint,omitempty" yaml:"endpoint,omitempty"`

	// Path to the kubeconfig.
	Path string `json:"path,omitempty" yaml:"path,omitempty"`

	// The context to use (if required), defaults to current.
	Context string `json:"context,omitempty" yaml:"context,omitempty"`
}

ManagementClusterServer is the configuration for a management cluster kubeconfig. Deprecation targeted for a future version. Superseded by ClusterServer.

func (*ManagementClusterServer) DeepCopy 

func (in *ManagementClusterServer) DeepCopy() *ManagementClusterServer

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ManagementClusterServer.

func (*ManagementClusterServer) DeepCopyInto 

func (in *ManagementClusterServer) DeepCopyInto(out *ManagementClusterServer)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Metadata added in v0.0.2 

type Metadata struct {
	// ConfigMetadata to store any config related metadata or settings
	ConfigMetadata *ConfigMetadata `json:"configMetadata,omitempty" yaml:"configMetadata,omitempty" mapstructure:"configMetadata,omitempty"`
}

Metadata struct type to store config related metadata

func (*Metadata) DeepCopy added in v0.0.2 

func (in *Metadata) DeepCopy() *Metadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metadata.

func (*Metadata) DeepCopyInto added in v0.0.2 

func (in *Metadata) DeepCopyInto(out *Metadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OCIDiscovery 

type OCIDiscovery struct {
	// Name is a name of the discovery
	Name string `json:"name,omitempty" yaml:"name,omitempty"`
	// Image is an OCI compliant image. Which include DNS-compatible registry name,
	// a valid URI path(MAY contain zero or more ‘/’) and a valid tag.
	// E.g., harbor.my-domain.local/tanzu-cli/plugins-manifest:latest
	// Contains a directory containing YAML files, each of which contains single
	// CLIPlugin API resource.
	Image string `json:"image,omitempty" yaml:"image,omitempty"`
}

OCIDiscovery provides a plugin discovery mechanism via a OCI Image Registry

func (*OCIDiscovery) DeepCopy 

func (in *OCIDiscovery) DeepCopy() *OCIDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OCIDiscovery.

func (*OCIDiscovery) DeepCopyInto 

func (in *OCIDiscovery) DeepCopyInto(out *OCIDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PluginDiscovery 

type PluginDiscovery struct {
	// GCPStorage is set if the plugins are to be discovered via Google Cloud Storage.
	GCP *GCPDiscovery `json:"gcp,omitempty" yaml:"gcp,omitempty"`
	// OCIDiscovery is set if the plugins are to be discovered via an OCI Image Registry.
	OCI *OCIDiscovery `json:"oci,omitempty" yaml:"oci,omitempty"`
	// GenericRESTDiscovery is set if the plugins are to be discovered via a REST API endpoint.
	REST *GenericRESTDiscovery `json:"rest,omitempty" yaml:"rest,omitempty"`
	// KubernetesDiscovery is set if the plugins are to be discovered via the Kubernetes API server.
	Kubernetes *KubernetesDiscovery `json:"k8s,omitempty" yaml:"k8s,omitempty"`
	// LocalDiscovery is set if the plugins are to be discovered via Local Manifest fast.
	Local *LocalDiscovery `json:"local,omitempty" yaml:"local,omitempty"`
}

PluginDiscovery contains a specific distribution mechanism. Only one of the configs must be set.

func (*PluginDiscovery) DeepCopy 

func (in *PluginDiscovery) DeepCopy() *PluginDiscovery

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginDiscovery.

func (*PluginDiscovery) DeepCopyInto 

func (in *PluginDiscovery) DeepCopyInto(out *PluginDiscovery)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PluginRepository 

type PluginRepository struct {
	// GCPPluginRepository is a plugin repository that utilizes GCP cloud storage.
	GCPPluginRepository *GCPPluginRepository `json:"gcpPluginRepository,omitempty" yaml:"gcpPluginRepository,omitempty"`
}

PluginRepository is a CLI plugin repository

func (*PluginRepository) DeepCopy 

func (in *PluginRepository) DeepCopy() *PluginRepository

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PluginRepository.

func (*PluginRepository) DeepCopyInto 

func (in *PluginRepository) DeepCopyInto(out *PluginRepository)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Server 

type Server struct {
	// Name of the server.
	Name string `json:"name,omitempty" yaml:"name,omitempty"`

	// Type of the endpoint.
	Type ServerType `json:"type,omitempty" yaml:"type,omitempty"`

	// GlobalOpts if the server is global.
	GlobalOpts *GlobalServer `json:"globalOpts,omitempty" yaml:"globalOpts,omitempty"`

	// ManagementClusterOpts if the server is a management cluster.
	ManagementClusterOpts *ManagementClusterServer `json:"managementClusterOpts,omitempty" yaml:"managementClusterOpts,omitempty"`

	// DiscoverySources determines from where to discover plugins
	// associated with this server
	DiscoverySources []PluginDiscovery `json:"discoverySources,omitempty" yaml:"discoverySources,omitempty"`
}

Server connection. Deprecation targeted for a future version. Superseded by Context.

func (*Server) DeepCopy 

func (in *Server) DeepCopy() *Server

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Server.

func (*Server) DeepCopyInto 

func (in *Server) DeepCopyInto(out *Server)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Server) IsGlobal 

func (s *Server) IsGlobal() bool

IsGlobal tells if the server is global. Deprecation targeted for a future version. Use Context.Target instead.

func (*Server) IsManagementCluster 

func (s *Server) IsManagementCluster() bool

IsManagementCluster tells if the server is a management cluster. Deprecation targeted for a future version. Use Context.Target instead.

type ServerType 

type ServerType string

ServerType is the type of server. Deprecation targeted for a future version. Superseded by cliapi.Target. 

const (
	// ManagementClusterServerType is a management cluster server.
	// Deprecation targeted for a future version. Superseded by cliapi.TargetK8s.
	ManagementClusterServerType ServerType = "managementcluster"

	// GlobalServerType is a global control plane server.
	// Deprecation targeted for a future version. Superseded by cliapi.TargetTMC.
	GlobalServerType ServerType = "global"
)

type VersionSelectorLevel 

type VersionSelectorLevel string

VersionSelectorLevel allows selecting plugin versions based on semver properties 

const (
	// AllUnstableVersions allows all plugin versions
	AllUnstableVersions VersionSelectorLevel = "all"
	// AlphaUnstableVersions allows all alpha tagged versions
	AlphaUnstableVersions VersionSelectorLevel = "alpha"
	// ExperimentalUnstableVersions includes all pre-releases, minus +build tags
	ExperimentalUnstableVersions VersionSelectorLevel = "experimental"
	// NoUnstableVersions allows no unstable plugin versions, format major.minor.patch only
	NoUnstableVersions VersionSelectorLevel = "none"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.