config

Documentation

Overview

Package config contains common configuration to all commands & control abstractions.

Index

• type Config
  • func FromEnv() (cfg *Config, err error)
  • func (c *Config) SetFlags(f *flag.FlagSet)
  • func (c *Config) Validate() error

Types

type Config

type Config struct {
	// Environment is the current environment ctpu is running in
	Environment string
	// The current active configuration we are using as default.
	ActiveConfiguration string
	// The "flock" name to use when creating the VMs and TPUs
	FlockName string
	// The GCP project we will use to allocate / deallocate TPUs and VMs.
	Project string
	// The Compute Engine zone we will use to allocate / deallocate TPUs and VMs.
	Zone string
	// contains filtered or unexported fields
}

Config encapsulates all common configuration required to execute a command.

func FromEnv

func FromEnv() (cfg *Config, err error)

FromEnv constructs a Config object from the environment.

func (*Config) SetFlags

func (c *Config) SetFlags(f *flag.FlagSet)

SetFlags registers flag overrides for the config object.

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies that the configuration has been fully populated.