Skip to content

Commit 2e2b7e9

Browse files
committed
add st2.packs.volumes caveats similar to those documented in #118
1 parent 0f1c9c3 commit 2e2b7e9

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,23 @@ Or, for example, to use NFS:
286286
path: /var/nfsshare/configs
287287
```
288288

289+
#### Caveat: Mounting and copying packs
290+
If you use something like NFS where you can mount the shares outside of the StackStorm pods, there are a couple of things to keep in mind.
291+
292+
Though you could manually copy packs into the `packs` shared volume, be aware that StackStorm does not automatically register any changed content.
293+
So, if you manually copy a pack into the `packs` shared volume, then you also need to trigger updating the virtualenv and registering the content,
294+
possibly using APIs like:
295+
[packs/install](https://api.stackstorm.com/api/v1/packs/#/packs_controller.install.post), and
296+
[packs/register](https://api.stackstorm.com/api/v1/packs/#/packs_controller.register.post)
297+
You will have to repeat the process each time the packs code is modified.
298+
299+
#### Caveat: System packs
300+
After Helm installs, upgrades, or rolls back a StackStorm install, it runs an `st2-register-content` batch job.
301+
This job will copy and register system packs. If you have made any changes (like disabling default aliases), those changes will be overwritten.
302+
303+
NOTE: Upgrades will not remove files (such as a renamed or removed action) if they were removed in newer StackStorm versions.
304+
This mirrors the how pack registration works. Make sure to review any upgrade notes and manually handle any removals.
305+
289306
## Tips & Tricks
290307
Grab all logs for entire StackStorm cluster with dependent services in Helm release:
291308
```

0 commit comments

Comments
 (0)