View instance information on all supported cloud providers
Project description
# cloudview
View instance information on all supported cloud providers
[![Build Status](https://travis-ci.org/ricardobranco777/cloudview.svg?branch=master)](https://travis-ci.org/ricardobranco777/cloudview)
## Usage
```
Usage: cloudview [OPTIONS]
Options:
-h, --help show this help message and exit
-l, --log debug|info|warning|error|critical
-o, --output text|html|json|JSON output type
-p, --port PORT run a web server on port PORT
-r, --reverse reverse sort
-s, --sort name|time|status sort type
-S, --status stopped|running|all filter by instance status
-T, --time TIME_FORMAT time format as used by strftime(3)
-v, --verbose be verbose
-V, --version show version and exit
Filter options:
--filter-aws NAME VALUE may be specified multiple times
--filter-azure FILTER Filter for Azure
--filter-gcp FILTER Filter for GCP
```
**NOTES**:
- Use `--output JSON` to dump _all_ available information received from each provider.
- Remember to set these environment variables:
- `GOOGLE_APPLICATION_CREDENTIALS`
- `AZURE_TENANT_ID`
- `AZURE_SUBSCRIPTION_ID`
- `AZURE_CLIENT_SECRET`
- `AZURE_CLIENT_ID`
This script is best run with Docker to have all dependencies in just one package, but it may be run stand-alone on systems with Python 3.5+
## To run stand-alone:
```
pip3 install --user cloudview
```
## To run with Docker:
Build image with:
```
docker build -t cloud --pull .
```
Run with:
```
docker run --rm -v ~/.aws:/root/.aws:ro -v "$GOOGLE_APPLICATION_CREDENTIALS:$GOOGLE_APPLICATION_CREDENTIALS:ro" -e AZURE_TENANT_ID -e AZURE_SUBSCRIPTION_ID -e AZURE_CLIENT_SECRET -e AZURE_CLIENT_ID -e GOOGLE_APPLICATION_CREDENTIALS=/root/$(basename $GOOGLE_APPLICATION_CREDENTIALS) cloudview --status all
```
## Run the web server with [Docker Compose](https://docs.docker.com/compose/install/):
If you have a TLS key pair, rename the certificate to `cert.pem`, the private key to `key.pem` and the file containing the password to the private key to `key.txt`. Then edit the [docker-compose.yml](docker-compose.yml) file to mount them to `/etc/nginx/ssl` in read-only mode like this: `- "/path/to/tls:/etc/nginx/ssl:ro"`.
If you don't have a TLS key pair, a self-signed certificate will be generated. Be aware of the typical problems with time resolution related to TLS certificates.
```
docker-compose up -d
```
Now browse to [https://localhost:8443](https://localhost:8443)
To stop the web server:
```
docker-compose down
```
To rebuild with latest version:
```
docker-compose build --pull
```
## TODO
- Search by tag
- Sort by instance type
- Use apache-libcloud?
View instance information on all supported cloud providers
[![Build Status](https://travis-ci.org/ricardobranco777/cloudview.svg?branch=master)](https://travis-ci.org/ricardobranco777/cloudview)
## Usage
```
Usage: cloudview [OPTIONS]
Options:
-h, --help show this help message and exit
-l, --log debug|info|warning|error|critical
-o, --output text|html|json|JSON output type
-p, --port PORT run a web server on port PORT
-r, --reverse reverse sort
-s, --sort name|time|status sort type
-S, --status stopped|running|all filter by instance status
-T, --time TIME_FORMAT time format as used by strftime(3)
-v, --verbose be verbose
-V, --version show version and exit
Filter options:
--filter-aws NAME VALUE may be specified multiple times
--filter-azure FILTER Filter for Azure
--filter-gcp FILTER Filter for GCP
```
**NOTES**:
- Use `--output JSON` to dump _all_ available information received from each provider.
- Remember to set these environment variables:
- `GOOGLE_APPLICATION_CREDENTIALS`
- `AZURE_TENANT_ID`
- `AZURE_SUBSCRIPTION_ID`
- `AZURE_CLIENT_SECRET`
- `AZURE_CLIENT_ID`
This script is best run with Docker to have all dependencies in just one package, but it may be run stand-alone on systems with Python 3.5+
## To run stand-alone:
```
pip3 install --user cloudview
```
## To run with Docker:
Build image with:
```
docker build -t cloud --pull .
```
Run with:
```
docker run --rm -v ~/.aws:/root/.aws:ro -v "$GOOGLE_APPLICATION_CREDENTIALS:$GOOGLE_APPLICATION_CREDENTIALS:ro" -e AZURE_TENANT_ID -e AZURE_SUBSCRIPTION_ID -e AZURE_CLIENT_SECRET -e AZURE_CLIENT_ID -e GOOGLE_APPLICATION_CREDENTIALS=/root/$(basename $GOOGLE_APPLICATION_CREDENTIALS) cloudview --status all
```
## Run the web server with [Docker Compose](https://docs.docker.com/compose/install/):
If you have a TLS key pair, rename the certificate to `cert.pem`, the private key to `key.pem` and the file containing the password to the private key to `key.txt`. Then edit the [docker-compose.yml](docker-compose.yml) file to mount them to `/etc/nginx/ssl` in read-only mode like this: `- "/path/to/tls:/etc/nginx/ssl:ro"`.
If you don't have a TLS key pair, a self-signed certificate will be generated. Be aware of the typical problems with time resolution related to TLS certificates.
```
docker-compose up -d
```
Now browse to [https://localhost:8443](https://localhost:8443)
To stop the web server:
```
docker-compose down
```
To rebuild with latest version:
```
docker-compose build --pull
```
## TODO
- Search by tag
- Sort by instance type
- Use apache-libcloud?
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cloudview-0.1.39.tar.gz
(12.3 kB
view hashes)
Built Distribution
cloudview-0.1.39-py3-none-any.whl
(16.8 kB
view hashes)
Close
Hashes for cloudview-0.1.39-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19af87d7e33eccc7c3599dfde217c8f44a0af251df6275fedfbbc3290d7fa2ea |
|
MD5 | 4792c3e622319f314a91e26742126eca |
|
BLAKE2b-256 | 53ab99153983b83a55a9cd3383a8bcebf96af209f57a7d549c6d3c39ba8e0bb9 |