shared

Documentation

Overview

Package shared should not be imported by external consumers. It was not designed for external use.

Index

• Constants
• func CheckCCAPIVersion(currentAPIVersion string) (string, error)
• func FlagBoolToString(enabled bool) string
• func GetNewClientsAndConnectToCF(config command.Config, ui command.UI, minVersionV3 string) (*ccv3.Client, *uaa.Client, *router.Client, error)
• func NewAuthWrappedCloudControllerClient(config command.Config, ui command.UI, uaaClient *uaa.Client) *ccv3.Client
• func NewNetworkingClient(apiURL string, config command.Config, uaaClient *uaa.Client, ui command.UI) (*cfnetv1.Client, error)
• func NewWrappedCloudControllerClient(config command.Config, ui command.UI, extraWrappers ...ccv3.ConnectionWrapper) *ccv3.Client
• func PollStage(dropletStream <-chan resources.Droplet, ...) (resources.Droplet, error)
• func WaitForResult(stream chan v7action.PollJobEvent, ui command.UI, waitForCompletion bool) (bool, error)
• type AppStager
  • func NewAppStager(actor stagingAndStartActor, ui command.UI, config command.Config, ...) AppStager
• type AppSummaryDisplayer
  • func NewAppSummaryDisplayer(ui command.UI) *AppSummaryDisplayer
  • func (display AppSummaryDisplayer) AppDisplay(summary v7action.DetailedApplicationSummary, displayStartCommand bool)
• type ManifestDiffDisplayer
  • func NewManifestDiffDisplayer(ui command.UI) *ManifestDiffDisplayer
  • func (display *ManifestDiffDisplayer) DisplayDiff(rawManifest []byte, diff resources.ManifestDiff) error
• type PackageDisplayer
  • func NewPackageDisplayer(ui command.UI, config command.Config) PackageDisplayer
  • func (display PackageDisplayer) DisplaySetupMessage(appName, currentUser string, isDockerImage bool) error
• type QuotaDisplayer
  • func NewQuotaDisplayer(ui command.UI) QuotaDisplayer
  • func (displayer QuotaDisplayer) DisplayQuotasTable(quotas []resources.Quota, emptyMessage string)
  • func (displayer QuotaDisplayer) DisplaySingleQuota(quota resources.Quota)
• type Stager
  • func (stager *Stager) StageAndStart(app resources.Application, space configv3.Space, ...) error
  • func (stager *Stager) StageApp(app resources.Application, packageGUID string, space configv3.Space) (resources.Droplet, error)
  • func (stager *Stager) StartApp(app resources.Application, resourceGuid string, ...) error

Constants

const (
	MEGABYTE = 1024 * 1024
	GIGABYTE = 1024 * MEGABYTE
	TERABYTE = 1024 * GIGABYTE
)

Functions

func CheckCCAPIVersion

func CheckCCAPIVersion(currentAPIVersion string) (string, error)

func FlagBoolToString

func FlagBoolToString(enabled bool) string

func GetNewClientsAndConnectToCF

func GetNewClientsAndConnectToCF(config command.Config, ui command.UI, minVersionV3 string) (*ccv3.Client, *uaa.Client, *router.Client, error)

func NewAuthWrappedCloudControllerClient

func NewAuthWrappedCloudControllerClient(config command.Config, ui command.UI, uaaClient *uaa.Client) *ccv3.Client

func NewNetworkingClient

func NewNetworkingClient(apiURL string, config command.Config, uaaClient *uaa.Client, ui command.UI) (*cfnetv1.Client, error)

NewNetworkingClient creates a new cfnetworking client.

func NewWrappedCloudControllerClient

func NewWrappedCloudControllerClient(config command.Config, ui command.UI, extraWrappers ...ccv3.ConnectionWrapper) *ccv3.Client

func PollStage

func PollStage(dropletStream <-chan resources.Droplet, warningsStream <-chan v7action.Warnings, errStream <-chan error, logStream <-chan sharedaction.LogMessage, logErrStream <-chan error, ui command.UI) (resources.Droplet, error)

func WaitForResult

func WaitForResult(stream chan v7action.PollJobEvent, ui command.UI, waitForCompletion bool) (bool, error)

Types

type AppStager

type AppStager interface {
	StageAndStart(
		app resources.Application,
		space configv3.Space,
		organization configv3.Organization,
		packageGUID string,
		strategy constant.DeploymentStrategy,
		noWait bool,
		appAction constant.ApplicationAction,
	) error

	StageApp(
		app resources.Application,
		packageGUID string,
		space configv3.Space,
	) (resources.Droplet, error)

	StartApp(
		app resources.Application,
		resourceGuid string,
		strategy constant.DeploymentStrategy,
		noWait bool,
		space configv3.Space,
		organization configv3.Organization,
		appAction constant.ApplicationAction,
	) error
}

func NewAppStager

func NewAppStager(actor stagingAndStartActor, ui command.UI, config command.Config, logCache sharedaction.LogCacheClient) AppStager

type AppSummaryDisplayer

type AppSummaryDisplayer struct {
	UI command.UI
}

func NewAppSummaryDisplayer

func NewAppSummaryDisplayer(ui command.UI) *AppSummaryDisplayer

func (AppSummaryDisplayer) AppDisplay

func (display AppSummaryDisplayer) AppDisplay(summary v7action.DetailedApplicationSummary, displayStartCommand bool)

type ManifestDiffDisplayer

type ManifestDiffDisplayer struct {
	UI command.UI
}

func NewManifestDiffDisplayer

func NewManifestDiffDisplayer(ui command.UI) *ManifestDiffDisplayer

func (*ManifestDiffDisplayer) DisplayDiff

func (display *ManifestDiffDisplayer) DisplayDiff(rawManifest []byte, diff resources.ManifestDiff) error

type PackageDisplayer

type PackageDisplayer struct {
	// contains filtered or unexported fields
}

func NewPackageDisplayer

func NewPackageDisplayer(ui command.UI, config command.Config) PackageDisplayer

func (PackageDisplayer) DisplaySetupMessage

func (display PackageDisplayer) DisplaySetupMessage(appName, currentUser string, isDockerImage bool) error

type QuotaDisplayer

type QuotaDisplayer struct {
	// contains filtered or unexported fields
}

func NewQuotaDisplayer

func NewQuotaDisplayer(ui command.UI) QuotaDisplayer

func (QuotaDisplayer) DisplayQuotasTable

func (displayer QuotaDisplayer) DisplayQuotasTable(quotas []resources.Quota, emptyMessage string)

func (QuotaDisplayer) DisplaySingleQuota

func (displayer QuotaDisplayer) DisplaySingleQuota(quota resources.Quota)

type Stager

type Stager struct {
	Actor    stagingAndStartActor
	UI       command.UI
	Config   command.Config
	LogCache sharedaction.LogCacheClient
}

func (*Stager) StageAndStart

func (stager *Stager) StageAndStart(
	app resources.Application,
	space configv3.Space,
	organization configv3.Organization,
	packageGUID string,
	strategy constant.DeploymentStrategy,
	noWait bool,
	appAction constant.ApplicationAction,
) error

func (*Stager) StageApp

func (stager *Stager) StageApp(app resources.Application, packageGUID string, space configv3.Space) (resources.Droplet, error)

func (*Stager) StartApp

func (stager *Stager) StartApp(
	app resources.Application,
	resourceGuid string,
	strategy constant.DeploymentStrategy,
	noWait bool,
	space configv3.Space,
	organization configv3.Organization,
	appAction constant.ApplicationAction,
) error