Skip to content
Snippets Groups Projects
Select Git revision
  • feature/refacture-l3-core-services
  • develop default protected
  • feature/l2c-lso-steps
  • master protected
  • feature/10GGBS-NAT-980
  • fix/NAT-1009/fix-redeploy-base-config-if-there-is-a-vprn
  • feature/NAT-732-ias-to-re-interconnect
  • 2.44
  • 2.43
  • 2.42
  • 2.41
  • 2.40
  • 2.39
  • 2.38
  • 2.37
  • 2.36
  • 2.35
  • 2.34
  • 2.33
  • 2.32
  • 2.31
  • 2.29
  • 2.28
  • 2.27
  • 2.26
  • 2.25
  • 2.24
27 results
Blame Permalink
quickstart.rst 1.81 KiB

Quickstart

Development environment and dependencies

  • Install python 3.12 if you do not have it already:
    • add-apt-repository ppa:deadsnakes/ppa
    • apt install python3.12 python3.12-distutils
  • Follow Steps 1 and 2 from here to install dependencies and setup DB: https://workfloworchestrator.org/orchestrator-core/workshops/beginner/debian/
  • To install the orchestrator GUI, you can follow the steps 5 and 6 from the previous link.
  • Create a virtual environment:
    • source /usr/share/virtualenvwrapper/virtualenvwrapper.sh
    • mkvirtualenv --python python3.12 gso
  • To use the virtual environment:
    • source /usr/share/virtualenvwrapper/virtualenvwrapper.sh
    • workon gso

Installation

Do all this inside the virtual environment.

  • Clone this repository
  • pip install -r requirements.txt
    • If you get an error because you pip version is too old, run this: curl -sS https://bootstrap.pypa.io/get-pip.py | python3.12
  • pip install -e .
  • Create an oss-params.json based on the oss-params-example.json file inside /gso.
  • Export the oss-params file: export OSS_PARAMS_FILENAME="/path/to/oss-params.json"
  • Upgrade DB to latest revision: PYTHONPATH=. python main.py db upgrade heads

Run

  • Start the workflow orchestrator core with uvicorn --host 0.0.0.0 --port 8080 main:app from inside the gso directory of this repository.
  • Start the GUI with yarn start.

Useful workflow orchestrator resources