Skip to content

Commit

Permalink
Documentation update for release 0.4.0 (#128)
Browse files Browse the repository at this point in the history
* Update project name and copyright year in docs config

* Update the main readme:
- Current release series is 0.4.x
- Include instructions for starting the orchestrator as part of running TRAC

* Add a run config for the orchestrator
  • Loading branch information
Martin Traverse authored Mar 18, 2022
1 parent d352f94 commit b6c59d1
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 9 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ https://github.com/finos/tracdap/actions/workflows/packaging.yml)
https://tracdap.finos.org/en/stable/?badge=stable)


The current release series (0.3.x) is intended for reference and experimentation.
The current release series (0.4.x) is intended for reference and experimentation.
It includes the metadata service, data service and core data engine, runtime engine
for Python and a partial implementation of the platform Gateway. This release can
be used to prototype client applications (e.g. web UIs) and to build and run models
in a development sandbox.
for Python and preview versions of the orchestration service and platform Gateway.
This release can be used to prototype client applications (e.g. web UIs), to build
and run models and to run small calculation workflows.

At the moment TRAC's API calls and metadata structures are subject to change between
versions, including between point versions. As the platform evolves these APIs will
Expand Down Expand Up @@ -97,10 +97,20 @@ the TRAC metadata schema into an H2 database file.
gradlew :deploy-metadb:run --args="--config etc/trac-devlocal.yaml --task deploy_schema"
gradlew :deploy-metadb:run --args="--config etc/trac-devlocal.yaml --task add_tenant:ACME_CORP"

Once you have a database prepared you can start the TRAC services.
To run models in TRAC you will need an execution environment. A local execution
environment for can be configured by creating a Python venv and installing the
TRAC D.A.P. runtime, then editing trac-devlocal.yaml to set the executor venvPath.

python -m vemv path/to/venv/
. path/to/venv/bin/activate # For macOS and Linux
path\to\venv\Scripts\activate # For Windows
pip install tracdap-runtime

Once you have a database and an executor prepared, you can start the TRAC services.

gradlew :tracdap-svc-meta:run --args="--config etc/trac-devlocal.yaml"
gradlew :tracdap-svc-data:run --args="--config etc/trac-devlocal.yaml"
gradlew :tracdap-svc-orch:run --args="--config etc/trac-devlocal.yaml"
gradlew :tracdap-gateway:run --args="--config etc/trac-devlocal-gateway.yaml"

To confirm the platform is working you can use the [example API calls](./examples/rest_calls)
Expand Down
4 changes: 2 additions & 2 deletions dev/docgen/docgen-ctrl.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,8 @@ def get_version_and_release(self):
version = re.sub(r"[+-].+$", "", version_output)
release = re.sub(r".*\+.+$", "(latest dev)", version_output)

self._log.info(f"TRAC d.a.p. version: {version}")
self._log.info(f"TRAC d.a.p. release: {release}")
self._log.info(f"TRAC D.A.P. version: {version}")
self._log.info(f"TRAC D.A.P. release: {release}")

self._version = version # noqa
self._release = release # noqa
Expand Down
11 changes: 11 additions & 0 deletions dev/ide/idea/runConfigurations/TRAC__Orchestrator.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="TRAC: Orchestrator" type="Application" factoryName="Application">
<option name="MAIN_CLASS_NAME" value="org.finos.tracdap.svc.orch.TracOrchestratorService" />
<module name="tracdap.tracdap-svc-orch.main" />
<option name="PROGRAM_PARAMETERS" value="--config etc/trac-devlocal.yaml" />
<option name="VM_PARAMETERS" value="--add-opens java.base/jdk.internal.misc=ALL-UNNAMED --add-opens java.base/java.nio=ALL-UNNAMED -Dio.netty.tryReflectionSetAccessible=true" />
<method v="2">
<option name="Make" enabled="true" />
</method>
</configuration>
</component>
4 changes: 2 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ def setup(app):

# -- Project information -----------------------------------------------------

project = 'TRAC'
copyright = '2021, Accenture' # noqa
project = 'TRAC D.A.P.'
copyright = '2022, Accenture' # noqa
author = 'Martin Traverse'

# ReadTheDocs does not fetch tags by default and we need them to get version information
Expand Down

0 comments on commit b6c59d1

Please sign in to comment.