tfctl

Documentation

Index

• type CLI
  • func New(build, release string) *CLI
  • func (c *CLI) ApprovePlan(out io.Writer, resource string, yamlFile string) error
  • func (c *CLI) BreakTheGlass(out io.Writer, resource string) error
  • func (c *CLI) Create(out io.Writer, name string, namespace string, path string, source string, ...) error
  • func (c *CLI) DeleteTerraform(out io.Writer, resource string) error
  • func (c *CLI) ForceUnlock(out io.Writer, resource, lockID string) error
  • func (c *CLI) Get(out io.Writer) error
  • func (c *CLI) GetTerraform(out io.Writer, resource string) error
  • func (c *CLI) Init(kubeconfigArgs *genericclioptions.ConfigFlags, config *viper.Viper) error
  • func (c *CLI) Install(out io.Writer, version string, export bool) (err error)
  • func (c *CLI) Reconcile(out io.Writer, resource string) error
  • func (c *CLI) Replan(out io.Writer, resource string) error
  • func (c *CLI) Resume(out io.Writer, resource string) error
  • func (c *CLI) ShowPlan(out io.Writer, resource string) error
  • func (c *CLI) Suspend(out io.Writer, resource string) error
  • func (c *CLI) Uninstall(out io.Writer) error
  • func (c *CLI) Version(out io.Writer) error

Types

type CLI

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

CLI is the main struct for the tfctl command line tool

func New

func New(build, release string) *CLI

New returns a new CLI instance

func (*CLI) ApprovePlan

func (c *CLI) ApprovePlan(out io.Writer, resource string, yamlFile string) error

ApprovePlan approves the pending plan for a given terraform resource

func (*CLI) BreakTheGlass

func (c *CLI) BreakTheGlass(out io.Writer, resource string) error

func (*CLI) Create

func (c *CLI) Create(
	out io.Writer,
	name string,
	namespace string,
	path string,
	source string,
	interval string,
	export bool,
) error

Create generates a Terraform resource

func (*CLI) DeleteTerraform

func (c *CLI) DeleteTerraform(out io.Writer, resource string) error

DeleteTerraform deletes the terraform resource from the cluster

func (*CLI) ForceUnlock

func (c *CLI) ForceUnlock(out io.Writer, resource, lockID string) error

ForceUnlock will set the corresponding field and request a reconciliation for the corresponding resource.

func (*CLI) Get

func (c *CLI) Get(out io.Writer) error

Get prints information about terraform resources

func (*CLI) GetTerraform

func (c *CLI) GetTerraform(out io.Writer, resource string) error

GetTerraform prints information about the provided resource

func (*CLI) Init

func (c *CLI) Init(kubeconfigArgs *genericclioptions.ConfigFlags, config *viper.Viper) error

Init initializes the CLI instance for a given kubeconfig, namespace and terraform binary

func (*CLI) Install

func (c *CLI) Install(out io.Writer, version string, export bool) (err error)

Install installs the tf-controller resources into the cluster.

func (*CLI) Reconcile

func (c *CLI) Reconcile(out io.Writer, resource string) error

Reconcile annotates the given object

func (*CLI) Replan

func (c *CLI) Replan(out io.Writer, resource string) error

Replan re-plans the given Terraform resource

func (*CLI) Resume

func (c *CLI) Resume(out io.Writer, resource string) error

Resume sets the resume field to true on the given Terraform resource.

func (*CLI) ShowPlan

func (c *CLI) ShowPlan(out io.Writer, resource string) error

ShowPlan displays the plan for the given Terraform resource

func (*CLI) Suspend

func (c *CLI) Suspend(out io.Writer, resource string) error

Suspend sets the suspend field to true on the given Terraform resource.

func (*CLI) Uninstall

func (c *CLI) Uninstall(out io.Writer) error

Uninstall removes the tf-controller resources from the cluster.

func (*CLI) Version

func (c *CLI) Version(out io.Writer) error

Version prints the installed version of tf-controller and the tfctl cli