Documentation
¶
Index ¶
- Constants
- Variables
- func GenerateSigningKeyPair(publicPath, privatePath string) error
- func PrettyPrintConfig(config *DockerEnvironmentConfig, writer io.Writer) error
- func RenderConfig(templateValues ConfigTemplateValues, writer io.Writer) error
- type BuffersConfig
- type ConfigTemplateValues
- type DataPlaneSigningKeys
- type DockerEnvironmentConfig
- type Installer
- func (inst *Installer) ApplyMigrations(ctx context.Context, targetVersion int, ...) error
- func (inst *Installer) ApplyMultiOrgFilter([]string) error
- func (inst *Installer) ApplySingleOrgFilter(string) error
- func (inst *Installer) GetConfig() install.ValidatableConfig
- func (inst *Installer) GetMigrationLogs(ctx context.Context, id int, destination io.Writer) error
- func (inst *Installer) GetServerLogs(ctx context.Context, options install.ServerLogOptions) error
- func (inst *Installer) InstallTyger(ctx context.Context) error
- func (inst *Installer) ListDatabaseVersions(ctx context.Context, allVersions bool) ([]install.DatabaseVersion, error)
- func (inst *Installer) UninstallTyger(ctx context.Context, deleteData bool, preserveRunContainers bool) error
- type KeyPair
- type NetworkConfig
Constants ¶
View Source
const (
ConfigKindDocker = "docker"
)
Variables ¶
View Source
var ( NameRegex = regexp.MustCompile(`^[a-z][a-z\-0-9]{1,23}$`) DefaultEnvironmentName = "local" DefaultInstallationPath = "/opt/tyger" DefaultPostgresImage = "postgres:16.2" DefaultMarinerImage = "mcr.microsoft.com/azurelinux/base/core:3.0" InstallationPathMaxLength = 70 )
Functions ¶
func GenerateSigningKeyPair ¶
func PrettyPrintConfig ¶
func PrettyPrintConfig(config *DockerEnvironmentConfig, writer io.Writer) error
func RenderConfig ¶
func RenderConfig(templateValues ConfigTemplateValues, writer io.Writer) error
Types ¶
type BuffersConfig ¶
type ConfigTemplateValues ¶
type DataPlaneSigningKeys ¶
type DockerEnvironmentConfig ¶
type DockerEnvironmentConfig struct {
install.ConfigFileCommon `yaml:",inline"`
EnvironmentName string `yaml:"environmentName"`
DataPlanePort int `yaml:"dataPlanePort"`
UserId string `yaml:"userId"`
AllowedGroupId string `yaml:"allowedGroupId"`
InstallationPath string `yaml:"installationPath"`
PostgresImage string `yaml:"postgresImage"`
MarinerImage string `yaml:"marinerImage"`
ControlPlaneImage string `yaml:"controlPlaneImage"`
DataPlaneImage string `yaml:"dataPlaneImage"`
BufferSidecarImage string `yaml:"bufferSidecarImage"`
GatewayImage string `yaml:"gatewayImage"`
UseGateway *bool `yaml:"useGateway"`
SigningKeys DataPlaneSigningKeys `yaml:"signingKeys"`
InitialDatabaseVersion *int `yaml:"initialDatabaseVersion"`
Network *NetworkConfig `yaml:"network"`
Buffers *BuffersConfig `yaml:"buffers"`
}
func (*DockerEnvironmentConfig) GetGroupIdInt ¶
func (c *DockerEnvironmentConfig) GetGroupIdInt() int
func (*DockerEnvironmentConfig) GetUserIdInt ¶
func (c *DockerEnvironmentConfig) GetUserIdInt() int
func (*DockerEnvironmentConfig) QuickValidateConfig ¶
func (envConfig *DockerEnvironmentConfig) QuickValidateConfig(ctx context.Context) error
type Installer ¶
type Installer struct {
Config *DockerEnvironmentConfig
// contains filtered or unexported fields
}
func NewInstaller ¶
func NewInstaller(config *DockerEnvironmentConfig) (*Installer, error)
func (*Installer) ApplyMigrations ¶
func (*Installer) ApplyMultiOrgFilter ¶
func (*Installer) ApplySingleOrgFilter ¶
func (*Installer) GetConfig ¶
func (inst *Installer) GetConfig() install.ValidatableConfig
func (*Installer) GetMigrationLogs ¶
func (*Installer) GetServerLogs ¶
func (*Installer) ListDatabaseVersions ¶
type NetworkConfig ¶
type NetworkConfig struct {
Subnet string `yaml:"subnet"`
}
Click to show internal directories.
Click to hide internal directories.