constants

Documentation

Index

• Constants

Constants

const (
	// GlobalFlagHelp - global help flag
	GlobalFlagHelp               = "help"
	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"
	VPOTimeoutFlag               = "platform-operator-timeout"
	VPOTimeoutFlagHelp           = "Limits the amount of time a command will wait for the Verrazzano Platform Operator to be ready"
	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" // an alias for the manifests flag
	OperatorFileDeprecateMsg     = "Use --manifests instead"
	ManifestsFlag                = "manifests"
	ManifestsShorthand           = "m"
	ManifestsFlagHelp            = "" /* 230-byte string literal not displayed */
	ImageRegistryFlag            = "image-registry"
	ImageRegistryFlagHelp        = "" /* 136-byte string literal not displayed */
	ImageRegistryFlagDefault     = ""
	ImagePrefixFlag              = "image-prefix"
	ImagePrefixFlagHelp          = "" /* 173-byte string literal not displayed */
	ImagePrefixFlagDefault       = ""
	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 */
	SkipConfirmationFlagHelp     = "Non-interactive mode - assumes the answers to all interactive questions to be 'Y'."
	SkipConfirmationFlag         = "skip-confirmation"
	SkipConfirmationShort        = "y"
	SkipPlatformOperatorFlag     = "skip-platform-operator"
	SkipPlatformOperatorFlagHelp = "Installing the platform operator is skipped, but continues on to install Verrazzano."
	VerboseFlag                  = "verbose"
	VerboseFlagShorthand         = "v"
	VerboseFlagDefault           = false
	VerboseFlagUsage             = "Enable verbose output."
	ReadOnly                     = "read-only file system"
	AutoBugReportFlag            = "auto-bug-report"
	AutoBugReportFlagDefault     = true
	AutoBugReportFlagHelp        = "Automatically call vz bug-report if command fails"
	VzAnalysisReportTmpFile      = "details-*.out"
	// DatetimeFormat - suffix to vz bug report file in yyyymmddhhmmss format
	DatetimeFormat = "20060102150405"
)

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

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

	TarFileFlagName  = "tar-file"
	TarFileFlagValue = ""
	TarFileFlagUsage = "Name of the cluster-dump tar file, which can have extensions of .tar, .tgz, and .tar.gz"

	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 (
	NamespaceFlag        = "namespace"
	NamespaceFlagDefault = "default"
	NamespaceFlagUsage   = "The namespace containing the OAM application to export"
	AppNameFlag          = "name"
	AppNameFlagDefault   = ""
	AppNameFlagUsage     = "The name of the OAM application to export"
)

Constants for export

const (
	InputTarFileFlagName  = "input-tar-file"
	InputTarFileFlagValue = ""
	InputTarFileFlagUsage = "Name of the input bug-report tar file, which can have extensions of .tar, .tgz, and .tar.gz"

	OutputTarGZFileFlagName  = "output-tar.gz-file"
	OutputTarGZFileFlagValue = ""
	OutputTarGZFileFlagUsage = "Name of the .tar.gz file that contains the sanitized output"

	InputDirectoryFlagName  = "input-directory"
	InputDirectoryFlagValue = ""
	InputDirectoryFlagUsage = "Name of the directory that contains the un-sanitized bug-report"

	OutputDirectoryFlagName  = "output-directory"
	OutputDirectoryFlagValue = ""
	OutputDirectoryFlagUsage = "Name of the directory that will contain the sanitized bug-report"
)

Constants for sanitize

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

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

	// Flag for generating the redacted values mappping file
	RedactedValuesFlagName  = "redacted-values-file"
	RedactedValuesFlagValue = ""
	RedactedValuesFlagUsage = "" /* 195-byte string literal not displayed */

	BugReportDir = "bug-report"

	SanitizeDirInput = "sanitize-input"

	SanitizeDirOutput = "sanitize-output"

	TestDirectory   = "test-directory"
	OutputTarGZFile = "output-tar-file.tar.gz"

	// File name for the log captured from the pod
	LogFile         = "logs.txt"
	PreviousLogFile = "previous-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 containing a map from redacted values to their original values
	RedactionPrefix     = "REDACTED-"
	RedactionFileSuffix = "-sensitive-do-not-share-redaction-map.csv"

	// File names for the various resources
	VzResource        = "verrazzano-resources.json"
	DeploymentsJSON   = "deployments.json"
	EventsJSON        = "events.json"
	PodsJSON          = "pods.json"
	CertificatesJSON  = "certificates.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"
	NamespaceJSON     = "namespace.json"
	MetadataJSON      = "metadata.json"
	InnoDBClusterJSON = "inno-db-cluster.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 (
	ProgressFlag        = "progress"
	ProgressFlagHelp    = "Displaying progress bar with components and their status"
	ProgressFlagDefault = false
)

const (
	FlagErrorMessage          = "an error occurred while reading value for the flag --%s: %s"
	RedactionMapCreationError = "an error occurred while creating the redacted values map at %s: %s"
)

Common error strings

const GlobalFlagContext = "context"

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

const GlobalFlagContextHelp = "The name of the kubeconfig context to use" // Flags that are common to more than one command

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 MysqlBackupMutatingWebhookName = "verrazzano-mysql-backup"

MysqlBackupMutatingWebhookName specifies the name of mysql webhook.

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 ProgressShorthand = "p"

const RefreshRate = time.Second * 10

const TotalWidth = 50

const VerrazzanoApplicationOperator = "verrazzano-application-operator"

const VerrazzanoClusterOperator = "verrazzano-cluster-operator"

const VerrazzanoInstall = "verrazzano-install"

const VerrazzanoManagedCluster = "verrazzano-managed-cluster"

const VerrazzanoManagedLabel = "verrazzano-managed=true"

const VerrazzanoMonitoringOperator = "verrazzano-monitoring-operator"

const VerrazzanoMysqlInstallValuesWebhook = "verrazzano-platform-mysqlinstalloverrides"

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 VerrazzanoPlatformOperatorWebhook = "verrazzano-platform-operator-webhook"

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

VerrazzanoReleaseList - API for getting the list of Verrazzano releases

const VerrazzanoRequirementsValidatorWebhook = "verrazzano-platform-requirements-validator"

const VerrazzanoUninstall = "verrazzano-uninstall"