Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update beginner tutorial: Change front end, suggestions for localhost running, reformat tutorial #733

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
17 changes: 7 additions & 10 deletions docs/workshops/beginner/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,25 +102,22 @@ PYTHONPATH=. python main.py db init
PYTHONPATH=. python main.py db upgrade heads
```

### Step 5 - Install orchestrator client
### Step 5 - Install orchestrator frontend

Install the orchestrator client in the parent directory of the
example-orchestrator:

```shell
cd ..
git clone https://github.com/workfloworchestrator/orchestrator-core-gui.git
git clone https://github.com/workfloworchestrator/example-orchestrator-ui.git
```

Install the Yarn package manager and use it to install the orchestrator
client dependencies:
Install the npm packages
`npm i`

```shell
cd orchestrator-core-gui/
sudo npm install --global yarn
sudo npm install --global --save-dev npm-run-all
yarn install
```
Set the environment variables. The defaults from .env.example will work out of the box with the example orchestrator backend.
`cp .env.example .env`
If you are working without authentication, be sure to set `OAUTH2_ACTIVE=true`.

### Step 6 - Init orchestrator client:

Expand Down
2 changes: 1 addition & 1 deletion docs/workshops/beginner/domain-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Introduction

First read the [Architecture; TL;DR](/orchestrator-core/architecture/tldr/)
First read the [Architecture TL;DR](docs/architecture/tldr.md)
section of the orchestrator core documentation to get an overview of the
concepts that will be covered.

Expand Down
4 changes: 2 additions & 2 deletions docs/workshops/beginner/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,15 +107,15 @@ example-orchestrator:

```shell
cd ..
git clone https://github.com/workfloworchestrator/orchestrator-core-gui.git
git clone https://github.com/workfloworchestrator/example-orchestrator-ui.git
```

When multiple version of Node.js are installed, make sure node@14 is being
used, this can be achieved by explicitly prepending it to the shell PATH. Use
the Yarn package manager to install the orchestrator client dependencies:

```shell
cd orchestrator-core-gui/
cd example-orchestrator-ui/
export PATH="/usr/local/opt/node@14/bin:$PATH"
yarn install
```
Expand Down
18 changes: 0 additions & 18 deletions docs/workshops/beginner/scenario.md

This file was deleted.

18 changes: 7 additions & 11 deletions docs/workshops/beginner/start-applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,17 @@ From the `example-orchestrator` folder, use Uvicorn to start the orchestrator:
uvicorn --host 127.0.0.1 --port 8080 main:app
```

If you are running without authentication set up, you can set the environment variable to false from the command line:
```
OAUTH2_ACTIVE=false uvicorn --host localhost --port 8080 main:app
```

Visit [the app](http://127.0.0.1:8080/api/docs) to view the API documentation.

### Start client

From the `orchestrator-core-gui` folder, initialize your shell environment with
the variables from `.env.local` and start the client:

```
source .env.local
# on MacOS make sure node@14 is being used
export PATH="/usr/local/opt/node@14/bin:$PATH"
yarn start
```

Point a web browser to `$REACT_APP_BACKEND_URL`.
From the `example-orchestrator-ui` folder, run the following command to start the front end.
`npm run dev`

## Docker compose

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Overview beginner workshop
# Beginner Workshop Overview

## Intended audience

Expand Down Expand Up @@ -33,6 +33,24 @@ are prerequisites to do this workshop.
as part of defining the create workflow. This will show how a simple
product block hierarchy is created.


During this workshop a set of products will be created together with the needed
workflows to administer users and user groups. The products will be just
complex enough to show the basic capabilities of products, product blocks,
fixed inputs, resource types and workflows in the workflow orchestrator.

The following user and user group attributes will be stored:

* **UserGroup**
* **group_name**: name of the user group
* **group_id**: ID of the group in an imaginary group management system
* **User**
* **affiliation**: the user's affiliation (**internal** or **external**)
* **username**: name of the user
* **age**: age of the user
* **user_id**: ID of the user in an imaginary user management system
* **group**: group the user belongs to

## Workshop folder layout

This workshop uses the following folder layout:
Expand Down Expand Up @@ -67,8 +85,9 @@ beginner-workshop
   └── ...
```

The `orchestrator-core-gui` folder will be cloned from GitHub. The
The `example-orchestrator-ui` folder will be cloned from GitHub. The
`example-orchestrator` folder will be used for the orchestrator that is created
during this workshop. Although any layout of the latter folder will work, it
is encouraged to use the suggested folder layout and filenames during this
workshop.

Loading