reporter

package

v0.1.63 Latest Latest Go to latest Published: Apr 24, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/codefresh-io/cli-v2

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (

	// Install
	InstallPhasePreCheckStart                         CliStep = "install.pre-check.phase.start"
	InstallStepPreCheckValidateRuntimeVersion         CliStep = "install.pre-check.step.validate-runtime-version"
	InstallStepPreCheckGetRuntimeName                 CliStep = "install.pre-check.step.get-runtime-name"
	InstallStepPreCheckRuntimeNameValidation          CliStep = "install.pre-check.step.runtime-name-validation"
	InstallStepPreCheckGetKubeContext                 CliStep = "install.pre-check.step.get-kube-context"
	InstallStepPreCheckEnsureIngressClass             CliStep = "install.pre-check.step.ensure-ingress-class"
	InstallStepPreCheckEnsureIngressHost              CliStep = "install.pre-check.step.ensure-ingress-host"
	InstallStepPreCheckEnsureRuntimeRepo              CliStep = "install.pre-check.step.ensure-runtime-repo"
	InstallStepPreCheckEnsureGitToken                 CliStep = "install.pre-check.step.ensure-git-token"
	InstallStepPreCheckEnsureGitPAT                   CliStep = "install.pre-check.step.ensure-git-personal-access-token"
	InstallStepPreCheckShouldInstallDemoResources     CliStep = "install.pre-check.step.should-install-demo-resources"
	InstallPhasePreCheckFinish                        CliStep = "install.pre-check.phase.finish"
	InstallPhaseRunPreCheckStart                      CliStep = "install.run.pre-check.phase.start"
	InstallStepRunPreCheckGitProvider                 CliStep = "install.run.pre-check.step.check-git-provider"
	InstallStepRunPreCheckDownloadRuntimeDefinition   CliStep = "install.run.pre-check.step.download-runtime-definition"
	InstallStepRunPreCheckEnsureCliVersion            CliStep = "install.run.pre-check.step.ensure-cli-version"
	InstallStepRunPreCheckRuntimeCollision            CliStep = "install.run.pre-check.step.runtime-collision"
	InstallStepRunPreCheckExisitingRuntimes           CliStep = "install.run.pre-check.step.existing-runtimes"
	InstallStepRunPreCheckValidateClusterRequirements CliStep = "install.run.pre-check.step.validate-cluster-requirements"
	InstallPhaseRunPreCheckFinish                     CliStep = "install.run.pre-check.phase.finish"
	InstallPhaseStart                                 CliStep = "install.run.phase.start"
	InstallStepDownloadRuntimeDefinition              CliStep = "install.run.step.download-runtime-definition"
	InstallStepGetServerAddress                       CliStep = "install.run.step.get-server-address"
	InstallStepCreateRuntimeOnPlatform                CliStep = "install.run.step.create-runtime-on-platform"
	InstallStepBootstrapRepo                          CliStep = "install.run.step.bootstrap-repo"
	InstallStepCreateProject                          CliStep = "install.run.step.create-project"
	InstallStepCreateOrUpdateConfigMap                CliStep = "install.run.step.create-or-update-codefresh-cm"
	InstallStepApplySecretsToCluster                  CliStep = "install.run.step.apply-secrets-to-cluster"
	InstallStepCreateComponents                       CliStep = "install.run.step.create-components"
	InstallStepInstallComponenets                     CliStep = "install.run.step.install-components"
	InstallStepCreateGitsource                        CliStep = "install.run.step.create-gitsource"
	InstallStepCreateMarketplaceGitsource             CliStep = "install.run.step.create-marketplace-gitsource"
	InstallStepCompleteRuntimeInstallation            CliStep = "install.run.step.complete-runtime-installation"
	InstallStepCreateDefaultGitIntegration            CliStep = "install.run.step.create-default-git-integration"
	InstallStepRegisterToDefaultGitIntegration        CliStep = "install.run.step.register-to-default-git-integration"
	InstallPhaseFinish                                CliStep = "install.run.phase.finish"

	// Uninstall
	UninstallPhasePreCheckStart                     CliStep = "uninstall.pre-check.phase.start"
	UninstallStepPreCheckGetKubeContext             CliStep = "uninstall.pre-check.step.get-kube-context"
	UninstallStepPreCheckEnsureRuntimeOnKubeContext CliStep = "uninstall.pre-check.step.ensure-runtime-on-kube-context"
	UninstallStepPreCheckEnsureRuntimeName          CliStep = "uninstall.pre-check.step.ensure-runtime-name"
	UninstallStepPreCheckRuntimeNameValidation      CliStep = "uninstall.pre-check.step.runtime-name-validation"
	UninstallStepPreCheckEnsureRuntimeRepo          CliStep = "uninstall.pre-check.step.ensure-runtime-repo"
	UninstallStepPreCheckEnsureGitToken             CliStep = "uninstall.pre-check.step.ensure-git-token"
	UninstallPhasePreCheckFinish                    CliStep = "uninstall.pre-check.phase.finish"
	UninstallPhaseStart                             CliStep = "uninstall.run.phase.start"
	UninstallStepCheckRuntimeExists                 CliStep = "uninstall.run.step.check-runtime-exists"
	UninstallStepUninstallRepo                      CliStep = "uninstall.run.step.uninstall-repo"
	UninstallStepRemoveRuntimeIsc                   CliStep = "uninstall.run.step.remove-runtime-isc"
	UninstallStepRemoveGitIntegrations              CliStep = "uninstall.run.step.remove-git-integrations"
	UninstallStepDeleteRuntimeFromPlatform          CliStep = "uninstall.run.step.delete-runtime-from-platform"
	UninstallPhaseFinish                            CliStep = "uninstall.run.phase.finish"

	// Upgrade
	UpgradePhasePreCheckStart              CliStep = "upgrade.pre-check.phase.start"
	UpgradeStepPreCheckEnsureRuntimeName   CliStep = "upgrade.pre-check.step.ensure-runtime-name"
	UpgradeStepPreCheckIsManagedRuntime    CliStep = "upgrade.pre-check.step.is-managed-runtime"
	UpgradeStepPreCheckEnsureRuntimeRepo   CliStep = "upgrade.pre-check.step.ensure-runtime-repo"
	UpgradeStepPreCheckEnsureGitToken      CliStep = "upgrade.pre-check.step.ensure-git-token"
	UpgradePhasePreCheckFinish             CliStep = "upgrade.pre-check.phase.finish"
	UpgradePhaseStart                      CliStep = "upgrade.run.phase.start"
	UpgradeStepDownloadRuntimeDefinition   CliStep = "upgrade.run.step.download-runtime-definition"
	UpgradeStepRunPreCheckEnsureCliVersion CliStep = "upgrade.run.step.ensure-cli-version"
	UpgradeStepGetRepo                     CliStep = "upgrade.run.step.get-repo"
	UpgradeStepLoadRuntimeDefinition       CliStep = "upgrade.run.step.load-runtime-definition"
	UpgradeStepCompareRuntimeVersions      CliStep = "upgrade.run.step.compare-runtime-versions"
	UpgradeStepUpgradeRuntime              CliStep = "upgrade.run.step.upgrade-runtime"
	UpgradeStepPushRuntimeDefinition       CliStep = "upgrade.run.step.push-runtime-definition"
	UpgradeStepInstallNewComponents        CliStep = "upgrade.run.step.install-new-components"
	UpgradeStepMigrateInternalRouter       CliStep = "upgrade.run.step.migrate-internal-router"
	UpgradePhaseFinish                     CliStep = "upgrade.run.phase.finish"

	// General
	SIGNAL_TERMINATION CliStep = "signal-termination"
	FINISH             CliStep = "run.finish"

	SUCCESS           CliStepStatus = "SUCCESS"
	FAILURE           CliStepStatus = "FAILURE"
	CANCELED          CliStepStatus = "CANCELED"
	ABRUPTLY_CANCELED CliStepStatus = "ABRUPTLY_CANCELED"

	InstallFlow   FlowType = "installation"
	UninstallFlow FlowType = "uninstallation"
	UpgradeFlow   FlowType = "upgrade"
)

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(user *v1.User, flow FlowType)

Types ¶

type AnalyticsReporter ¶

type AnalyticsReporter interface {
	ReportStep(CliStepData)
	Close(step CliStepStatus, err error)
}

func G ¶

func G() AnalyticsReporter

G returns the global reporter

type CliStep ¶ added in v0.0.204

type CliStep string

type CliStepData ¶

type CliStepData struct {
	Step        CliStep
	Status      CliStepStatus
	Description string
	Err         error
}

type CliStepStatus ¶

type CliStepStatus string

type FlowType ¶ added in v0.0.204

type FlowType string

Source Files ¶

View all Source files

reporter.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL