qhub-ops

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #llm #go #rust #linux #macos #nodejs #java #cli #awesome-list #ios

(★ 8)

A tool for initialising and maintaining the state of QHub deployments on Digital Ocean, Amazon Web Services, and Google Cloud Platform

qhub-ops Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Please direct all issues and pull requests to https://github.com/Quansight/qhub. Project has unified under this single directory.

# QHub-Ops

Is a tool for initializing and maintaining the state of QHub
deployments on Digital Ocean, Amazon Web Services, and Google Cloud
Platform.

## Installation:

```bash
pip install qhub-ops
```

## Configuration

QHub is entirely controlled from a configuration file. Example
configuration files can be found in
[tests/assets](https://github.com/Quansight/qhub-ops/tree/master/tests/assets). Documentation
on creating a configuration file is detailed [here](https://github.com/Quansight/qhub-ops/blob/master/qhub_ops/template/%7B%7B%20cookiecutter.repo_directory%20%7D%7D/docs/configuration.md).

Templates for each file are at the following paths:
  - AWS :: tests/assets/config_aws.yaml
  - DO  :: tests/assets/config_do.yaml
  - GCP :: tests/assets/config_gcp.yaml

## Initializing the Provider Template

The exact naming of the configuration file is needed to trigger the CI
actions when the configuration is changed.

```bash
mkdir <repository-name>
# mv <config-filename> <repository-name>/qhub-ops-config.yaml
qhub-ops render -c <repository-name>/qhub-ops-config.yaml -o <repository-name>/ --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.

```bash
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:

```bash
python <diagram_file>.py
```

# License

qhub-ops is BSD3 licensed

qhub-ops

qhub-ops Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

qhub-ops

qhub-ops Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README