info

Documentation

Index

• Constants
• Variables
• type BuildInfoService
• type DefaultBuildInfoServiceImpl
  • func (b *DefaultBuildInfoServiceImpl) GetBuildInfo() (info *debug.BuildInfo, ok bool)
• type DefaultInfoServiceImpl
  • func (i *DefaultInfoServiceImpl) GetVersion() string
• type InfoService

Constants

const (
	// Environment Variables
	BackplaneURLEnvName        = "BACKPLANE_URL"
	BackplaneProxyEnvName      = "HTTPS_PROXY"
	BackplaneConfigPathEnvName = "BACKPLANE_CONFIG"
	BackplaneKubeconfigEnvName = "KUBECONFIG"

	// Configuration
	BackplaneConfigDefaultFilePath = ".config/backplane"
	BackplaneConfigDefaultFileName = "config.json"

	// Session
	BackplaneDefaultSessionDirectory = "backplane"

	// GitHub API get fetch the latest tag
	UpstreamReleaseAPI = "https://api.github.com/repos/openshift/backplane-cli/releases/latest"

	// Upstream git module
	UpstreamGitModule = "https://github.com/openshift/backplane-cli/cmd/ocm-backplane"

	// GitHub README page
	UpstreamREADMETemplate = "https://github.com/openshift/backplane-cli/-/blob/%s/README.md"

	// GitHub Host
	GitHubHost = "github.com"

	// Nginx configuration template for monitoring-plugin
	MonitoringPluginNginxConfigTemplate = `` /* 266-byte string literal not displayed */

	MonitoringPluginNginxConfigFilename = "monitoring-plugin-nginx-%s.conf"
)

Variables

var (
	// Version of the backplane-cli
	// This will be set via Goreleaser during the build process
	Version string

	UpstreamREADMETagged = fmt.Sprintf(UpstreamREADMETemplate, Version)
)

Types

type BuildInfoService

type BuildInfoService interface {
	// return the BuildInfo from Go build
	GetBuildInfo() (info *debug.BuildInfo, ok bool)
}

var DefaultBuildInfoService BuildInfoService = &DefaultBuildInfoServiceImpl{}

type DefaultBuildInfoServiceImpl

type DefaultBuildInfoServiceImpl struct {
}

func (*DefaultBuildInfoServiceImpl) GetBuildInfo

func (b *DefaultBuildInfoServiceImpl) GetBuildInfo() (info *debug.BuildInfo, ok bool)

type DefaultInfoServiceImpl

type DefaultInfoServiceImpl struct {
}

func (*DefaultInfoServiceImpl) GetVersion

func (i *DefaultInfoServiceImpl) GetVersion() string

type InfoService

type InfoService interface {
	// get the current binary version from available sources
	GetVersion() string
}

var DefaultInfoService InfoService = &DefaultInfoServiceImpl{}