common

package
v1.1.21-fix27 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 28, 2020 License: Apache-2.0 Imports: 38 Imported by: 1

Documentation

Index

Constants

View Source
const (
	CleaningCommandsForceOptionDescription = "First remove containers that use werf docker images which are going to be deleted"
	StubImagesRepoAddress                  = "stub/repository"
)
View Source
const (
	CmdEnvAnno                  string = "environment"
	DisableOptionsInUseLineAnno string = "disableOptionsInUseLine"

	WerfDebugAnsibleArgs Env = "WERF_DEBUG_ANSIBLE_ARGS"
	WerfSecretKey        Env = "WERF_SECRET_KEY"
	WerfOldSecretKey     Env = "WERF_OLD_SECRET_KEY"
)

Variables

This section is empty.

Functions

func ConvertInt32Value

func ConvertInt32Value(v string) (int32, error)

func ConvertIntValue

func ConvertIntValue(v string, bitSize int) (int64, error)

func DisableTerminationSignalsTrap

func DisableTerminationSignalsTrap()

func DockerRegistryInit

func DockerRegistryInit(cmdData *CmdData) error

func EnableTerminationSignalsTrap

func EnableTerminationSignalsTrap()

func EnvsDescription

func EnvsDescription(envs ...Env) string

func GetBoolEnvironmentDefaultFalse

func GetBoolEnvironmentDefaultFalse(environmentName string) bool

func GetBoolEnvironmentDefaultTrue added in v1.1.21

func GetBoolEnvironmentDefaultTrue(environmentName string) bool

func GetConveyorOptions

func GetConveyorOptions(commonCmdData *CmdData) build.ConveyorOptions

func GetDeployTag

func GetDeployTag(cmdData *CmdData, opts TagOptionsGetterOptions) (string, tag_strategy.TagStrategy, error)

func GetGitCommitStrategyExpiryDays

func GetGitCommitStrategyExpiryDays(cmdData *CmdData) (int64, error)

func GetGitCommitStrategyLimit

func GetGitCommitStrategyLimit(cmdData *CmdData) (int64, error)

func GetGitTagStrategyExpiryDays

func GetGitTagStrategyExpiryDays(cmdData *CmdData) (int64, error)

func GetGitTagStrategyLimit

func GetGitTagStrategyLimit(cmdData *CmdData) (int64, error)

func GetHelmChartDir

func GetHelmChartDir(projectDir string, cmdData *CmdData) (string, error)

func GetHelmRelease

func GetHelmRelease(releaseOption string, environmentOption string, werfConfig *config.WerfConfig) (string, error)

func GetHelmReleaseStorageType

func GetHelmReleaseStorageType(helmReleaseStorageType string) (string, error)

func GetHooksStatusProgressPeriod

func GetHooksStatusProgressPeriod(cmdData *CmdData) time.Duration

func GetImagesCleanupPolicies

func GetImagesCleanupPolicies(cmdData *CmdData) (cleanup.ImagesCleanupPolicies, error)

func GetImagesRepo

func GetImagesRepo(projectName string, cmdData *CmdData) (storage.ImagesRepo, error)

func GetImagesRepoWithOptionalStubRepoAddress

func GetImagesRepoWithOptionalStubRepoAddress(projectName string, cmdData *CmdData) (storage.ImagesRepo, error)

func GetIntrospectOptions

func GetIntrospectOptions(cmdData *CmdData, werfConfig *config.WerfConfig) (build.IntrospectOptions, error)

func GetKubernetesNamespace

func GetKubernetesNamespace(namespaceOption string, environmentOption string, werfConfig *config.WerfConfig) (string, error)

func GetLocalGitRepoForImagesCleanup added in v1.1.23

func GetLocalGitRepoForImagesCleanup(projectDir string, cmdData *CmdData) (cleaning.GitRepo, error)

func GetLongCommandDescription

func GetLongCommandDescription(text string) string

func GetManagedImageName

func GetManagedImageName(userSpecifiedImageName string) string

func GetManagedImagesNames

func GetManagedImagesNames(projectName string, stagesStorage storage.StagesStorage, werfConfig *config.WerfConfig) ([]string, error)

func GetOptionalImagesRepoAddress

func GetOptionalImagesRepoAddress(projectName string, cmdData *CmdData) (string, error)

func GetOptionalStagesStorageAddress

func GetOptionalStagesStorageAddress(cmdData *CmdData) string

func GetOptionalWerfConfig

func GetOptionalWerfConfig(projectDir string, cmdData *CmdData, logRenderedFilePath bool) (*config.WerfConfig, error)

func GetProjectDir

func GetProjectDir(cmdData *CmdData) (string, error)

func GetPublishReportFormat

func GetPublishReportFormat(cmdData *CmdData) (build.PublishReportFormat, error)

func GetRequiredWerfConfig

func GetRequiredWerfConfig(projectDir string, cmdData *CmdData, logRenderedFilePath bool) (*config.WerfConfig, error)

func GetStagesSignatureStrategyExpiryDays

func GetStagesSignatureStrategyExpiryDays(cmdData *CmdData) (int64, error)

func GetStagesSignatureStrategyLimit

func GetStagesSignatureStrategyLimit(cmdData *CmdData) (int64, error)

func GetStagesStorage

func GetStagesStorage(containerRuntime container_runtime.ContainerRuntime, cmdData *CmdData) (storage.StagesStorage, error)

func GetStagesStorageAddress

func GetStagesStorageAddress(cmdData *CmdData) (string, error)

func GetStagesStorageCache

func GetStagesStorageCache(synchronization *SynchronizationParams) (storage.StagesStorageCache, error)

func GetStatusProgressPeriod

func GetStatusProgressPeriod(cmdData *CmdData) time.Duration

func GetStorageLockManager

func GetStorageLockManager(synchronization *SynchronizationParams) (storage.LockManager, error)

func GetTagOptions

func GetTagOptions(cmdData *CmdData, opts TagOptionsGetterOptions) (build.TagOptions, error)

func GetThreeWayMergeMode

func GetThreeWayMergeMode(threeWayMergeModeParam string) (helm.ThreeWayMergeModeType, error)

func GetUserExtraAnnotations

func GetUserExtraAnnotations(cmdData *CmdData) (map[string]string, error)

func GetUserExtraLabels

func GetUserExtraLabels(cmdData *CmdData) (map[string]string, error)

func GetWerfConfigPath

func GetWerfConfigPath(projectDir string, cmdData *CmdData, required bool) (string, error)

func GetWerfConfigTemplatesDir

func GetWerfConfigTemplatesDir(projectDir string, cmdData *CmdData) string

func InitKubedog

func InitKubedog() error

func LogKubeContext

func LogKubeContext(kubeContext string)

func LogRunningTime

func LogRunningTime(f func() error) error

func LogVersion

func LogVersion()

func PrintHelp

func PrintHelp(cmd *cobra.Command)

func ProcessLogColorMode

func ProcessLogColorMode(cmdData *CmdData) error

func ProcessLogOptions

func ProcessLogOptions(cmdData *CmdData) error

func ProcessLogProjectDir

func ProcessLogProjectDir(cmdData *CmdData, projectDir string)

func ProcessLogTerminalWidth

func ProcessLogTerminalWidth(cmdData *CmdData) error

func SetupAddAnnotations

func SetupAddAnnotations(cmdData *CmdData, cmd *cobra.Command)

func SetupAddLabels

func SetupAddLabels(cmdData *CmdData, cmd *cobra.Command)

func SetupAllowGitShallowClone added in v1.1.23

func SetupAllowGitShallowClone(cmdData *CmdData, cmd *cobra.Command)

func SetupCommonRepoData

func SetupCommonRepoData(cmdData *CmdData, cmd *cobra.Command)

func SetupConfigPath

func SetupConfigPath(cmdData *CmdData, cmd *cobra.Command)

func SetupConfigTemplatesDir

func SetupConfigTemplatesDir(cmdData *CmdData, cmd *cobra.Command)

func SetupDir

func SetupDir(cmdData *CmdData, cmd *cobra.Command)

func SetupDockerConfig

func SetupDockerConfig(cmdData *CmdData, cmd *cobra.Command, extraDesc string)

func SetupDockerHubPasswordForRepoData

func SetupDockerHubPasswordForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupDockerHubTokenForRepoData

func SetupDockerHubTokenForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupDockerHubUsernameForRepoData

func SetupDockerHubUsernameForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupDryRun

func SetupDryRun(cmdData *CmdData, cmd *cobra.Command)

func SetupEnvironment

func SetupEnvironment(cmdData *CmdData, cmd *cobra.Command)

func SetupGitHistorySynchronization added in v1.1.21

func SetupGitHistorySynchronization(cmdData *CmdData, cmd *cobra.Command)

func SetupGitUnshallow added in v1.1.23

func SetupGitUnshallow(cmdData *CmdData, cmd *cobra.Command)

func SetupGithubTokenForRepoData

func SetupGithubTokenForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupHarborPasswordForRepoData

func SetupHarborPasswordForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupHarborUsernameForRepoData

func SetupHarborUsernameForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupHelmChartDir

func SetupHelmChartDir(cmdData *CmdData, cmd *cobra.Command)

func SetupHelmReleaseStorageNamespace

func SetupHelmReleaseStorageNamespace(cmdData *CmdData, cmd *cobra.Command)

func SetupHelmReleaseStorageType

func SetupHelmReleaseStorageType(cmdData *CmdData, cmd *cobra.Command)

func SetupHomeDir

func SetupHomeDir(cmdData *CmdData, cmd *cobra.Command)

func SetupHooksStatusProgressPeriod

func SetupHooksStatusProgressPeriod(cmdData *CmdData, cmd *cobra.Command)

func SetupIgnoreSecretKey

func SetupIgnoreSecretKey(cmdData *CmdData, cmd *cobra.Command)

func SetupImagesCleanupPolicies

func SetupImagesCleanupPolicies(cmdData *CmdData, cmd *cobra.Command)

func SetupImagesRepoOptions

func SetupImagesRepoOptions(cmdData *CmdData, cmd *cobra.Command)

func SetupImplementationForRepoData

func SetupImplementationForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupInsecureRegistry

func SetupInsecureRegistry(cmdData *CmdData, cmd *cobra.Command)

func SetupIntrospectStage

func SetupIntrospectStage(cmdData *CmdData, cmd *cobra.Command)

func SetupKubeConfig

func SetupKubeConfig(cmdData *CmdData, cmd *cobra.Command)

func SetupKubeConfigBase64 added in v1.1.23

func SetupKubeConfigBase64(cmdData *CmdData, cmd *cobra.Command)

func SetupKubeContext

func SetupKubeContext(cmdData *CmdData, cmd *cobra.Command)

func SetupLogOptions

func SetupLogOptions(cmdData *CmdData, cmd *cobra.Command)

func SetupLogProjectDir

func SetupLogProjectDir(cmdData *CmdData, cmd *cobra.Command)

func SetupNamespace

func SetupNamespace(cmdData *CmdData, cmd *cobra.Command)

func SetupProjectName

func SetupProjectName(cmdData *CmdData, cmd *cobra.Command)

func SetupPublishReportFormat

func SetupPublishReportFormat(cmdData *CmdData, cmd *cobra.Command)

func SetupPublishReportPath

func SetupPublishReportPath(cmdData *CmdData, cmd *cobra.Command)

func SetupQuayTokenForRepoData

func SetupQuayTokenForRepoData(repoData *RepoData, cmd *cobra.Command, paramName string, paramEnvNames []string)

func SetupRelease

func SetupRelease(cmdData *CmdData, cmd *cobra.Command)

func SetupReleasesHistoryMax

func SetupReleasesHistoryMax(cmdData *CmdData, cmd *cobra.Command)

func SetupSSHKey

func SetupSSHKey(cmdData *CmdData, cmd *cobra.Command)

func SetupSecretValues

func SetupSecretValues(cmdData *CmdData, cmd *cobra.Command)

func SetupSet

func SetupSet(cmdData *CmdData, cmd *cobra.Command)

func SetupSetString

func SetupSetString(cmdData *CmdData, cmd *cobra.Command)

func SetupSkipTlsVerifyRegistry

func SetupSkipTlsVerifyRegistry(cmdData *CmdData, cmd *cobra.Command)

func SetupStagesStorageOptions

func SetupStagesStorageOptions(cmdData *CmdData, cmd *cobra.Command)

func SetupStatusProgressPeriod

func SetupStatusProgressPeriod(cmdData *CmdData, cmd *cobra.Command)

func SetupSynchronization

func SetupSynchronization(cmdData *CmdData, cmd *cobra.Command)

func SetupTag

func SetupTag(cmdData *CmdData, cmd *cobra.Command)

func SetupThreeWayMergeMode

func SetupThreeWayMergeMode(cmdData *CmdData, cmd *cobra.Command)

func SetupTmpDir

func SetupTmpDir(cmdData *CmdData, cmd *cobra.Command)

func SetupValues

func SetupValues(cmdData *CmdData, cmd *cobra.Command)

func SetupVirtualMerge

func SetupVirtualMerge(cmdData *CmdData, cmd *cobra.Command)

func SetupVirtualMergeFromCommit

func SetupVirtualMergeFromCommit(cmdData *CmdData, cmd *cobra.Command)

func SetupVirtualMergeIntoCommit

func SetupVirtualMergeIntoCommit(cmdData *CmdData, cmd *cobra.Command)

func SetupWithoutKube

func SetupWithoutKube(cmdData *CmdData, cmd *cobra.Command)

func TerminateWithError

func TerminateWithError(errMsg string, exitCode int)

func ValidateArgumentCount

func ValidateArgumentCount(expectedCount int, args []string, cmd *cobra.Command) error

func ValidateMaximumNArgs

func ValidateMaximumNArgs(maxArgs int, args []string, cmd *cobra.Command) error

func ValidateMinimumNArgs

func ValidateMinimumNArgs(minArgs int, args []string, cmd *cobra.Command) error

func ValidateRepoImplementation

func ValidateRepoImplementation(implementation string) error

func WithoutTerminationSignalsTrap

func WithoutTerminationSignalsTrap(f func() error) error

Types

type CmdData

type CmdData struct {
	ProjectName        *string
	Dir                *string
	ConfigPath         *string
	ConfigTemplatesDir *string
	TmpDir             *string
	HomeDir            *string
	SSHKeys            *[]string

	TagCustom            *[]string
	TagGitBranch         *string
	TagGitTag            *string
	TagGitCommit         *string
	TagByStagesSignature *bool

	HelmChartDir                     *string
	Environment                      *string
	Release                          *string
	Namespace                        *string
	AddAnnotations                   *[]string
	AddLabels                        *[]string
	KubeContext                      *string
	KubeConfig                       *string
	KubeConfigBase64                 *string
	HelmReleaseStorageNamespace      *string
	HelmReleaseStorageType           *string
	StatusProgressPeriodSeconds      *int64
	HooksStatusProgressPeriodSeconds *int64
	ReleasesHistoryMax               *int

	Set             *[]string
	SetString       *[]string
	Values          *[]string
	SecretValues    *[]string
	IgnoreSecretKey *bool

	CommonRepoData *RepoData

	StagesStorage         *string
	StagesStorageRepoData *RepoData

	ImagesRepo     *string
	ImagesRepoMode *string
	ImagesRepoData *RepoData

	Synchronization           *string
	GitHistorySynchronization *bool
	GitUnshallow              *bool
	AllowGitShallowClone      *bool

	DockerConfig          *string
	InsecureRegistry      *bool
	SkipTlsVerifyRegistry *bool
	DryRun                *bool

	GitTagStrategyLimit               *int64
	GitTagStrategyExpiryDays          *int64
	GitCommitStrategyLimit            *int64
	GitCommitStrategyExpiryDays       *int64
	StagesSignatureStrategyLimit      *int64
	StagesSignatureStrategyExpiryDays *int64

	WithoutKube *bool

	StagesToIntrospect *[]string

	LogDebug         *bool
	LogPretty        *bool
	LogVerbose       *bool
	LogQuiet         *bool
	LogColorMode     *string
	LogProjectDir    *bool
	LogTerminalWidth *int64

	ThreeWayMergeMode *string

	PublishReportPath   *string
	PublishReportFormat *string

	VirtualMerge           *bool
	VirtualMergeFromCommit *string
	VirtualMergeIntoCommit *string
}

type Env

type Env string

type RepoData

type RepoData struct {
	IsCommon               bool
	DesignationStorageName string

	Implementation    *string
	DockerHubUsername *string
	DockerHubPassword *string
	DockerHubToken    *string
	GitHubToken       *string
	HarborUsername    *string
	HarborPassword    *string
	QuayToken         *string
}

func MergeRepoData

func MergeRepoData(repoDataArr ...*RepoData) *RepoData

type SynchronizationParams added in v1.1.23

type SynchronizationParams struct {
	Address             string
	SynchronizationType SynchronizationType
	KubeParams          *storage.KubernetesSynchronizationParams
}

func GetSynchronization

func GetSynchronization(cmdData *CmdData, projectName string, stagesStorage storage.StagesStorage) (*SynchronizationParams, error)

type SynchronizationType added in v1.1.23

type SynchronizationType string
const (
	LocalSynchronization      SynchronizationType = "LocalSynchronization"
	KubernetesSynchronization SynchronizationType = "KubernetesSynchronization"
	HttpSynchronization       SynchronizationType = "HttpSynchronization"
)

type TagOptionsGetterOptions

type TagOptionsGetterOptions struct {
	Optional bool
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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