https://github.com/redhat-scholars/devnation-labs-dashboard
Python tiny CRUD application with Flask, SQLAlchemy and Bootstrap to assign clusters for DevNation HOWL Labs.
https://github.com/redhat-scholars/devnation-labs-dashboard
container docker flask mariadb openshift python s2i sqlalchemy
Last synced: 2 months ago
JSON representation
Python tiny CRUD application with Flask, SQLAlchemy and Bootstrap to assign clusters for DevNation HOWL Labs.
- Host: GitHub
- URL: https://github.com/redhat-scholars/devnation-labs-dashboard
- Owner: redhat-scholars
- License: gpl-3.0
- Created: 2020-11-23T11:35:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-30T11:15:05.000Z (almost 5 years ago)
- Last Synced: 2026-04-18T00:28:56.396Z (3 months ago)
- Topics: container, docker, flask, mariadb, openshift, python, s2i, sqlalchemy
- Language: Python
- Homepage: https://developers.redhat.com/devnation/labs/openshift-howl
- Size: 231 KB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DevNation Labs (HOWL) Dashboard
Python tiny CRUD application with Flask, SQLAlchemy and Bootstrap to assign clusters for [HOWL](https://developers.redhat.com/devnation/labs/openshift-howl) Labs.
It uses MariaDB as DB.
## OpenShift
### Create a new project
```
oc new-project devnation-labs
```
### Get MariaDB
```
oc new-app mariadb-persistent -p DATABASE_SERVICE_NAME=mariadb -p MYSQL_USER=mariadb -p MYSQL_PASSWORD=mariadb -p MYSQL_ROOT_PASSWORD=mariadb -p MYSQL_DATABASE=cluster_booking -l 'app.kubernetes.io/name=mariadb,app.kubernetes.io/part-of=labs-dashboard'
```
### Deploy
Overriding S2I run script at `.s2i/bin/run` to run migrations and start the app.
#### ENV vars as parameters to the Deployment
Default parameters are stored as ENV vars in [config.py](config.py#).
List of variables to use for a deployment:
| ENV | Default value | Description
| ------------- | ------------- | ------------- |
| `DB_USER` | `mariadb` | MariaDB username
| `DB_PASS` | `mariadb` | MariaDB password
| `DB_HOST` | `mariadb` | MariaDB hostname
| `DB_NAME` | `cluster_booking` | DB name
| `ADMIN_USER` | `admin@email.tld` | Default admin user **CHANGE IT**
| `ADMIN_PASS` | `_some_difficult_pass@` | Default admin pass **CHANGE IT**
| `SECRET_KEY` | `2621a03cd4e5881cac070d675dac75d2d973c46f466aa1b5` | Default secret key **CHANGE IT**
#### Generate Session Secret Key
You should avoid using default `SECRET_KEY` from [config.py](config.py#L6), which defaults to a Dev-only one. For Prod envs, you can generate a new one with this command:
```
export SECRET_KEY=`openssl rand -hex 24`
```
#### Change Admin user
By default there's only one Admin user, default credentials are stored in [config.py](config.py)
Please change default credentials before deploying the app in Prod:
```
export ADMIN_USER=
export ADMIN_PASS=
```
#### Source-2-Image: oc new-app
Just deploy the app in 2 steps.
Create the app:
```
oc new-app https://github.com/redhat-scholars/devnation-labs-dashboard.git -e DB_USER=mariadb -e DB_PASS=mariadb -e DB_HOST=mariadb -e DB_NAME=cluster_booking -e ADMIN_USER=$ADMIN_USER -e ADMIN_PASS=$ADMIN_PASS -e SECRET_KEY=$SECRET_KEY -l 'app.kubernetes.io/name=python,app.kubernetes.io/part-of=labs-dashboard'
```
Expose a secure Route:
```
oc create route edge get-cluster --service=devnation-labs-dashboard --insecure-policy=Redirect
```
Here we go, the Dashboard should be ready in a few seconds!
#### Edit from Eclipse Che
If you are running on a cluster with [CodeReadyWorkspaces](https://developers.redhat.com/products/codeready-workspaces/overview) like [Developer Sandbox](https://developers.redhat.com/developer-sandbox), you can start editing it directly from there.
Just annotate the Deployment for that:
````
oc annotate deployments devnation-labs-dashboard app.openshift.io/vcs-uri='https://github.com/redhat-scholars/devnation-labs-dashboard.git'
oc annotate deployments devnation-labs-dashboard app.openshift.io/vcs-ref='master'
````
Or Run it with [Eclipse Che Factories](https://developers.redhat.com/che/creating-factories):
NOTE: Change the address of Factory with your CRW URL
[](https://codeready-openshift-workspaces.apps.crc.testing/factory?url=https://github.com/redhat-scholars/devnation-labs-dashboard.git)
#### (Optional) Source-2-Image: Upload from local working dir
If you are working locally with the source code, you can upload it to OpenShift and let OpenShift run S2I in this way:
```
oc new-build --name devnation-labs -i python --binary=true
oc start-build devnation-labs --from-dir=.
oc new-app devnation-labs -e DB_USER=mariadb -e DB_PASS=mariadb -e DB_HOST=mariadb -e DB_NAME=cluster_booking -e ADMIN_USER=foo@web.tld -e ADMIN_PASS=foo -e SECRET_KEY=$SECRET_KEY
oc create route edge --service=devnation-labs --insecure-policy=Redirect
```
#### (Experimental) Source-2-Image: odo
odo should been able to [link services](https://docs.openshift.com/container-platform/latest/cli_reference/developer_cli_odo/creating-instances-of-services-managed-by-operators.html#listing-available-services-from-the-operators-installed-on-the-cluster_creating-instances-of-services-managed-by-operators) like MariaDB, however there's no MariaDB yet inside OCP OperatorHub.
```
odo project create devnation-labs
odo create python --s2i
odo push
odo url create --port 8080 --secure
odo push
```
## Local Development
### Setup MariaDB
Get MariaDB from Dockerhub:
```
docker pull mariadb
```
Run MariaDB:
```
docker run --rm -d --name mariadb -v /some/local/dir:/var/lib/mysql:z -p 3306:3306 -e MYSQL_ROOT_PASSWORD=foo -ti mariadb
```
### Setup Python
Start local Python 3 env:
```
virtualenv --python=/usr/bin/python3 venv
source ./venv/bin/activate
pip3 install -r requirements.txt
```
### Run locally
#### Run Migrations
```
python manage.py db init
DB_USER=user DB_PASS=pass DB_HOST=127.0.0.1 DB_NAME=cluster_booking python manage.py db migrate
DB_USER=user DB_PASS=pass DB_HOST=127.0.0.1 DB_NAME=cluster_booking python manage.py db upgrade
```
#### Run the app
```
DB_USER=user DB_PASS=pass DB_HOST=127.0.0.1 DB_NAME=cluster_booking ADMIN_USER=foo@web.tld ADMIN_PASS=foo python app.py
```
Open at your Web browser the following link http://127.0.0.1:8080
### Docker/Podman
The `docker-entrypoint.sh` is not initializating the db by default, you can do it with adding this ENV the first time:
```INIT_DB=yes```
#### Build
```
docker build -f Dockerfile.alpine -t devnation-labs:latest
```
#### Run
```
docker run -e DB_USER="mariadb" -e DB_PASS="mariadb" -e DB_HOST="" -e ADMIN_USER=foo@web.tld -e ADMIN_PASS=foo -p 8080:8080 -ti devnation-labs
```
## Paths
### Web
- `/`: Student cluster booking form
- `/admin/panel`: Administrator panel (Upload clusters and users via CSV, assigning manually clusters)
- `/admin/login`: Administrator login
### REST (@protected)
| Path | HTTP Method | Description
| ------------- | ------------- | ------------- |
| /user/assign | POST | Assign a cluster
| /user/add | POST | Add single user
| /user/upload | POST | Add users from a CSV
| /user/delete | POST | Delete single user
| /cluster/upload | POST | Add clusters from a CSV
| /cluster/update | POST | Update assigned cluster
| /cluster/delete | POST | Delete single cluster
| /admin/data/export | GET | Get list of users and assigned cluster as CSV
| /admin/login | POST | Login for admin user
## Usage
- **Students view** : http://127.0.0.1:8080/ or URL from OpenShift Route + path
- **Admin panel**: http://127.0.0.1:8080/admin/panel or URL from OpenShift Route + path
### Upload Cluster CSV
Expected min format (can contain more columns, but those listed and order is **mandatory**)
```
Cluster ID,Cluster Name,Username,User Password,Login URL,Workshop URL
```
### Upload Registration CSV
Expected min format (can contain more columns, but those listed and order is **mandatory**)
```
name[0],email[1],location[2],GEO[3],Company Name[8],Country[9],What is your job role/title?[10]
```
### Add User manually
Use the form
### Export CSV
It will generated a CSV containing all the info like in Registration CSV + cluster assigned info, ordered by cluster name atm.
# Reference
- https://flask.palletsprojects.com/en/1.1.x/
- https://docs.sqlalchemy.org/en/latest/orm/tutorial.html
- https://github.com/macagua/example.flask.crud-app.git