Skip to content

Commit

Permalink
doc: minor README updates.
Browse files Browse the repository at this point in the history
* Specify JIRA is supported
* Specify webhook notifications are supported now.
* Minor wording cleanup/updates.
* Remove mention of Docker installation method.

Change-Id: Ib7a850381710062eead33aefbd424b47c838c77a
  • Loading branch information
sadsfae committed Feb 18, 2023
1 parent c18b3e5 commit 52de615
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,14 +103,15 @@ QUADS automates the future scheduling, end-to-end provisioning and delivery of b
* Currently allocated/free optional publicly routable VLAN status
- Query scheduling data to determine future availability
- Generates a per-month visualization map for per-machine allocations to assignments.
- RT (or similiar ticketing system) integration.
- IRC bot and email notifications for new provisioning tasks and ones ending completion
- ~~Control PDU sockets for connected bare-metal systems for power action~~ (to be re-introduced in 1.2)
- JIRA integration.
- Webhook and IRC notifications (via supybot/notify plugin) for system releases.
- Email notifications to users for new future assignments, releases and expirations.
- Flask-based Web UI for searching for available bare-metal systems in the future based on model.

## Design
- Main components: `Python3, Cherrypy, Mongoengine, MongoDB, Jinja2`
- Installation via Docker compose, RPM (Fedora or EL8+) or Github sources
- We use [badfish](https://github.com/redhat-performance/badfish) for managing bare-metal IPMI
- Main components: `Python3, CherryPy, Mongoengine, MongoDB, Jinja2`
- Installation via RPM for Fedora Linux.
- We use [Badfish](https://github.com/redhat-performance/badfish) for managing bare-metal IPMI
- We use [Foreman](https://theforeman.org/) for the systems provisioning backend.
- We use [Wordpress](https://wordpress.org/) for auto-generating wiki and documentation.
- A typical container-based QUADS deployment might look like this:
Expand All @@ -134,7 +135,7 @@ QUADS automates the future scheduling, end-to-end provisioning and delivery of b
| Install and Setup Foreman/Satellite | [docs](https://theforeman.org/manuals/nightly/#3.InstallingForeman) | Not covered here |
| Setup Foreman/Satellite Validation Templates | [examples](/templates/README.md) | Templates for internal interface configs |
| Prepare Host and Network Environment | [docs](/docs/switch-host-setup.md) | Covers Juniper Environments, IPMI, Foreman |
| Install QUADS | [docs](#installing-quads) | RPM, Docker or Github Source |
| Install QUADS | [docs](#installing-quads) | Install via RPM |
| Install MongoDB | [docs](/docs/install-mongodb.md) | May not be available via your distribution due to licensing changes |
| Install Wiki | [docs](#installing-other-quads-components) | For RPM or Github Source only |
| Configure your QUADS Move Command | [docs](#quads-move-command) | Configure your provisioning and move actions |
Expand Down Expand Up @@ -1046,13 +1047,12 @@ quads-cli --ls-hosts --filter "retired==True"
quads-cli --cloud-only cloud13 --filter "model==FC640"
```

#### Find Available Web Preview
#### Find Available Web Interface

* We now have a Flask-based `--ls-available` web interface available on `quadshost:5001` if your firewall rules are open for `TCP/5001`.
* Available in QUADS `1.1.4` or above as a tech preview (when we migrate fully to Flask this will be supplanted with a full UI).
* This is provided via the `quads-web` systemd service or you can run it manually via `cd /opt/quads/web ; python3 main.py`
* You will need to seed the `models` data for your systems using the new [host metadata feature](/docs/quads-host-metadata-search.md)
* This is **not** available in containers as it's a tech preview but will be featured once our move from CherryPy to Flask is completed later.

![quads-available-web](/image/quads-available-web.png?raw=true)

Expand Down

0 comments on commit 52de615

Please sign in to comment.