database

Documentation

Index

• Constants
• func CreateDatabase(databaseSpec DatabaseTopologySpec) (*rds.DBCluster, error)
• func DeleteDatabase(region string, databaseId string) error
• type DatabaseTemplateData
  • func CreateDatabaseTemplateData(data framework.TemplateData) DatabaseTemplateData
• type DatabaseTopology
  • func CreateDefaultDatabaseTopology(namePrefix string) DatabaseTopology
  • func (t *DatabaseTopology) GetKind() string
  • func (t *DatabaseTopology) ToString() string
• type DatabaseTopologySpec
• type TopologyHandler
  • func (t *TopologyHandler) Generate() (framework.Topology, error)
  • func (t *TopologyHandler) Install(topology framework.Topology) (framework.DeploymentOutput, error)
  • func (t *TopologyHandler) Parse(yamlContent []byte) (framework.Topology, error)
  • func (t *TopologyHandler) Resolve(topology framework.Topology, data framework.TemplateData) (framework.Topology, error)
  • func (t *TopologyHandler) Uninstall(topology framework.Topology) (framework.DeploymentOutput, error)

Constants

const (
	DefaultUserName = "user1"

	KindDatabaseTopology = "Database"

	FieldMaskValue = "***"

	DefaultVersion    = "datapunch.org/v1alpha1"
	DefaultRegion     = "us-west-1"
	DefaultNamePrefix = "my"
)

Functions

func CreateDatabase

func CreateDatabase(databaseSpec DatabaseTopologySpec) (*rds.DBCluster, error)

func DeleteDatabase

func DeleteDatabase(region string, databaseId string) error

Types

type DatabaseTemplateData

type DatabaseTemplateData struct {
	framework.TemplateDataWithRegion
}

func CreateDatabaseTemplateData

func CreateDatabaseTemplateData(data framework.TemplateData) DatabaseTemplateData

type DatabaseTopology

type DatabaseTopology struct {
	ApiVersion string                     `json:"apiVersion" yaml:"apiVersion"`
	Kind       string                     `json:"kind" yaml:"kind"`
	Metadata   framework.TopologyMetadata `json:"metadata"`
	Spec       DatabaseTopologySpec       `json:"spec"`
}

func CreateDefaultDatabaseTopology

func CreateDefaultDatabaseTopology(namePrefix string) DatabaseTopology

func (*DatabaseTopology) GetKind

func (t *DatabaseTopology) GetKind() string

func (*DatabaseTopology) ToString

func (t *DatabaseTopology) ToString() string

type DatabaseTopologySpec

type DatabaseTopologySpec struct {
	NamePrefix        string   `json:"namePrefix" yaml:"namePrefix"`
	Region            string   `json:"region" yaml:"region"`
	VpcId             string   `json:"vpcId" yaml:"vpcId"`
	AvailabilityZones []string `json:"availabilityZones" yaml:"availabilityZones"`
	DatabaseId        string   `json:"databaseId" yaml:"databaseId"`
	MasterUserName    string   `json:"masterUserName" yaml:"masterUserName"`
	// password must not shorter than 8 characters
	MasterUserPassword string                   `json:"masterUserPassword" yaml:"masterUserPassword"`
	SecurityGroups     []resource.SecurityGroup `json:"securityGroups" yaml:"securityGroups"`
}

type TopologyHandler

type TopologyHandler struct {
}

func (*TopologyHandler) Generate

func (t *TopologyHandler) Generate() (framework.Topology, error)

func (*TopologyHandler) Install

func (t *TopologyHandler) Install(topology framework.Topology) (framework.DeploymentOutput, error)

func (*TopologyHandler) Parse

func (t *TopologyHandler) Parse(yamlContent []byte) (framework.Topology, error)

func (*TopologyHandler) Resolve

func (t *TopologyHandler) Resolve(topology framework.Topology, data framework.TemplateData) (framework.Topology, error)

func (*TopologyHandler) Uninstall

func (t *TopologyHandler) Uninstall(topology framework.Topology) (framework.DeploymentOutput, error)