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.

Sign up for GitHub

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

Jump to bottom

Describe plugin restart policies #286

Merged
merged 3 commits into from
Sep 25, 2023
Merged

Describe plugin restart policies #286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c33760a
Describe plugin restart policies
Sep 25, 2023
d135254
run prettier
Sep 25, 2023
798752b
explain restart policy types
Sep 25, 2023
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
26 changes: 26 additions & 0 deletions docs/configuration/executor/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,32 @@ executors:

For all executor configuration properties, see the [**syntax**](#syntax) section.

#### Restart Policy and Health Check Interval

This section of the configuration allows you to configure the restart policy for the Botkube executor plugins. The restart policy is used when the executor plugin fails to start. The default restart policy is `DeactivatePlugin`, which means that the plugin is deactivated after a given number of restarts. The restart policy can be configured with the following properties:

- `type` - restart policy type. Allowed values: `RestartAgent`, `DeactivatePlugin`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we describe the possible values? One sentence per the value would be enough.
Please apply that to each document.
Thanks!

- `threshold` - number of restarts before the policy takes into effect.

Restart policy types:

- `RestartAgent` - when the threshold is reached, the Botkube agent is restarted.
- `DeactivatePlugin` - when the threshold is reached, the plugin is deactivated. To activate the plugin again, you need to restart the Botkube agent.

The health check interval is used to check the health of the executor plugins. The default health check interval is 10 seconds. The health check interval can be configured with the following property:

- `healthCheckInterval` - health check interval.

```yaml
# -- Botkube Restart Policy on plugin failure.
restartPolicy:
# -- Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin".
type: "DeactivatePlugin"
# -- Number of restarts before policy takes into effect.
threshold: 10
healthCheckInterval: 10s
```

## Syntax

```yaml
Expand Down
26 changes: 26 additions & 0 deletions docs/configuration/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,32 @@ sources:

For all source configuration properties, see the [**syntax**](#syntax) section.

#### Restart Policy and Health Check Interval

This section of the configuration allows you to configure the restart policy for the Botkube source plugins. The restart policy is used when the source plugin fails to start. The default restart policy is `DeactivatePlugin`, which means that the plugin is deactivated after a given number of restarts. The restart policy can be configured with the following properties:

- `type` - restart policy type. Allowed values: `RestartAgent`, `DeactivatePlugin`.
- `threshold` - number of restarts before the policy takes into effect.

Restart policy types:

- `RestartAgent` - when the threshold is reached, the Botkube agent is restarted.
- `DeactivatePlugin` - when the threshold is reached, the plugin is deactivated. To activate the plugin again, you need to restart the Botkube agent.

The health check interval is used to check the health of the source plugins. The default health check interval is 10 seconds. The health check interval can be configured with the following property:

- `healthCheckInterval` - health check interval.

```yaml
# -- Botkube Restart Policy on plugin failure.
restartPolicy:
# -- Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin".
type: "DeactivatePlugin"
# -- Number of restarts before policy takes into effect.
threshold: 10
healthCheckInterval: 10s
```

## Syntax

```yaml
Expand Down
26 changes: 26 additions & 0 deletions versioned_docs/version-1.4/configuration/executor/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,32 @@ executors:

For all executor configuration properties, see the [**syntax**](#syntax) section.

#### Restart Policy and Health Check Interval

This section of the configuration allows you to configure the restart policy for the Botkube executor plugins. The restart policy is used when the executor plugin fails to start. The default restart policy is `DeactivatePlugin`, which means that the plugin is deactivated after a given number of restarts. The restart policy can be configured with the following properties:

- `type` - restart policy type. Allowed values: `RestartAgent`, `DeactivatePlugin`.
- `threshold` - number of restarts before the policy takes into effect.

Restart policy types:

- `RestartAgent` - when the threshold is reached, the Botkube agent is restarted.
- `DeactivatePlugin` - when the threshold is reached, the plugin is deactivated. To activate the plugin again, you need to restart the Botkube agent.

The health check interval is used to check the health of the executor plugins. The default health check interval is 10 seconds. The health check interval can be configured with the following property:

- `healthCheckInterval` - health check interval.

```yaml
# -- Botkube Restart Policy on plugin failure.
restartPolicy:
# -- Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin".
type: "DeactivatePlugin"
# -- Number of restarts before policy takes into effect.
threshold: 10
healthCheckInterval: 10s
```

## Syntax

```yaml
Expand Down
26 changes: 26 additions & 0 deletions versioned_docs/version-1.4/configuration/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,32 @@ sources:

For all source configuration properties, see the [**syntax**](#syntax) section.

#### Restart Policy and Health Check Interval

This section of the configuration allows you to configure the restart policy for the Botkube source plugins. The restart policy is used when the source plugin fails to start. The default restart policy is `DeactivatePlugin`, which means that the plugin is deactivated after a given number of restarts. The restart policy can be configured with the following properties:

- `type` - restart policy type. Allowed values: `RestartAgent`, `DeactivatePlugin`.
- `threshold` - number of restarts before the policy takes into effect.

Restart policy types:

- `RestartAgent` - when the threshold is reached, the Botkube agent is restarted.
- `DeactivatePlugin` - when the threshold is reached, the plugin is deactivated. To activate the plugin again, you need to restart the Botkube agent.

The health check interval is used to check the health of the source plugins. The default health check interval is 10 seconds. The health check interval can be configured with the following property:

- `healthCheckInterval` - health check interval.

```yaml
# -- Botkube Restart Policy on plugin failure.
restartPolicy:
# -- Restart policy type. Allowed values: "RestartAgent", "DeactivatePlugin".
type: "DeactivatePlugin"
# -- Number of restarts before policy takes into effect.
threshold: 10
healthCheckInterval: 10s
```

## Syntax

```yaml
Expand Down