env

Documentation

Index

• Constants
• func CreateEnv(envArgs *types.EnvMeta) error
• func DeleteEnv(envName string) (string, error)
• func GetCurrentEnv() (*types.EnvMeta, error)
• func GetEnvByName(name string) (*types.EnvMeta, error)
• func ListEnvs(envName string) ([]*types.EnvMeta, error)
• func SetCurrentEnv(meta *types.EnvMeta) error
• func SetEnvLabels(envArgs *types.EnvMeta) error

Constants

const (
	// IndicatingLabel is label key indicating application is an env
	IndicatingLabel = "cli.env.oam.dev/name"
	// RawType is component type of raw
	RawType = "raw"
	// DefaultEnvNamespace is namespace of default env
	DefaultEnvNamespace = "default"
)

Functions

func CreateEnv

func CreateEnv(envArgs *types.EnvMeta) error

CreateEnv will create e env. Because Env equals to namespace, one env should not be updated

func DeleteEnv

func DeleteEnv(envName string) (string, error)

DeleteEnv will delete env and its application

func GetCurrentEnv

func GetCurrentEnv() (*types.EnvMeta, error)

GetCurrentEnv will get current env

func GetEnvByName

func GetEnvByName(name string) (*types.EnvMeta, error)

GetEnvByName will get env info by name

func ListEnvs

func ListEnvs(envName string) ([]*types.EnvMeta, error)

ListEnvs will list all envs if envName specified, return list that only contains one env

func SetCurrentEnv

func SetCurrentEnv(meta *types.EnvMeta) error

SetCurrentEnv will set the current env to the specified one

func SetEnvLabels

func SetEnvLabels(envArgs *types.EnvMeta) error

SetEnvLabels set labels for namespace