Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/itsdalmo/ssm-sh

Experiment to use SSM RunCommand instead of SSH
https://github.com/itsdalmo/ssm-sh

aws bastion golang jumpbox ssh ssm

Last synced: 9 days ago
JSON representation

Experiment to use SSM RunCommand instead of SSH

Host: GitHub
URL: https://github.com/itsdalmo/ssm-sh
Owner: itsdalmo
License: mit
Created: 2018-01-30T08:39:48.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2019-12-08T21:15:20.000Z (almost 5 years ago)
Last Synced: 2024-10-20T15:46:02.119Z (21 days ago)
Topics: aws, bastion, golang, jumpbox, ssh, ssm
Language: Go
Homepage: https://medium.com/telia-next/ssh-on-aws-there-is-a-service-for-that-21bc01987044
Size: 1.58 MB
Stars: 144
Watchers: 13
Forks: 15
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## SSM shell

[![Build Status](https://travis-ci.org/itsdalmo/ssm-sh.svg?branch=master)](https://travis-ci.org/itsdalmo/ssm-sh)

Little experiment to mimic SSH by using SSM agent to send commands to
remote instances and fetching the output.

## Install

Grab a binary from the [releases](https://github.com/itsdalmo/ssm-sh/releases).

#### Docker

There is also a docker image [here](https://hub.docker.com/r/itsdalmo/ssm-sh/).

#### Manual install

Have Go installed:

```bash
$ which go
/usr/local/bin/go

$ echo $GOPATH
/Users/dalmo/go

$ echo $PATH
# Make sure $GOPATH/bin is in your PATH.
```

Get the repository:

```bash
go get -u github.com/itsdalmo/ssm-sh
```

If everything was successful, you should have a shiny new binary:

```bash
which ssm-sh
# Should point to $GOPATH/bin/ssm-sh
```

## Usage

```bash
$ ssm-sh --help

Usage:
ssm-sh [OPTIONS]

Application Options:
-v, --version Print the version and exit.

AWS Options:
-p, --profile= AWS Profile to use. (If you are not using Vaulted).
-r, --region= Region to target. (default: eu-west-1)

Help Options:
-h, --help Show this help message

Available commands:
describe Description a document from ssm.
list List managed instances or documents. (aliases: ls)
run Run a command or document on the targeted instances.
shell Start an interactive shell. (aliases: sh)
```

#### List instances usage

```bash
$ ssm-sh list instances --help

...
[instances command options]
-f, --filter= Filter the produced list by tag (key=value,..)
-l, --limit= Limit the number of instances printed (default: 50)
-o, --output= Path to a file where the list of instances will be written as JSON.
```

#### List documents usage
```bash
$ ssm-sh list documents --help

...
[documents command options]
-f, --filter= Filter the produced list by property (Name, Owner, DocumentType, PlatformTypes)
-l, --limit= Limit the number of instances printed (default: 50)
```

#### Run cmd/shell usage

```bash
$ ssm-sh run cmd --help

...
[cmd command options]
-i, --timeout= Seconds to wait for command result before timing out. (default: 30)
-t, --target= One or more instance ids to target
--target-file= Path to a JSON file containing a list of targets.

SSM options:
-x, --extend-output Extend truncated command outputs by fetching S3 objects containing full ones
-b, --s3-bucket= S3 bucket in which S3 objects containing full command outputs are stored. Required when --extend-output is provided.
-k, --s3-key-prefix= Key prefix of S3 objects containing full command outputs.
```

#### Run document usage

```bash
$ ssm-sh run document --help

...
[document command options]
-n, --name= Name of document in ssm.
-i, --timeout= Seconds to wait for command result before timing out. (default: 30)
-p, --parameter= Zero or more parameters for the document (name:value)
-t, --target= One or more instance ids to target
--target-file= Path to a JSON file containing a list of targets.

## Example

```bash
$ vaulted -n lab-admin -- ssm-sh list instances --filter Name="*itsdalmo" -o example.json

$ vaulted -n lab-admin -- ssm-sh shell --target-file example.json
Initialized with targets: [i-03762678c45546813 i-0d04464ff18b5db7d]
Type 'exit' to exit. Use ctrl-c to abort running commands.

$ ps aux | grep agent
i-03762678c45546813 - Success:
root 3261 0.0 1.9 243560 19668 ? Ssl Jan27 4:29 /usr/bin/amazon-ssm-agent
root 9058 0.0 0.0 9152 936 ? S 15:02 0:00 grep agent

i-0d04464ff18b5db7d - Success:
root 3245 0.0 1.9 317292 19876 ? Ssl Feb05 0:27 /usr/bin/amazon-ssm-agent
root 4893 0.0 0.0 9152 924 ? S 15:02 0:00 grep agent

$ echo $HOSTNAME
i-03762678c45546813 - Success:
ip-172-53-17-163.eu-west-1.compute.internal

i-0d04464ff18b5db7d - Success:
ip-172-53-20-172.eu-west-1.compute.internal
```

#### Note

If you don't see any instances listed and still want to test `ssm-sh`,
you can see the [terraform/README.md](./terraform/README.md) for a quick
way of setting up some test instances.