Manages cloud_sql_proxy connections, allocating fixed ports and allowing control over starting and stopping
Project description
Cloud SQL Instance Manager
A command-line tool for managing GCP cloud_sql_proxy connections to a number of instances. It can automatically import your GCP project's Cloud SQL instances, assign ports to them, and start and stop the proxies.
Installation
Use the package manager pip to install cloud_sql_instance_manager.
pip install cloud_sql_instance_manager
You will need to have gcloud command line installed and logged in with gcloud auth login
The manager will default to using the output of which cloud_sql_proxy
to determine the location of the cloud_sql_proxy executable. You can override this with
cloud_sql config --path /FULL/PATH/TO/EXECUTABLE
Usage
Importing from gcloud
Ensure you are authenticated with gcloud command line.
cloud_sql import
The instance manager will import any (new) instances and automatically assign them ports.
If you want to specify a different project to your current default, then
cloud_sql import --project YOUR-PROJECT-NAME
Nicknames
By default, instances are given a nickname of everything proceeding "-instance-" in the full name. For example - test-application-instance-9956326571963535019
will get the nickname test-application
You can amend the nickname with
cloud_sql update ORIGINAL-NICKNAME --nick NEW-NICKNAME
At any point, you can have more than one instance with the same nickname but different projects, and you can differentiate with --project PROJECT-NAME
Starting an instance
cloud_sql start NICK-NAME
Stopping an instance
cloud_sql stop NICK-NAME
Listing instances
List all instances
cloud_sql list
List all instances for a project
cloud_sql list --project YOUR-PROJECT
List all running instances
cloud_sql list-running
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
TODO List
- Export to DBeaver
- Default instances - set and unset, start all default
- Stop all
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
Built Distribution
File details
Details for the file cloud_sql_instance_manager-0.1.1.tar.gz
.
File metadata
- Download URL: cloud_sql_instance_manager-0.1.1.tar.gz
- Upload date:
- Size: 8.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f46d97b6ee60306c077e286ef5bb2667e7ce1438c5766eb8fec344227e859397 |
|
MD5 | 14dd6f1a9df3bc7e6f133f2ed89d45c4 |
|
BLAKE2b-256 | 57ffbc13e0e04ce239d99ab1145a32fed7ddca0a28f6c1b01866cd04b305ac7b |
File details
Details for the file cloud_sql_instance_manager-0.1.1-py3-none-any.whl
.
File metadata
- Download URL: cloud_sql_instance_manager-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3caeb262ba5c6d55a6a8ee4a04b48b5e98e659d9b318001df314f7b8e81b8d97 |
|
MD5 | 3935d001ea064353c0809a2b16aeb68b |
|
BLAKE2b-256 | 77695377b094681fed8b32b4cc79daed45649edb3967ccae6cfbc51d42a6e84b |