stacki

Documentation

Index

• type Config
  • func NewConfigFrom(m map[interface{}]interface{}) *Config
  • func (c *Config) MergeNodePools(nodePoolsEnvConf map[string]string)
  • func (c *Config) MergeWithEnv(envConf map[string]string, conf ...Config) error
  • func (c *Config) MergeWithMapConfig(m map[interface{}]interface{})
• type Node
• type NodePool
• type Platform
  • func CreateFrom(clusterName string, config map[interface{}]interface{}, credentials []string, ...) *Platform
  • func New(clusterName string, envConfig map[string]string, ui *ui.UI, version string) (*Platform, error)
  • func (p *Platform) Address() string
  • func (p *Platform) Apply(destroy bool) error
  • func (p *Platform) BeProvisioner(state *terraformer.State) error
  • func (p *Platform) Code() []byte
  • func (p *Platform) Config() interface{}
  • func (p *Platform) CreateVariables() *Variables
  • func (p *Platform) Credentials(params ...string)
  • func (p *Platform) GetPrivateKey() (string, []byte, bool)
  • func (p *Platform) GetPublicKey() (string, []byte, bool)
  • func (p *Platform) LoadState(stateBuffer *bytes.Buffer) error
  • func (p *Platform) MergeWithEnv(envConfig map[string]string) error
  • func (p *Platform) Name() string
  • func (p *Platform) Nodes() []*state.Node
  • func (p *Platform) Output(name string) string
  • func (p *Platform) Plan(destroy bool) (plan *terraformer.Plan, err error)
  • func (p *Platform) Port() int
  • func (p *Platform) PrivateKey(file string, encKey, key []byte)
  • func (p *Platform) Provision() error
  • func (p *Platform) PublicKey(file string, key []byte)
  • func (p *Platform) State() *terraformer.State
  • func (p *Platform) Terminate() error
  • func (p *Platform) Variables() map[string]interface{}
• type Variables

Types

type Config

type Config struct {
	APIAddress             string              `json:"api_address" yaml:"api_address" mapstructure:"api_address"`
	KubeAPISSLPort         int                 `json:"kube_api_ssl_port" yaml:"kube_api_ssl_port" mapstructure:"kube_api_ssl_port"`
	DisableMasterHA        bool                `json:"disable_master_ha" yaml:"disable_master_ha" mapstructure:"disable_master_ha"`
	KubeVirtualIPShortname string              `json:"kube_virtual_ip_shortname" yaml:"kube_virtual_ip_shortname" mapstructure:"kube_virtual_ip_shortname"`
	KubeVirtualIPApi       string              `json:"kube_virtual_ip_api" yaml:"kube_virtual_ip_api" mapstructure:"kube_virtual_ip_api"`
	KubeVIPAPISSLPort      int                 `json:"kube_vip_api_ssl_port" yaml:"kube_vip_api_ssl_port" mapstructure:"kube_vip_api_ssl_port"`
	Username               string              `json:"username" yaml:"username" mapstructure:"username"`
	Password               string              `json:"password" yaml:"password" mapstructure:"password"`
	PrivateKey             string              `json:"private_key,omitempty" yaml:"private_key,omitempty" mapstructure:"private_key"`
	PrivateKeyFile         string              `json:"private_key_file" yaml:"private_key_file" mapstructure:"private_key_file"`
	PublicKey              string              `json:"public_key,omitempty" yaml:"public_key,omitempty" mapstructure:"public_key"`
	PublicKeyFile          string              `json:"public_key_file" yaml:"public_key_file" mapstructure:"public_key_file"`
	DNSServers             []string            `json:"dns_servers" yaml:"dns_servers" mapstructure:"dns_servers"`
	DNSSearch              []string            `json:"dns_search" yaml:"dns_search" mapstructure:"dns_search"`
	TimeServers            []string            `json:"time_servers" yaml:"time_servers" mapstructure:"time_servers"`
	DefaultNodePool        NodePool            `json:"default_node_pool" yaml:"default_node_pool" mapstructure:"default_node_pool"`
	NodePools              map[string]NodePool `json:"node_pools,omitempty" yaml:"node_pools,omitempty" mapstructure:"node_pools"`
	// contains filtered or unexported fields
}

Config defines the Stacki configuration parameters in the Cluster config file

func NewConfigFrom

func NewConfigFrom(m map[interface{}]interface{}) *Config

NewConfigFrom returns a new Stacki configuration from a map, usually from a cluster config file

func (*Config) MergeNodePools

func (c *Config) MergeNodePools(nodePoolsEnvConf map[string]string)

MergeNodePools merges the node pools in this configuration with the given environment configuration for node pools

func (*Config) MergeWithEnv

func (c *Config) MergeWithEnv(envConf map[string]string, conf ...Config) error

MergeWithEnv merges this configuration with the given configuration in a map[string]string, usually from environment variables

func (*Config) MergeWithMapConfig

func (c *Config) MergeWithMapConfig(m map[interface{}]interface{})

MergeWithMapConfig merges this configuration with the given configuration in a map[string], usually from a cluster config file

type Node

type Node struct {
	PublicIP   string `json:"public_ip" yaml:"public_ip" mapstructure:"public_ip"`
	PrivateIP  string `json:"private_ip" yaml:"private_ip" mapstructure:"private_ip"`
	PublicDNS  string `json:"public_dns" yaml:"public_dns" mapstructure:"public_dns"`
	PrivateDNS string `json:"private_dns" yaml:"private_dns" mapstructure:"private_dns"`
}

Node encapsulate a node or host information to save in the configuration

type NodePool

type NodePool struct {
	Name              string   `json:"-" yaml:"-" mapstructure:"name"`
	Count             int      `json:"count" yaml:"count" mapstructure:"count"`
	KubeletNodeLabels []string `json:"kubelet_node_labels,omitempty" yaml:"kubelet_node_labels,omitempty" mapstructure:"kubelet_node_labels"`
	KubeletNodeTaints []string `json:"kubelet_node_taints,omitempty" yaml:"kubelet_node_taints,omitempty" mapstructure:"kubelet_node_taints"`
	Nodes             []Node   `json:"address_pool" yaml:"address_pool" mapstructure:"address_pool"`
}

NodePool defines the settings for group of instances on stacki

type Platform

type Platform struct {
	// contains filtered or unexported fields
}

Platform implements the Provisioner interface for vSphere

func CreateFrom

func CreateFrom(clusterName string, config map[interface{}]interface{}, credentials []string, ui *ui.UI, version string) *Platform

CreateFrom creates a new Plaftorm with the given configuration for Stacki

func New

func New(clusterName string, envConfig map[string]string, ui *ui.UI, version string) (*Platform, error)

New creates a new Plaform with the given environment configuration

func (*Platform) Address

func (p *Platform) Address() string

Address returns the address to access the Kubernetes cluster

func (*Platform) Apply

func (p *Platform) Apply(destroy bool) error

Apply apply the changes either to create or destroy the cluster on this platform

func (*Platform) BeProvisioner

func (p *Platform) BeProvisioner(state *terraformer.State) error

BeProvisioner setup the Plaftorm to be a Provisioner

func (*Platform) Code

func (p *Platform) Code() []byte

Code returns the Terraform code to execute

func (*Platform) Config

func (p *Platform) Config() interface{}

Config returns the default configuration for Stacki

func (*Platform) CreateVariables

func (p *Platform) CreateVariables() *Variables

CreateVariables creates the variables from the platform configuration If the platform does not have configuration, will use the default one

func (*Platform) Credentials

func (p *Platform) Credentials(params ...string)

Credentials is to assign the credentials to the configuration

func (*Platform) GetPrivateKey

func (p *Platform) GetPrivateKey() (string, []byte, bool)

GetPrivateKey returns the private key and file from the configuration, also if this platform requires a private key for provisioning

func (*Platform) GetPublicKey

func (p *Platform) GetPublicKey() (string, []byte, bool)

GetPublicKey return the public key and file from the configuration, also if this platform requires a public key for provisioning

func (*Platform) LoadState

func (p *Platform) LoadState(stateBuffer *bytes.Buffer) error

LoadState loads the given Terraform state in a buffer into the terraformer state

func (*Platform) MergeWithEnv

func (p *Platform) MergeWithEnv(envConfig map[string]string) error

MergeWithEnv implements the MergeWithEnv method from the interfase Provisioner. It merges the environment variables with the existing configuration

func (*Platform) Name

func (p *Platform) Name() string

Name returns the platform name

func (*Platform) Nodes

func (p *Platform) Nodes() []*state.Node

Nodes return the list of nodes provisioned. It took the value from the

func (*Platform) Output

func (p *Platform) Output(name string) string

Output returns a value from the terraform output

func (*Platform) Plan

func (p *Platform) Plan(destroy bool) (plan *terraformer.Plan, err error)

Plan do the planning of the changes either to create or destroy the cluster on this platform.

func (*Platform) Port

func (p *Platform) Port() int

Port returns the port to access the Kubernetes cluster

func (*Platform) PrivateKey

func (p *Platform) PrivateKey(file string, encKey, key []byte)

PrivateKey sets the private key and file in the configuration

func (*Platform) Provision

func (p *Platform) Provision() error

Provision provisions or creates a cluster on this platform

func (*Platform) PublicKey

func (p *Platform) PublicKey(file string, key []byte)

PublicKey sets the public key and file in the configuration and variables

func (*Platform) State

func (p *Platform) State() *terraformer.State

State returns the current Terraform state of the cluster

func (*Platform) Terminate

func (p *Platform) Terminate() error

Terminate terminates or destroys a cluster on this platform

func (*Platform) Variables

func (p *Platform) Variables() map[string]interface{}

Variables returns the variables as a map where the key is the variable name

type Variables

type Variables struct{}

Variables encapsulate all the TF variables.