improve docs

robusta-dev · Jul 9, 2024 · c012a87 · c012a87
1 parent 255337b
commit c012a87
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/docs/playbook-reference/defining-playbooks/external-playbook-repositories.rst b/docs/playbook-reference/defining-playbooks/external-playbook-repositories.rst
@@ -129,7 +129,13 @@ either .tar, .tar.gz, .tgz, .tar.bz2, or .tbz2.
         url: "https://my-domain.com/bla/web-playbooks.tgz"
         http_headers: # optional, may be used for auth
           Authorization: Bearer XXXYYY
-        # pip_install: True      # optional: load this playbook's dependencies (default True)
+        # pip_install: true      # optional: load this playbook's dependencies (default True)
+        # build_isolation: false
+
+Note that the `http_headers` option is only available for this method of loading actions. Also,
+the `build_isolation` is optional (defaults to `true`). If specified as `false`, the `pip`
+install command for the package being installed will be run with `--no-build-isolation` (see
+https://pip.pypa.io/en/stable/cli/pip_install/#cmdoption-no-build-isolation for details).
 
 Handling Secrets
 *******************

diff --git a/src/robusta/core/model/runner_config.py b/src/robusta/core/model/runner_config.py
@@ -37,7 +37,7 @@ class PlaybookRepo(BaseModel):
     branch: Optional[str] = None  # when url is a git repo
     pip_install: bool = True  # Set to False, if the playbooks package is already in site-packages.
     http_headers: Optional[Dict[str, str]] = None
-    build_isolation: Optional[bool] = False
+    build_isolation: bool = False
 
     @root_validator
     def validate_pip_build_isolation(cls, values: Dict) -> Dict: