Documentation ¶
Index ¶
- func AddContextToConfig(contextName string, context Context, configPath string, set bool) error
- func AddTokenToConfig(token Token, configPath string) error
- func DeleteTokenFromConfig(tokenName string, configPath string) error
- func SetTokenToConfig(tokenName string, configPath string, ctxName string) error
- func UpdateContextInConfig(v *viper.Viper, context *Context, name string) error
- type Context
- func (ctx *Context) GetChannel() string
- func (ctx *Context) GetComponents() []string
- func (ctx *Context) GetEndpoint() string
- func (ctx *Context) GetPlatform() string
- func (ctx *Context) GetToken() string
- func (ctx *Context) GetVersion() string
- func (ctx *Context) SetChannel(channel string)
- func (ctx *Context) SetEndpoint(endpoint string)
- func (ctx *Context) SetPlatform(platform string)
- func (ctx *Context) SetToken(token string)
- func (ctx *Context) SetVersion(version string)
- func (ctx *Context) ValidateVersion() error
- type MesheryCtlConfig
- func (mc *MesheryCtlConfig) CheckIfCurrentContextIsValid() (*Context, error)
- func (mc *MesheryCtlConfig) CheckIfGivenContextIsValid(name string) (*Context, error)
- func (mc *MesheryCtlConfig) GetBaseMesheryURL() string
- func (mc *MesheryCtlConfig) GetContext(name string) (*Context, error)
- func (mc *MesheryCtlConfig) GetCurrentContext() (*Context, error)
- func (mc *MesheryCtlConfig) GetCurrentContextName() string
- func (mc *MesheryCtlConfig) GetTokenForContext(contextName string) (Token, error)
- func (mc *MesheryCtlConfig) GetTokens() *[]Token
- func (mc *MesheryCtlConfig) SetCurrentContext(contextName string) error
- type Token
- type Version
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddContextToConfig ¶ added in v0.5.27
AddContextToConfig adds context passed to it to mesheryctl config file
func AddTokenToConfig ¶ added in v0.5.27
AddTokenToConfig adds token passed to it to mesheryctl config file
func DeleteTokenFromConfig ¶ added in v0.5.39
DeleteTokenFromConfig deletes a token passed to it to mesheryctl config file
func SetTokenToConfig ¶ added in v0.5.39
Types ¶
type Context ¶
type Context struct { Endpoint string `mapstructure:"endpoint,omitempty"` Token string `mapstructure:"token,omitempty"` Platform string `mapstructure:"platform"` Components []string `mapstructure:"components,omitempty"` Channel string `mapstructure:"channel,omitempty"` Version string `mapstructure:"version,omitempty"` }
Context defines a meshery environment
func (*Context) GetChannel ¶ added in v0.5.38
GetChannel returns the channel of the current context
func (*Context) GetComponents ¶ added in v0.6.2
GetComponents returns the components in the current context
func (*Context) GetEndpoint ¶ added in v0.5.38
GetEndpoint returns the endpoint of the current context
func (*Context) GetPlatform ¶ added in v0.5.38
GetPlatform returns the platform of the current context
func (*Context) GetVersion ¶ added in v0.5.38
GetVersion returns the version of the current context
func (*Context) SetChannel ¶ added in v0.5.38
SetChannel sets the channel of the current context
func (*Context) SetEndpoint ¶ added in v0.5.38
SetEndpoint sets the endpoint of the current context
func (*Context) SetPlatform ¶ added in v0.5.38
SetPlatform sets the platform of the current context
func (*Context) SetVersion ¶ added in v0.5.38
SetVersion sets the version of the current context
func (*Context) ValidateVersion ¶ added in v0.5.2
ValidateVersion checks if the version is valid, if empty sets it to default value latest. Returns an error if the version is invalid.
type MesheryCtlConfig ¶
type MesheryCtlConfig struct { Contexts map[string]Context `mapstructure:"contexts"` CurrentContext string `mapstructure:"current-context"` Tokens []Token `mapstructure:"tokens"` }
MesheryCtlConfig is configuration structure of mesheryctl with contexts
func GetMesheryCtl ¶
func GetMesheryCtl(v *viper.Viper) (*MesheryCtlConfig, error)
GetMesheryCtl returns a reference to the mesheryctl configuration object
func (*MesheryCtlConfig) CheckIfCurrentContextIsValid ¶
func (mc *MesheryCtlConfig) CheckIfCurrentContextIsValid() (*Context, error)
CheckIfCurrentContextIsValid checks if current context is valid
func (*MesheryCtlConfig) CheckIfGivenContextIsValid ¶ added in v0.5.39
func (mc *MesheryCtlConfig) CheckIfGivenContextIsValid(name string) (*Context, error)
func (*MesheryCtlConfig) GetBaseMesheryURL ¶
func (mc *MesheryCtlConfig) GetBaseMesheryURL() string
GetBaseMesheryURL returns the base meshery server URL
func (*MesheryCtlConfig) GetContext ¶ added in v0.5.39
func (mc *MesheryCtlConfig) GetContext(name string) (*Context, error)
Get any context
func (*MesheryCtlConfig) GetCurrentContext ¶
func (mc *MesheryCtlConfig) GetCurrentContext() (*Context, error)
GetCurrentContext returns contents of the current context
func (*MesheryCtlConfig) GetCurrentContextName ¶ added in v0.5.38
func (mc *MesheryCtlConfig) GetCurrentContextName() string
func (*MesheryCtlConfig) GetTokenForContext ¶ added in v0.5.32
func (mc *MesheryCtlConfig) GetTokenForContext(contextName string) (Token, error)
GetTokenForContext takes in the contextName and returns the token name and path corresponding to the given current context
func (*MesheryCtlConfig) GetTokens ¶ added in v0.5.38
func (mc *MesheryCtlConfig) GetTokens() *[]Token
GetTokens returns the tokens present in the config file
func (*MesheryCtlConfig) SetCurrentContext ¶
func (mc *MesheryCtlConfig) SetCurrentContext(contextName string) error
SetCurrentContext sets current context and returns contents of the current context
type Token ¶
Token defines the structure of Token stored in mesheryctl
func (*Token) GetLocation ¶ added in v0.5.32
GetLocation returns the location of the token
func (*Token) SetLocation ¶ added in v0.5.39
SetLocation sets the location of the token
type Version ¶
type Version struct { Build string `json:"build,omitempty"` CommitSHA string `json:"commitsha,omitempty"` ReleaseChannel string `json:"release_channel,omitempty"` }
Version unmarshals the json response from the server's version api
func (*Version) GetCommitSHA ¶
GetCommitSHA returns the commit sha for the binary