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

refactor(docs): move from reST to Markdown (#567) #567

Merged
merged 1 commit into from
Feb 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Authors

The list of contributors in alphabetical order:

- [Adelina Lintuluoto](https://orcid.org/0000-0002-0726-1452)
- [Audrius Mecionis](https://orcid.org/0000-0002-3759-1663)
- [Anton Khodak](https://orcid.org/0000-0003-3263-4553)
- [Camila Diaz](https://orcid.org/0000-0001-5543-797X)
- [Diego Rodriguez](https://orcid.org/0000-0003-0649-2002)
- [Dinos Kousidis](https://orcid.org/0000-0002-4914-4289)
- [Harri Hirvonsalo](https://orcid.org/0000-0002-5503-510X)
- [Jan Okraska](https://orcid.org/0000-0002-1416-3244)
- [Leticia Wanderley](https://orcid.org/0000-0003-4649-6630)
- [Lukas Heinrich](https://orcid.org/0000-0002-4048-7584)
- [Marco Donadoni](https://orcid.org/0000-0003-2922-5505)
- [Marco Vidal](https://orcid.org/0000-0002-9363-4971)
- [Michael R. Crusoe](https://orcid.org/0000-0002-2961-9670)
- [Rokas Maciulaitis](https://orcid.org/0000-0003-1064-6967)
- [Sinclert Perez](https://www.linkedin.com/in/sinclert)
- [Tibor Simko](https://orcid.org/0000-0001-7202-5803)
21 changes: 0 additions & 21 deletions AUTHORS.rst

This file was deleted.

187 changes: 187 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,187 @@
# Changelog

## 0.9.2 (2023-12-12)

- Adds automated multi-platform container image building for amd64 and arm64 architectures.
- Adds metadata labels to Dockerfile.
- Changes CVMFS support to allow users to automatically mount any available repository.
- Changes how pagination is performed in order to avoid counting twice the total number of records.
- Changes the workflow deletion endpoint to return a different and more appropriate message when deleting all the runs of a workflow.
- Fixes job status consumer exception while attempting to fetch workflow engine logs for workflows that were not successfully scheduled.
- Fixes runtime uWSGI warning by rebuilding uWSGI with the PCRE support.

## 0.9.1 (2023-09-27)

- Adds the timestamp of when the workflow was stopped (`run_stopped_at`) to the workflow list and the workflow status endpoints.
- Adds PDF files to the list of file types that can be previewed from the web interface.
- Changes the deletion of a workflow to automatically delete an open interactive session attached to its workspace.
- Changes the k8s specification for interactive session pods to include labels for improved subset selection of objects.
- Changes the k8s specification for interactive session ingress resource to include annotations.
- Changes uWSGI configuration to increase buffer size, add vacuum option, etc.
- Fixes job status inconsistency when stopping a workflow by setting the job statuses to `stopped` for any running jobs.
- Fixes job status consumer to correctly rollback the database transaction when an error occurs.
- Fixes uWSGI memory consumption on systems with very high allowed number of open files.
- Fixes uWSGI and `consume-job-queue` command to gracefully stop when being terminated.
- Fixes container image names to be Podman-compatible.

## 0.9.0 (2023-01-19)

- Adds the remote origin of workflows submitted via Launch-on-REANA (`launcher_url`) to the workflow list endpoint.
- Adds support for Kerberos authentication for workflow orchestration.
- Adds the `REANA_WORKSPACE` environment variable to jupyter notebooks and terminals.
- Adds option to sort workflows by most disk and cpu quota usage to the workflow list endpoint.
- Adds support for specifying and listing workspace file retention rules.
- Changes workflow list endpoint to add the possibility to filter by workflow ID.
- Changes the deployment of interactive sessions to use `networking/v1` Kubernetes API.
- Changes default consumer prefetch count to handle 10 messages instead of 200 in order to reduce the probability of 406 PRECONDITION errors on message acknowledgement.
- Changes to Flask v2.
- Changes job status consumer to improve logging for not-alive workflows.
- Changes the deletion of a workflow to also update the user disk quota usage if the workspace is deleted.
- Changes the CWD of jupyter's terminals to the directory of the workflow's workspace.
- Changes the k8s specification of interactive sessions' pods to remove the environment variables used for service discovery.
- Changes GitLab integration to use `reana` as pipeline name instead of `default` when setting status of a commit.
- Changes the deletion of a workflow to always remove the workflow's workspace and to fail if the request is asking not to delete the workspace.
- Changes the `move_files` endpoint to allow moving files while a workflow is running.
- Changes the deployment of interactive sessions to improve security by not automounting the Kubernetes service account token.
- Changes workspace file management commands to use common utility functions present in reana-commons.
- Changes to PostgreSQL 12.13.
- Changes the deployment of job-controller to avoid unnecessarily mounting the database's directory.
- Changes the base image of the component to Ubuntu 20.04 LTS and reduces final Docker image size by removing build-time dependencies.
- Fixes the download of files by changing the default MIME type to `application/octet-stream`.
- Fixes the workflow list endpoint to correctly parse the boolean parameters `include_progress`, `include_workspace_size` and `include_retention_rules`.
- Fixes Kerberos authentication for long-running workflows by renewing the Kerberos ticket periodically.
- Fixes job status consumer by discarding invalid job IDs.

## 0.8.2 (2022-10-06)

- Fixes `delete --include-all-runs` functionality to delete only workflow owner's past runs.

## 0.8.1 (2022-02-07)

- Adds configuration environment variable to set default timeout for user's jobs for the Kubernetes compute backend (`REANA_KUBERNETES_JOBS_TIMEOUT_LIMIT`).
- Adds configuration environment variable to set maximum custom timeout limit that users can assign to their jobs for the Kubernetes compute backend (`REANA_KUBERNETES_JOBS_MAX_USER_TIMEOUT_LIMIT`).

## 0.8.0 (2021-11-22)

- Adds users quota accounting.
- Adds new job properties `started_at` and `finished_at` to the `/logs` endpoint.
- Adds configuration environment variable to limit the number of messages received in the job status consumer (`prefetch_count`).
- Adds file search capabilities to the workflow workspace endpoint.
- Adds Snakemake workflow engine support.
- Adds support for custom workflow workspace path.
- Changes to PostgreSQL 12.8.
- Changes workflow run manager to query the specific workflow engine during pod deletion.
- Fixes workflow list endpoint query logic to improve optimization.

## 0.7.4 (2021-07-05)

- Changes internal dependencies.

## 0.7.3 (2021-04-28)

- Adds configuration environment variable to set job memory limits for the Kubernetes compute backend (`REANA_KUBERNETES_JOBS_MEMORY_LIMIT`).
- Adds configuration environment variable to set maximum custom memory limits that users can assign to their job containers for the Kubernetes compute backend (`REANA_KUBERNETES_JOBS_MAX_USER_MEMORY_LIMIT`).
- Adds support for listing files using glob patterns.
- Adds support for glob patterns and directory downloads, packaging files into a zip.

## 0.7.2 (2021-03-17)

- Adds new configuration to toggle Kubernetes user jobs clean up.
- Fixes `job-status-consumer` exception detection for better resilience.

## 0.7.1 (2021-02-03)

- Fixes minor code warnings.
- Changes CI system to include Python flake8 and Dockerfile hadolint checkers.

## 0.7.0 (2020-10-20)

- Adds possibility to restart workflows.
- Adds exposure of workflow engines logs.
- Adds possibility to pass workflow operational options.
- Adds progress report information on workflow list response.
- Adds code mount on dev mode in workflow engines and job controller.
- Adds preview flag to file download endpoint.
- Fixes deletion of workflows in queued state.
- Fixes CVMFS availability for interactive sessions.
- Fixes jobs status update.
- Fixes response on close interactive session action.
- Changes runtime component creation to use centrally configured namespace from REANA-Commons.
- Changes workflow engine pod labelling for better traceability.
- Changes logs endpoint to provide richer information.
- Changes git clone depth when retrieving GitLab projects.
- Changes REANA submodule installation in editable mode for live code updates for developers.
- Changes base image to use Python 3.8.
- Changes code formatting to respect `black` coding style.
- Changes documentation to single-page layout.

## 0.6.1 (2020-05-25)

- Upgrades REANA-Commons package using latest Kubernetes client version.

## 0.6.0 (2019-12-20)

- Modifies the batch workflow run creation, including an instance of
REANA-Job-Controller running alongside with the workflow engine (sidecar
pattern). Only DB and workflow worksapce are mounted.
- Refactors volume mounts using `reana-commons` base.
- Provides user secrets to the job controller.
- Extends workflow APIs for GitLab integration.
- Allows stream file uploads.

## 0.5.0 (2019-04-23)

- Adds support to create interactive sessions so the workspace can be explored
and modified through a Jupyter notebook.
- Creates workflow engine instances on demand for each user and makes CVMFS
available inside of them.
- Adds new endpoint to compare two workflows. The output is a `git` like
diff which can be configured to show differences at metadata level,
workspace level or both.
- Adds new endpoint to delete workflows including the stopped ones.
- Adds new endpoints to delete and move files whithin the workspace.
The deletion can be also done recursively with a wildcard.
- Adds new endpoint which returns workflow parameters.
- Adds new endpoint to query the disk usage of a given workspace.
- Makes docker image slimmer by using `python:3.6-slim`.
- Centralises log level and log format configuration.

## 0.4.0 (2018-11-06)

- Improves AMQP re-connection handling. Switches from `pika` to `kombu`.
- Improves REST API documentation rendering.
- Changes license to MIT.

## 0.3.2 (2018-09-25)

- Modifies job input identification process for caching purposes, adding compatibility
with CephFS storage volumes.

## 0.3.1 (2018-09-07)

- Harmonises date and time outputs amongst various REST API endpoints.
- Separates workflow parameters and engine parameters when running Serial
workflows.
- Pins REANA-Commons and REANA-DB dependencies.

## 0.3.0 (2018-08-10)

- Adds support for
[Serial workflows](http://reana-workflow-engine-serial.readthedocs.io/en/latest/).
- Tracks progress of workflow runs.
- Adds uwsgi for production deployments.
- Allows downloading of any file from a workflow workspace.

## 0.2.0 (2018-04-19)

- Adds support for Common Workflow Language workflows.
- Adds support for specifying workflow names in REST API requests.
- Adds sequential incrementing of workflow run numbers.
- Adds support for nested inputs and runtime code directory uploads.
- Improves error messages and information.
- Prevents multiple starts of the same workflow.

## 0.1.0 (2018-01-30)

- Initial public release.

Loading
Loading