Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/felipemarinho97/dev-spaces
A CLI to help creating development environments on cloud using AWS Spot Instances
https://github.com/felipemarinho97/dev-spaces
aws dev-environment hacktoberfest spot-instances
Last synced: about 2 months ago
JSON representation
A CLI to help creating development environments on cloud using AWS Spot Instances
- Host: GitHub
- URL: https://github.com/felipemarinho97/dev-spaces
- Owner: felipemarinho97
- Created: 2022-02-13T03:55:48.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T12:33:29.000Z (11 months ago)
- Last Synced: 2024-07-28T16:36:22.564Z (about 2 months ago)
- Topics: aws, dev-environment, hacktoberfest, spot-instances
- Language: Go
- Homepage:
- Size: 218 KB
- Stars: 13
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DevSpaces
This is a CLI to help creating on-demand development spaces using EC2 Spot Intances.
Currently, the following commands are availble:
* [start](#starting-a-devspace), [stop](#terminating-devspaces), [status, list](#listing-my-devspaces), [create](#creating-a-devspace), [bootstrap](BOOTSTRAPPING.md), [destroy](#destroying-a-devspace) and [tools](#configuration).
```bash
$ dev-spaces --help
NAME:
dev-spaces - CLI to help dev-spaces creation and management
USAGE:
dev-spaces [global options] command [command options] [arguments...]
AUTHOR:
Felipe Marinho
COMMANDS:
help, h Shows a list of commands or help for one command
ADMINISTRATION:
create -n -k -i [-p -s -t ]
bootstrap -t [-n ]
destroy -n
tools
- scale
- copy
DEV-SPACE:
start -n [-c -m --max-price -t ]
stop [-n ]
status [-n ]
list [-o ]
GLOBAL OPTIONS:
--region value, -r value AWS region (default: "ap-south-1") [$AWS_REGION]
--help, -h show help (default: false)
```
# FAQ
## What is a DevSpace?
A DevSpace is a elastic development environment on AWS. Because there is no need to build a machine if you can cheaply develop on the Cloud!
## My progress is lost when I stop my DevSpace?
No! When you `stop` a DevSpace, the CLI only destroys the instance, leaving the attached EBS Volume intact.
When you call `start` again, the EBS Volume will be attached on the new instance and you can just continue from the point you stop.
This means you are running a _stateful_ workloads on spot instances.
## How I can use it?
First, you need to install the CLI. You can do it by running the command below:
```bash
curl -sL https://raw.githubusercontent.com/felipemarinho97/dev-spaces/master/install.sh | bash
```
If you prefer, you can download the binary from the [releases page](https://github.com/felipemarinho97/dev-spaces/releases).
Please, follow the steps in this document: [How to create a Dev Space](CREATING.md) and [Configuring the CLI](CONFIGURATION.md).
For the legacy way of bootstraping (for advanced users), please, follow these steps: [How to bootstrap a Dev Space from scratch](BOOTSTRAPPING.md)
If you have any issue during the bootstrap progress, contact the author for more details on how to proceed.
# Examples
## Starting a DevSpace
You can specify the minimum desired vCPUs and Memory (GBs), as well the max price (in hours) you are willing to pay for the resources.
```bash
$ ds --region us-east-1 start --name MySpace \
--min-cpus 2 \
--min-memory 4 \
--max-price 0.05 \
--wait
✓ Waiting for instance to be running... (0/-, 0 it/min)
✓ Instance started with id: i-044716c726b039014 and type: m1.large (0/-, 0 it/min)
✓ Attached EBS volume with id: vol-08b3a681b2b20dcf5 (0/-, 0 it/min)
✓ Created SSH config entry for MySpace. (0/-, 0 it/min)
✓ You can customize the SSH config entry at ~/.ssh/config.d/dev-spaces/MySpace (0/-, 0 it/min)
✓ Waiting for port 2222 (ssh) to be reachable. This can take a few minutes... (0/-, 0 it/min)
✓ You can now ssh into your dev space with the following command: (0/-, 0 it/min)
$ ssh -i root@MySpace
```
DevSpaces will be listening by default on SSH port `2222`.
**Tip**: To omit the `--region` parameter, you can set the `AWS_REGION` environment variable. You can also use shorthands like `-c`, `-m`, `-n` instead of `--min-cpus`, `--min-memory`, `--name`, etc.
```bash
$ export AWS_REGION=us-east-1
$ dev-spaces start -n MySpace -c 2 -m 4 --max-price 0.05 --wait
```
| Parameter | Description | Default |
| --- | --- | --- |
| `--name` | The name of the DevSpace | |
| `--min-cpus` | Minimum number of vCPUs | 0 |
| `--min-memory` | Minimum amount of memory in GB | 0 |
| `--max-price` | Maximum price ($) per hour for the spot request | 0.50 |
| `--timeout` | Timeout for the spot request | 1h0m0s |
| `--wait` | Wait for DevSpace instance to be ready for SSH | false |
## Listing my DevSpaces
You can list the most recent (last 48h) created DevSpaces.
```bash
$ dev-spaces status
NAME REQUEST STATE REQUEST ID CREATE TIME STATUS
MySpace active sfr-fac050b3-2db3-4d2f-9efa-2403eb239650 2022-02-13T14:37:30Z fulfilled
teste cancelled sfr-6bce6369-7a7b-4d0e-a65e-1498eb5aba90 2022-02-13T13:48:13Z
```
It's also possible to see all the created (regradless if they are active or not) DevSpaces using the command `list`.
```bash
$ dev-spaces list -o wide
SPACE NAME ID CREATE TIME VERSION [...] PUBLIC IP
MySpace lt-0639c1eccbb51e345 2022-07-07 22:55:01 1 [...] 52.23.206.106
arch lt-08fb20577838aa54d 2022-07-05 22:02:00 1 [...] 52.91.16.131
al2022-05 lt-0ca2cf57f06544590 2022-07-05 23:01:10 1 [...] -
```
## Terminating DevSpaces
When you are done, you can use the `stop` command to terminate the DevSpace instance(s).
Note: If you want to stop all running DevSpaces, ommit the `--name` parameter.
```bash
$ dev-spaces stop -n MySpace
```
This will not delete your files, just terminate the DevSpace instance.
---
## Creating a DevSpace
The example below shows an example on how to create a DevSpace using the `create` command.
```bash
$ dev-spaces create --name MySpace --key-name MyKey --ami ami-1234567890
```
You can also optionaly specify the instance profile ARN `--instance-profile-arn`, the storage size (in GBs) `--storage-size`, and the preferred instance type `--preferred-instance-type`. See all the options [here](CREATING.md#command-parameters).
The `--preferred-instance-type` option helps to create your DevSpace in an avaliability zone with the best possible price for that instance type (this is important because once created, the DevSpace will be locked in that zone).
For a complete list of all the options, run `dev-spaces create --help`. View the [Creating a DevSpace](CREATING.md) document for full guide on how to create a DevSpace.
## Destroying a DevSpace
The command below will destroy the DevSpace instance and all it's associated resources like EBS Volumes, Launch Templates, Security Groups, etc.
```bash
$ dev-spaces destroy -n MySpace
✓ Destroying security group sg-0b48ecc167b8a81c7 (0/-, 0 it/min)
✓ Destroying launch template lt-01d0e11ac8523614f (0/-, 0 it/min)
✓ Destroying volume vol-069210dc254fcdc6b (0/-, 0 it/min)
OK
```
**This WILL destroy everythng, including all your files.**
## Tools
or Configuration `dev-spaces cfg`
### Scaling Up/Down the DevSpace
The command below will scale up or down the DevSpace instance to the desired number of vCPUs and Memory (GBs).
```bash
$ dev-spaces tools scale -i ~/.ssh/MyKey.pem -n MySpace -c 4 -m 32
```
### Copying the DevSpace to another region
You can use the command `dev-spaces tools copy` to copy the DevSpace to another region.
```bash
# lets say the current region is us-east-1
$ export AWS_REGION=us-east-1
# copy to us-west-1
$ dev-spaces tools copy -n MySpace -r us-west-1 -z us-west-1a
```
Tip: If you want to move the DevSpace to another region, you can use the `copy` command and then the `destroy` command.