Management of QHub on Cloud Infrastructure
Project description
| Information | Links |
|---|---|
| Project |    |
| Community |   |
| CI |     |
Table of contents
- Table of contents
- QHub HPC
- QHub
- :computer: Installation
- :label: Usage
- :question: Questions?
- :book: Code of Conduct
- :gear: Installing the Development version of QHub
- :raised_hands: Contributions
- Ongoing Support
- License
Automated data science platform. From JupyterHub to Cloud environments with Dask Gateway.
QHub is an open source tool that enables users to build and maintain cost-effective and scalable compute/data science platforms on HPC or on Kubernetes with minimal DevOps experience.
This repository details the QHub (Kubernetes) version.
Not sure what to choose? Check out our Setup Initialization page.
QHub HPC
Version of QHub based on OpenHPC.
NOTE: The tool is currently under development. Curious? Check out the Qhub HPC repository.
QHub
The Kubernetes version of QHub is built using Terraform, Helm, and
GitHub Actions. Terraform handles the build, change, and versioning of the infrastructure. Helm helps to define, install,
and manage Kubernetes. GitHub Actions is used to automatically create commits when the
configuration file (qhub-config.yaml) is rendered, as well as to kick off the deployment action.
QHub aims to abstract all these complexities for its users. Hence, it is not necessary to know any of the above mentioned technologies to have your project successfully deployed.
TLDR: If you know GitHub and feel comfortable generating and using API keys, you should have all it takes to deploy and maintain your system without the need for a dedicated DevOps team. No need to learn Kubernetes, Terraform, or Helm.
:cloud: Cloud Providers
QHub offers out-of-the-box support for Digital Ocean, Amazon AWS, GCP, and Microsoft Azure.
For more details, check out the release blog post.
:computer: Installation
Pre-requisites
- QHub is supported by macOS and Linux operating systems (Windows is NOT currently supported).
- Compatible with Python 3.7+. New to Python? We recommend using Anaconda.
- Adoption of virtual environments (
conda,pipenvorvenv) is also encouraged.
Install QHub
To install QHub type the following commands in your command line:
-
Install using
conda:conda install -c conda-forge qhub
-
Install using
pip:pip install qhub
Once finished, you can check QHub's version (and additional CLI args) by typing:
qhub --help
If successful, the CLI output will be similar to the following:
usage: qhub [-h] [-v] {deploy,destroy,render,init,validate} ...
QHub command line
positional arguments:
{deploy,destroy,render,init,validate}
QHub
optional arguments:
-h, --help show this help message and exit
-v, --version QHub version
:label: Usage
QHub requires the setting of environment variables to automate the deployments fully. For details on how to obtain those variables, check the installation guide in the docs.
Once all the necessary credentials are gathered and set as UNIX environment variables, QHub can be deployed in under 20 minutes using:
qhub init ... # generates initial config file and optionally automates deployment steps
qhub deploy ... # creates and configures the cloud infrastructure
:question: Questions?
Have a look at our FAQ to see if your query has been answered.
We separate the queries for QHub into:
-
GitHub Discussions used to raise discussions about a subject, such as: "What is the recommended way to do X with QHub?"
-
Issues for queries, bug reporting, feature requests,documentation, etc.
We work around the clock to make QHub better, but sometimes your query might take a while to get a reply. We apologise in advance and ask you to please, be patient :pray:.
:book: Code of Conduct
To guarantee a welcoming and friendly community, we require contributors to follow our Code of Conduct.
:gear: Installing the Development version of QHub
To install the latest developer version (unstable) use:
pip install git+https://github.com/Quansight/qhub.git@dev
:raised_hands: Contributions
Thinking about contributing? Check out our Contribution Guidelines.
Ongoing Support
The v0.4.0 release introduced many changes that will irrevocably break your deployment if you attempt an inplace upgrade; for details see our
RELEASE notes. In order to focus on the future direction of the project, we have decided as a team that we will provide limited support for older versions. Any new user is encouraged to use v0.4.0 or greater.
If you're using an older version of QHub and would like professional support, please reach out to Quansight.
License
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
Built Distribution
File details
Details for the file qhub-0.4.1.tar.gz.
File metadata
- Download URL: qhub-0.4.1.tar.gz
- Upload date:
- Size: 362.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04f94dd3250dfaf09794becc8d2ed2b3fe71044d8a75d1f8b4fff582bacff488 |
|
| MD5 | ae43068247580844ce5dcf78819439d2 |
|
| BLAKE2b-256 | a88861d69c64d0257520604ecc4508616e862f82f4949e5eed21ea467cb1f4ce |
Provenance
File details
Details for the file qhub-0.4.1-py3-none-any.whl.
File metadata
- Download URL: qhub-0.4.1-py3-none-any.whl
- Upload date:
- Size: 390.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.0 CPython/3.9.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 46aae3d11ca78092d4c3ccd282f0cdc7ff50540bf675a15c7deecdd0da3af7f0 |
|
| MD5 | 08812a0138c341325e66133169c1b757 |
|
| BLAKE2b-256 | e2bfba4803b4cdbf9e5727c3e383941394e9c075701dc66241f977bfa2a0e24e |
