tarmak

Documentation

Overview

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Copyright Jetstack Ltd. See LICENSE for details.

Index

• type CmdTarmak
  • func (c *CmdTarmak) Apply() error
  • func (c *CmdTarmak) Destroy() error
  • func (c *CmdTarmak) DestroyEnvironment() error
  • func (c *CmdTarmak) ForceUnlock() error
  • func (c *CmdTarmak) ImagesBuild() error
  • func (c *CmdTarmak) Kubeconfig() error
  • func (c *CmdTarmak) Kubectl() error
  • func (c *CmdTarmak) Logs() error
  • func (c *CmdTarmak) Plan() (returnCode int, err error)
  • func (c *CmdTarmak) Shell() error
• type Tarmak
  • func New(flags *tarmakv1alpha1.Flags) *Tarmak
  • func (t *Tarmak) CancellationContext() interfaces.CancellationContext
  • func (t *Tarmak) Cleanup()
  • func (t *Tarmak) Cluster() interfaces.Cluster
  • func (t *Tarmak) ClusterFlags() tarmakv1alpha1.ClusterFlags
  • func (t *Tarmak) CmdClusterInit() error
  • func (t *Tarmak) CmdEnvironmentInit() error
  • func (t *Tarmak) CmdProviderInit() error
  • func (t *Tarmak) Config() interfaces.Config
  • func (t *Tarmak) ConfigPath() string
  • func (t *Tarmak) DestroyClusterMetadata() error
  • func (t *Tarmak) EnsureRemoteResources() error
  • func (t *Tarmak) Environment() interfaces.Environment
  • func (t *Tarmak) EnvironmentByName(environmentName string) (interfaces.Environment, error)
  • func (t *Tarmak) Environments() (envs []interfaces.Environment)
  • func (t *Tarmak) HomeDir() string
  • func (t *Tarmak) HomeDirExpand(in string) (string, error)
  • func (t *Tarmak) KeepContainers() bool
  • func (t *Tarmak) Log() *logrus.Entry
  • func (t *Tarmak) Must(err error)
  • func (t *Tarmak) NewCmdTarmak(pflags *pflag.FlagSet, args []string) *CmdTarmak
  • func (t *Tarmak) Packer() interfaces.Packer
  • func (t *Tarmak) Perform(err error)
  • func (t *Tarmak) Provider() interfaces.Provider
  • func (t *Tarmak) ProviderByName(providerName string) (interfaces.Provider, error)
  • func (t *Tarmak) Providers() (providers []interfaces.Provider)
  • func (t *Tarmak) Puppet() interfaces.Puppet
  • func (t *Tarmak) RootPath() (string, error)
  • func (t *Tarmak) SSH() interfaces.SSH
  • func (t *Tarmak) SSHPassThrough(argsAdditional []string) error
  • func (t *Tarmak) Terraform() interfaces.Terraform
  • func (t *Tarmak) Validate() error
  • func (t *Tarmak) Variables() map[string]interface{}
  • func (t *Tarmak) Verify() error
  • func (t *Tarmak) Version() string

Types

type CmdTarmak

type CmdTarmak struct {
	*Tarmak
	// contains filtered or unexported fields
}

func (*CmdTarmak) Apply

func (c *CmdTarmak) Apply() error

func (*CmdTarmak) Destroy

func (c *CmdTarmak) Destroy() error

func (*CmdTarmak) DestroyEnvironment

func (c *CmdTarmak) DestroyEnvironment() error

func (*CmdTarmak) ForceUnlock

func (c *CmdTarmak) ForceUnlock() error

func (*CmdTarmak) ImagesBuild

func (c *CmdTarmak) ImagesBuild() error

func (*CmdTarmak) Kubeconfig

func (c *CmdTarmak) Kubeconfig() error

func (*CmdTarmak) Kubectl

func (c *CmdTarmak) Kubectl() error

func (*CmdTarmak) Logs

func (c *CmdTarmak) Logs() error

func (*CmdTarmak) Plan

func (c *CmdTarmak) Plan() (returnCode int, err error)

func (*CmdTarmak) Shell

func (c *CmdTarmak) Shell() error

type Tarmak

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

func New

func New(flags *tarmakv1alpha1.Flags) *Tarmak

allocate a new tarmak struct

func (*Tarmak) CancellationContext

func (t *Tarmak) CancellationContext() interfaces.CancellationContext

func (*Tarmak) Cleanup

func (t *Tarmak) Cleanup()

func (*Tarmak) Cluster

func (t *Tarmak) Cluster() interfaces.Cluster

func (*Tarmak) ClusterFlags

func (t *Tarmak) ClusterFlags() tarmakv1alpha1.ClusterFlags

func (*Tarmak) CmdClusterInit

func (t *Tarmak) CmdClusterInit() error

CmdClusterInit initializes a new tarmak cluster from CLI input

func (*Tarmak) CmdEnvironmentInit

func (t *Tarmak) CmdEnvironmentInit() error

func (*Tarmak) CmdProviderInit

func (t *Tarmak) CmdProviderInit() error

func (*Tarmak) Config

func (t *Tarmak) Config() interfaces.Config

func (*Tarmak) ConfigPath

func (t *Tarmak) ConfigPath() string

func (*Tarmak) DestroyClusterMetadata

func (t *Tarmak) DestroyClusterMetadata() error

func (*Tarmak) EnsureRemoteResources

func (t *Tarmak) EnsureRemoteResources() error

func (*Tarmak) Environment

func (t *Tarmak) Environment() interfaces.Environment

func (*Tarmak) EnvironmentByName

func (t *Tarmak) EnvironmentByName(environmentName string) (interfaces.Environment, error)

func (*Tarmak) Environments

func (t *Tarmak) Environments() (envs []interfaces.Environment)

func (*Tarmak) HomeDir

func (t *Tarmak) HomeDir() string

func (*Tarmak) HomeDirExpand

func (t *Tarmak) HomeDirExpand(in string) (string, error)

func (*Tarmak) KeepContainers

func (t *Tarmak) KeepContainers() bool

func (*Tarmak) Log

func (t *Tarmak) Log() *logrus.Entry

func (*Tarmak) Must

func (t *Tarmak) Must(err error)

func (*Tarmak) NewCmdTarmak

func (t *Tarmak) NewCmdTarmak(pflags *pflag.FlagSet, args []string) *CmdTarmak

func (*Tarmak) Packer

func (t *Tarmak) Packer() interfaces.Packer

func (*Tarmak) Perform

func (t *Tarmak) Perform(err error)

func (*Tarmak) Provider

func (t *Tarmak) Provider() interfaces.Provider

func (*Tarmak) ProviderByName

func (t *Tarmak) ProviderByName(providerName string) (interfaces.Provider, error)

func (*Tarmak) Providers

func (t *Tarmak) Providers() (providers []interfaces.Provider)

func (*Tarmak) Puppet

func (t *Tarmak) Puppet() interfaces.Puppet

func (*Tarmak) RootPath

func (t *Tarmak) RootPath() (string, error)

this builds a temporary directory with the needed assets that are built into the go binary

func (*Tarmak) SSH

func (t *Tarmak) SSH() interfaces.SSH

func (*Tarmak) SSHPassThrough

func (t *Tarmak) SSHPassThrough(argsAdditional []string) error

func (*Tarmak) Terraform

func (t *Tarmak) Terraform() interfaces.Terraform

func (*Tarmak) Validate

func (t *Tarmak) Validate() error

func (*Tarmak) Variables

func (t *Tarmak) Variables() map[string]interface{}

func (*Tarmak) Verify

func (t *Tarmak) Verify() error

func (*Tarmak) Version

func (t *Tarmak) Version() string