From 23ac9e8a060fb2e09e5de8ddc8b02a5c955e6b49 Mon Sep 17 00:00:00 2001 From: Javed Habib Date: Thu, 5 Sep 2024 15:36:38 +0530 Subject: [PATCH] reamde --- README.md | 14 +++++++++++ docs/source/pages/tesk/tesk.k8s.rst | 29 ++++++++++++++++++++++ docs/source/pages/tesk/tesk.kubernetes.rst | 29 ---------------------- docs/source/pages/tesk/tesk.rst | 2 +- 4 files changed, 44 insertions(+), 30 deletions(-) create mode 100644 docs/source/pages/tesk/tesk.k8s.rst delete mode 100644 docs/source/pages/tesk/tesk.kubernetes.rst diff --git a/README.md b/README.md index 0dd388ec..211572e3 100644 --- a/README.md +++ b/README.md @@ -66,3 +66,17 @@ and the taskmaster ends, completing the task. need either an FTP account or a PVC that can be accessed from within or from outside of the cluster by the workflow manager (more in the [deployment](deployment/documentation/deployment.md) page). + +### Environment Variables + +| **Environment Variable** | **Default Value** | **Description** | +|-------------------------------------------------|----------------------------------------------------|------------------------------------------------| +| `TESK_API_TASKMASTER_FILER_IMAGE_NAME` | `docker.io/elixircloud/tesk-core-filer` | Name of the filer image | +| `TESK_API_TASKMASTER_FILER_IMAGE_VERSION` | `latest` | Version of the filer image | +| `TESK_API_TASKMASTER_IMAGE_NAME` | `docker.io/elixircloud/tesk-core-taskmaster` | Name of the taskmaster image | +| `TESK_API_TASKMASTER_IMAGE_VERSION` | `latest` | Version of the taskmaster image | +| `TESK_API_K8S_NAMESPACE` | `tesk` | Namespace in which TESK creates K8s resources | +| `TESK_API_TASKMASTER_SERVICE_ACCOUNT_NAME` | `taskmaster` | Taskmaster service account name | +| `ENVIRONMENT_EXECUTOR_BACKOFF_LIMIT` | `6` | Backoff limit for taskmaster execution | +| `FILER_BACKOFF_LIMIT` | `2` | Backoff limit for filer job | +| `EXECUTOR_BACKOFF_LIMIT` | `2` | Backoff limit for executor job | \ No newline at end of file diff --git a/docs/source/pages/tesk/tesk.k8s.rst b/docs/source/pages/tesk/tesk.k8s.rst new file mode 100644 index 00000000..6756e055 --- /dev/null +++ b/docs/source/pages/tesk/tesk.k8s.rst @@ -0,0 +1,29 @@ +tesk.k8s package +================ + +Submodules +---------- + +tesk.k8s.constants module +------------------------- + +.. automodule:: tesk.k8s.constants + :members: + :undoc-members: + :show-inheritance: + +tesk.k8s.wrapper module +----------------------- + +.. automodule:: tesk.k8s.wrapper + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: tesk.k8s + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/tesk/tesk.kubernetes.rst b/docs/source/pages/tesk/tesk.kubernetes.rst deleted file mode 100644 index 332e72b3..00000000 --- a/docs/source/pages/tesk/tesk.kubernetes.rst +++ /dev/null @@ -1,29 +0,0 @@ -tesk.kubernetes package -======================= - -Submodules ----------- - -tesk.kubernetes.constants module --------------------------------- - -.. automodule:: tesk.kubernetes.constants - :members: - :undoc-members: - :show-inheritance: - -tesk.kubernetes.wrapper module ------------------------------- - -.. automodule:: tesk.kubernetes.wrapper - :members: - :undoc-members: - :show-inheritance: - -Module contents ---------------- - -.. automodule:: tesk.kubernetes - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/pages/tesk/tesk.rst b/docs/source/pages/tesk/tesk.rst index 9918ebda..9b4aede7 100644 --- a/docs/source/pages/tesk/tesk.rst +++ b/docs/source/pages/tesk/tesk.rst @@ -8,7 +8,7 @@ Subpackages :maxdepth: 4 tesk.api - tesk.kubernetes + tesk.k8s tesk.services Submodules