config

Documentation

Index

• func RequiredCertFlags() []string
• type Certs
  • func NewCerts(c *cli.Context) (*Certs, error)
• type Config
  • func NewConfig(c *cli.Context) (*Config, error)
  • func (c *Config) MySQLProxyHost() string
• type Disk
• type IP
• type InstanceCount
• type Secret
  • func NewSecret(c *cli.Context) (*Secret, error)
• type User
  • func NewUser(c *cli.Context) User
• type VMType

Functions

func RequiredCertFlags

func RequiredCertFlags() []string

Types

type Certs

type Certs struct {
	EtcdServerCert                 string
	EtcdServerKey                  string
	EtcdClientCert                 string
	EtcdClientKey                  string
	EtcdPeerCert                   string
	EtcdPeerKey                    string
	BBSCACert                      string
	BBSClientCert                  string
	BBSClientKey                   string
	BBSServerCert                  string
	BBSServerKey                   string
	RouterSSLCert                  string
	RouterSSLKey                   string
	HAProxySSLPem                  string
	ConsulAgentCert                string
	ConsulAgentKey                 string
	ConsulServerCert               string
	ConsulServerKey                string
	JWTVerificationKey             string
	SAMLServiceProviderKey         string
	SAMLServiceProviderCertificate string
	JWTSigningKey                  string
}

func NewCerts

func NewCerts(c *cli.Context) (*Certs, error)

type Config

type Config struct {
	DeploymentName                string   `omg:"deployment-name,optional"`
	AZs                           []string `omg:"az"`
	StemcellName                  string
	NetworkName                   string `omg:"network"`
	SystemDomain                  string
	AppDomains                    []string `omg:"app-domain"`
	AllowSSHAccess                bool     `omg:"allow-app-ssh-access"`
	SkipSSLCertVerify             bool     `omg:"skip-cert-verify"`
	NATSPort                      int      `omg:"nats-port"`
	UAALoginProtocol              string   `omg:"uaa-login-protocol"`
	SyslogAddress                 string   `omg:"syslog-address,optional"`
	SyslogPort                    int      `omg:"syslog-port,optional"`
	SyslogTransport               string   `omg:"syslog-transport,optional"`
	DopplerZone                   string   `omg:"doppler-zone,optional"`
	DopplerMessageDrainBufferSize int      `omg:"doppler-drain-buffer-size"`
	BBSRequireSSL                 bool     `omg:"bbs-require-ssl"`
	CCUploaderJobPollInterval     int      `omg:"cc-uploader-poll-interval"`
	CCExternalPort                int      `omg:"cc-external-port"`
	SelfServiceLinksEnabled       bool     `omg:"uaa-enable-selfservice-links"`
	SignupsEnabled                bool     `omg:"uaa-signups-enabled"`
	CompanyName                   string   `omg:"uaa-company-name"`
	ProductLogo                   string   `omg:"uaa-product-logo"`
	SquareLogo                    string   `omg:"uaa-square-logo"`
	FooterLegalText               string   `omg:"uaa-footer-legal-txt"`
	LDAPUrl                       string   `omg:"uaa-ldap-url,optional"`
	LDAPUserDN                    string   `omg:"uaa-ldap-user-dn,optional"`
	LDAPSearchBase                string   `omg:"uaa-ldap-search-base,optional"`
	LDAPSearchFilter              string   `omg:"uaa-ldap-search-filter,optional"`
	LDAPMailAttributeName         string   `omg:"uaa-ldap-mail-attributename,optional"`
	LDAPEnabled                   bool     `omg:"uaa-ldap-enabled,optional"`
	SharePath                     string   `omg:"nfs-share-path"`
	HostKeyFingerprint            string
	SupportAddress                string   `omg:"support-address,optional"`
	MinCliVersion                 string   `omg:"min-cli-version"`
	HAProxySkip                   bool     `omg:"skip-haproxy"`
	MySQLProxyExternalHost        string   `omg:"mysql-proxy-external-host,optional"`
	RouterEnableSSL               bool     `omg:"router-enable-ssl"`
	NFSAllowFromNetworkCIDR       []string `omg:"nfs-allow-from-network-cidr"`
	LoggregatorPort               int
	*Certs                        `omg:"-"` // certs are a special case that we handle manually for now
	IP
	VMType
	Disk
	Secret
	InstanceCount
	User
}

func NewConfig

func NewConfig(c *cli.Context) (*Config, error)

func (*Config) MySQLProxyHost

func (c *Config) MySQLProxyHost() string

type Disk

type Disk struct {
	EtcdPersistentDiskType       string `omg:"etcd-disk-type"`
	MySQLPersistentDiskType      string `omg:"mysql-disk-type"`
	NFSPersistentDiskType        string `omg:"nfs-disk-type"`
	DiegoDBPersistentDiskType    string `omg:"diego-db-disk-type"`
	DiegoCellPersistentDiskType  string `omg:"diego-cell-disk-type"`
	DiegoBrainPersistentDiskType string `omg:"diego-brain-disk-type"`
}

Disk contains the disk types for a Cloud Foundry deployment.

type IP

type IP struct {
	HAProxyIPs      []string `omg:"haproxy-ip,optional"`
	NFSIP           string   `omg:"nfs-ip"`
	MySQLIPs        []string `omg:"mysql-ip"`
	LoggregratorIPs []string `omg:"loggregator-traffic-controller-ip"`
	DopplerIPs      []string `omg:"doppler-ip"`
	EtcdMachines    []string `omg:"etcd-machine-ip"`
	DiegoCellIPs    []string `omg:"diego-cell-ip"`
	ConsulIPs       []string `omg:"consul-ip"`
	DiegoBrainIPs   []string `omg:"diego-brain-ip"`
	MySQLProxyIPs   []string `omg:"mysql-proxy-ip"`
	RouterMachines  []string `omg:"router-ip"`
	DiegoDBIPs      []string `omg:"diego-db-ip"`
	NATSMachines    []string `omg:"nats-machine-ip"`
}

IP contains IP configuration for a Cloud Foundry deployment.

type InstanceCount

type InstanceCount struct {
	CloudControllerWorkerInstances int `omg:"cc-worker-instances"`
	CloudControllerInstances       int `omg:"cc-instances"`
	UAAInstances                   int `omg:"uaa-instances"`
}

InstanceCount contains the configurable instance counts for a cloud foundry deployment.

type Secret

type Secret struct {
	AdminPassword                             string
	MySQLBootstrapPassword                    string `omg:"mysql-bootstrap-password"`
	NATSPassword                              string `omg:"nats-pass"`
	SmokeTestsPassword                        string
	DopplerSecret                             string `omg:"doppler-client-secret"`
	DopplerSharedSecret                       string
	CCBulkAPIPassword                         string `omg:"cc-bulk-api-password"`
	CCInternalAPIPassword                     string `omg:"cc-internal-api-password"`
	SSHProxyClientSecret                      string `omg:"ssh-proxy-uaa-secret"`
	DiegoDBPassphrase                         string `omg:"diego-db-passphrase"`
	AdminSecret                               string `omg:"uaa-admin-secret"`
	UAADBPassword                             string `omg:"db-uaa-password"`
	PushAppsManagerPassword                   string
	SystemServicesPassword                    string
	SystemVerificationPassword                string
	OpentsdbFirehoseNozzleClientSecret        string
	IdentityClientSecret                      string
	LoginClientSecret                         string
	PortalClientSecret                        string
	AutoScalingServiceClientSecret            string `omg:"autoscaling-service-client-secret"`
	SystemPasswordsClientSecret               string
	CCServiceDashboardsClientSecret           string `omg:"cc-service-dashboards-client-secret"`
	GoRouterClientSecret                      string `omg:"gorouter-client-secret"`
	NotificationsClientSecret                 string
	NotificationsUIClientSecret               string `omg:"notifications-ui-client-secret"`
	CloudControllerUsernameLookupClientSecret string
	CCRoutingClientSecret                     string `omg:"cc-routing-client-secret"`
	AppsMetricsClientSecret                   string
	AppsMetricsProcessingClientSecret         string
	LDAPUserPassword                          string `omg:"uaa-ldap-user-password,optional"`
	DbEncryptionKey                           string `omg:"cc-db-encryption-key"`
	CCDBPassword                              string `omg:"db-ccdb-password"`
	StagingUploadPassword                     string `omg:"cc-staging-upload-password"`
	MySQLProxyAPIPassword                     string `omg:"mysql-proxy-api-password"`
	RouterPass                                string
	MySQLAdminPassword                        string   `omg:"mysql-admin-password"`
	ConsoleDBPassword                         string   `omg:"db-console-password"`
	ConsulEncryptKeys                         []string `omg:"consul-encryption-key"`
	AppUsageDBPassword                        string   `omg:"db-app_usage-password"`
	AppsManagerSecretToken                    string
	AutoscaleBrokerPassword                   string `omg:"-"` // always autogenerated
	AutoscaleDBPassword                       string `omg:"db-autoscale-password"`
	NotificationsDBPassword                   string `omg:"db-notifications-password"`
}

Secret contains the secrets for a Cloud Foundry deployment.

func NewSecret

func NewSecret(c *cli.Context) (*Secret, error)

type User

type User struct {
	CCInternalAPIUser     string `omg:"cc-internal-api-user"`
	MySQLBootstrapUser    string `omg:"mysql-bootstrap-username"`
	NATSUser              string `omg:"nats-user"`
	StagingUploadUser     string `omg:"cc-staging-upload-user"`
	CCDBUsername          string `omg:"db-ccdb-username"`
	ConsoleDBUserName     string `omg:"db-console-username"`
	MySQLProxyAPIUsername string `omg:"mysql-proxy-api-username"`
	UAADBUserName         string `omg:"db-uaa-username"`
	AutoscaleDBUser       string `omg:"db-autoscale-username"`
	RouterUser            string
	AutoscaleBrokerUser   string `omg:"-"`
	NotificationsDBUser   string `omg:"db-notifications-username"`
}

func NewUser

func NewUser(c *cli.Context) User

type VMType

type VMType struct {
	NatsVMType                  string `omg:"nats-vm-type"`
	ConsulVMType                string `omg:"consul-vm-type"`
	MySQLVMType                 string `omg:"mysql-vm-type"`
	EtcdVMType                  string `omg:"etcd-vm-type"`
	ClockGlobalVMType           string `omg:"clock-global-vm-type"`
	MySQLProxyVMType            string `omg:"mysql-proxy-vm-type"`
	HAProxyVMType               string `omg:"haproxy-vm-type,optional"`
	RouterVMType                string `omg:"router-vm-type"`
	NFSVMType                   string `omg:"nfs-vm-type"`
	CloudControllerVMType       string `omg:"cc-vm-type"`
	CloudControllerWorkerVMType string `omg:"cc-worker-vm-type"`
	DiegoDBVMType               string `omg:"diego-db-vm-type"`
	UAAVMType                   string `omg:"uaa-vm-type"`
	DiegoCellVMType             string `omg:"diego-cell-vm-type"`
	DiegoBrainVMType            string `omg:"diego-brain-vm-type"`
	DopplerVMType               string `omg:"doppler-vm-type"`
	ErrandVMType                string `omg:"errand-vm-type"`
	LoggregratorVMType          string `omg:"loggregator-traffic-controller-vmtype"`
}

VMType contains the VM types for a Cloud Foundry deployment.