Skip to content

Commit d487ba0

Browse files
committed
feat: update documentation
1 parent c68349c commit d487ba0

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

docs/deployment/provision/provider.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,13 @@ The high-level provisioning mechanism:
129129

130130
Provider configurations can be updated dynamically by changing the YAML files in the `KEEP_PROVIDERS_DIRECTORY` directory.
131131

132-
On every restart, Keep reads the YAML files in the `KEEP_PROVIDERS_DIRECTORY` directory and determines which providers need to be added or removed.
132+
Provider provisioning is done on every restart. It can also be triggered without a restart via the `/providers/provision` endpoint of the API. The user needs `write` permissions on providers.
133+
134+
```
135+
curl -XPOST -u user:password http://localhost:8080/providers/provision
136+
```
137+
138+
Keep reads the YAML files in the `KEEP_PROVIDERS_DIRECTORY` directory and determines which providers need to be added or removed.
133139
134140
The high-level provisioning mechanism:
135141
1. Keep reads the YAML files in the `KEEP_PROVIDERS_DIRECTORY` directory.

docs/deployment/provision/workflow.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,15 @@ Example directory structure:
2222
```
2323
### Update Provisioned Workflows
2424

25-
On every restart, Keep reads the `KEEP_WORKFLOWS_DIRECTORY` environment variable and determines which workflows need to be added, removed, or updated.
25+
You can efficiently add new workflows, remove existing ones, or modify their configurations by simply updating the workflow files in the `KEEP_WORKFLOWS_DIRECTORY`. This process allows for flexible management of workflows without requiring manual intervention.
2626

27-
This process allows for flexible management of workflows without requiring manual intervention. By simply updating the workflow files in the `KEEP_WORKFLOWS_DIRECTORY` and restarting the application, you can efficiently add new workflows, remove existing ones, or modify their configurations.
27+
Workflow provisioning is done on every restart. It can also be triggered without a restart via the `/workflows/provision` endpoint of the API. The user needs `write` permissions on workflows.
28+
29+
```
30+
curl -XPOST -u user:password http://localhost:8080/workflows/provision
31+
```
32+
33+
Keep reads the `KEEP_WORKFLOWS_DIRECTORY` environment variable and determines which workflows need to be added, removed, or updated.
2834

2935
The high-level provisioning mechanism:
3036
1. Keep reads the `KEEP_WORKFLOWS_DIRECTORY` value.

0 commit comments

Comments
 (0)