Documentation
¶
Index ¶
- Variables
- type Configuration
- func (cfg *Configuration) AddContext(c *Context, force bool) bool
- func (cfg *Configuration) AddControlPlane(cp *ControlPlane, force bool) bool
- func (*Configuration) Descriptor() ([]byte, []int)deprecated
- func (cfg *Configuration) GetContext(name string) (int, *Context)
- func (x *Configuration) GetContexts() []*Context
- func (cfg *Configuration) GetControlPlane(name string) (int, *ControlPlane)
- func (x *Configuration) GetControlPlanes() []*ControlPlane
- func (cfg *Configuration) GetCurrent() *Context
- func (x *Configuration) GetCurrentContext() string
- func (*Configuration) ProtoMessage()
- func (x *Configuration) ProtoReflect() protoreflect.Message
- func (cfg *Configuration) RemoveContext(name string) bool
- func (cfg *Configuration) RemoveControlPlane(name string) bool
- func (x *Configuration) Reset()
- func (x *Configuration) String() string
- func (cfg *Configuration) SwitchContext(name string) bool
- type Context
- func (*Context) Descriptor() ([]byte, []int)deprecated
- func (x *Context) GetControlPlane() string
- func (x *Context) GetDefaults() *Context_Defaults
- func (x *Context) GetName() string
- func (*Context) ProtoMessage()
- func (x *Context) ProtoReflect() protoreflect.Message
- func (x *Context) Reset()
- func (x *Context) String() string
- type Context_Defaults
- type ControlPlane
- func (*ControlPlane) Descriptor() ([]byte, []int)deprecated
- func (x *ControlPlane) GetCoordinates() *ControlPlaneCoordinates
- func (x *ControlPlane) GetName() string
- func (*ControlPlane) ProtoMessage()
- func (x *ControlPlane) ProtoReflect() protoreflect.Message
- func (x *ControlPlane) Reset()
- func (x *ControlPlane) String() string
- type ControlPlaneCoordinates
- func (*ControlPlaneCoordinates) Descriptor() ([]byte, []int)deprecated
- func (x *ControlPlaneCoordinates) GetApiServer() *ControlPlaneCoordinates_ApiServer
- func (*ControlPlaneCoordinates) ProtoMessage()
- func (x *ControlPlaneCoordinates) ProtoReflect() protoreflect.Message
- func (x *ControlPlaneCoordinates) Reset()
- func (x *ControlPlaneCoordinates) String() string
- type ControlPlaneCoordinates_ApiServer
- func (*ControlPlaneCoordinates_ApiServer) Descriptor() ([]byte, []int)deprecated
- func (x *ControlPlaneCoordinates_ApiServer) GetAuthConf() map[string]string
- func (x *ControlPlaneCoordinates_ApiServer) GetAuthType() string
- func (x *ControlPlaneCoordinates_ApiServer) GetCaCertFile() string
- func (x *ControlPlaneCoordinates_ApiServer) GetClientCertFile() string
- func (x *ControlPlaneCoordinates_ApiServer) GetClientKeyFile() string
- func (x *ControlPlaneCoordinates_ApiServer) GetHeaders() []*ControlPlaneCoordinates_Headers
- func (x *ControlPlaneCoordinates_ApiServer) GetUrl() string
- func (cfg *ControlPlaneCoordinates_ApiServer) HasCerts() bool
- func (*ControlPlaneCoordinates_ApiServer) ProtoMessage()
- func (x *ControlPlaneCoordinates_ApiServer) ProtoReflect() protoreflect.Message
- func (x *ControlPlaneCoordinates_ApiServer) Reset()
- func (x *ControlPlaneCoordinates_ApiServer) String() string
- type ControlPlaneCoordinates_Headers
- func (*ControlPlaneCoordinates_Headers) Descriptor() ([]byte, []int)deprecated
- func (x *ControlPlaneCoordinates_Headers) GetKey() string
- func (x *ControlPlaneCoordinates_Headers) GetValue() string
- func (*ControlPlaneCoordinates_Headers) ProtoMessage()
- func (x *ControlPlaneCoordinates_Headers) ProtoReflect() protoreflect.Message
- func (x *ControlPlaneCoordinates_Headers) Reset()
- func (x *ControlPlaneCoordinates_Headers) String() string
Constants ¶
This section is empty.
Variables ¶
var File_pkg_config_app_kumactl_v1alpha1_config_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
// List of known Control Planes.
ControlPlanes []*ControlPlane `protobuf:"bytes,1,rep,name=control_planes,json=controlPlanes,proto3" json:"control_planes,omitempty"`
// List of configured `kumactl` contexts.
Contexts []*Context `protobuf:"bytes,2,rep,name=contexts,proto3" json:"contexts,omitempty"`
// Name of the context to use by default.
CurrentContext string `protobuf:"bytes,3,opt,name=current_context,json=currentContext,proto3" json:"current_context,omitempty"`
// contains filtered or unexported fields
}
Configuration defines configuration of `kumactl`.
func (*Configuration) AddContext ¶
func (cfg *Configuration) AddContext(c *Context, force bool) bool
func (*Configuration) AddControlPlane ¶
func (cfg *Configuration) AddControlPlane(cp *ControlPlane, force bool) bool
func (*Configuration) Descriptor
deprecated
func (*Configuration) Descriptor() ([]byte, []int)
Deprecated: Use Configuration.ProtoReflect.Descriptor instead.
func (*Configuration) GetContext ¶
func (cfg *Configuration) GetContext(name string) (int, *Context)
func (*Configuration) GetContexts ¶
func (x *Configuration) GetContexts() []*Context
func (*Configuration) GetControlPlane ¶
func (cfg *Configuration) GetControlPlane(name string) (int, *ControlPlane)
func (*Configuration) GetControlPlanes ¶
func (x *Configuration) GetControlPlanes() []*ControlPlane
func (*Configuration) GetCurrent ¶
func (cfg *Configuration) GetCurrent() *Context
func (*Configuration) GetCurrentContext ¶
func (x *Configuration) GetCurrentContext() string
func (*Configuration) ProtoMessage ¶
func (*Configuration) ProtoMessage()
func (*Configuration) ProtoReflect ¶
func (x *Configuration) ProtoReflect() protoreflect.Message
func (*Configuration) RemoveContext ¶
func (cfg *Configuration) RemoveContext(name string) bool
func (*Configuration) RemoveControlPlane ¶
func (cfg *Configuration) RemoveControlPlane(name string) bool
func (*Configuration) SwitchContext ¶
func (cfg *Configuration) SwitchContext(name string) bool
type Context ¶
type Context struct {
// Name defines a reference name for a given context.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// ControlPlane defines a reference to a known Control Plane.
ControlPlane string `protobuf:"bytes,2,opt,name=control_plane,json=controlPlane,proto3" json:"control_plane,omitempty"`
// Defaults defines default settings for a given context.
Defaults *Context_Defaults `protobuf:"bytes,3,opt,name=defaults,proto3" json:"defaults,omitempty"`
// contains filtered or unexported fields
}
Context defines a context in which individual `kumactl` commands run.
func (*Context) Descriptor
deprecated
func (*Context) Descriptor() ([]byte, []int)
Deprecated: Use Context.ProtoReflect.Descriptor instead.
func (*Context) GetControlPlane ¶
func (x *Context) GetControlPlane() string
func (*Context) GetDefaults ¶
func (x *Context) GetDefaults() *Context_Defaults
func (*Context) ProtoMessage ¶
func (*Context) ProtoMessage()
func (*Context) ProtoReflect ¶
func (x *Context) ProtoReflect() protoreflect.Message
type Context_Defaults ¶
type Context_Defaults struct {
// Mesh defines a Mesh to use in requests if one is not provided explicitly.
Mesh string `protobuf:"bytes,1,opt,name=mesh,proto3" json:"mesh,omitempty"`
// contains filtered or unexported fields
}
Defaults defines default settings for a context.
func (*Context_Defaults) Descriptor
deprecated
func (*Context_Defaults) Descriptor() ([]byte, []int)
Deprecated: Use Context_Defaults.ProtoReflect.Descriptor instead.
func (*Context_Defaults) ProtoMessage ¶
func (*Context_Defaults) ProtoMessage()
func (*Context_Defaults) ProtoReflect ¶
func (x *Context_Defaults) ProtoReflect() protoreflect.Message
type ControlPlane ¶
type ControlPlane struct {
// Name defines a reference name for a given Control Plane.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Coordinates defines coordinates of a given Control Plane.
Coordinates *ControlPlaneCoordinates `protobuf:"bytes,2,opt,name=coordinates,proto3" json:"coordinates,omitempty"`
// contains filtered or unexported fields
}
ControlPlane defines a Control Plane.
func (*ControlPlane) Descriptor
deprecated
func (*ControlPlane) Descriptor() ([]byte, []int)
Deprecated: Use ControlPlane.ProtoReflect.Descriptor instead.
func (*ControlPlane) GetCoordinates ¶
func (x *ControlPlane) GetCoordinates() *ControlPlaneCoordinates
func (*ControlPlane) ProtoMessage ¶
func (*ControlPlane) ProtoMessage()
func (*ControlPlane) ProtoReflect ¶
func (x *ControlPlane) ProtoReflect() protoreflect.Message
type ControlPlaneCoordinates ¶
type ControlPlaneCoordinates struct {
ApiServer *ControlPlaneCoordinates_ApiServer `protobuf:"bytes,1,opt,name=api_server,json=apiServer,proto3" json:"api_server,omitempty"`
// contains filtered or unexported fields
}
ControlPlaneCoordinates defines coordinates of a Control Plane.
func (*ControlPlaneCoordinates) Descriptor
deprecated
func (*ControlPlaneCoordinates) Descriptor() ([]byte, []int)
Deprecated: Use ControlPlaneCoordinates.ProtoReflect.Descriptor instead.
func (*ControlPlaneCoordinates) GetApiServer ¶
func (x *ControlPlaneCoordinates) GetApiServer() *ControlPlaneCoordinates_ApiServer
func (*ControlPlaneCoordinates) ProtoMessage ¶
func (*ControlPlaneCoordinates) ProtoMessage()
func (*ControlPlaneCoordinates) ProtoReflect ¶
func (x *ControlPlaneCoordinates) ProtoReflect() protoreflect.Message
type ControlPlaneCoordinates_ApiServer ¶
type ControlPlaneCoordinates_ApiServer struct {
// URL defines URL of the Control Plane API Server.
Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
// CaCert defines the certificate authority which will be used to verify
// connection to the control plane API server
CaCertFile string `protobuf:"bytes,2,opt,name=ca_cert_file,json=caCertFile,proto3" json:"ca_cert_file,omitempty"`
// ClientCert defines the certificate of the authorized client of the
// control plane API server
ClientCertFile string `protobuf:"bytes,3,opt,name=client_cert_file,json=clientCertFile,proto3" json:"client_cert_file,omitempty"`
// ClientKey defines the key of the authorized client of the control plane
// API server
ClientKeyFile string `protobuf:"bytes,4,opt,name=client_key_file,json=clientKeyFile,proto3" json:"client_key_file,omitempty"`
// Headers to be added for communication with Kuma control plane
Headers []*ControlPlaneCoordinates_Headers `protobuf:"bytes,5,rep,name=headers,proto3" json:"headers,omitempty"`
// Authentication type
AuthType string `protobuf:"bytes,6,opt,name=auth_type,json=authType,proto3" json:"auth_type,omitempty"`
// Authentication configuration for defined authentication type
AuthConf map[string]string `` /* 173-byte string literal not displayed */
// contains filtered or unexported fields
}
func (*ControlPlaneCoordinates_ApiServer) Descriptor
deprecated
func (*ControlPlaneCoordinates_ApiServer) Descriptor() ([]byte, []int)
Deprecated: Use ControlPlaneCoordinates_ApiServer.ProtoReflect.Descriptor instead.
func (*ControlPlaneCoordinates_ApiServer) GetAuthConf ¶ added in v1.8.1
func (x *ControlPlaneCoordinates_ApiServer) GetAuthConf() map[string]string
func (*ControlPlaneCoordinates_ApiServer) GetAuthType ¶ added in v1.8.1
func (x *ControlPlaneCoordinates_ApiServer) GetAuthType() string
func (*ControlPlaneCoordinates_ApiServer) GetCaCertFile ¶
func (x *ControlPlaneCoordinates_ApiServer) GetCaCertFile() string
func (*ControlPlaneCoordinates_ApiServer) GetClientCertFile ¶
func (x *ControlPlaneCoordinates_ApiServer) GetClientCertFile() string
func (*ControlPlaneCoordinates_ApiServer) GetClientKeyFile ¶
func (x *ControlPlaneCoordinates_ApiServer) GetClientKeyFile() string
func (*ControlPlaneCoordinates_ApiServer) GetHeaders ¶
func (x *ControlPlaneCoordinates_ApiServer) GetHeaders() []*ControlPlaneCoordinates_Headers
func (*ControlPlaneCoordinates_ApiServer) GetUrl ¶
func (x *ControlPlaneCoordinates_ApiServer) GetUrl() string
func (*ControlPlaneCoordinates_ApiServer) HasCerts ¶
func (cfg *ControlPlaneCoordinates_ApiServer) HasCerts() bool
func (*ControlPlaneCoordinates_ApiServer) ProtoMessage ¶
func (*ControlPlaneCoordinates_ApiServer) ProtoMessage()
func (*ControlPlaneCoordinates_ApiServer) ProtoReflect ¶
func (x *ControlPlaneCoordinates_ApiServer) ProtoReflect() protoreflect.Message
type ControlPlaneCoordinates_Headers ¶
type ControlPlaneCoordinates_Headers struct {
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*ControlPlaneCoordinates_Headers) Descriptor
deprecated
func (*ControlPlaneCoordinates_Headers) Descriptor() ([]byte, []int)
Deprecated: Use ControlPlaneCoordinates_Headers.ProtoReflect.Descriptor instead.
func (*ControlPlaneCoordinates_Headers) GetKey ¶
func (x *ControlPlaneCoordinates_Headers) GetKey() string
func (*ControlPlaneCoordinates_Headers) GetValue ¶
func (x *ControlPlaneCoordinates_Headers) GetValue() string
func (*ControlPlaneCoordinates_Headers) ProtoMessage ¶
func (*ControlPlaneCoordinates_Headers) ProtoMessage()
func (*ControlPlaneCoordinates_Headers) ProtoReflect ¶
func (x *ControlPlaneCoordinates_Headers) ProtoReflect() protoreflect.Message