internal

package

v0.0.0-...-257e31b Latest Latest Go to latest Published: May 22, 2024 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/codezninja/gossm

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AskHost() (host string, retErr error)
func CallProcess(process string, args ...string) error
func CreateStartSession(ctx context.Context, cfg aws.Config, input *ssm.StartSessionInput) (*ssm.StartSessionOutput, error)
func DeleteStartSession(ctx context.Context, cfg aws.Config, input *ssm.TerminateSessionInput) error
func FindDomainByInstanceId(ctx context.Context, cfg aws.Config, instanceId string) ([]string, error)
func FindInstanceIdByIp(ctx context.Context, cfg aws.Config, ip string) (string, error)
func FindInstanceIdsWithConnectedSSM(ctx context.Context, cfg aws.Config) ([]string, error)
func FindInstances(ctx context.Context, cfg aws.Config, filterTag string) (map[string]*Target, error)
func GenerateSSHExecCommand(exec, identity, user, domain string) (newExec string)
func GetAsset(filename string) ([]byte, error)
func GetSsmPlugin() ([]byte, error)
func GetSsmPluginName() string
func GetTerminalHeight() int
func NewConfig(ctx context.Context, key, secret, session, region, roleArn string) (aws.Config, error)
func NewSharedConfig(ctx context.Context, profile string, ...) (aws.Config, error)
func PrintCommandInvocation(ctx context.Context, cfg aws.Config, inputs []*ssm.GetCommandInvocationInput)
func PrintReady(cmd, region, target string)
func SendCommand(ctx context.Context, cfg aws.Config, targets []*Target, command string) (*ssm.SendCommandOutput, error)
func WrapError(err error) error
type Port
- func AskPorts() (port *Port, retErr error)
type Region
- func AskRegion(ctx context.Context, cfg aws.Config) (*Region, error)
type Target
- func AskMultiTarget(ctx context.Context, cfg aws.Config, tag string) ([]*Target, error)
- func AskTarget(ctx context.Context, cfg aws.Config, tag string) (*Target, error)
type User
- func AskUser() (*User, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidParams is an error type to use when passed arguments are invalid.
	ErrInvalidParams = errors.New("[err] invalid params")
	// ErrUnknown is an error type to use when error reason doesn't know.
	ErrUnknown = errors.New("[err] unknown")
)

Functions ¶

func AskHost ¶

func AskHost() (host string, retErr error)

AskUser asks you which selects a user.

func CallProcess ¶

func CallProcess(process string, args ...string) error

CallProcess calls process.

func CreateStartSession ¶

func CreateStartSession(ctx context.Context, cfg aws.Config, input *ssm.StartSessionInput) (*ssm.StartSessionOutput, error)

CreateStartSession creates start session.

func DeleteStartSession ¶

func DeleteStartSession(ctx context.Context, cfg aws.Config, input *ssm.TerminateSessionInput) error

DeleteStartSession creates session.

func FindDomainByInstanceId ¶

func FindDomainByInstanceId(ctx context.Context, cfg aws.Config, instanceId string) ([]string, error)

FindDomainByInstanceId returns domain by instance id.

func FindInstanceIdByIp ¶

func FindInstanceIdByIp(ctx context.Context, cfg aws.Config, ip string) (string, error)

FindInstanceIdByIp returns instance ids by ip.

func FindInstanceIdsWithConnectedSSM ¶

func FindInstanceIdsWithConnectedSSM(ctx context.Context, cfg aws.Config) ([]string, error)

FindInstanceIdsWithConnectedSSM asks you which selects instances.

func FindInstances ¶

func FindInstances(ctx context.Context, cfg aws.Config, filterTag string) (map[string]*Target, error)

FindInstances returns all of instances-map with running state.

func GenerateSSHExecCommand ¶

func GenerateSSHExecCommand(exec, identity, user, domain string) (newExec string)

GenerateSSHExecCommand generates ssh exec command.

func GetAsset ¶

func GetAsset(filename string) ([]byte, error)

GetAsset returns asset file. cannot be accessed from outer package.

func GetSsmPlugin ¶

func GetSsmPlugin() ([]byte, error)

GetSsmPlugin returns filepath for aws ssm plugin.

func GetSsmPluginName ¶

func GetSsmPluginName() string

GetSsmPluginName returns filename for aws ssm plugin.

func GetTerminalHeight ¶

func GetTerminalHeight() int

func NewConfig ¶

func NewConfig(ctx context.Context, key, secret, session, region, roleArn string) (aws.Config, error)

NewConfig creates a config for accessing AWS with passing credential parameters.

func NewSharedConfig ¶

func NewSharedConfig(ctx context.Context, profile string, sharedConfigFiles, sharedCredentialsFiles []string) (aws.Config, error)

NewSharedConfig creates a config for accessing AWS that is based on shared files, such as credentials file.

func PrintCommandInvocation ¶

func PrintCommandInvocation(ctx context.Context, cfg aws.Config, inputs []*ssm.GetCommandInvocationInput)

PrintCommandInvocation watches command invocations.

func PrintReady ¶

func PrintReady(cmd, region, target string)

func SendCommand ¶

func SendCommand(ctx context.Context, cfg aws.Config, targets []*Target, command string) (*ssm.SendCommandOutput, error)

SendCommand send commands to instance targets.

func WrapError ¶

func WrapError(err error) error

WrapError wraps error.

Types ¶

type Port ¶

type Port struct {
	Remote string
	Local  string
}

func AskPorts ¶

func AskPorts() (port *Port, retErr error)

AskPorts asks you which select ports.

type Region ¶

type Region struct {
	Name string
}

func AskRegion ¶

func AskRegion(ctx context.Context, cfg aws.Config) (*Region, error)

AskRegion asks you which selects a region.

type Target ¶

type Target struct {
	Name          string
	PublicDomain  string
	PrivateDomain string
}

func AskMultiTarget ¶

func AskMultiTarget(ctx context.Context, cfg aws.Config, tag string) ([]*Target, error)

AskMultiTarget asks you which selects multi targets.

func AskTarget ¶

func AskTarget(ctx context.Context, cfg aws.Config, tag string) (*Target, error)

AskTarget asks you which selects an instance.

type User ¶

type User struct {
	Name string
}

func AskUser ¶

func AskUser() (*User, error)

AskUser asks you which selects a user.

Source Files ¶

View all Source files

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