Skip to main content

The easiest way to create and connect to secure cloud instances

Project description

# ProvisionPad [![Join the Community](https://img.shields.io/badge/Join%20the%20community-blueviolet.svg)](https://spectrum.chat/provisionpad/) [![Open Issues](https://img.shields.io/github/issues-raw/provisionpad/provisionpad.svg)](https://github.com/provisionpad/provisionpad/issues) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/provisionpad/provisionpad/blob/master/LICENSE)

[<img src=”https://i.ibb.co/88kHGrt/logo-1x.png” />](https://provisionpad.com/?ref=github)

ProvisionPad makes it easy to create and connect to cloud instances right from your termial.

This repo is open source and is one of the libraries that powers [ProvisoinPad](https://provisionpad.com/?ref=github). The hosted version provides advanced tools for monitoring usage and managing access to cloud resources across different teams.

Check out our [website](https://provisionpad.com/?ref=github) for more details and to sign up for Beta.

ProvisionPad takes care of all the tedious details of setting up secure EC2 instances and adding proper configuration to your local machine so you can start, stop and connect to your instances directly from your Terminal/editor.

  • Start and stop EC2 instances directly from your terminal without the hassle.

  • Use your local VS Code editor or Terminal to access, edit and run the code on EC2 instances.

  • Automatically stop inactive instances.

<img src=”https://i.ibb.co/KqgLQwf/terminal-border.png” />

## Prerequisites

  • AWS Access Key ID and Secret Access Key (See the last section if you don’t know how to get them)

  • Python installed locally

## Installing ProvisionPad Not published to PyPi yet

` git clone https://github.com/amirzed/provisionpad cd /path/to/cloned/directory pip install . `

## Getting Started

To initiate the environment:

` propad initiate `

After initiating the environment you can create an EC2 instance using:

` propad create `

To stop the instance: ` propad stop [instancename] `

To get a list of all your running/stopped instances: ` propad stat `

You can start a stopped instance using

` propad start [instancename] `

You can terminate a running instance using

` propad terminate [instancename] `

For more information on commands

` propad --help `

## Connecting to the Remote Host

To ssh into an instance simply use

` ssh [instancename] `

## Connecting through VS Code To connect to the instance using VS Code, install the [Visual Studio Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview).

Ctrl+Shift+P reload window then Ctrl+Shift+P Remote-SSH:Connect to Host and select the instance name from the menu

To access terminal on remote using VS Code simply use Ctrl+`

## AWS Cost Saving

Instances created with ProvisionPad will stop automatically after 20 minutes of low CPU activity, i.e. if the idle time percentage was over 98% and the gradient of CPU usage is less than 0.001. more options will be added

## How to get your AWS Access Key ID and Secret Access Key

If you don’t have AWS access credentials you can get them through AWS management console:

  • Log in to AWS management console

  • Click on user menu

  • Click on My Security Credentials

  • Section Access keys for CLI, SDK, & API access you can create one.

Before you can use/test this library you need to have AWS user account with the following permissions (You already have these permissions if you have root access (owner) or admin access to the AWS account.):

  • AmazonEC2FullAccess

  • IAMFullAccess

  • AmazonVPCFullAccess

## Contributing

Feel free to create issues or pull requests. More detailed guides are coming soon.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

testpropad-0.0.2.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

testpropad-0.0.2-py3-none-any.whl (28.3 kB view details)

Uploaded Python 3

File details

Details for the file testpropad-0.0.2.tar.gz.

File metadata

  • Download URL: testpropad-0.0.2.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.7.2

File hashes

Hashes for testpropad-0.0.2.tar.gz
Algorithm Hash digest
SHA256 7f83443bd12e39e9b37d8dbe3fc7da627e6955ed2a5b9056e8c8a038ed0a2dab
MD5 5a3f1e1b2ccb69e6026fd20338108cb5
BLAKE2b-256 38d5403a147230f0f236f17b9261605c6e2a39e6b50911d67e1dfb47034563f0

See more details on using hashes here.

File details

Details for the file testpropad-0.0.2-py3-none-any.whl.

File metadata

  • Download URL: testpropad-0.0.2-py3-none-any.whl
  • Upload date:
  • Size: 28.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.34.0 CPython/3.7.2

File hashes

Hashes for testpropad-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 af3460ce3f14b2bbc90861621e1a1d3952cf262b7787c7f583ce2a7cf7532869
MD5 7131d9800e591c2a1f58561f236e0b4a
BLAKE2b-256 15b76cd22e55dd33c52086747db13b8c6e064a4fbf66305c8ede02321c5aa201

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page