Management of QHub on Cloud Infrastructure
Project description
QHub
Is a tool for initializing and maintaining the state of QHub deployments on Digital Ocean, Amazon Web Services, and Google Cloud Platform.
Installation:
pip install qhub
Configuration
QHub is entirely controlled from a configuration file.
To generate a configuration file follow these instructions.
mkdir <repository-name>
cd <repository-name>
qhub init <platform-name> # platform-name can be do, aws or gcp.
This generates a configuration file. Now modify the configuration according to your needs. Documentation on modify a configuration file is detailed here.
Initializing the Provider Template
The exact naming of the configuration file is needed to trigger the CI actions when the configuration is changed.
qhub render -c qhub-config.yaml -o ./ --force
After initialising the provider templates, follow the instructions in
docs on deploying the infrastructure at
<repository-name>/docs/installation.md. At this current moment some
bootstrapping is required before github-actions can manage the
infrastructure as code. All of these instructions are automated in
scripts/00-guided-install.sh. Note that you will need to set the
environment variables in intallation.md for this script to
succeed. You will be prompted several times for use actions such as
setting oauth provider and dns.
./scripts/00-guided-install.sh
Terraform Module Dependencies
This project depends on the terraform modules repository: https://github.com/Quansight/qhub-terraform-modules
Architecture
The architecture diagrams for each cloud provider is in architecture folder.
To generate them, just run the following command:
python <diagram_file>.py
License
QHub is BSD3 licensed
Release
Creating a release:
- Increment the version number in
qhub/VERSION - Ensure that the version number in
qhub/VERSIONis used in pinning qhub in the github actionsqhub/template/{{ cookiecutter.repo_directory }}/.github/workflows/qhub-config.yaml
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
File details
Details for the file qhub-0.1.19.tar.gz.
File metadata
- Download URL: qhub-0.1.19.tar.gz
- Upload date:
- Size: 29.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.50.1 CPython/3.8.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 089824ffd0a03e970b8a7d5aa7f3d088fb536f6c9d5bf996d5c2d39071d1e36a |
|
| MD5 | b1fc39788fa1bff856ff933243b347ed |
|
| BLAKE2b-256 | 1cee6730bd5ae211cb570c8868f7741c0a03362ba342575be904f7b3a7590abe |
