Package: qhub
InformationLinksProjectCommunityCITable of contentsTable of contentsQHub HPCQHub:cloud: Cloud Providers:computer: InstallationPre-requisitesInstall QHub:label: Usage:question: Questions?:book: Code of Conduct:gear: Installing the Development version of QHub:raised_hands: ContributionsOngoing SupportLicenseAutomated data science platform. FromJupyterHubto Cloud environments withDask Gateway.QHub is an open source tool that enables users to build and maintain cost-effective and scalable compute/data science platforms onHPCor onKuberneteswith
minimal DevOps experience.This repository details theQHub(Kubernetes) version.Not sure what to choose? Check out ourSetup Initializationpage.QHub HPCVersion of QHub based on OpenHPC.NOTE: The tool is currently under development. Curious? Check out theQhub HPCrepository.QHubThe Kubernetes version of QHub is built usingTerraform,Helm, andGitHub Actions. Terraform handles the build, change, and versioning of the infrastructure. Helm helps to define, install,
and manageKubernetes. 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 ProvidersQHub offers out-of-the-box support forDigital Ocean, AmazonAWS,GCP, and MicrosoftAzure.For more details, check out the releaseblog post.:computer: InstallationPre-requisitesQHub is supported by macOS and Linux operating systems (Windows isNOTcurrently supported).Compatible with Python 3.7+. New to Python? We recommend usingAnaconda.Adoption of virtual environments (conda,pipenvorvenv) is also encouraged.Install QHubTo install QHub type the following commands in your command line:Install usingconda:condainstall-cconda-forgeqhubInstall usingpip:pipinstallqhubOnce finished, you can check QHub's version (and additional CLI args) by typing:qhub--helpIf successful, the CLI output will be similar to the following:usage:qhub[-h][-v]{deploy,destroy,render,init,validate}...

QHubcommandline

positionalarguments:{deploy,destroy,render,init,validate}QHub

optionalarguments:-h,--helpshowthishelpmessageandexit-v,--versionQHubversion:label: UsageQHub requires the setting of environment variables to automate the deployments fully. For details on how to obtain those variables, check theinstallation guidein the docs.Once all the necessary credentials are gathered and set asUNIX environment variables, QHub can be
deployed in under 20 minutes using:qhubinit...# generates initial config file and optionally automates deployment stepsqhubdeploy...# creates and configures the cloud infrastructure:question: Questions?Have a look at ourFAQto see if your query has been answered.We separate the queries for QHub into:GitHub Discussionsused to raise discussions about a subject, such as: "What is the recommended way to do X with QHub?"Issuesfor 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 ConductTo guarantee a welcoming and friendly community, we require contributors to follow ourCode of Conduct.:gear: Installing the Development version of QHubTo install the latest developer version (unstable) use:pipinstallgit+https://github.com/Quansight/qhub.git@dev:raised_hands: ContributionsThinking about contributing? Check out ourContribution Guidelines.Ongoing SupportThev0.4.0release introduced many changes that will irrevocably break your deployment if you attempt an inplace upgrade; for details see ourRELEASEnotes. In order to focus on the future direction of the project, we have decided as a team that we will providelimitedsupport for older versions. Any new user is encouraged to usev0.4.0or greater.If you're using an older version of QHub and would like professional support, please reach out to Quansight.LicenseQHub is BSD3 licensed.