deployment

package
v0.0.0-...-33704e8 Latest Latest
Warning

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

Go to latest
Published: Dec 20, 2024 License: Apache-2.0 Imports: 81 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_config_deployment_automate_config_proto protoreflect.FileDescriptor
View Source
var File_config_deployment_config_request_proto protoreflect.FileDescriptor

Functions

func GeneratePassword

func GeneratePassword() (string, error)

GeneratePassword generates a random password. This function an be used when generating default configuration.

func LbFQDN

func LbFQDN() string

LbFQDN -- First try executing `hostname -f` and if that fails use ip address. os.Hostname returns just the hostname (automate-deployment) instead of the FQDN (automate-deployment.test) which is what we really want.

func WithChannel

func WithChannel(channel string) func(*AutomateConfig) error

WithChannel returns a functional option to set the channel in the deployment config.

func WithChefServerEnabled

func WithChefServerEnabled(enabled bool) func(*AutomateConfig) error

func WithConfigOptions

func WithConfigOptions(cfg *AutomateConfig, options ...AutomateConfigOpt) error

WithConfigOptions applies the given AutomateConfigOpts to an AutomateConfig

func WithDeploymentOrderStressMode

func WithDeploymentOrderStressMode(enabled bool) func(*AutomateConfig) error

func WithHartifacts

func WithHartifacts(path string) func(*AutomateConfig) error

WithHartifacts returns a functional option to set hartifacts path on AutomateConfig in LoadUserOverrideConfigFile

func WithManifestDir

func WithManifestDir(path string) func(*AutomateConfig) error

WithManifestDir returns an AutomateConfigOpt that sets the manifest path on an AutomateConfig

func WithOrigin

func WithOrigin(origin string) func(*AutomateConfig) error

WithOrigin returns a functional option to set override origin on AutomateConfig in LoadUserOverrideConfigFile

func WithProducts

func WithProducts(products []string) func(*AutomateConfig) error

func WithUpgradeStrategy

func WithUpgradeStrategy(strategy string) func(*AutomateConfig) error

WithUpgradeStrategy returns a functional option to set the upgrade strategy in the deployment config.

Types

type AutomateConfig

type AutomateConfig struct {
	Global           *shared.GlobalConfig             `protobuf:"bytes,19,opt,name=global,proto3" json:"global,omitempty" toml:"global,omitempty" mapstructure:"global,omitempty"`
	AuthN            *authn.ConfigRequest             `` /* 132-byte string literal not displayed */
	AuthZ            *authz.ConfigRequest             `` /* 132-byte string literal not displayed */
	Compliance       *compliance.ConfigRequest        `` /* 138-byte string literal not displayed */
	ConfigMgmt       *cfgmgmt.ConfigRequest           `` /* 157-byte string literal not displayed */
	Deployment       *ConfigRequest                   `` /* 137-byte string literal not displayed */
	Dex              *dex.ConfigRequest               `protobuf:"bytes,4,opt,name=dex,proto3" json:"dex,omitempty" toml:"dex,omitempty" mapstructure:"dex,omitempty"`
	Elasticsearch    *elasticsearch.ConfigRequest     `` /* 149-byte string literal not displayed */
	Esgateway        *esgateway.ConfigRequest         `` /* 134-byte string literal not displayed */
	EsSidecar        *es_sidecar.ConfigRequest        `` /* 153-byte string literal not displayed */
	Gateway          *gateway.ConfigRequest           `protobuf:"bytes,5,opt,name=gateway,proto3" json:"gateway,omitempty" toml:"gateway,omitempty" mapstructure:"gateway,omitempty"`
	Ingest           *ingest.ConfigRequest            `protobuf:"bytes,13,opt,name=ingest,proto3" json:"ingest,omitempty" toml:"ingest,omitempty" mapstructure:"ingest,omitempty"`
	LoadBalancer     *load_balancer.ConfigRequest     `` /* 167-byte string literal not displayed */
	LocalUser        *local_user.ConfigRequest        `` /* 153-byte string literal not displayed */
	LicenseControl   *license_control.ConfigRequest   `` /* 178-byte string literal not displayed */
	Notifications    *notifications.ConfigRequest     `` /* 150-byte string literal not displayed */
	Postgresql       *postgresql.ConfigRequest        `` /* 138-byte string literal not displayed */
	Session          *session.ConfigRequest           `` /* 126-byte string literal not displayed */
	Teams            *teams.ConfigRequest             `protobuf:"bytes,18,opt,name=teams,proto3" json:"teams,omitempty" toml:"teams,omitempty" mapstructure:"teams,omitempty"`
	UI               *ui.ConfigRequest                `protobuf:"bytes,9,opt,name=u_i,json=uI,proto3" json:"u_i,omitempty" toml:"u_i,omitempty" mapstructure:"u_i,omitempty"`
	Secrets          *secrets.ConfigRequest           `` /* 126-byte string literal not displayed */
	BackupGateway    *backup_gateway.ConfigRequest    `` /* 173-byte string literal not displayed */
	PgSidecar        *pg_sidecar.ConfigRequest        `` /* 153-byte string literal not displayed */
	PgGateway        *pg_gateway.ConfigRequest        `` /* 153-byte string literal not displayed */
	Applications     *applications.ConfigRequest      `` /* 146-byte string literal not displayed */
	Bookshelf        *bookshelf.ConfigRequest         `` /* 134-byte string literal not displayed */
	Bifrost          *bifrost.ConfigRequest           `` /* 126-byte string literal not displayed */
	Erchef           *erchef.ConfigRequest            `protobuf:"bytes,24,opt,name=erchef,proto3" json:"erchef,omitempty" toml:"erchef,omitempty" mapstructure:"erchef,omitempty"`
	CsNginx          *cs_nginx.ConfigRequest          `` /* 143-byte string literal not displayed */
	EventService     *event.ConfigRequest             `` /* 168-byte string literal not displayed */
	Nodemanager      *nodemanager.ConfigRequest       `` /* 142-byte string literal not displayed */
	EventGateway     *event_gateway.ConfigRequest     `` /* 168-byte string literal not displayed */
	Prometheus       *prometheus.ConfigRequest        `` /* 138-byte string literal not displayed */
	DataFeedService  *data_feed.ConfigRequest         `` /* 187-byte string literal not displayed */
	EventFeedService *event_feed.ConfigRequest        `` /* 192-byte string literal not displayed */
	Cereal           *cereal.ConfigRequest            `protobuf:"bytes,40,opt,name=cereal,proto3" json:"cereal,omitempty" toml:"cereal,omitempty" mapstructure:"cereal,omitempty"`
	BuilderApi       *builder_api.ConfigRequest       `` /* 158-byte string literal not displayed */
	BuilderApiProxy  *builder_api_proxy.ConfigRequest `` /* 187-byte string literal not displayed */
	Minio            *minio.ConfigRequest             `protobuf:"bytes,43,opt,name=minio,proto3" json:"minio,omitempty" toml:"minio,omitempty" mapstructure:"minio,omitempty"`
	BuilderMemcached *builder_memcached.ConfigRequest `` /* 188-byte string literal not displayed */
	InfraProxy       *infra_proxy.ConfigRequest       `` /* 158-byte string literal not displayed */
	Cds              *cds.ConfigRequest               `protobuf:"bytes,46,opt,name=cds,proto3" json:"cds,omitempty" toml:"cds,omitempty" mapstructure:"cds,omitempty"`
	SampleData       *sample_data.ConfigRequest       `` /* 158-byte string literal not displayed */
	UserSettings     *user_settings.ConfigRequest     `` /* 168-byte string literal not displayed */
	Opensearch       *opensearch.ConfigRequest        `` /* 138-byte string literal not displayed */
	ReportManager    *report_manager.ConfigRequest    `` /* 173-byte string literal not displayed */
	Ocid             *ocid.ConfigRequest              `protobuf:"bytes,51,opt,name=ocid,proto3" json:"ocid,omitempty" toml:"ocid,omitempty" mapstructure:"ocid,omitempty"`
	// contains filtered or unexported fields
}

func DefaultAutomateConfig

func DefaultAutomateConfig() *AutomateConfig

DefaultAutomateConfig returns a new instance of Automate config with default values.

func LoadUserOverrideConfigFile

func LoadUserOverrideConfigFile(file string, options ...AutomateConfigOpt) (*AutomateConfig, error)

LoadUserOverrideConfigFile loads a user-specified override config from a toml file and also applies specific values to the deployment service's override origin and hartifacts path if they are set. the following things are validated: - hartifacts path is a directory that exists on the local system (where the CLI is run) - the resulting config, when merged with defaults, is a valid automate config

func MergeWithDefaults

func MergeWithDefaults(c *AutomateConfig) (*AutomateConfig, error)

MergeWithDefaults takes as an argument an AutomateConfig and returns a new instance of an AutomateConfig that has been merged with the defaults from DefaultAutomateConfig

func NewAutomateConfig

func NewAutomateConfig() *AutomateConfig

NewAutomateConfig returns a new instance of AutomateConfig with zero values.

func NewUserOverrideConfig

func NewUserOverrideConfig() *AutomateConfig

NewUserOverrideConfig returns a completely blank config struct onto which we will merge user-set configs.

*WARN* Only values that are overridden by the user should exist here *WARN* *WARN* otherwise these values will be persisted forever *WARN*

func NewUserOverrideConfigFromTOML

func NewUserOverrideConfigFromTOML(data []byte) (*AutomateConfig, error)

NewUserOverrideConfigFromTOML takes a byte-slice representing a TOML config and returns an override config.

*WARN* Same warnings apply as NewUserOverrideConfig *WARN*

func (*AutomateConfig) AddCredentials

func (c *AutomateConfig) AddCredentials(adminName, adminUsername, adminPassword string) error

AddCredentials sets the required admin name/username/password. It's used as a shim while we store these in the config but keep them out of init config and hide them from users.

func (*AutomateConfig) Descriptor deprecated

func (*AutomateConfig) Descriptor() ([]byte, []int)

Deprecated: Use AutomateConfig.ProtoReflect.Descriptor instead.

func (*AutomateConfig) GetApplications

func (x *AutomateConfig) GetApplications() *applications.ConfigRequest

func (*AutomateConfig) GetAuthN

func (x *AutomateConfig) GetAuthN() *authn.ConfigRequest

func (*AutomateConfig) GetAuthZ

func (x *AutomateConfig) GetAuthZ() *authz.ConfigRequest

func (*AutomateConfig) GetBackupGateway

func (x *AutomateConfig) GetBackupGateway() *backup_gateway.ConfigRequest

func (*AutomateConfig) GetBifrost

func (x *AutomateConfig) GetBifrost() *bifrost.ConfigRequest

func (*AutomateConfig) GetBookshelf

func (x *AutomateConfig) GetBookshelf() *bookshelf.ConfigRequest

func (*AutomateConfig) GetBuilderApi

func (x *AutomateConfig) GetBuilderApi() *builder_api.ConfigRequest

func (*AutomateConfig) GetBuilderApiProxy

func (x *AutomateConfig) GetBuilderApiProxy() *builder_api_proxy.ConfigRequest

func (*AutomateConfig) GetBuilderMemcached

func (x *AutomateConfig) GetBuilderMemcached() *builder_memcached.ConfigRequest

func (*AutomateConfig) GetCds

func (x *AutomateConfig) GetCds() *cds.ConfigRequest

func (*AutomateConfig) GetCereal

func (x *AutomateConfig) GetCereal() *cereal.ConfigRequest

func (*AutomateConfig) GetCompliance

func (x *AutomateConfig) GetCompliance() *compliance.ConfigRequest

func (*AutomateConfig) GetConfigMgmt

func (x *AutomateConfig) GetConfigMgmt() *cfgmgmt.ConfigRequest

func (*AutomateConfig) GetCsNginx

func (x *AutomateConfig) GetCsNginx() *cs_nginx.ConfigRequest

func (*AutomateConfig) GetDataFeedService

func (x *AutomateConfig) GetDataFeedService() *data_feed.ConfigRequest

func (*AutomateConfig) GetDeployment

func (x *AutomateConfig) GetDeployment() *ConfigRequest

func (*AutomateConfig) GetDex

func (x *AutomateConfig) GetDex() *dex.ConfigRequest

func (*AutomateConfig) GetElasticsearch

func (x *AutomateConfig) GetElasticsearch() *elasticsearch.ConfigRequest

func (*AutomateConfig) GetErchef

func (x *AutomateConfig) GetErchef() *erchef.ConfigRequest

func (*AutomateConfig) GetEsSidecar

func (x *AutomateConfig) GetEsSidecar() *es_sidecar.ConfigRequest

func (*AutomateConfig) GetEsgateway

func (x *AutomateConfig) GetEsgateway() *esgateway.ConfigRequest

func (*AutomateConfig) GetEventFeedService

func (x *AutomateConfig) GetEventFeedService() *event_feed.ConfigRequest

func (*AutomateConfig) GetEventGateway

func (x *AutomateConfig) GetEventGateway() *event_gateway.ConfigRequest

func (*AutomateConfig) GetEventService

func (x *AutomateConfig) GetEventService() *event.ConfigRequest

func (*AutomateConfig) GetGateway

func (x *AutomateConfig) GetGateway() *gateway.ConfigRequest

func (*AutomateConfig) GetGlobal

func (x *AutomateConfig) GetGlobal() *shared.GlobalConfig

func (*AutomateConfig) GetInfraProxy

func (x *AutomateConfig) GetInfraProxy() *infra_proxy.ConfigRequest

func (*AutomateConfig) GetIngest

func (x *AutomateConfig) GetIngest() *ingest.ConfigRequest

func (*AutomateConfig) GetLicenseControl

func (x *AutomateConfig) GetLicenseControl() *license_control.ConfigRequest

func (*AutomateConfig) GetLoadBalancer

func (x *AutomateConfig) GetLoadBalancer() *load_balancer.ConfigRequest

func (*AutomateConfig) GetLocalUser

func (x *AutomateConfig) GetLocalUser() *local_user.ConfigRequest

func (*AutomateConfig) GetMinio

func (x *AutomateConfig) GetMinio() *minio.ConfigRequest

func (*AutomateConfig) GetNodemanager

func (x *AutomateConfig) GetNodemanager() *nodemanager.ConfigRequest

func (*AutomateConfig) GetNotifications

func (x *AutomateConfig) GetNotifications() *notifications.ConfigRequest

func (*AutomateConfig) GetOcid

func (x *AutomateConfig) GetOcid() *ocid.ConfigRequest

func (*AutomateConfig) GetOpensearch

func (x *AutomateConfig) GetOpensearch() *opensearch.ConfigRequest

func (*AutomateConfig) GetPgGateway

func (x *AutomateConfig) GetPgGateway() *pg_gateway.ConfigRequest

func (*AutomateConfig) GetPgSidecar

func (x *AutomateConfig) GetPgSidecar() *pg_sidecar.ConfigRequest

func (*AutomateConfig) GetPostgresql

func (x *AutomateConfig) GetPostgresql() *postgresql.ConfigRequest

func (*AutomateConfig) GetPrometheus

func (x *AutomateConfig) GetPrometheus() *prometheus.ConfigRequest

func (*AutomateConfig) GetReportManager

func (x *AutomateConfig) GetReportManager() *report_manager.ConfigRequest

func (*AutomateConfig) GetSampleData

func (x *AutomateConfig) GetSampleData() *sample_data.ConfigRequest

func (*AutomateConfig) GetSecrets

func (x *AutomateConfig) GetSecrets() *secrets.ConfigRequest

func (*AutomateConfig) GetSession

func (x *AutomateConfig) GetSession() *session.ConfigRequest

func (*AutomateConfig) GetTeams

func (x *AutomateConfig) GetTeams() *teams.ConfigRequest

func (*AutomateConfig) GetUI

func (x *AutomateConfig) GetUI() *ui.ConfigRequest

func (*AutomateConfig) GetUserSettings

func (x *AutomateConfig) GetUserSettings() *user_settings.ConfigRequest

func (*AutomateConfig) MarshalToTOML

func (c *AutomateConfig) MarshalToTOML() ([]byte, error)

MarshalToTOML marshals the AutomateConfig to a TOML representation and returns it as a byte slice.

func (*AutomateConfig) MarshalToTOMLFile

func (c *AutomateConfig) MarshalToTOMLFile(path string, perm os.FileMode) error

MarshalToTOMLFile marshals the AutomateConfig to a TOML representation and writes it to a file at the given path.

func (*AutomateConfig) NewDeepCopy

func (c *AutomateConfig) NewDeepCopy() (*AutomateConfig, error)

NewDeepCopy will return a new deep copy of the existing struct.

func (*AutomateConfig) OverrideConfigValues

func (c *AutomateConfig) OverrideConfigValues(in *AutomateConfig) error

OverrideConfigValues allows the caller to specify a sparse set of config values to apply on top of an existing config. This is a useful pattern to avoid needing to check whether a nested value of the config is nil or not before setting fields on it

func (*AutomateConfig) PlatformServiceConfigForService

func (c *AutomateConfig) PlatformServiceConfigForService(serviceName string) (shared.PlatformServiceConfigurable, bool)

PlatformServiceConfigForService gets the config for the service by name

func (*AutomateConfig) PopulateSecretsFromEnvironment

func (c *AutomateConfig) PopulateSecretsFromEnvironment()

func (*AutomateConfig) ProtoMessage

func (*AutomateConfig) ProtoMessage()

func (*AutomateConfig) ProtoReflect

func (x *AutomateConfig) ProtoReflect() protoreflect.Message

func (*AutomateConfig) PullSecretsFromConfig

func (c *AutomateConfig) PullSecretsFromConfig() map[string]string

func (*AutomateConfig) Redact

func (c *AutomateConfig) Redact()

Redact removes sensitive or deprecated values from the configuration

func (*AutomateConfig) RedactedCopy

func (c *AutomateConfig) RedactedCopy() (*AutomateConfig, error)

RedactedCopy does a TOML round-trip, then returns a redacted version of the deep-dup'd AutomateConfig

func (*AutomateConfig) Reset

func (x *AutomateConfig) Reset()

func (*AutomateConfig) SetAdminPassword

func (c *AutomateConfig) SetAdminPassword(password string) error

SetAdminPassword does a "deep set" to set deployment admin password in the AutomateConfig, which is needed to support setting the admin password via the command line

func (*AutomateConfig) SetChannel

func (c *AutomateConfig) SetChannel(channel string) error

SetChannel does a "deep set" to set deployment channel in the AutomateConfig, which is needed to support setting the channel via the command line

func (*AutomateConfig) SetChefServerEnabled

func (c *AutomateConfig) SetChefServerEnabled(enabled bool) error

func (*AutomateConfig) SetDeploymentOrderStressMode

func (c *AutomateConfig) SetDeploymentOrderStressMode(enabled bool) error

func (*AutomateConfig) SetGlobalConfig

func (c *AutomateConfig) SetGlobalConfig()

SetGlobalConfig iterates over the AutomateConfig and applies global configuration

func (*AutomateConfig) SetHartifactsPath

func (c *AutomateConfig) SetHartifactsPath(path string) error

SetHartifactsPath does a "deep set" to set hartifacts path on AutomateConfig, which is needed to be able to set hartifacts path on the config object when the path is specified on the command line

func (*AutomateConfig) SetManifestDir

func (c *AutomateConfig) SetManifestDir(dir string) error

SetManifestDir does a "deep set" to set the manifest directory on AutomateConfig

func (*AutomateConfig) SetOverrideOrigin

func (c *AutomateConfig) SetOverrideOrigin(origin string) error

SetOverrideOrigin does a "deep set" to set override origin on AutomateConfig, which is needed to support setting override origin on the command line

func (*AutomateConfig) SetUpgradeStrategy

func (c *AutomateConfig) SetUpgradeStrategy(strategy string) error

SetUpgradeStrategy does a "deep set" to set deployment upgrade strategy in the AutomateConfig, which is needed to support setting the upgrade strategy via the command line

func (*AutomateConfig) String

func (x *AutomateConfig) String() string

func (*AutomateConfig) Sum64

func (c *AutomateConfig) Sum64() (uint64, error)

Sum64 returns the 64-bit FNV hash of the TOML representation of the Config.

func (*AutomateConfig) Validate

func (c *AutomateConfig) Validate() error

Validate verifies that all required configuration keys are present and enforces other invariants on configuration option values.

If the configuration is valid, the returned error is nil.

func (*AutomateConfig) ValidateCredentials

func (c *AutomateConfig) ValidateCredentials() error

ValidateCredentials ensures that initial admin credentials are present in the configuration. TODO XXX UGH: this is here because we are trying to remove AdminUser from deployment-service's config, but thus far we just have a workaround that hides the config from the user. We still need the config when we configure deployment for a deploy or upgrade, in which case we need to confirm the information is provided.

func (*AutomateConfig) ValidateWithGlobalAndDefaults

func (c *AutomateConfig) ValidateWithGlobalAndDefaults() error

ValidateWithGlobalAndDefaults tries merging setting configuration settings from the globals section, merges the result with the default AutomateConfig and then runs validation against the merged result.

func (*AutomateConfig) ValidateWithGlobalAndDefaultsAndCredentials

func (c *AutomateConfig) ValidateWithGlobalAndDefaultsAndCredentials() error

ValidateWithGlobalAndDefaultsAndCredentials does all of the same validation as ValidateWithGlobalAndDefaults and additionally runs ValidateCredentials(). TODO XXX UGH: this is here because we are trying to remove AdminUser from deployment-service's config, but thus far we just have a workaround that hides the config from the user. We still need the config when we configure deployment for a deploy or upgrade, in which case we need to confirm the information is provided.

type AutomateConfigOpt

type AutomateConfigOpt func(*AutomateConfig) error

AutomateConfigOpt is a functional option for LoadUserOverrideConfigFile

type ConfigRequest

type ConfigRequest struct {
	V1 *ConfigRequest_V1 `protobuf:"bytes,3,opt,name=v1,proto3" json:"v1,omitempty" toml:"v1,omitempty" mapstructure:"v1,omitempty"`
	// contains filtered or unexported fields
}

func DefaultConfigRequest

func DefaultConfigRequest() *ConfigRequest

DefaultConfigRequest returns a new ConfigRequest instance with default values

func NewConfigRequest

func NewConfigRequest() *ConfigRequest

NewConfigRequest returns a new ConfigRequest instance with zero values

func (*ConfigRequest) BindPort

func (m *ConfigRequest) BindPort(name string, value uint16) error

BindPort sets the port tagged with the given name

func (*ConfigRequest) Descriptor deprecated

func (*ConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest.ProtoReflect.Descriptor instead.

func (*ConfigRequest) GetPort

func (m *ConfigRequest) GetPort(name string) (uint16, error)

GetPort gets the port tagged with the given name. If the value is not set, it returns 0.

func (*ConfigRequest) GetSecret

func (m *ConfigRequest) GetSecret(name string) *wrappers.StringValue

GetSecret gets a secret by name. Returns nil if it is not set

func (*ConfigRequest) GetV1

func (x *ConfigRequest) GetV1() *ConfigRequest_V1

func (*ConfigRequest) ListPorts

func (m *ConfigRequest) ListPorts() []a2conf.PortInfo

ListPorts lists all the ports exposed by the config

func (*ConfigRequest) ListSecrets

func (m *ConfigRequest) ListSecrets() []a2conf.SecretInfo

ListSecrets lists all the secrets exposed by the config

func (*ConfigRequest) PrepareSystemConfig

PrepareSystemConfig returns a system configuration that can be used to start the service.

func (*ConfigRequest) ProtoMessage

func (*ConfigRequest) ProtoMessage()

func (*ConfigRequest) ProtoReflect

func (x *ConfigRequest) ProtoReflect() protoreflect.Message

func (*ConfigRequest) Reset

func (x *ConfigRequest) Reset()

func (*ConfigRequest) ServiceName

func (m *ConfigRequest) ServiceName() string

ServiceName returns the name of the service this config belongs to

func (*ConfigRequest) SetGlobalConfig

func (c *ConfigRequest) SetGlobalConfig(g *config.GlobalConfig)

SetGlobalConfig imports settings from the global configuration

func (*ConfigRequest) SetSecret

func (m *ConfigRequest) SetSecret(name string, value *wrappers.StringValue) error

SetSecret sets a secret by name. Returns ErrSecretNotFound if the secret does not exist

func (*ConfigRequest) String

func (x *ConfigRequest) String() string

func (*ConfigRequest) SystemdProxyConfig

func (c *ConfigRequest) SystemdProxyConfig() string

SystemdProxyConfig returns the proxy configuration in a format that can be directly injected into a systemd unit file.

func (*ConfigRequest) Validate

func (c *ConfigRequest) Validate() error

Validate validates that the config is sufficient to start the service and returns true.

func (*ConfigRequest) ValidateCredentials

func (c *ConfigRequest) ValidateCredentials() error

ValidateCredentials checks that AdminUser credentials are present in the config. It's used when we initially configure a deployment to ensure we have the admin user name/username/password set. In other contexts, we do not need this configuration. TODO XXX UGH: This is here because we want to remove AdminUser from deployment's config, but we have thus far only implemented a workaround where we hide it from the user but we still need to have it in the config for the initial deployment. Therefore we need to have one code path for deployment and a different path for `chef-automate config set`. This is the code path for deployment.

type ConfigRequest_V1

type ConfigRequest_V1 struct {
	Sys *ConfigRequest_V1_System  `protobuf:"bytes,1,opt,name=sys,proto3" json:"sys,omitempty" toml:"sys,omitempty" mapstructure:"sys,omitempty"`
	Svc *ConfigRequest_V1_Service `protobuf:"bytes,2,opt,name=svc,proto3" json:"svc,omitempty" toml:"svc,omitempty" mapstructure:"svc,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1) Descriptor deprecated

func (*ConfigRequest_V1) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1) GetSvc

func (*ConfigRequest_V1) GetSys

func (*ConfigRequest_V1) ProtoMessage

func (*ConfigRequest_V1) ProtoMessage()

func (*ConfigRequest_V1) ProtoReflect

func (x *ConfigRequest_V1) ProtoReflect() protoreflect.Message

func (*ConfigRequest_V1) Reset

func (x *ConfigRequest_V1) Reset()

func (*ConfigRequest_V1) String

func (x *ConfigRequest_V1) String() string

type ConfigRequest_V1_AdminUser

type ConfigRequest_V1_AdminUser struct {

	// use 'name' instead of 'email' for new code. It hasn't been reserved
	// because we'll support using 'email' from installations.
	//
	// Deprecated: Do not use.
	Email    *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=email,proto3" json:"email,omitempty" toml:"email,omitempty" mapstructure:"email,omitempty"`
	Username *wrapperspb.StringValue `` /* 129-byte string literal not displayed */
	Name     *wrapperspb.StringValue `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty" toml:"name,omitempty" mapstructure:"name,omitempty"`
	Password *wrapperspb.StringValue `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_AdminUser) Descriptor deprecated

func (*ConfigRequest_V1_AdminUser) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_AdminUser.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_AdminUser) GetEmail deprecated

Deprecated: Do not use.

func (*ConfigRequest_V1_AdminUser) GetName

func (*ConfigRequest_V1_AdminUser) GetPassword

func (*ConfigRequest_V1_AdminUser) GetUsername

func (*ConfigRequest_V1_AdminUser) ProtoMessage

func (*ConfigRequest_V1_AdminUser) ProtoMessage()

func (*ConfigRequest_V1_AdminUser) ProtoReflect

func (*ConfigRequest_V1_AdminUser) Reset

func (x *ConfigRequest_V1_AdminUser) Reset()

func (*ConfigRequest_V1_AdminUser) String

func (x *ConfigRequest_V1_AdminUser) String() string

type ConfigRequest_V1_Health

type ConfigRequest_V1_Health struct {
	HealthCheckInterval *wrapperspb.Int32Value `` /* 206-byte string literal not displayed */
	Services            []string               `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_Health) Descriptor deprecated

func (*ConfigRequest_V1_Health) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_Health.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_Health) GetHealthCheckInterval

func (x *ConfigRequest_V1_Health) GetHealthCheckInterval() *wrapperspb.Int32Value

func (*ConfigRequest_V1_Health) GetServices

func (x *ConfigRequest_V1_Health) GetServices() []string

func (*ConfigRequest_V1_Health) ProtoMessage

func (*ConfigRequest_V1_Health) ProtoMessage()

func (*ConfigRequest_V1_Health) ProtoReflect

func (x *ConfigRequest_V1_Health) ProtoReflect() protoreflect.Message

func (*ConfigRequest_V1_Health) Reset

func (x *ConfigRequest_V1_Health) Reset()

func (*ConfigRequest_V1_Health) String

func (x *ConfigRequest_V1_Health) String() string

type ConfigRequest_V1_Service

type ConfigRequest_V1_Service struct {
	Name                            *wrapperspb.StringValue     `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty" toml:"name,omitempty" mapstructure:"name,omitempty"`
	Origin                          *wrapperspb.StringValue     `protobuf:"bytes,2,opt,name=origin,proto3" json:"origin,omitempty" toml:"origin,omitempty" mapstructure:"origin,omitempty"`
	Channel                         *wrapperspb.StringValue     `protobuf:"bytes,3,opt,name=channel,proto3" json:"channel,omitempty" toml:"channel,omitempty" mapstructure:"channel,omitempty"`
	UpgradeStrategy                 *wrapperspb.StringValue     `` /* 182-byte string literal not displayed */
	DeploymentType                  *wrapperspb.StringValue     `` /* 177-byte string literal not displayed */
	OverrideOrigin                  *wrapperspb.StringValue     `` /* 177-byte string literal not displayed */
	HartifactsPath                  *wrapperspb.StringValue     `` /* 177-byte string literal not displayed */
	AdminUser                       *ConfigRequest_V1_AdminUser `` /* 152-byte string literal not displayed */
	ManifestCacheExpiry             *wrapperspb.StringValue     `` /* 206-byte string literal not displayed */
	ManifestDirectory               *wrapperspb.StringValue     `` /* 193-byte string literal not displayed */
	EnableChefServer                *wrapperspb.BoolValue       `` /* 192-byte string literal not displayed */
	EnableDeploymentOrderStressMode *wrapperspb.BoolValue       `` /* 275-byte string literal not displayed */
	FeatureFlagS3Backups            *wrapperspb.BoolValue       `` /* 217-byte string literal not displayed */
	PackageCleanupMode              *wrapperspb.StringValue     `` /* 202-byte string literal not displayed */
	EnableDevMonitoring             *wrapperspb.BoolValue       `` /* 207-byte string literal not displayed */
	Products                        []string                    `` /* 130-byte string literal not displayed */
	Health                          *ConfigRequest_V1_Health    `protobuf:"bytes,17,opt,name=health,proto3" json:"health,omitempty" toml:"health,omitempty" mapstructure:"health,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_Service) Descriptor deprecated

func (*ConfigRequest_V1_Service) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_Service.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_Service) GetAdminUser

func (*ConfigRequest_V1_Service) GetChannel

func (*ConfigRequest_V1_Service) GetDeploymentType

func (x *ConfigRequest_V1_Service) GetDeploymentType() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetEnableChefServer

func (x *ConfigRequest_V1_Service) GetEnableChefServer() *wrapperspb.BoolValue

func (*ConfigRequest_V1_Service) GetEnableDeploymentOrderStressMode

func (x *ConfigRequest_V1_Service) GetEnableDeploymentOrderStressMode() *wrapperspb.BoolValue

func (*ConfigRequest_V1_Service) GetEnableDevMonitoring

func (x *ConfigRequest_V1_Service) GetEnableDevMonitoring() *wrapperspb.BoolValue

func (*ConfigRequest_V1_Service) GetFeatureFlagS3Backups

func (x *ConfigRequest_V1_Service) GetFeatureFlagS3Backups() *wrapperspb.BoolValue

func (*ConfigRequest_V1_Service) GetHartifactsPath

func (x *ConfigRequest_V1_Service) GetHartifactsPath() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetHealth

func (*ConfigRequest_V1_Service) GetManifestCacheExpiry

func (x *ConfigRequest_V1_Service) GetManifestCacheExpiry() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetManifestDirectory

func (x *ConfigRequest_V1_Service) GetManifestDirectory() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetName

func (*ConfigRequest_V1_Service) GetOrigin

func (*ConfigRequest_V1_Service) GetOverrideOrigin

func (x *ConfigRequest_V1_Service) GetOverrideOrigin() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetPackageCleanupMode

func (x *ConfigRequest_V1_Service) GetPackageCleanupMode() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) GetProducts

func (x *ConfigRequest_V1_Service) GetProducts() []string

func (*ConfigRequest_V1_Service) GetUpgradeStrategy

func (x *ConfigRequest_V1_Service) GetUpgradeStrategy() *wrapperspb.StringValue

func (*ConfigRequest_V1_Service) ProtoMessage

func (*ConfigRequest_V1_Service) ProtoMessage()

func (*ConfigRequest_V1_Service) ProtoReflect

func (x *ConfigRequest_V1_Service) ProtoReflect() protoreflect.Message

func (*ConfigRequest_V1_Service) Reset

func (x *ConfigRequest_V1_Service) Reset()

func (*ConfigRequest_V1_Service) String

func (x *ConfigRequest_V1_Service) String() string

type ConfigRequest_V1_System

type ConfigRequest_V1_System struct {
	Mlsa       *shared.Mlsa                        `protobuf:"bytes,1,opt,name=mlsa,proto3" json:"mlsa,omitempty" toml:"mlsa,omitempty" mapstructure:"mlsa,omitempty"`
	Service    *ConfigRequest_V1_System_Service    `protobuf:"bytes,2,opt,name=service,proto3" json:"service,omitempty" toml:"service,omitempty" mapstructure:"service,omitempty"`
	Log        *ConfigRequest_V1_System_Log        `protobuf:"bytes,3,opt,name=log,proto3" json:"log,omitempty" toml:"log,omitempty" mapstructure:"log,omitempty"`
	GatherLogs *ConfigRequest_V1_System_GatherLogs `` /* 157-byte string literal not displayed */
	Proxy      *ConfigRequest_V1_System_Proxy      `protobuf:"bytes,5,opt,name=proxy,proto3" json:"proxy,omitempty" toml:"proxy,omitempty" mapstructure:"proxy,omitempty"`
	Backup     *ConfigRequest_V1_System_Backup     `protobuf:"bytes,6,opt,name=backup,proto3" json:"backup,omitempty" toml:"backup,omitempty" mapstructure:"backup,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System) Descriptor deprecated

func (*ConfigRequest_V1_System) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System) GetBackup

func (*ConfigRequest_V1_System) GetGatherLogs

func (*ConfigRequest_V1_System) GetLog

func (*ConfigRequest_V1_System) GetMlsa

func (x *ConfigRequest_V1_System) GetMlsa() *shared.Mlsa

func (*ConfigRequest_V1_System) GetProxy

func (*ConfigRequest_V1_System) GetService

func (*ConfigRequest_V1_System) ProtoMessage

func (*ConfigRequest_V1_System) ProtoMessage()

func (*ConfigRequest_V1_System) ProtoReflect

func (x *ConfigRequest_V1_System) ProtoReflect() protoreflect.Message

func (*ConfigRequest_V1_System) Reset

func (x *ConfigRequest_V1_System) Reset()

func (*ConfigRequest_V1_System) String

func (x *ConfigRequest_V1_System) String() string

type ConfigRequest_V1_System_Backup

type ConfigRequest_V1_System_Backup struct {
	Filesystem *ConfigRequest_V1_System_Backup_Filesystem `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_Backup) Descriptor deprecated

func (*ConfigRequest_V1_System_Backup) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_Backup.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_Backup) GetFilesystem

func (*ConfigRequest_V1_System_Backup) ProtoMessage

func (*ConfigRequest_V1_System_Backup) ProtoMessage()

func (*ConfigRequest_V1_System_Backup) ProtoReflect

func (*ConfigRequest_V1_System_Backup) Reset

func (x *ConfigRequest_V1_System_Backup) Reset()

func (*ConfigRequest_V1_System_Backup) String

type ConfigRequest_V1_System_Backup_Filesystem

type ConfigRequest_V1_System_Backup_Filesystem struct {
	Path *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty" toml:"path,omitempty" mapstructure:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_Backup_Filesystem) Descriptor deprecated

func (*ConfigRequest_V1_System_Backup_Filesystem) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_Backup_Filesystem.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_Backup_Filesystem) GetPath

func (*ConfigRequest_V1_System_Backup_Filesystem) ProtoMessage

func (*ConfigRequest_V1_System_Backup_Filesystem) ProtoReflect

func (*ConfigRequest_V1_System_Backup_Filesystem) Reset

func (*ConfigRequest_V1_System_Backup_Filesystem) String

type ConfigRequest_V1_System_GatherLogs

type ConfigRequest_V1_System_GatherLogs struct {
	StagingDir *wrapperspb.StringValue `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_GatherLogs) Descriptor deprecated

func (*ConfigRequest_V1_System_GatherLogs) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_GatherLogs.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_GatherLogs) GetStagingDir

func (*ConfigRequest_V1_System_GatherLogs) ProtoMessage

func (*ConfigRequest_V1_System_GatherLogs) ProtoMessage()

func (*ConfigRequest_V1_System_GatherLogs) ProtoReflect

func (*ConfigRequest_V1_System_GatherLogs) Reset

func (*ConfigRequest_V1_System_GatherLogs) String

type ConfigRequest_V1_System_Log

type ConfigRequest_V1_System_Log struct {
	Level *wrapperspb.StringValue `protobuf:"bytes,1,opt,name=level,proto3" json:"level,omitempty" toml:"level,omitempty" mapstructure:"level,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_Log) Descriptor deprecated

func (*ConfigRequest_V1_System_Log) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_Log.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_Log) GetLevel

func (*ConfigRequest_V1_System_Log) ProtoMessage

func (*ConfigRequest_V1_System_Log) ProtoMessage()

func (*ConfigRequest_V1_System_Log) ProtoReflect

func (*ConfigRequest_V1_System_Log) Reset

func (x *ConfigRequest_V1_System_Log) Reset()

func (*ConfigRequest_V1_System_Log) String

func (x *ConfigRequest_V1_System_Log) String() string

type ConfigRequest_V1_System_Proxy

type ConfigRequest_V1_System_Proxy struct {
	ConnectionString *wrapperspb.StringValue `` /* 187-byte string literal not displayed */
	NoProxyString    *wrapperspb.StringValue `` /* 176-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_Proxy) Descriptor deprecated

func (*ConfigRequest_V1_System_Proxy) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_Proxy.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_Proxy) GetConnectionString

func (x *ConfigRequest_V1_System_Proxy) GetConnectionString() *wrapperspb.StringValue

func (*ConfigRequest_V1_System_Proxy) GetNoProxyString

func (x *ConfigRequest_V1_System_Proxy) GetNoProxyString() *wrapperspb.StringValue

func (*ConfigRequest_V1_System_Proxy) ProtoMessage

func (*ConfigRequest_V1_System_Proxy) ProtoMessage()

func (*ConfigRequest_V1_System_Proxy) ProtoReflect

func (*ConfigRequest_V1_System_Proxy) Reset

func (x *ConfigRequest_V1_System_Proxy) Reset()

func (*ConfigRequest_V1_System_Proxy) String

type ConfigRequest_V1_System_Service

type ConfigRequest_V1_System_Service struct {

	// Deprecated: Do not use.
	ListenAddress *wrapperspb.StringValue `` // The listen host is no longer setable(localhost only)
	/* 172-byte string literal not displayed */
	Port *wrapperspb.Int32Value `protobuf:"bytes,2,opt,name=port,proto3" json:"port,omitempty" toml:"port,omitempty" mapstructure:"port,omitempty"`
	// contains filtered or unexported fields
}

func (*ConfigRequest_V1_System_Service) Descriptor deprecated

func (*ConfigRequest_V1_System_Service) Descriptor() ([]byte, []int)

Deprecated: Use ConfigRequest_V1_System_Service.ProtoReflect.Descriptor instead.

func (*ConfigRequest_V1_System_Service) GetListenAddress deprecated

Deprecated: Do not use.

func (*ConfigRequest_V1_System_Service) GetPort

func (*ConfigRequest_V1_System_Service) ProtoMessage

func (*ConfigRequest_V1_System_Service) ProtoMessage()

func (*ConfigRequest_V1_System_Service) ProtoReflect

func (*ConfigRequest_V1_System_Service) Reset

func (*ConfigRequest_V1_System_Service) String

type InitConfig

type InitConfig struct {
	DeploymentType  string
	Channel         string
	UpgradeStrategy string
	Fqdn            string
	FrontendCert    string
	FrontendKey     string
	License         string
	TLSWarning      string
	ProxyHost       string
	ProxyPort       int32
	ProxyUser       string
	ProxyPassword   string
	NoProxy         []string
	ESHeapSize      string
	OSHeapSize      string
}

InitConfig is a struct that contains fields that correspond to user facing configuration values that we'll use when rendering the config template.

func GenerateInitConfig

func GenerateInitConfig(channel string, upgradeStrategy string, opts ...InitConfigOpt) (*InitConfig, error)

GenerateInitConfig constructions an InitConfig, generating values not passed by the caller if possible.

func NewInitConfig

func NewInitConfig() *InitConfig

NewInitConfig returns a new instance of InitConfig with default values

func (InitConfig) AutomateConfig

func (c InitConfig) AutomateConfig() *AutomateConfig

AutomateConfig returns an AutomateConfig with the appropriate fields from an InitConfig filled in

func (InitConfig) Render

func (c InitConfig) Render() (string, error)

Render returns a user facing subset of the AutomateConfig as a TOML string.

type InitConfigOpt

type InitConfigOpt func(*InitConfig) error

InitConfigOpt is an option that can be passed to the GenerateInitConfig

func ESMem

func ESMem(mem string) InitConfigOpt

ESMem sets the ES heap size for the generated configuration

func InitialFQDN

func InitialFQDN(fqdn string) InitConfigOpt

InitialFQDN sets the FQDN for the generated configuration

func InitialTLSCerts

func InitialTLSCerts(keyPath string, certPath string) InitConfigOpt

InitialTLSCerts sets the TLS certificates in the generated configuration to those contained in the files at the specified path

func OSMem

func OSMem(mem string) InitConfigOpt

OSMem sets the ES heap size for the generated configuration

Jump to

Keyboard shortcuts

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