specs

package

Go to main page

Versions in this module

v0

v0.8.0

Jul 28, 2025

Changes in this version

type Remote

+ CiscoDevice bool

+ CiscoPrompt string

+ func (r *Remote) GetCiscoDevice() bool

+ func (r *Remote) GetCiscoPrompt() string

v0.7.0

Jul 28, 2025

Changes in this version

type Remote

+ Chain []Remote

+ TimeoutSecs *uint

+ TunLocalAddr string

+ TunLocalBind bool

+ TunLocalPort int

+ func (r *Remote) GetChain() []Remote

+ func (r *Remote) GetTimeoutSecs() *uint

+ func (r *Remote) GetTunLocalAddr() string

+ func (r *Remote) GetTunLocalBind() bool

+ func (r *Remote) GetTunLocalPort() int

+ func (r *Remote) HasChain() bool

+ func (r *Remote) Sanitize()

+ func (r *Remote) SetTimeoutSecs(timeout uint)

+ func (r *Remote) SetTunLocalPort(port int)

v0.6.2

Dec 10, 2024

Changes in this version

type SshCCommand

+ func (c *SshCCommand) SetDisableGroups(list []string)

+ func (c *SshCCommand) SetEnableGroups(list []string)

v0.6.1

Dec 8, 2024

Changes in this version

type SshCGroup

+ func (g *SshCGroup) PrependHooksList(list []*SshCHooks)

type SshCNode

+ func (n *SshCNode) PrependHooksList(list []*SshCHooks)

type SshCProject

+ func (p *SshCProject) PrependHooksList(list []*SshCHooks)

v0.6.0

Dec 8, 2024

Changes in this version

+ const HookFinally

+ const IncludeTypeAppend

+ const IncludeTypePrepend

type Remote

+ Labels []string

+ Options map[string]string

+ func (r *Remote) GetLabels() []string

+ func (r *Remote) GetOption(o string) string

+ func (r *Remote) GetOptions() map[string]string

+ func (r *Remote) HasLabel(l string) bool

type SshCGroup

+ func (g *SshCGroup) PrependHooks(h *SshCHooks)

+ type SshCInclude struct

+ Files []string

+ Type string

+ func (i *SshCInclude) GetFiles() []string

+ func (i *SshCInclude) GetType() string

+ func (i *SshCInclude) IncludeInAppend() bool

type SshCNode

+ func (n *SshCNode) PrependHooks(h *SshCHooks)

type SshCProject

+ func (p *SshCProject) PrependHooks(h *SshCHooks)

v0.5.0

Jul 3, 2024

v0.4.0

Jun 6, 2024

v0.3.0

May 25, 2024

v0.2.0

May 24, 2024

v0.1.0

May 23, 2024

Changes in this version

+ const AuthMethodPassword

+ const AuthMethodPublickey

+ const HookPostGroup

+ const HookPostNodeSync

+ const HookPostProject

+ const HookPreGroup

+ const HookPreNodeSync

+ const HookPreProject

+ const SSH_COMPOSE_CONFIGNAME

+ const SSH_COMPOSE_ENV_PREFIX

+ const SSH_COMPOSE_VERSION

+ func GenDefault(viper *v.Viper)

+ func GetSshCRemotesDefaultConfDir() (string, error)

+ type Remote struct

+ AuthMethod string

+ Host string

+ Pass string

+ Port int

+ PrivateKeyFile string

+ PrivateKeyPass string

+ PrivateKeyRaw string

+ Protocol string

+ User string

+ func NewRemote(host, protocol, authMethod string, port int) *Remote

+ func (r *Remote) GetAuthMethod() string

+ func (r *Remote) GetHost() string

+ func (r *Remote) GetPass() string

+ func (r *Remote) GetPort() int

+ func (r *Remote) GetPrivateKeyFile() string

+ func (r *Remote) GetPrivateKeyPass() string

+ func (r *Remote) GetPrivateKeyRaw() string

+ func (r *Remote) GetProtocol() string

+ func (r *Remote) GetUser() string

+ func (r *Remote) SetPass(p string)

+ func (r *Remote) SetPrivateKeyFile(f string)

+ func (r *Remote) SetPrivateKeyPass(p string)

+ func (r *Remote) SetPrivateKeyRaw(p string)

+ func (r *Remote) SetUser(u string)

+ type RemotesConfig struct

+ DefaultRemote string

+ File string

+ Remotes map[string]*Remote

+ func LoadRemotesConfig(remotesconfdir string) (*RemotesConfig, error)

+ func NewRemotesConfig() *RemotesConfig

+ func RemotesConfigFromFile(file string) (*RemotesConfig, error)

+ func RemotesConfigFromYaml(data []byte, file string) (*RemotesConfig, error)

+ func (rc *RemotesConfig) AddRemote(name string, r *Remote)

+ func (rc *RemotesConfig) DelRemote(name string)

+ func (rc *RemotesConfig) GetAbsConfigDir() (string, error)

+ func (rc *RemotesConfig) GetDefault() string

+ func (rc *RemotesConfig) GetRemote(remote string) *Remote

+ func (rc *RemotesConfig) HasRemote(remote string) bool

+ func (rc *RemotesConfig) Sanitize()

+ func (rc *RemotesConfig) SetDefault(remote string)

+ func (rc *RemotesConfig) Write() error

+ type SshCCommand struct

+ ApplyAlias bool

+ Description string

+ Destroy bool

+ DisableFlags []string

+ DisableGroups []string

+ EnableFlags []string

+ EnableGroups []string

+ Envs SshCEnvVars

+ IncludeHooksFiles []string

+ Name string

+ Project string

+ SkipSync bool

+ VarFiles []string

+ func CommandFromFile(file string) (*SshCCommand, error)

+ func CommandFromYaml(data []byte) (*SshCCommand, error)

+ func (c *SshCCommand) GetDescription() string

+ func (c *SshCCommand) GetDestroy() bool

+ func (c *SshCCommand) GetDisableFlags() []string

+ func (c *SshCCommand) GetDisableGroups() []string

+ func (c *SshCCommand) GetEnableFlags() []string

+ func (c *SshCCommand) GetEnableGroups() []string

+ func (c *SshCCommand) GetEnvs() SshCEnvVars

+ func (c *SshCCommand) GetName() string

+ func (c *SshCCommand) GetProject() string

+ func (c *SshCCommand) GetSkipSync() bool

+ func (c *SshCCommand) GetVarFiles() []string

+ type SshCConfigTemplate struct

+ Destination string

+ Source string

+ type SshCEnvVars struct

+ EnvVars map[string]interface{}

+ func EnvVarsFromYaml(data []byte) (*SshCEnvVars, error)

+ func NewEnvVars() *SshCEnvVars

+ func (e *SshCEnvVars) AddKV(key, value string) error

+ func (e *SshCEnvVars) AddKVAggregated(aggregatedEnv string) error

+ type SshCEnvironment struct

+ Commands []SshCCommand

+ File string

+ IncludeCommandsFiles []string

+ PackExtra *SshCPackExtra

+ Projects []SshCProject

+ TemplateEngine SshCTemplateEngine

+ Version string

+ func EnvironmentFromYaml(data []byte, file string) (*SshCEnvironment, error)

+ func (e *SshCEnvironment) AddCommand(cmd *SshCCommand)

+ func (e *SshCEnvironment) GetBaseFile() string

+ func (e *SshCEnvironment) GetCommand(name string) (*SshCCommand, error)

+ func (e *SshCEnvironment) GetCommands() *[]SshCCommand

+ func (e *SshCEnvironment) GetProjectByName(pName string) *SshCProject

+ func (e *SshCEnvironment) GetProjects() *[]SshCProject

+ type SshCGeneral struct

+ Debug bool

+ EnvSessionPrefix string

+ RemotesConfDir string

+ func (g *SshCGeneral) HasDebug() bool

+ type SshCGroup struct

+ CommonProfiles []string

+ Config map[string]string

+ ConfigTemplates []SshCConfigTemplate

+ Connection string

+ Description string

+ Ephemeral bool

+ Hooks []SshCHook

+ IncludeHooksFiles []string

+ Name string

+ Nodes []SshCNode

+ func GroupFromYaml(data []byte) (*SshCGroup, error)

+ func (g *SshCGroup) AddHooks(h *SshCHooks)

+ func (g *SshCGroup) GetConnection() string

+ func (g *SshCGroup) GetDescription() string

+ func (g *SshCGroup) GetHooks(event string) []SshCHook

+ func (g *SshCGroup) GetHooks4Nodes(event string, nodes []string) []SshCHook

+ func (g *SshCGroup) GetName() string

+ func (g *SshCGroup) GetNodes() *[]SshCNode

+ func (g *SshCGroup) Init()

+ func (g *SshCGroup) ToProcess(groupsEnabled, groupsDisabled []string) bool

+ type SshCHook struct

+ Commands []string

+ Disable bool

+ Entrypoint []string

+ Err2Var string

+ Event string

+ Flags []string

+ Node string

+ Out2Var string

+ PullKeepSourcePath bool

+ PullResources []*SshCSyncResource

+ func FilterHooks4Node(hooks *[]SshCHook, nodes []string) []SshCHook

+ func (h *SshCHook) Clone() *SshCHook

+ func (h *SshCHook) ContainsFlag(flag string) bool

+ func (h *SshCHook) For(node string) bool

+ func (h *SshCHook) HasPullResources() bool

+ func (h *SshCHook) SetNode(node string)

+ func (h *SshCHook) ToProcess(enabledFlags, disabledFlags []string) bool

+ type SshCHooks struct

+ Hooks []SshCHook

+ func HooksFromYaml(data []byte) (*SshCHooks, error)

+ type SshCLogging struct

+ CmdsOutput bool

+ Color bool

+ EnableEmoji bool

+ EnableLogFile bool

+ JsonFormat bool

+ Level string

+ Path string

+ RuntimeCmdsOutput bool

+ type SshCNode struct

+ Config map[string]string

+ ConfigTemplates []SshCConfigTemplate

+ Endpoint string

+ Entrypoint []string

+ Hooks []SshCHook

+ IncludeHooksFiles []string

+ Labels map[string]string

+ Name string

+ SourceDir string

+ SyncResources []SshCSyncResource

+ func (n *SshCNode) AddHooks(h *SshCHooks)

+ func (n *SshCNode) GetAllHooks(event string) []SshCHook

+ func (n *SshCNode) GetHooks(event string) []SshCHook

+ func (n *SshCNode) GetName() string

+ func (n *SshCNode) Init()

+ func (n *SshCNode) IsSourcePathRelative() bool

+ func (n *SshCNode) ToJson() (string, error)

+ type SshCPackExtra struct

+ Dirs []string

+ Files []string

+ Rename []*tarf_specs.RenameRule

+ type SshCProject struct

+ ConfigTemplates []SshCConfigTemplate

+ Description string

+ Environments []SshCEnvVars

+ Groups []SshCGroup

+ Hooks []SshCHook

+ IncludeEnvFiles []string

+ IncludeGroupFiles []string

+ IncludeHooksFiles []string

+ Name string

+ func (p *SshCProject) AddEnvironment(e *SshCEnvVars)

+ func (p *SshCProject) AddGroup(grp *SshCGroup)

+ func (p *SshCProject) AddHooks(h *SshCHooks)

+ func (p *SshCProject) GetDescription() string

+ func (p *SshCProject) GetEnvsMap() (map[string]string, error)

+ func (p *SshCProject) GetGroupByName(name string) *SshCGroup

+ func (p *SshCProject) GetGroups() *[]SshCGroup

+ func (p *SshCProject) GetHooks(event string) []SshCHook

+ func (p *SshCProject) GetHooks4Nodes(event string, nodes []string) []SshCHook

+ func (p *SshCProject) GetName() string

+ func (p *SshCProject) Init()

+ func (p *SshCProject) LoadEnvVarsFile(file string) error

+ func (p *SshCProject) Sanitize() *SshCProjectSanitized

+ type SshCProjectSanitized struct

+ ConfigTemplates []SshCConfigTemplate

+ Description string

+ Groups []SshCGroup

+ Hooks []SshCHook

+ IncludeEnvFiles []string

+ IncludeGroupFiles []string

+ IncludeHooksFiles []string

+ Name string

+ func (p *SshCProjectSanitized) GetDescription() string

+ func (p *SshCProjectSanitized) GetGroups() *[]SshCGroup

+ func (p *SshCProjectSanitized) GetName() string

+ type SshCSyncResource struct

+ Destination string

+ Source string

+ type SshCTemplateEngine struct

+ Engine string

+ Opts []string

+ type SshComposeConfig struct

+ EnvironmentDirs []string

+ General SshCGeneral

+ Logging SshCLogging

+ RenderDefaultFile string

+ RenderEnvsVars map[string]interface{}

+ RenderTemplatesDirs []string

+ RenderValuesFile string

+ Viper *v.Viper

+ func NewSshComposeConfig(viper *v.Viper) *SshComposeConfig

+ func (c *SshComposeConfig) Clone() *SshComposeConfig

+ func (c *SshComposeConfig) GetEnvironmentDirs() []string

+ func (c *SshComposeConfig) GetGeneral() *SshCGeneral

+ func (c *SshComposeConfig) GetLogging() *SshCLogging

+ func (c *SshComposeConfig) IsEnableRenderEngine() bool

+ func (c *SshComposeConfig) SetRenderEnvs(envs []string) error

+ func (c *SshComposeConfig) Unmarshal() error

+ func (c *SshComposeConfig) Yaml() ([]byte, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL