common

package
v1.2.0-alpha1 Latest Latest
Warning

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

 Go to latest Published: Sep 24, 2020 License: Apache-2.0 Imports: 41 Imported by: 1

Documentation

Index

Constants

View Source 
const (
	CleaningCommandsForceOptionDescription = "First remove containers that use werf docker images which are going to be deleted"
	StubRepoAddress                        = "stub/repository"
	StubTag                                = "TAG"
	DefaultBuildParallelTasksLimit         = 5
	DefaultCleanupParallelTasksLimit       = 10
)
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 BackgroundContext added in v1.1.23 

func BackgroundContext() context.Context

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 GetBuildOptions added in v1.2.0 

func GetBuildOptions(commonCmdData *CmdData, werfConfig *config.WerfConfig) (buildOptions build.BuildOptions, err error)

func GetConveyorOptions 

func GetConveyorOptions(commonCmdData *CmdData) build.ConveyorOptions

func GetConveyorOptionsWithParallel added in v1.1.23 

func GetConveyorOptionsWithParallel(commonCmdData *CmdData, buildStagesOptions build.BuildOptions) (build.ConveyorOptions, 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 GetHooksStatusProgressPeriod 

func GetHooksStatusProgressPeriod(cmdData *CmdData) time.Duration

func GetIntrospectOptions 

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

func GetKubernetesContextClients added in v1.1.23 

func GetKubernetesContextClients(cmdData *CmdData) ([]*kube.ContextClient, error)

func GetKubernetesNamespace 

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

func GetKubernetesNamespaceRestrictionByContext added in v1.1.23 

func GetKubernetesNamespaceRestrictionByContext(cmdData *CmdData, contextClients []*kube.ContextClient) map[string]string

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(ctx context.Context, projectName string, stagesStorage storage.StagesStorage, werfConfig *config.WerfConfig) ([]string, error)

func GetOptionalStagesStorageAddress 

func GetOptionalStagesStorageAddress(cmdData *CmdData) string

func GetOptionalWerfConfig 

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

func GetParallelTasksLimit added in v1.1.23 

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

func GetProjectDir 

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

func GetReportFormat added in v1.2.0 

func GetReportFormat(cmdData *CmdData) (build.ReportFormat, error)

func GetRequiredWerfConfig 

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

func GetStagesStorage 

func GetStagesStorage(stagesStorageAddress string, 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(ctx context.Context, synchronization *SynchronizationParams) (storage.LockManager, 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(ctx context.Context) 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 SetupHomeDir 

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

func SetupHooksStatusProgressPeriod 

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

func SetupHooksStatusProgressPeriodP added in v1.1.23 

func SetupHooksStatusProgressPeriodP(destination *int64, cmd *cobra.Command)

func SetupIgnoreSecretKey 

func SetupIgnoreSecretKey(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 SetupIntrospectAfterError added in v1.1.23 

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

func SetupIntrospectBeforeError added in v1.1.23 

func SetupIntrospectBeforeError(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 SetupParallel added in v1.1.23 

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

func SetupParallelOptions added in v1.1.23 

func SetupParallelOptions(cmdData *CmdData, cmd *cobra.Command, defaultValue int64)

func SetupParallelTasksLimit added in v1.1.23 

func SetupParallelTasksLimit(cmdData *CmdData, cmd *cobra.Command, defaultValue int64)

func SetupProjectName 

func SetupProjectName(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 SetupReportFormat added in v1.2.0 

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

func SetupReportPath added in v1.2.0 

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

func SetupSSHKey 

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

func SetupScanContextNamespaceOnly added in v1.1.23 

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

func SetupSecretValues 

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

func SetupSet 

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

func SetupSetFile added in v1.2.0 

func SetupSetFile(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 SetupStatusProgressPeriodP added in v1.1.23 

func SetupStatusProgressPeriodP(destination *int64, cmd *cobra.Command)

func SetupSynchronization 

func SetupSynchronization(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 StubImageInfoGetters added in v1.2.0 

func StubImageInfoGetters(werfConfig *config.WerfConfig) (list []*image.InfoGetter)

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

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

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

	CommonRepoData *RepoData
	StagesStorage  *string

	Synchronization           *string
	GitHistorySynchronization *bool
	GitUnshallow              *bool
	AllowGitShallowClone      *bool
	Parallel                  *bool
	ParallelTasksLimit        *int64

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

	WithoutKube *bool

	IntrospectBeforeError *bool
	IntrospectAfterError  *bool
	StagesToIntrospect    *[]string

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

	ReportPath   *string
	ReportFormat *string

	VirtualMerge           *bool
	VirtualMergeFromCommit *string
	VirtualMergeIntoCommit *string

	ScanContextNamespaceOnly *bool
}

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(ctx context.Context, 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"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.