system

Documentation

Index

• Constants
• Variables
• func ErrApplyManifest(err error, deleteStatus, updateStatus bool) error
• func ErrApplyOperatorManifest(err error, deleteStatus, updateStatus bool) error
• func ErrCreateDir(err error, obj string) error
• func ErrCreateManifestsFolder(err error) error
• func ErrDownloadFile(err error, obj string) error
• func ErrHealthCheckFailed(err error) error
• func ErrInvalidAdapter(err error, obj string) error
• func ErrProcessingMctlConfig(err error) error
• func ErrResetMeshconfig(err error) error
• func ErrRestartMeshery(err error) error
• func ErrRetrievingCurrentContext(err error) error
• func ErrSettingTemporaryContext(err error) error
• func ErrStopMeshery(err error) error
• func ErrUnmarshal(err error, obj string) error
• func ErrUnsupportedPlatform(platform string, config string) error
• func IsBetaOrStable(str string) bool
• func PrintChannelAndVersionToStdout(ctx config.Context, contextName string) string
• type HealthCheckOptions
• type HealthChecker
  • func NewHealthChecker(options *HealthCheckOptions) (*HealthChecker, error)
  • func (hc *HealthChecker) Run() error
  • func (hc *HealthChecker) RunPreflightHealthChecks() error

Constants

const (
	ErrHealthCheckFailedCode        = "1000"
	ErrInvalidAdapterCode           = "1001"
	ErrDownloadFileCode             = "1002"
	ErrStopMesheryCode              = "1003"
	ErrResetMeshconfigCode          = "1004"
	ErrApplyManifestCode            = "1005"
	ErrApplyOperatorManifestCode    = "1006"
	ErrCreateDirCode                = "1007"
	ErrUnmarshalCode                = "1008"
	ErrUnsupportedPlatformCode      = "1009"
	ErrRetrievingCurrentContextCode = "1022"
	ErrSettingTemporaryContextCode  = "1023"
	ErrCreateManifestsFolderCode    = "1024"
	ErrProcessingMctlConfigCode     = "1025"
	ErrRestartMesheryCode           = "1026"
)

Variables

var ContextCmd = &cobra.Command{
	Use:   "context [command]",
	Short: "Configure your Meshery deployment(s)",
	Long:  `Configure and switch between different named Meshery server and adapter versions and deployments.`,
	Args:  cobra.MaximumNArgs(1),
	RunE: func(cmd *cobra.Command, args []string) error {
		if len(args) == 0 {
			currentContext := viper.GetString("current-context")
			if currentContext == "" {
				return errors.New("current context not set")
			}

			log.Printf("Current context: %s\n", currentContext)
			return cmd.Help()
		}

		if ok := utils.IsValidSubcommand(availableSubcommands, args[0]); !ok {
			return errors.New(utils.SystemError(fmt.Sprintf("invalid command: \"%s\"", args[0])))
		}
		return nil
	},
}

ContextCmd represents the context command

var SystemCmd = &cobra.Command{
	Use:   "system",
	Short: "Meshery Lifecycle Management",
	Long:  `Manage the state and configuration of Meshery server, adapters, and client.`,
	Args:  cobra.MinimumNArgs(1),
	RunE: func(cmd *cobra.Command, args []string) error {
		if ok := utils.IsValidSubcommand(availableSubcommands, args[0]); !ok {
			return errors.New(utils.SystemError(fmt.Sprintf("invalid command: \"%s\"", args[0])))
		}
		mctlCfg, err := config.GetMesheryCtl(viper.GetViper())
		if err != nil {
			return errors.Wrap(err, "error processing config")
		}
		mctlCfg.GetBaseMesheryURL()
		return nil
	},
}

SystemCmd represents Meshery Lifecycle Management cli commands

Functions

func ErrApplyManifest

func ErrApplyManifest(err error, deleteStatus, updateStatus bool) error

func ErrApplyOperatorManifest

func ErrApplyOperatorManifest(err error, deleteStatus, updateStatus bool) error

func ErrCreateDir

func ErrCreateDir(err error, obj string) error

func ErrCreateManifestsFolder

func ErrCreateManifestsFolder(err error) error

func ErrDownloadFile

func ErrDownloadFile(err error, obj string) error

func ErrHealthCheckFailed

func ErrHealthCheckFailed(err error) error

func ErrInvalidAdapter

func ErrInvalidAdapter(err error, obj string) error

func ErrProcessingMctlConfig

func ErrProcessingMctlConfig(err error) error

func ErrResetMeshconfig

func ErrResetMeshconfig(err error) error

func ErrRestartMeshery

func ErrRestartMeshery(err error) error

func ErrRetrievingCurrentContext

func ErrRetrievingCurrentContext(err error) error

func ErrSettingTemporaryContext

func ErrSettingTemporaryContext(err error) error

func ErrStopMeshery

func ErrStopMeshery(err error) error

func ErrUnmarshal

func ErrUnmarshal(err error, obj string) error

func ErrUnsupportedPlatform

func ErrUnsupportedPlatform(platform string, config string) error

func IsBetaOrStable

func IsBetaOrStable(str string) bool

IsBetaOrStable to determine which release channel is being used

func PrintChannelAndVersionToStdout

func PrintChannelAndVersionToStdout(ctx config.Context, contextName string) string

PrintChannelAndVersionToStdout to return curren release channel details

Types

type HealthCheckOptions

type HealthCheckOptions struct {
	// PrintLogs to keep incheck to print logs during a healthcheck
	PrintLogs bool
	// IsPreRunE to keep incheck if healthchecks are triggered as as a PreRunE
	IsPreRunE bool

	// the command under which the healthchecks are being triggered
	Subcommand string
	// if RunDockerChecks is true we run docker checks
	RunDockerChecks bool
	// if RunKubernetesChecks is true we run k8s checks
	RunKubernetesChecks bool
	// if RunOperatorChecks is true we run operator checks
	RunOperatorChecks bool
	// if RunVersionChecks is true we run version checks
	RunVersionChecks bool
	// if RunAdapterChecks is true we run adapter checks
	RunAdapterChecks bool
}

type HealthChecker

type HealthChecker struct {
	Options *HealthCheckOptions
	// contains filtered or unexported fields
}

func NewHealthChecker

func NewHealthChecker(options *HealthCheckOptions) (*HealthChecker, error)

func (*HealthChecker) Run

func (hc *HealthChecker) Run() error

Run triggers all the healthchecks according to the requirements defined from struct HealthChecks

func (*HealthChecker) RunPreflightHealthChecks

func (hc *HealthChecker) RunPreflightHealthChecks() error

Run preflight healthchecks to verify environment health