Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

workspace

package

Go to main page

Versions in this module

v0

v0.11.1

Apr 30, 2024

v0.11.0

Apr 1, 2024

Changes in this version

+ func GetInt32PointerFromGenericConfig(config v1.GenericConfig, key string) (*int32, error)

+ type Storage interface

+ Create func(ws *v1.Workspace) error

+ Delete func(name string) error

+ Get func(name string) (*v1.Workspace, error)

+ GetCurrent func() (string, error)

+ GetNames func() ([]string, error)

+ SetCurrent func(name string) error

+ Update func(ws *v1.Workspace) error

v0.11.0-rc.2

Apr 1, 2024

v0.11.0-rc.1

Mar 28, 2024

v0.10.0

Jan 15, 2024

Changes in this version

+ var ErrEmptyAWSRegion = errors.New("region must be provided when using AWS Secrets Manager")

+ var ErrEmptyAccessKeyID = errors.New("empty access key id")

+ var ErrEmptyAccessKeySecret = errors.New("empty access key secret")

+ var ErrEmptyAlicloudRegion = errors.New("region must be provided when using Alicloud Secrets Manager")

+ var ErrEmptyBucket = errors.New("empty bucket")

+ var ErrEmptyModuleConfigPatcherBlock = errors.New("empty patcher block in module config")

+ var ErrEmptyModuleConfigPatcherBlockName = errors.New("empty patcher block name in module config")

+ var ErrEmptyModuleConfigProjectName = errors.New("empty project name at projectSelector in module config patcher block")

+ var ErrEmptyMysqlDBName = errors.New("empty db name")

+ var ErrEmptyMysqlHost = errors.New("empty mysql host")

+ var ErrEmptyMysqlUser = errors.New("empty mysql db user")

+ var ErrEmptyOssEndpoint = errors.New("empty oss endpoint")

+ var ErrEmptyS3Region = errors.New("empty s3 region")

+ var ErrEmptyTenantID = errors.New("azure tenant id must be provided when using Azure KeyVault")

+ var ErrEmptyTerraformProviderConfigKey = errors.New("empty provider config key")

+ var ErrEmptyTerraformProviderConfigValue = errors.New("empty provider config value")

+ var ErrEmptyTerraformProviderSource = errors.New("empty provider source")

+ var ErrEmptyTerraformProviderVersion = errors.New("empty provider version")

+ var ErrEmptyVaultServer = errors.New("server address must be provided when using Hashicorp Vault")

+ var ErrEmptyVaultURL = errors.New("vault url must be provided when using Azure KeyVault")

+ var ErrInvalidModuleConfigPatcherBlockName = errors.New("patcher name must not be default in module config")

+ var ErrInvalidMysqlPort = errors.New("mysql port must be between 1 and 65535")

+ var ErrMissingProvider = errors.New("invalid secret store spec, missing provider config")

+ var ErrMissingProviderType = errors.New("must specify a provider type")

+ var ErrMultiSecretStoreProviders = errors.New("may not specify more than 1 secret store provider")

+ var ErrMultipleBackends = errors.New("more than one backend configured")

+ func CheckWorkspaceExistenceByDefaultOperator(name string) (bool, error)

+ func CompleteMysqlConfig(config *v1.MysqlConfig)

+ func CompleteWholeMysqlConfig(config *v1.MysqlConfig)

+ func CompleteWholeOssConfig(config *v1.OssConfig)

+ func CompleteWholeS3Config(config *v1.S3Config)

+ func CompleteWorkspace(ws *v1.Workspace, name string)

+ func CreateWorkspaceByDefaultOperator(ws *v1.Workspace) error

+ func DeleteWorkspaceByDefaultOperator(name string) error

+ func GetBackendName(configs *v1.BackendConfigs) string

+ func GetIntFromGenericConfig(config v1.GenericConfig, key string) (int, error)

+ func GetMapFromGenericConfig(config v1.GenericConfig, key string) (map[string]any, error)

+ func GetMysqlPasswordFromEnv() string

+ func GetOssSensitiveDataFromEnv() (string, string)

+ func GetProviderConfig(configs *v1.RuntimeConfigs, providerName string) (*v1.ProviderConfig, error)

+ func GetS3SensitiveDataFromEnv() (string, string, string)

+ func GetStringFromGenericConfig(config v1.GenericConfig, key string) (string, error)

+ func GetStringMapFromGenericConfig(config v1.GenericConfig, key string) (map[string]string, error)

+ func GetWorkspaceByDefaultOperator(name string) (*v1.Workspace, error)

+ func GetWorkspaceNamesByDefaultOperator() ([]string, error)

+ func UpdateWorkspaceByDefaultOperator(ws *v1.Workspace) error

+ func ValidateGenericObjectStorageConfig(config *v1.GenericObjectStorageConfig) error

+ func ValidateModuleDefaultConfig(config v1.GenericConfig) error

+ func ValidateModulePatcherConfigs(config v1.ModulePatcherConfigs) error

+ func ValidateMysqlConfig(config *v1.MysqlConfig) error

+ func ValidateProviderConfig(config *v1.ProviderConfig) error

+ func ValidateSecretStoreConfig(spec *v1.SecretStoreSpec) []error

+ func ValidateWholeOssConfig(config *v1.OssConfig) error

+ func ValidateWholeS3Config(config *v1.S3Config) error

type Operator

+ func NewValidDefaultOperator() (*Operator, error)

v0.10.0-rc.1

Jan 11, 2024

v0.9.1

Dec 6, 2023

Changes in this version

+ var ErrEmptyKubeConfig = errors.New("empty kubeconfig")

+ var ErrEmptyKubernetesConfig = errors.New("empty kubernetes config")

+ var ErrEmptyLocalFilePath = errors.New("empty local file path")

+ var ErrEmptyModuleConfig = errors.New("empty module config")

+ var ErrEmptyModuleConfigBlock = errors.New("empty block in module config")

+ var ErrEmptyModuleConfigBlockName = errors.New("empty block name in module config")

+ var ErrEmptyModuleConfigProjectSelector = errors.New("empty projectSelector in module config patcher block")

+ var ErrEmptyModuleConfigs = errors.New("empty module configs")

+ var ErrEmptyModuleName = errors.New("empty module name")

+ var ErrEmptyProjectModuleConfig = errors.New("empty module config of the project")

+ var ErrEmptyProjectModuleConfigs = errors.New("empty module configs of the project")

+ var ErrEmptyProjectName = errors.New("empty project name")

+ var ErrEmptyRuntimeConfigs = errors.New("empty runtime configs")

+ var ErrEmptyStoragePath = errors.New("empty storage path")

+ var ErrEmptyTerraformConfig = errors.New("empty terraform config")

+ var ErrEmptyTerraformProviderConfig = errors.New("empty terraform provider config")

+ var ErrEmptyTerraformProviderName = errors.New("empty terraform provider name")

+ var ErrEmptyWorkspace = errors.New("empty workspace")

+ var ErrEmptyWorkspaceName = errors.New("empty workspace name")

+ var ErrFileNotYAML = errors.New("not yaml file under storage path")

+ var ErrInvalidModuleConfigProjectSelector = errors.New("invalid projectSelector in module config patcher block")

+ var ErrMultipleModuleConfigSelectedProjects = errors.New("a project cannot assign in more than one patcher block's projectSelector")

+ var ErrNotEmptyModuleConfigProjectSelector = errors.New("not empty projectSelector in module config default block")

+ var ErrRepeatedModuleConfigSelectedProjects = errors.New("project should not repeat in one patcher block's projectSelector")

+ var ErrUnexpectedDir = errors.New("unexpected dir under storage path")

+ var ErrWorkspaceAlreadyExist = errors.New("workspace has already existed")

+ var ErrWorkspaceNotExist = errors.New("workspace does not exist")

+ func GetKubernetesConfig(configs *workspace.RuntimeConfigs) (*workspace.KubernetesConfig, error)

+ func GetProjectModuleConfig(config workspace.ModuleConfig, projectName string) (workspace.GenericConfig, error)

+ func GetProjectModuleConfigs(configs workspace.ModuleConfigs, projectName string) (map[string]workspace.GenericConfig, error)

+ func GetTerraformConfig(configs *workspace.RuntimeConfigs) (workspace.TerraformConfig, error)

+ func GetTerraformProviderConfig(configs *workspace.RuntimeConfigs, providerName string) (workspace.GenericConfig, error)

+ func ValidateBackendConfigs(configs *workspace.BackendConfigs) error

+ func ValidateKubernetesConfig(config *workspace.KubernetesConfig) error

+ func ValidateLocalFileConfig(config *workspace.LocalFileConfig) error

+ func ValidateModuleConfig(config workspace.ModuleConfig) error

+ func ValidateModuleConfigs(configs workspace.ModuleConfigs) error

+ func ValidateRuntimeConfigs(configs *workspace.RuntimeConfigs) error

+ func ValidateTerraformConfig(config workspace.TerraformConfig) error

+ func ValidateWorkspace(ws *workspace.Workspace) error

+ type Operator struct

+ func NewDefaultOperator() (*Operator, error)

+ func NewOperator(storagePath string) (*Operator, error)

+ func (o *Operator) CreateWorkspace(ws *workspace.Workspace) error

+ func (o *Operator) DeleteWorkspace(name string) error

+ func (o *Operator) GetWorkspace(name string) (*workspace.Workspace, error)

+ func (o *Operator) GetWorkspaceNames() ([]string, error)

+ func (o *Operator) UpdateWorkspace(ws *workspace.Workspace) error

+ func (o *Operator) Validate() error

+ func (o *Operator) WorkspaceExist(name string) bool

v0.9.1-rc.2

Dec 6, 2023

v0.9.1-rc

Dec 5, 2023