Skip to content

Commit

Permalink
Correction in Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samuchila committed Dec 4, 2023
1 parent e959374 commit f79848f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ PREvant calls this function with the app name (see `appName`) and an array of se
| `files` | A map of key and value containing the files that will be mounted into the container. |

## Persistence Hooks
Persistence Hooks in PREvant are designed to handle data persistence by managing volume paths of services. For example, you can use a Persistence Hook to dynamically adjust persistence paths for data backups. Based on the
Persistence Hooks in PREvant are designed to handle data persistence by managing volume paths of services. For example, you can use a Persistence Hook to configure any services that share a persistence path or add missing additional paths that caters to unreleased features.

Like Deployment Hooks, these hooks are Javascript files that provide functions to manage and manipulate persistence settings. This configuration snippet enables the _persistence hook_ that will be used to modify the services' configurations.

Expand All @@ -250,7 +250,7 @@ function persistenceHook(appName, serviceConfigs) {
//Return Array of an Array of pairs of service name and path.
}
```
Note: The input to thePersistence Hook is an array of name and path pairs. If multiple paths are declared in the configuration, they are split and treated as separate pairs.
Note: The input to the Persistence Hook is an array of name and path pairs. If multiple paths are declared in the configuration, they are split and treated as separate pairs.

PREvant will invoke this function with an array of service config with name and path as fields. This input can be modified according to the required persistence logic and must be returned by the function in an Array of Arrays format. The output structure allows for grouping shared paths or treating them as individual, based on the deployment's specific requirements.

Expand Down

0 comments on commit f79848f

Please sign in to comment.