Add sandbox plugin

 * Add missing tmux plugin docstring

Author: md-mq

cli/polyaxon/_flow/plugins/__init__.py

@@ -21,6 +21,7 @@ class V1Plugins(BaseSchemaModel):
         docker: bool, optional, default: False
         shm: bool, optional, default: True
         tmux: bool, optional, default: False
+        sandbox: bool, optional, default: False
         mount_artifacts_store: bool, optional, default: True
         collect_artifacts: bool, optional, default: True
         collect_logs: bool, optional, default: True
@@ -39,6 +40,7 @@ class V1Plugins(BaseSchemaModel):
     >>>   docker:
     >>>   shm:
     >>>   tmux:
+    >>>   sandbox:
     >>>   mountArtifactsStore:
     >>>   collectArtifacts:
     >>>   collectLogs:
@@ -59,6 +61,7 @@ class V1Plugins(BaseSchemaModel):
     >>>     docker=True,
     >>>     shm=True,
     >>>     tmux=True,
+    >>>     sandbox=True,
     >>>     mount_artifacts_store=True,
     >>>     collect_artifacts=False,
     >>>     collect_logs=False,
@@ -133,6 +136,36 @@ class V1Plugins(BaseSchemaModel):
     >>>   shm: false
     ```
 
+    ### tmux
+
+    <blockquote class="light">This plugin is disabled by default.</blockquote>
+
+    This plugin ships a statically-linked `tmux` into the user container so
+    that the in-cluster shell session opened by `polyaxon ops shell` can attach
+    to a persistent terminal. Without it, `shell` falls back to `/bin/bash` and
+    the session ends as soon as the websocket disconnects.
+
+    To enable this plugin:
+
+    ```yaml
+    >>> plugins:
+    >>>   tmux: true
+    ```
+
+    ### sandbox
+
+    <blockquote class="light">This plugin is disabled by default.</blockquote>
+
+    This plugin enables the sandbox daemon for programmatic exec, filesystem,
+    and PTY access from SDKs, agents, and UIs.
+
+    To enable this plugin:
+
+    ```yaml
+    >>> plugins:
+    >>>   sandbox: true
+    ```
+
     ### mountArtifactsStore
 
     <blockquote class="light">This plugin is disabled by default.</blockquote>
@@ -270,6 +303,7 @@ class V1Plugins(BaseSchemaModel):
     docker: Optional[BoolOrRef] = None
     shm: Optional[BoolOrRef] = None
     tmux: Optional[BoolOrRef] = None
+    sandbox: Optional[BoolOrRef] = None
     mount_artifacts_store: Optional[BoolOrRef] = Field(
         alias="mountArtifactsStore", default=None
     )
@@ -306,6 +340,7 @@ def get_or_create(
         config.set_auto_resume()
         config.set_external_host()
         config.set_tmux()
+        config.set_sandbox()
         return config
 
     @staticmethod
@@ -375,3 +410,7 @@ def set_external_host(self, default: bool = False):
     def set_tmux(self, default: bool = False):
         if self.tmux is None:
             self.tmux = default
+
+    def set_sandbox(self, default: bool = False):
+        if self.sandbox is None:
+            self.sandbox = default

cli/tests/test_polyflow/test_plugins/test_plugins.py

@@ -2,7 +2,7 @@
 
 from clipped.utils.assertions import assert_equal_dict
 
-from polyaxon._flow import V1CompiledOperation, V1Plugins, V1RunKind
+from polyaxon.schemas import V1CompiledOperation, V1Plugins, V1RunKind
 from polyaxon._polyaxonfile.specs import kinds
 from polyaxon._utils.test_utils import BaseTestCase
 
@@ -46,6 +46,11 @@ def test_plugins_config(self):
         config = V1Plugins.from_dict(config_dict)
         assert_equal_dict(config_dict, config.to_dict())
 
+        # Add sandbox bool
+        config_dict["sandbox"] = True
+        config = V1Plugins.from_dict(config_dict)
+        assert_equal_dict(config_dict, config.to_dict())
+
         # Add notifications
         config_dict["notifications"] = [
             {"connections": ["test1"], "trigger": "succeeded"},
@@ -66,6 +71,17 @@ def test_plugins_tmux_config(self):
         assert_equal_dict(config_dict, config.to_dict())
         assert config.tmux is False
 
+    def test_plugins_sandbox_config(self):
+        config_dict = {"sandbox": True}
+        config = V1Plugins.from_dict(config_dict)
+        assert_equal_dict(config_dict, config.to_dict())
+        assert config.sandbox is True
+
+        config_dict = {"sandbox": False}
+        config = V1Plugins.from_dict(config_dict)
+        assert_equal_dict(config_dict, config.to_dict())
+        assert config.sandbox is False
+
     def test_get_from_spec(self):
         compiled_operation = V1CompiledOperation.read(
             {
@@ -79,6 +95,7 @@ def test_get_from_spec(self):
                     "collectArtifacts": False,
                     "syncStatuses": False,
                     "externalHost": True,
+                    "sandbox": True,
                 },
                 "run": {"kind": V1RunKind.JOB, "container": {"image": "test"}},
             }
@@ -94,6 +111,7 @@ def test_get_from_spec(self):
         assert plugins.sync_statuses is False
         assert plugins.external_host is True
         assert plugins.tmux is False
+        assert plugins.sandbox is True
 
     def test_read_keys_from_env(self):
         spec = V1Plugins(
@@ -106,6 +124,7 @@ def test_read_keys_from_env(self):
             sync_statuses=True,
             external_host=True,
             tmux=True,
+            sandbox=True,
         )
         spec = V1Plugins.get_or_create(spec)
         assert spec.auth is True
@@ -117,6 +136,7 @@ def test_read_keys_from_env(self):
         assert spec.sync_statuses is True
         assert spec.external_host is True
         assert spec.tmux is True
+        assert spec.sandbox is True
 
     def test_get_from_empty_env(self):
         spec = V1Plugins()
@@ -130,6 +150,7 @@ def test_get_from_empty_env(self):
         assert spec.sync_statuses is True
         assert spec.external_host is False
         assert spec.tmux is False
+        assert spec.sandbox is False
 
         spec = V1Plugins()
         spec = V1Plugins.get_or_create(spec)
@@ -142,3 +163,4 @@ def test_get_from_empty_env(self):
         assert spec.sync_statuses is True
         assert spec.external_host is False
         assert spec.tmux is False
+        assert spec.sandbox is False