constants

Documentation

Index

• Constants

Constants

const (
	WaitFlag        = "wait"
	WaitFlagHelp    = "Wait for the command to complete and stream the logs to the console. The wait period is controlled by --timeout."
	WaitFlagDefault = true

	TimeoutFlag     = "timeout"
	TimeoutFlagHelp = "Limits the amount of time a command will wait to complete"

	VersionFlag            = "version"
	VersionFlagDefault     = "latest"
	VersionFlagInstallHelp = "The version of Verrazzano to install"
	VersionFlagUpgradeHelp = "The version of Verrazzano to upgrade to"

	DryRunFlag = "dry-run"

	SetFlag          = "set"
	SetFlagShorthand = "s"
	SetFlagHelp      = "Override a Verrazzano resource value (e.g. --set profile=dev).  This flag can be specified multiple times."

	OperatorFileFlag     = "operator-file"
	OperatorFileFlagHelp = "The path to the file for installing the Verrazzano platform operator. The default is derived from the version string."

	LogFormatFlag = "log-format"
	LogFormatHelp = "The format of the log output. Valid output formats are \"simple\" and \"json\"."

	FilenameFlag          = "filename"
	FilenameFlagShorthand = "f"
	FilenameFlagHelp      = "" /* 181-byte string literal not displayed */

	VerboseFlag          = "verbose"
	VerboseFlagShorthand = "v"
	VerboseFlagDefault   = false
	VerboseFlagUsage     = "Enable verbose output."
)

Flags that are common to more than one command

const (
	DirectoryFlagName  = "capture-dir"
	DirectoryFlagValue = ""
	DirectoryFlagUsage = "Directory holding the captured data."

	ReportFileFlagName  = "report-file"
	ReportFileFlagValue = ""
	ReportFileFlagUsage = "Name of the report output file. (default stdout)"

	ReportFormatFlagName  = "report-format"
	ReportFormatFlagUsage = "The format of the report output. Valid report formats are \"summary\" and \"detailed\"."

	SummaryReport  = "summary"
	DetailedReport = "detailed"
)

Analysis tool flags

const (
	BugReportLogFlagDefault   = false
	BugReportFileFlagName     = "report-file"
	BugReportFileFlagValue    = ""
	BugReportFileFlagShort    = "r"
	BugReportFileFlagUsage    = "" /* 129-byte string literal not displayed */
	BugReportFileDefaultValue = "bug-report.tar.gz"

	BugReportIncludeNSFlagName  = "include-namespaces"
	BugReportIncludeNSFlagShort = "i"
	BugReportIncludeNSFlagUsage = "" /* 242-byte string literal not displayed */

	BugReportDir = "bug-report"

	// File name for the log captured from the pod
	LogFile = "logs.txt"

	// File containing list of resources captured by the tool
	BugReportOut = "bug-report.out"
	BugReportErr = "bug-report.err"

	BugReportError   = "" /* 129-byte string literal not displayed */
	BugReportWarning = "WARNING: Please examine the contents of the bug report for any sensitive data"

	// File names for the various resources
	VzResource       = "verrazzano-resources.json"
	DeploymentsJSON  = "deployments.json"
	EventsJSON       = "events.json"
	PodsJSON         = "pods.json"
	ServicesJSON     = "services.json"
	ReplicaSetsJSON  = "replicasets.json"
	DaemonSetsJSON   = "daemonsets.json"
	IngressJSON      = "ingress.json"
	StatefulSetsJSON = "statefulsets.json"
	AppConfigJSON    = "application-configurations.json"
	ComponentJSON    = "components.json"
	IngressTraitJSON = "ingress-traits.json"
	MetricsTraitJSON = "metrics-traits.json"
	McAppConfigJSON  = "multicluster-application-configurations.json"
	McComponentJSON  = "multicluster-components.json"
	VzProjectsJSON   = "verrazzano-projects.json"
	VmcJSON          = "verrazzano-managed-clusters.json"

	// Indentation when the resource is marshalled as Json
	JSONIndent = "  "

	// The prefix used for the json.MarshalIndent
	JSONPrefix = ""

	// Top level directory for the bug report, keeping cluster-snapshot for now to support the analyze the command
	BugReportRoot = "cluster-snapshot"

	// Label for application
	AppLabel               = "app"
	K8SAppLabel            = "k8s-app"
	K8sAppLabelExternalDNS = "app.kubernetes.io/name"
	// Message prefix for bug-report and live cluster analysis
	BugReportMsgPrefix = "Capturing "
	AnalysisMsgPrefix  = "Analyzing "

	// Flag for capture pods logs( both additional and system namespaces)
	BugReportLogFlagName         = "include-logs"
	BugReportLogFlagNameShort    = "l"
	BugReportLogFlagNameUsage    = "Include logs from the pods in one or more namespaces; this is specified along with the --include-namespaces flag."
	BugReportTimeFlagName        = "duration"
	BugReportTimeFlagNameShort   = "d"
	BugReportTimeFlagDefaultTime = 0
	BugReportTimeFlagNameUsage   = "The time period during which the logs are collected in seconds, minutes, and hours."
)

Constants for bug report

const (
	ClusterNameFlagName    = "name"
	ClusterNameFlagDefault = "vz-capi"
	ClusterNameFlagHelp    = "The name of the cluster"

	ClusterTypeFlagName    = "type"
	ClusterTypeFlagDefault = "ocne"
	ClusterTypeFlagHelp    = "The type of the cluster"

	ClusterImageFlagName    = "image"
	ClusterImageFlagDefault = ""
	ClusterImageFlagHelp    = "DEVELOPMENT ONLY - the image to use for the cluster"

	KubeconfigPathFlagName    = "path"
	KubeconfigPathFlagDefault = ""
	KubeconfigPathFlagHelp    = "Path to the file where the kubeconfig should be saved - defaults to your current kubeconfig"
)

Constants for cluster operations

const GlobalFlagContext = "context"

GlobalFlagContext - global flag for specifying which kube config context to use

const GlobalFlagContextHelp = "The name of the kubeconfig context to use"

const GlobalFlagHelp = "help"

GlobalFlagHelp - global help flag

const GlobalFlagKubeConfig = "kubeconfig"

GlobalFlagKubeConfig - global flag for specifying the location of the kube config

const GlobalFlagKubeConfigHelp = "Path to the kubeconfig file to use"

const LineSeparator = "-"

const OAMAppConfigurations = "applicationconfigurations"

const OAMComponents = "components"

const OAMIngressTraits = "ingresstraits"

const OAMMCAppConfigurations = "multiclusterapplicationconfigurations"

const OAMMCCompConfigurations = "multiclustercomponents"

const OAMManagedClusters = "verrazzanomanagedclusters"

const OAMMetricsTraits = "metricstraits"

const OAMProjects = "verrazzanoprojects"

const VerrazzanoApplicationOperator = "verrazzano-application-operator"

const VerrazzanoInstall = "verrazzano-install"

const VerrazzanoManagedCluster = "verrazzano-managed-cluster"

const VerrazzanoManagedLabel = "verrazzano-managed=true"

const VerrazzanoMonitoringOperator = "verrazzano-monitoring-operator"

const VerrazzanoOperatorURL = "https://github.com/verrazzano/verrazzano/releases/download/%s/operator.yaml"

VerrazzanoOperatorURL - URL for downloading Verrazzano operator.yaml

const VerrazzanoPlatformOperator = "verrazzano-platform-operator"

const VerrazzanoPlatformOperatorURL = "https://github.com/verrazzano/verrazzano/releases/download/%s/verrazzano-platform-operator.yaml"

VerrazzanoPlatformOperatorURL - URL for downloading verrazzano-platform-operator.yaml

const VerrazzanoPlatformOperatorWait = 1

const VerrazzanoReleaseList = "https://api.github.com/repos/verrazzano/verrazzano/releases"

VerrazzanoReleaseList - API for getting the list of Verrazzano releases

const VerrazzanoUninstall = "verrazzano-uninstall"