document baking actions into the robusta-runner image (robusta-dev#947)

docs/configuration/defining-playbooks/external-playbook-repositories.rst

@@ -25,8 +25,8 @@ Use HTTPs to load actions:
       # add playbooks from https://github.com/robusta-dev/robusta-chaos
       my_extra_playbooks:
         url: "https://github.com/robusta-dev/robusta-chaos.git"
-        # optional
-        # branch: some_branch
+        # branch: some_branch    # optional: which git branch to install from
+        # pip_install: True      # optional: load this playbook's dependencies (default True)
 
 Loading Actions from Private Git Repos
 -----------------------------------------
@@ -42,8 +42,8 @@ This method works for public repos too:
       my_extra_playbooks:
         url: "git@github.com:robusta-dev/robusta-chaos.git"
         key: LS0tLS1CRUdJTiBPUEVOU1NIIFBSSVZBVEUgS0VZLS0tL
-        # optional
-        # branch: some_branch
+        # branch: some_branch    # optional: which git branch to install from
+        # pip_install: True      # optional: load this playbook's dependencies (default True)
 
 
 The ``key`` parameter must contain a ``base64`` encoded deployment key with ``read`` access.
@@ -77,5 +77,26 @@ Then reference it using an environment variable:
       my_extra_playbooks:
         url: "git@github.com:robusta-dev/robusta-chaos.git"
         key: "{{env.GITHUB_SSH_KEY}}"
-        # optional
-        # branch: some_branch
+
+Baking Actions into a Custom Image
+--------------------------------------
+
+By default, Robusta loads custom actions at runtime. You can also bake custom actions into Robusta at build time. To do so:
+
+1. Create a custom image that inherits from the robusta-runner image. Copy your actions into the image and install them into site-packages with all dependencies.
+
+.. code-block::
+
+    COPY my_playbooks/ /etc/robusta/playbooks/my_playbooks
+    RUN python3 -m pip install --no-cache-dir /etc/robusta/playbooks/my_playbooks
+
+2. Load your actions with a ``file:///`` url and ``pip_install: False``.
+
+.. code-block:: yaml
+
+    playbookRepos:
+      my_extra_playbooks:
+        url: "file:///etc/robusta/playbooks/my_playbooks"
+        pip_install: False
+
+3. Configure Robusta's Helm value to use your custom image.