Skip to content

Commit

Permalink
restructure docs and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
JaeAeich committed May 11, 2024
1 parent 5ff8a07 commit 7ef9206
Show file tree
Hide file tree
Showing 37 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<img src="deployment/documentation/img/TESKlogowfont.png" height="200">
<img src="images/TESKlogowfont.png" height="200">


An implementation of a task execution engine based on the [TES standard](https://github.com/ga4gh/task-execution-schemas) running on `Kubernetes`. For more details on `TES`, see the (very) brief [introduction to TES](deployment/documentation/tesintro.md).
An implementation of a task execution engine based on the [TES standard](https://github.com/ga4gh/task-execution-schemas) running on `Kubernetes`. For more details on `TES`, see the (very) brief [introduction to TES](docs/tesintro.md).

For organisational reasons, this project is split into 3 repositories:
- This one, which contains documentation and deployment files
Expand All @@ -19,7 +19,7 @@ The technical documentation is available in the [documentation](deployment/docum
As a diagram:

<!-- TODO: Change the image remove tomcat, change naming etc -->
![TESK architecture](deployment/documentation/img/architecture.png)
![TESK architecture](images/architecture.png)

**Description**: The first pod in the task lifecycle is the API pod, a pod which runs a web server (`Tomcat`) and exposes the `TES` specified endpoints. It consumes `TES` requests, validates them and translates them to `Kubernetes` jobs. The API pod then creates a `task controller` pod, or `taskmaster`.

Expand Down
2 changes: 1 addition & 1 deletion deployment/charts/tesk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,5 +82,5 @@ See [`values.yaml`](values.yaml) for default values.
| ingress.rules| boolean | Apply or not the ingress rule |
| ingress.ingressClassName | string | Name of the Ingress Class |
| ingress.path | string | |
| ingress.tls_secret_name | string | If no TLS secret name configured, TLS will be switched off. A template can be found at [deployment/tls_secret_name.yml-TEMPLATE](deployment/tls_secret_name.yml-TEMPLATE). If you are using cert-manager the secret will be created automatically.|
| ingress.tls_secret_name | string | If no TLS secret name configured, TLS will be switched off. A template can be found at [tls_secret_name.yml-TEMPLATE](tls_secret_name.yml-TEMPLATE). If you are using cert-manager the secret will be created automatically.|
| ingress.annotations | string | Annotations for the ingress rules |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 7ef9206

Please sign in to comment.