Skip to content

Commit

Permalink
changelog: new conduit field (#162)
Browse files Browse the repository at this point in the history
* changelog: new conduit field

* fix typo

* s/field/flag
  • Loading branch information
raulb authored Oct 15, 2024
1 parent b8f1ed2 commit 8b86595
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions changelog/2024-10-15-pipelines-exit-on-degraded.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
slug: '2024-10-15-pipelines-exit-on-degraded'
title: New pipelines.exit-on-degraded flag
draft: false
tags: [conduit, deprecate]
---

In this [latest release (Conduit 0.12)](/changelog/2024-10-10-conduit-0-12-0-release.md), we introduced a new flag named `pipelines.exit-on-degraded` that allows Conduit to exit if a pipeline enters a degraded state, while deprecating `pipelines.exit-on-error`. This change provides a more accurate description of the functionality.

<!--truncate-->

After Conduit 0.12, if you ran `conduit --help` in your terminal, you should see the new flag:

```bash
$ conduit --help
...
-pipelines.exit-on-degraded:
exit Conduit if a pipeline enters a degraded state
...
```
If you were using a [Conduit Configuration file](/docs/features/configuration) this should look like:
```yaml title="conduit.yaml"
# ...
pipelines:
exit-on-degraded: true
# ...
```
Previously, this functionality was handled by `pipelines.exit-on-error`. However, with the introduction of [Pipeline Recovery](/docs/features/pipeline-recovery), the old description no longer accurately reflected the behavior, as a pipeline may not necessarily exit even in the presence of an error.
:::warning
The previous flag `pipelines.exit-on-error` will still be valid but is now hidden. We encourage all users to transition to `pipelines.exit-on-degraded` for improved clarity and functionality.
Please note that `pipelines.exit-on-error` will eventually be removed in a future release.
:::
To ensure optimal performance and clarity in your configurations, please start using `pipelines.exit-on-degraded` in your configuration moving forward. If you have any questions, feel free to join our [Discord Community](https://discord.meroxa.com/).

0 comments on commit 8b86595

Please sign in to comment.