wash helps you deal with all your remote or cloud-native infrastructure using the UNIX-y patterns and tools you already know and love!
• COMMUNITY • INSTALLATION • USAGE • ISSUES • ROADMAP • CONTRIBUTING •
Exploring, understanding, and inspecting modern infrastructure should be simple and straightforward. Whether it's containers, VMs, network devices, IoT stuff, or anything in between...they all have different ways of enumerating what you have, getting a stream of output, running commands, etc. Every vendor has its own tools and APIs that expose these features, each one different, each one bespoke. Thus, they are difficult to compose together to solve higher-level problems. And that's no fun at all!
UNIX's philosophy and abstractions have worked for decades. They're pretty good, and more importantly, they're familiar to millions of people. wash intends to apply those same philosophies and abstractions to modern, distributed infrastructure: With wash, we want to:
- make navigating stuff like servers, containers, or APIs as easy as navigating a local filesystem
- make scripting across your new-fangled infrastructure as easy as writing a local shell script
- render into text that which can be rendered into text (cuz text is a universal interface!) for easy viewing, editing, and UNIXy slicing-and-dicing
- build new versions of basic, UNIX tools to support the above goals (but reuse existing ones if they work!)
See the wash website for a list of current features.
We're actively soliciting community feedback and input on our roadmap! Don't hesitate to file issues for new features, new plugin types, new primitives, new command-line tools, or anything else that crosses your mind. You can also chat with us directly on #wash on Slack.
See the roadmap below to see what we've got planned!
See GitHub releases.
Clone repo and within it run go install.
Ensure $GOPATH/bin is part of $PATH.
Requires golang 1.12+.
If using iTerm2, we recommend installing iTerm2's shell integration to avoid issue#84.
Obtain FUSE for OSX here.
Add your mount directory to Spotlight's list of excluded directories to avoid heavy load.
Start the wash daemon and shell with
wash
The wash shell provides wrappers for executing most subcommands. You can usually find the native POSIX variants in /usr/bin or /bin.
See available subcommands - such as ls and exec - with
wash help
When done, exit to exit the shell and shutdown the daemon.
To get a sense of how wash works, we've included a multi-node Docker application based on the Docker Compose tutorial. To start it run
docker-compose -f examples/swarm/docker-compose.yml up -d
When done, run
docker-compose -f examples/swarm/docker-compose.yml downto stop the example application.
This starts a small Flask webapp that keeps a count of how often it's been accessed in a Redis instance that maintains state in a Docker volume.
Navigate the filesystem to view running containers
$ wash
wash$ cd docker/containers
wash$ wash ls
NAME CREATED ACTIONS
./ <unknown> list
45a0265546d63a8f1b0d17033748db1468dc49dfd09cdaf2db62c45a60e82aaf/ 20 Mar 19 17:02 PDT exec, list, metadata
382776912d9373e6c4dc1350894b5290b22c36893a8fed08e2ba53fbb680c8a6/ 20 Mar 19 17:02 PDT exec, list, metadata
$ wash ls 382776912d9373e6c4dc1350894b5290b22c36893a8fed08e2ba53fbb680c8a6
NAME CREATED ACTIONS
./ 20 Mar 19 17:02 PDT exec, list, metadata
metadata.json <unknown> read
log <unknown> read, stream
Those containers are displayed as a directory, and provide access to their logs and metadata as files. Recent output from both can be accessed with common tools.
wash$ tail */log
==> 382776912d9373e6c4dc1350894b5290b22c36893a8fed08e2ba53fbb680c8a6/log <==
* Serving Flask app "app" (lazy loading)
* Environment: production
WARNING: Do not use the development server in a production environment.
Use a production WSGI server instead.
...
==> 45a0265546d63a8f1b0d17033748db1468dc49dfd09cdaf2db62c45a60e82aaf/log <==
1:C 21 Mar 2019 00:02:33.112 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo
1:C 21 Mar 2019 00:02:33.112 # Redis version=5.0.4, bits=64, commit=00000000, modified=0, pid=1, just started
1:C 21 Mar 2019 00:02:33.112 # Configuration loaded
1:M 21 Mar 2019 00:02:33.113 * Running mode=standalone, port=6379.
...
The list earlier also noted that the container "directories" support the metadata action. We can get structured metadata in ether YAML or JSON with wash meta
wash$ meta 382776912d9373e6c4dc1350894b5290b22c36893a8fed08e2ba53fbb680c8a6 -o yaml
AppArmorProfile: ""
Args:
- app.py
Config:
...
We can interogate the container more closely with wash exec
$ wash exec 45a0265546d63a8f1b0d17033748db1468dc49dfd09cdaf2db62c45a60e82aaf whoami
root
Try exploring docker/volumes to interact with the volume created for Redis.
All operations have their activity recorded to journals in wash/activity under your user cache directory, identified by process ID and executable name.
wash uses a user-specific cache directory to store running state. The user cache directory is $XDG_CACHE_HOME or $HOME/.cache on Unix systems, $HOME/Library/Caches on macOS, and %LocalAppData% on Windows.
If the wash daemon exits with a exit status of 255, that typically means that wash couldn't load the FUSE extensions. MacOS only allows for a certain (small) number of virtual devices on the system, and if all available slots are taken up by other programs then we won't be able to run. You can view loaded extensions with kextstat. More information in this github issue for FUSE for macOS.
Project maintainers are not actively working on all of these things, but any of these are directions we would support others in pursuing.
- file/directory upload (prereq for executing commands that aren't just one-liners)
- edit a resource (e.g. edit a file representing a k8s ConfigMap, and upon write save it via the k8s api)
- delete a resource (e.g.
rm-ing a file in an S3 bucket deletes it) - signal handling to represent basic verbs (e.g. sending a TERM to an EC2 instance will terminate it)
- copy / move / rename (how should this work?)
- make
streamable to "go back in time" (e.g. supporttail -100 -fstyle of "look-back")
- rad startup ASCII art logo (<- high priority!)
- expose plugin configuration via main config file
- expose what API calls are in-flight (to report status on large, distributed calls)
- colorized output for
ls, similar toexa -l - make
lsemit something useful when used against non-washresources -
execshould work in parallel across multiple target resources - build an interactive shell that works over
exec(need to update plugins API to support this, most likely) - a version of
topthat works usingwashprimitives to get information to display from multiple targets
list |
read |
stream |
exec |
meta |
|
|---|---|---|---|---|---|
| Docker | |||||
| Containers | ✓ | ✓ | ✓ | ||
| Container logs | ✓ | ✓ | |||
| Volumes | ✓ | ✓ | ○ | ✓ | |
| Images | ○ | ○ | |||
| Networks | ○ | ○ | |||
| Services | ○ | ○ | ○ | ○ | |
| Stacks | ○ | ○ | |||
| Swarm nodes | ○ | ○ | |||
| Swarm config | ○ | ○ | ○ | ||
| Kubernetes | |||||
| Pods | ✓ | ✓ | ✓ | ✓ | ✓ |
| Persistent Volume Claims | ✓ | ✓ | ✓ | ✓ | |
| Services | ○ | ○ | |||
| ConfigMaps | ○ | ○ | ○ | ||
| generic k8s resources | ○ | ○ | |||
| AWS | |||||
| EC2 | ✓ | ✓ | ○ | ✓ | ✓ |
| S3 buckets | ✓ | ✓ | |||
| S3 directories | ✓ | ||||
| S3 objects | ✓ | ✓ | ✓ | ||
| Cloudwatch | ○ | ○ | ○ | ○ | |
| Lambda | ○ | ○ | ○ | ○ | ○ |
| pubsub (e.g. SNS) | ○ | ○ | ○ | ||
| databases (e.g. dynamo, RDS) | ○ | ○ | ○ | ○ | ○ |
| networking (e.g. ELB, Route53) | ○ | ○ | ○ | ○ | ○ |
| SSH/WinRM targets | ○ | ○ | |||
| SSHfs | ○ | ○ | ○ | ||
| GCP | ○ | ○ | ○ | ○ | ○ |
| Azure | ○ | ○ | ○ | ○ | ○ |
| VMware | ○ | ○ | ○ | ○ | ○ |
| Splunk | ○ | ○ | ○ | ||
| Logstash | ○ | ○ | ○ | ||
| Network Devices (e.g. Cisco) | ○ | ○ | ○ | ○ | ○ |
| IoT (e.g. Nest, Hue, Rachio) | ○ | ○ | ○ | ○ | ○ |
wash itself (expose internals) |
○ | ○ | ○ | ○ | ○ |
✓ = Implemented ○ = Possible, but not yet implemented
We'd love to get contributions from you! For a quick guide, take a look at our guide to contributing.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent