Documentation
¶
Index ¶
- Constants
- Variables
- func RunApply(m map[string]interface{}) error
- func RunComponentList(m map[string]interface{}) error
- func RunComponentRm(m map[string]interface{}) error
- func RunDelete(m map[string]interface{}) error
- func RunEnvAdd(m map[string]interface{}) error
- func RunEnvCurrent(m map[string]interface{}) error
- func RunEnvDescribe(m map[string]interface{}) error
- func RunEnvList(m map[string]interface{}) error
- func RunEnvRm(m map[string]interface{}) error
- func RunEnvSet(m map[string]interface{}) error
- func RunEnvTargets(m map[string]interface{}) error
- func RunEnvUpdate(m map[string]interface{}) error
- func RunImport(m map[string]interface{}) error
- func RunInit(m map[string]interface{}) error
- func RunModuleCreate(m map[string]interface{}) error
- func RunModuleList(m map[string]interface{}) error
- func RunParamDelete(m map[string]interface{}) error
- func RunParamDiff(m map[string]interface{}) error
- func RunParamList(m map[string]interface{}) error
- func RunParamSet(m map[string]interface{}) error
- func RunPkgDescribe(m map[string]interface{}) error
- func RunPkgInstall(m map[string]interface{}) error
- func RunPkgList(m map[string]interface{}) error
- func RunPrototypeDescribe(m map[string]interface{}) error
- func RunPrototypeList(m map[string]interface{}) error
- func RunPrototypePreview(m map[string]interface{}) error
- func RunPrototypeSearch(m map[string]interface{}) error
- func RunPrototypeUse(m map[string]interface{}) error
- func RunRegistryAdd(m map[string]interface{}) error
- func RunRegistryDescribe(m map[string]interface{}) error
- func RunRegistryList(m map[string]interface{}) error
- func RunShow(m map[string]interface{}) error
- func RunUpgrade(m map[string]interface{}) error
- func RunValidate(m map[string]interface{}) error
- type Apply
- type ComponentList
- type ComponentRm
- type Delete
- type DepCacher
- type EnvAdd
- type EnvCurrent
- type EnvDescribe
- type EnvList
- type EnvRm
- type EnvSet
- type EnvSetOpt
- type EnvTargets
- type EnvUpdate
- type Import
- type Init
- type ModuleCreate
- type ModuleList
- type ParamDelete
- type ParamDiff
- type ParamList
- type ParamSet
- type PkgDescribe
- type PkgInstall
- type PkgList
- type PrototypeDescribe
- type PrototypeList
- type PrototypePreview
- type PrototypeSearch
- type PrototypeUse
- type RegistryAdd
- type RegistryDescribe
- type RegistryList
- type Show
- type Upgrade
- type Validate
Constants ¶
const ( // OptionApp is app option. OptionApp = "app" // OptionArguments is arguments option. Used for passing arguments to prototypes. OptionArguments = "arguments" // OptionClientConfig is clientConfig option. OptionClientConfig = "client-config" // OptionComponentName is a componentName option. OptionComponentName = "component-name" // OptionComponentNames is componentNames option. OptionComponentNames = "component-names" // OptionCreate is create option. OptionCreate = "create" // OptionDryRun is dryRun option. OptionDryRun = "dry-run" // OptionEnvName is envName option. OptionEnvName = "env-name" // OptionEnvName1 is envName1. Used for param diff. OptionEnvName1 = "env-name-1" // OptionEnvName2 is envName1. Used for param diff. OptionEnvName2 = "env-name-2" // OptionFormat is format option. OptionFormat = "format" // OptionFs is fs option. OptionFs = "fs" // OptionGcTag is gcTag option. OptionGcTag = "gc-tag" // OptionGlobal is global option. OptionGlobal = "global" // OptionGracePeriod is gracePeriod option. OptionGracePeriod = "grace-period" // OptionLibName is libName. OptionLibName = "lib-name" // OptionName is name option. OptionName = "name" // OptionModule is component module option. OptionModule = "module" // OptionNamespace is a cluster namespace option OptionNamespace = "namespace" // OptionNewEnvName is newEnvName option. Used for renaming environments. OptionNewEnvName = "new-env-name" // OptionOutput is output option. OptionOutput = "output" // OptionOverride is override option. OptionOverride = "override" // OptionPackageName is packageName option. OptionPackageName = "package-name" // OptionPath is path option. OptionPath = "path" // OptionQuery is query option. OptionQuery = "query" // OptionRootPath is path option. OptionRootPath = "root-path" // OptionServer is server option. OptionServer = "server" // OptionServerURI is serverURI option. OptionServerURI = "server-uri" // OptionSkipDefaultRegistries is skipDefaultRegistries option. Used by init. OptionSkipDefaultRegistries = "skip-default-registries" // OptionSkipGc is skipGc option. OptionSkipGc = "skip-gc" // OptionSpecFlag is specFlag option. Used for setting k8s spec. OptionSpecFlag = "spec-flag" // OptionUnset is unset option. OptionUnset = "unset" // OptionURI is uri option. Used for setting registry URI. OptionURI = "URI" // OptionValue is value option. OptionValue = "value" // OptionVersion is version option. OptionVersion = "version" )
const ( // OutputWide is wide output OutputWide = "wide" // OutputJSON is JSON output OutputJSON = "json" )
Variables ¶
var ( // ErrNotInApp is an error stating the user is not in a ksonnet application directory // hierarchy. ErrNotInApp = errors.Errorf("could not find ksonnet app") )
Functions ¶
func RunComponentList ¶
RunComponentList runs `component list`
func RunComponentRm ¶
RunComponentRm runs `component list`
func RunEnvCurrent ¶
RunEnvCurrent runs `env current`.
func RunEnvDescribe ¶
RunEnvDescribe runs `env describe` func RunEnvDescribe(ksApp app.App, envName string) error {
func RunEnvSet ¶
RunEnvSet runs `env set` func RunEnvSet(ksApp app.App, envName string, opts ...EnvSetOpt) error {
func RunEnvTargets ¶
RunEnvTargets runs `env targets`
func RunEnvUpdate ¶
RunEnvUpdate runs `env update`.
func RunModuleCreate ¶
RunModuleCreate creates a module.
func RunModuleList ¶
RunModuleList runs `module list`
func RunParamDelete ¶
RunParamDelete runs `param set`
func RunParamDiff ¶
RunParamDiff runs `param diff`.
func RunParamList ¶
RunParamList runs `param list`.
func RunPkgDescribe ¶
RunPkgDescribe runs `pkg install`
func RunPkgInstall ¶
RunPkgInstall runs `pkg install`
func RunPrototypeDescribe ¶
RunPrototypeDescribe runs `prototype describe`
func RunPrototypeList ¶
RunPrototypeList runs `prototype list`
func RunPrototypePreview ¶
RunPrototypePreview runs `prototype describe`
func RunPrototypeSearch ¶
RunPrototypeSearch runs `prototype search`
func RunPrototypeUse ¶
RunPrototypeUse runs `prototype use`
func RunRegistryAdd ¶
RunRegistryAdd runs `registry add`
func RunRegistryDescribe ¶
RunRegistryDescribe runs `prototype list`
func RunRegistryList ¶
RunRegistryList runs `env list`
Types ¶
type Apply ¶
type Apply struct {
// contains filtered or unexported fields
}
Apply collects options for applying objects to a cluster.
type ComponentList ¶
type ComponentList struct {
// contains filtered or unexported fields
}
ComponentList create a list of components in a module.
func NewComponentList ¶
func NewComponentList(m map[string]interface{}) (*ComponentList, error)
NewComponentList creates an instance of ComponentList.
type ComponentRm ¶
type ComponentRm struct {
// contains filtered or unexported fields
}
ComponentRm removes a component from a module.
func NewComponentRm ¶
func NewComponentRm(m map[string]interface{}) (*ComponentRm, error)
NewComponentRm creates an instance of ComponentRm.
type Delete ¶
type Delete struct {
// contains filtered or unexported fields
}
Delete collects options for applying objects to a cluster.
type EnvAdd ¶
type EnvAdd struct {
// contains filtered or unexported fields
}
EnvAdd sets targets for an environment.
type EnvCurrent ¶
type EnvCurrent struct {
// contains filtered or unexported fields
}
EnvCurrent sets/unsets the current environment
type EnvDescribe ¶
type EnvDescribe struct {
// contains filtered or unexported fields
}
EnvDescribe describes an environment by printing its configuration.
func NewEnvDescribe ¶
func NewEnvDescribe(m map[string]interface{}) (*EnvDescribe, error)
NewEnvDescribe creates an instance of EnvDescribe.
type EnvList ¶
type EnvList struct {
// contains filtered or unexported fields
}
EnvList lists available namespaces
func NewEnvList ¶
NewEnvList creates an instance of EnvList
type EnvRm ¶
type EnvRm struct {
// contains filtered or unexported fields
}
EnvRm sets targets for an environment.
type EnvSet ¶
type EnvSet struct {
// contains filtered or unexported fields
}
EnvSet sets targets for an environment.
type EnvSetOpt ¶
type EnvSetOpt func(*EnvSet)
EnvSetOpt is an option for configuring EnvSet.
func EnvSetName ¶
EnvSetName is an option for setting a new name.
func EnvSetNamespace ¶
EnvSetNamespace is an option for setting a new namespace name.
type EnvTargets ¶
type EnvTargets struct {
// contains filtered or unexported fields
}
EnvTargets sets targets for an environment.
func NewEnvTargets ¶
func NewEnvTargets(m map[string]interface{}) (*EnvTargets, error)
NewEnvTargets creates an instance of EnvTargets.
type EnvUpdate ¶
type EnvUpdate struct {
// contains filtered or unexported fields
}
EnvUpdate updates ksonnet lib for an environment.
type Import ¶
type Import struct {
// contains filtered or unexported fields
}
Import imports files or directories into ksonnet.
type Init ¶
type Init struct {
// contains filtered or unexported fields
}
Init creates a component namespace
type ModuleCreate ¶
type ModuleCreate struct {
// contains filtered or unexported fields
}
ModuleCreate creates a component module
func NewModuleCreate ¶
func NewModuleCreate(m map[string]interface{}) (*ModuleCreate, error)
NewModuleCreate creates an instance of ModuleCreate.
type ModuleList ¶
type ModuleList struct {
// contains filtered or unexported fields
}
ModuleList lists modules.
func NewModuleList ¶
func NewModuleList(m map[string]interface{}) (*ModuleList, error)
NewModuleList creates an instance of ModuleList.
type ParamDelete ¶
type ParamDelete struct {
// contains filtered or unexported fields
}
ParamDelete sets a parameter for a component.
func NewParamDelete ¶
func NewParamDelete(m map[string]interface{}) (*ParamDelete, error)
NewParamDelete creates an instance of ParamDelete.
type ParamDiff ¶
type ParamDiff struct {
// contains filtered or unexported fields
}
ParamDiff shows difference between params in two environments.
func NewParamDiff ¶
NewParamDiff creates an instance of ParamDiff.
type ParamList ¶
type ParamList struct {
// contains filtered or unexported fields
}
ParamList lists parameters for a component.
func NewParamList ¶
NewParamList creates an instances of ParamList.
type ParamSet ¶
type ParamSet struct {
// contains filtered or unexported fields
}
ParamSet sets a parameter for a component.
func NewParamSet ¶
NewParamSet creates an instance of ParamSet.
type PkgDescribe ¶
type PkgDescribe struct {
// contains filtered or unexported fields
}
PkgDescribe describes a package.
func NewPkgDescribe ¶
func NewPkgDescribe(m map[string]interface{}) (*PkgDescribe, error)
NewPkgDescribe creates an instance of PkgDescribe.
type PkgInstall ¶
type PkgInstall struct {
// contains filtered or unexported fields
}
PkgInstall installs packages.
func NewPkgInstall ¶
func NewPkgInstall(m map[string]interface{}) (*PkgInstall, error)
NewPkgInstall creates an instance of PkgInstall.
type PkgList ¶
type PkgList struct {
// contains filtered or unexported fields
}
PkgList lists available registries
func NewPkgList ¶
NewPkgList creates an instance of PkgList
type PrototypeDescribe ¶
type PrototypeDescribe struct {
// contains filtered or unexported fields
}
PrototypeDescribe describes a prototype.
func NewPrototypeDescribe ¶
func NewPrototypeDescribe(m map[string]interface{}) (*PrototypeDescribe, error)
NewPrototypeDescribe creates an instance of PrototypeDescribe
func (*PrototypeDescribe) Run ¶
func (pd *PrototypeDescribe) Run() error
Run runs the env list action.
type PrototypeList ¶
type PrototypeList struct {
// contains filtered or unexported fields
}
PrototypeList lists available prototypes.
func NewPrototypeList ¶
func NewPrototypeList(m map[string]interface{}) (*PrototypeList, error)
NewPrototypeList creates an instance of PrototypeList
type PrototypePreview ¶
type PrototypePreview struct {
// contains filtered or unexported fields
}
PrototypePreview lists available namespaces
func NewPrototypePreview ¶
func NewPrototypePreview(m map[string]interface{}) (*PrototypePreview, error)
NewPrototypePreview creates an instance of PrototypePreview
func (*PrototypePreview) Run ¶
func (pp *PrototypePreview) Run() error
Run runs the env list action.
type PrototypeSearch ¶
type PrototypeSearch struct {
// contains filtered or unexported fields
}
PrototypeSearch searches for prototypes by name.
func NewPrototypeSearch ¶
func NewPrototypeSearch(m map[string]interface{}) (*PrototypeSearch, error)
NewPrototypeSearch creates an instance of PrototypeSearch
type PrototypeUse ¶
type PrototypeUse struct {
// contains filtered or unexported fields
}
PrototypeUse generates a component from a prototype.
func NewPrototypeUse ¶
func NewPrototypeUse(m map[string]interface{}) (*PrototypeUse, error)
NewPrototypeUse creates an instance of PrototypeUse
type RegistryAdd ¶
type RegistryAdd struct {
// contains filtered or unexported fields
}
RegistryAdd adds a registry.
func NewRegistryAdd ¶
func NewRegistryAdd(m map[string]interface{}) (*RegistryAdd, error)
NewRegistryAdd creates an instance of RegistryAdd.
type RegistryDescribe ¶
type RegistryDescribe struct {
// contains filtered or unexported fields
}
RegistryDescribe describes a registry
func NewRegistryDescribe ¶
func NewRegistryDescribe(m map[string]interface{}) (*RegistryDescribe, error)
NewRegistryDescribe creates an instance of RegistryDescribe
func (*RegistryDescribe) Run ¶
func (rd *RegistryDescribe) Run() error
Run runs the env list action.
type RegistryList ¶
type RegistryList struct {
// contains filtered or unexported fields
}
RegistryList lists available registries
func NewRegistryList ¶
func NewRegistryList(m map[string]interface{}) (*RegistryList, error)
NewRegistryList creates an instance of RegistryList
type Upgrade ¶
type Upgrade struct {
// contains filtered or unexported fields
}
Upgrade upgrades an application.
type Validate ¶
type Validate struct {
// contains filtered or unexported fields
}
Validate lists namespaces.
func NewValidate ¶
NewValidate creates an instance of Validate.
Source Files
¶
- actions.go
- apply.go
- component_list.go
- component_rm.go
- current_environment.go
- delete.go
- env_add.go
- env_current.go
- env_describe.go
- env_list.go
- env_rm.go
- env_set.go
- env_targets.go
- env_udpate.go
- import.go
- init.go
- module_create.go
- module_list.go
- param_delete.go
- param_diff.go
- param_list.go
- param_set.go
- pkg_describe.go
- pkg_install.go
- pkg_list.go
- prototype_describe.go
- prototype_list.go
- prototype_preview.go
- prototype_search.go
- prototype_use.go
- registry_add.go
- registry_describe.go
- registry_list.go
- show.go
- upgrade.go
- validate.go