README
¶
wash (Wide Area SHell)
wash helps you deal with all your remote or cloud-native infrastructure using the UNIX-y patterns and tools you already know and love!
For an introduction to Wash, see our main site at https://pup.pt/wash.
• COMMUNITY • DEVELOP • ROADMAP
Community Feedback
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. Please abide by our code of conduct when interacting with the community.
See the roadmap below to see what we've got planned!
We'd also love to get contributions from you! For a quick guide, take a look at our guide to contributing.
Developing Wash
See https://pup.pt/wash/#getting-started for pre-requisites to run Wash.
Wash is a single binary application written in Go. It uses Go modules to identify dependencies.
To build it, run go build. To test, run go test ./....
Requires golang 1.12+.
Acceptance tests are in the test directory. First build with go build, then run them using BATS with PATH=.:$PATH bats test.
See the core plugin docs if you're interested in core plugin development.
Roadmap
Project maintainers are not actively working on all of these things, but any of these are directions we would support others in pursuing.
Primitives
- 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")
Daemon enhancements
- 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)
CLI tools
- 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
Plugins / content
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
Documentation
¶
Overview ¶
Source for the wash executable.
To extend wash, see documentation for the 'plugin' package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package activity provides tools for recording wash operations to journals stored in the user's cache directory.
|
Package activity provides tools for recording wash operations to journals stored in the user's cache directory. |
|
Package analytics provides tools for sending over Wash events and screenviews to Google Analytics
|
Package analytics provides tools for sending over Wash events and screenviews to Google Analytics |
|
client
Package client provides helpers for interacting with the wash socket HTTP API.
|
Package client provides helpers for interacting with the wash socket HTTP API. |
|
fs
Package apifs is used by the Wash API to convert local files/directories into Wash entries
|
Package apifs is used by the Wash API to convert local files/directories into Wash entries |
|
types
Package apitypes declares types common to the API client and server.
|
Package apitypes declares types common to the API client and server. |
|
Package cmd implements Wash's CLI using https://github.com/spf13/cobra.
|
Package cmd implements Wash's CLI using https://github.com/spf13/cobra. |
|
internal/config
Package config implements configuration for the wash executable using https://github.com/spf13/viper.
|
Package config implements configuration for the wash executable using https://github.com/spf13/viper. |
|
internal/find
Package find stores all the logic for `wash find`.
|
Package find stores all the logic for `wash find`. |
|
internal/find/params
Package params represents `wash find`'s parameters.
|
Package params represents `wash find`'s parameters. |
|
internal/find/primary/meta
Package meta contains all the parsing logic for the `meta` primary
|
Package meta contains all the parsing logic for the `meta` primary |
|
util
Package cmdutil provides utilities for formatting CLI output.
|
Package cmdutil provides utilities for formatting CLI output. |
|
version
Package version reports Wash's version
|
Package version reports Wash's version |
|
Package datastore implements structured data storage for wash server functionality.
|
Package datastore implements structured data storage for wash server functionality. |
|
Package fuse adapts wash plugin types to a FUSE filesystem.
|
Package fuse adapts wash plugin types to a FUSE filesystem. |
|
Package plugin defines a set of interfaces that plugins must implement to enable wash functonality.
|
Package plugin defines a set of interfaces that plugins must implement to enable wash functonality. |
|
aws
Package aws presents a filesystem hierarchy for AWS resources.
|
Package aws presents a filesystem hierarchy for AWS resources. |
|
docker
Package docker presents a filesystem hierarchy for Docker resources.
|
Package docker presents a filesystem hierarchy for Docker resources. |
|
gcp
Package gcp presents a filesystem hierarchy for Google Cloud Platform resources.
|
Package gcp presents a filesystem hierarchy for Google Cloud Platform resources. |
|
kubernetes
Package kubernetes presents a filesystem hierarchy for Kubernetes resources.
|
Package kubernetes presents a filesystem hierarchy for Kubernetes resources. |
|
Package volume provides helpers for representing a remote filesystem.
|
Package volume provides helpers for representing a remote filesystem. |