truefoundry 0.3.0rc8__tar.gz → 0.3.0rc10__tar.gz

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: truefoundry
-Version: 0.3.0rc8
+Version: 0.3.0rc10
 Summary: Truefoundry CLI
 Author: Abhishek Choudhary
 Author-email: abhishek@truefoundry.com
@@ -24,7 +24,7 @@ Requires-Dist: flytekit (==1.12.2) ; extra == "workflow"
 Requires-Dist: gitignorefile (>=1.1.2,<1.2.0)
 Requires-Dist: importlib-metadata (>=6.0.1,<8.0.0)
 Requires-Dist: importlib-resources (>=5.2.0,<6.0.0)
-Requires-Dist: mlfoundry (==0.11.2) ; extra == "ml"
+Requires-Dist: mlfoundry (==0.11.3) ; extra == "ml"
 Requires-Dist: openai (>=1.16.2,<2.0.0)
 Requires-Dist: packaging (>=20.0,<25.0)
 Requires-Dist: pydantic (>=1.10.0,<3)
@@ -34,6 +34,7 @@ Requires-Dist: python-dotenv (>=1.0.1,<1.1.0)
 Requires-Dist: python-socketio[client] (>=5.5.2,<6.0.0)
 Requires-Dist: questionary (>=1.10.0,<2.0.0)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: requirements-parser (>=0.10.2,<0.11.0)
 Requires-Dist: rich (>=13.7.1,<14.0.0)
 Requires-Dist: rich-click (>=1.2.1,<2.0.0)
 Requires-Dist: tqdm (>=4.0.0,<5.0.0)

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "truefoundry"
-version = "0.3.0rc8"
+version = "0.3.0rc10"
 description = "Truefoundry CLI"
 authors = ["Abhishek Choudhary <abhishek@truefoundry.com>"]
 readme = "README.md"
@@ -17,7 +17,7 @@ GitPython = ">=3.1.43,<3.2.0"
 importlib-metadata = ">=6.0.1,<8.0.0"
 importlib-resources = "^5.2.0"
 Mako = "^1.1.6"
-mlfoundry = { version = "0.11.2", optional = true }
+mlfoundry = { version = "0.11.3", optional = true }
 openai = ">=1.16.2,<2.0.0"
 packaging = ">=20.0,<25.0"
 pydantic = ">=1.10.0,<3"
@@ -29,6 +29,7 @@ python-socketio = {version = ">=5.5.2,<6.0.0", extras = ["client"]}
 PyYAML = ">=6.0.0,<7.0.0"
 questionary = ">=1.10.0,<2.0.0"
 requests = ">=2.31.0,<3.0.0"
+requirements-parser = "^0.10.2"
 rich = ">=13.7.1,<14.0.0"
 rich-click = ">=1.2.1,<2.0.0"
 tqdm = ">=4.0.0,<5.0.0"

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/__init__.py

@@ -6,6 +6,7 @@ from truefoundry.deploy.auto_gen.models import (
     Kustomize,
     ParamType,
     Protocol,
+    WorkbenchImage,
 )
 from truefoundry.deploy.lib.dao.application import (
     delete_application,
@@ -15,6 +16,7 @@ from truefoundry.deploy.lib.dao.application import (
     list_job_runs,
     terminate_job_run,
     trigger_job,
+    trigger_workflow,
 )
 from truefoundry.deploy.lib.dao.version import (
     get_version as get_application_version,
@@ -56,14 +58,10 @@ from truefoundry.deploy.v2.lib.patched_models import (
     BlueGreen,
     Build,
     Canary,
-    CodeserverImage,
     CoreNATSOutputConfig,
     CPUUtilizationMetric,
     CronMetric,
     CUDAVersion,
-    CustomCodeserverImage,
-    CustomNotebookImage,
-    CustomSSHServerImage,
     DockerFileBuild,
     DynamicVolumeConfig,
     Endpoint,
@@ -104,15 +102,10 @@ from truefoundry.deploy.v2.lib.patched_models import (
     SQSInputConfig,
     SQSOutputConfig,
     SQSQueueMetricConfig,
-    SSHServerImage,
     StaticVolumeConfig,
     StringDataMount,
     TPUType,
     TruefoundryArtifactSource,
-    TruefoundryImageBase,
-    TruefoundryImageCuda1180,
-    TruefoundryImageCuda1211,
-    TruefoundryImageFull,
     VolumeBrowser,
     VolumeMount,
     WorkerConfig,

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/auto_gen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2024-07-24T13:42:02+00:00
+#   timestamp: 2024-08-09T07:42:58+00:00
 
 from __future__ import annotations
 
@@ -125,6 +125,13 @@ class AsyncProcessorSidecar(BaseModel):
     )
 
 
+class Autoshutdown(BaseModel):
+    wait_time: conint(ge=0) = Field(
+        300,
+        description="+label=Wait Time\n+usage=The period to wait after the last received request before scaling the replicas to 0",
+    )
+
+
 class BaseAutoscaling(BaseModel):
     min_replicas: conint(ge=0) = Field(
         1,
@@ -138,10 +145,6 @@ class BaseAutoscaling(BaseModel):
         30,
         description="+label=Polling Interval\n+usage=This is the interval to check each trigger on.",
     )
-    cooldown_period: conint(ge=0) = Field(
-        300,
-        description="+label=Cooldown Period\n+usage=The period to wait after the last trigger reported active before scaling the resource back to 0.",
-    )
 
 
 class BasicAuthCreds(BaseModel):
@@ -197,26 +200,6 @@ class CanaryStep(BaseModel):
     )
 
 
-class CodeserverImage(BaseModel):
-    """
-    +usage=Codeserver with persistent environment (Python 3.11.6)
-    """
-
-    type: constr(regex=r"^codeserver$") = Field(..., description="+value=codeserver")
-    enable_sudo: bool = Field(
-        True,
-        description="+label=Enable root access to the container\n+usage=Changes made to the root directory `/` will not be persisted across notebook restarts",
-    )
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
 class CronMetric(BaseModel):
     type: Literal["cron"] = Field(..., description="+value=cron")
     desired_replicas: Optional[conint(ge=1)] = Field(
@@ -237,60 +220,6 @@ class CronMetric(BaseModel):
     )
 
 
-class CustomCodeserverImage(BaseModel):
-    """
-    +usage=User supplied docker image URI for vscode server
-    """
-
-    type: constr(regex=r"^customcodeserver$") = Field(
-        ..., description="+value=customcodeserver"
-    )
-    image_uri: str = Field(
-        ...,
-        description="+label=Image URI\n+usage=The image URI. Specify the name of the image and the tag.\nIf the image is in Dockerhub, you can skip registry-url (for e.g. `tensorflow/tensorflow`).\nYou can use an image from a private registry using Advanced fields\n+placeholder=registry-url/account/image:version",
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
-class CustomNotebookImage(BaseModel):
-    """
-    +usage=User supplied docker image URI for jupyter notebook
-    """
-
-    type: constr(regex=r"^customnotebook$") = Field(
-        ..., description="+value=customnotebook"
-    )
-    image_uri: str = Field(
-        ...,
-        description="+label=Image URI\n+usage=The image URI. Specify the name of the image and the tag.\nIf the image is in Dockerhub, you can skip registry-url (for e.g. `tensorflow/tensorflow`).\nYou can use an image from a private registry using Advanced fields\n+placeholder=registry-url/account/image:version",
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
-class CustomSSHServerImage(BaseModel):
-    """
-    +usage=User supplied docker image URI for ssh server
-    """
-
-    type: constr(regex=r"^custom-ssh-server$") = Field(
-        ..., description="+value=custom-ssh-server"
-    )
-    image_uri: str = Field(
-        ...,
-        description="+label=Image URI\n+usage=The image URI. Specify the name of the image and the tag.\nIf the image is in Dockerhub, you can skip registry-url (for e.g. `tensorflow/tensorflow`).\nYou can use an image from a private registry using Advanced fields\n+placeholder=registry-url/account/image:version",
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
 class DockerFileBuild(BaseModel):
     """
     +docs=Describes that we are using a dockerfile to build our image
@@ -976,22 +905,6 @@ class SQSQueueMetricConfig(BaseModel):
     )
 
 
-class SSHServerImage(BaseModel):
-    """
-    +usage=Ssh Server with persistent environment (Python 3.11.6)
-    """
-
-    type: constr(regex=r"^ssh-server$") = Field(..., description="+value=ssh-server")
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
 class ConcurrencyPolicy(str, Enum):
     """
     +usage=Choose whether to allow this job to run while another instance of the job is running, or to replace the currently running instance. Allow
@@ -1149,86 +1062,6 @@ class TruefoundryArtifactSource(BaseModel):
     )
 
 
-class TruefoundryImageBase(BaseModel):
-    """
-    +usage=JupyterLab with persistent python environment (Python 3.11.6)
-    """
-
-    type: constr(regex=r"^truefoundrybase$") = Field(
-        ..., description="+value=truefoundrybase"
-    )
-    enable_sudo: bool = Field(
-        True,
-        description="+label=Enable root access to the container\n+usage=Changes made to the root directory `/` will not be persisted across notebook restarts",
-    )
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
-class TruefoundryImageCuda1180(BaseModel):
-    """
-    +usage=JupyterLab with persistent python environment (Python 3.11.6, Cuda 11.8.0)
-    """
-
-    type: constr(regex=r"^truefoundrycuda1180$") = Field(
-        ..., description="+value=truefoundrycuda1180"
-    )
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
-class TruefoundryImageCuda1211(BaseModel):
-    """
-    +usage=JupyterLab with persistent python environment (Python 3.11.6, Cuda 12.1.1)
-    """
-
-    type: constr(regex=r"^truefoundrycuda1211$") = Field(
-        ..., description="+value=truefoundrycuda1211"
-    )
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
-class TruefoundryImageFull(BaseModel):
-    """
-    +usage=JupyterLab + Tensorflow 2.15.0 and Pytorch 2.1.1 with persistent environment (Python 3.11.6)
-    """
-
-    type: constr(regex=r"^truefoundryfull$") = Field(
-        ..., description="+value=truefoundryfull"
-    )
-    enable_sudo: bool = Field(
-        True,
-        description="+label=Enable root access to the container\n+usage=Changes made to the root directory `/` will not be persisted across notebook restarts",
-    )
-    apt_packages: Optional[List[str]] = Field(
-        None,
-        description='+label=List of Debian packages to install.\n+usage=Debian packages to install via `apt get`.\nIn Python/YAML E.g. ["git", "ffmpeg", "htop"]\n+placeholder=Enter a debian package name E.g. ffmpeg',
-    )
-    docker_registry: Optional[str] = Field(
-        None,
-        description="+docs=FQN of the container registry. You can use the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
-    )
-
-
 class VolumeBrowser(BaseModel):
     """
     +label=Volume Browser
@@ -1265,6 +1098,25 @@ class VolumeMount(BaseModel):
     )
 
 
+class WorkbenchImage(BaseModel):
+    """
+    +usage=Workbench Image with persistent environment (Python 3.11.6)
+    """
+
+    image_uri: str = Field(
+        ...,
+        description="+label=Image URI\n+usage=The image URI. Specify the name of the image and the tag.\nIf the image is in Dockerhub, you can skip registry-url (for e.g. `tensorflow/tensorflow`).\nYou can use an image from a private registry using Advanced fields\n+placeholder=registry-url/account/image:version",
+    )
+    build_script: Optional[constr(min_length=1, max_length=1024)] = Field(
+        None,
+        description="+label=Build Script\n+usage=The build script to run when building the image.\nThis will be executed as the last step in the docker build process as the root user (RUN DEBIAN_FRONTEND=noninteractive bash -ex build_script.sh)\n+placeholder=Enter the build script",
+    )
+    docker_registry: Optional[str] = Field(
+        None,
+        description="+docs=FQN of the container registry. You can the FQN of your desired container registry (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations?tab=docker-registry) page\n+label=Docker Registry\n+usage=FQN of the container registry. If you can't find your registry here,\nadd it through the [Integrations](/integrations?tab=docker-registry) page",
+    )
+
+
 class ArtifactsDownload(BaseModel):
     """
     +docs=Describes the configuration for the artifacts cache
@@ -1365,9 +1217,7 @@ class Codeserver(BaseWorkbenchInput):
     """
 
     type: constr(regex=r"^codeserver$") = Field(..., description="+value=Code Server")
-    image: Union[CodeserverImage, CustomCodeserverImage] = Field(
-        ..., description="+usage=Pick a codeserver image to deploy\n+sort=2"
-    )
+    image: WorkbenchImage
     auth: Optional[BasicAuthCreds] = None
 
 
@@ -1627,16 +1477,7 @@ class Notebook(BaseWorkbenchInput):
     """
 
     type: constr(regex=r"^notebook$") = Field(..., description="+value=notebook")
-    image: Union[
-        TruefoundryImageBase,
-        TruefoundryImageFull,
-        CustomNotebookImage,
-        TruefoundryImageCuda1180,
-        TruefoundryImageCuda1211,
-    ] = Field(
-        ...,
-        description="+usage=Changes made to the root directory `/` will not be persisted across notebook restarts\n+sort=2",
-    )
+    image: WorkbenchImage
     auth: Optional[BasicAuthCreds] = None
     cull_timeout: conint(ge=5) = Field(
         30,
@@ -1672,9 +1513,7 @@ class SSHServer(BaseWorkbenchInput):
     """
 
     type: constr(regex=r"^ssh-server$") = Field(..., description="+value=SSH Server")
-    image: Union[SSHServerImage, CustomSSHServerImage] = Field(
-        ..., description="+usage=Pick a ssh server image to deploy\n+sort=2"
-    )
+    image: WorkbenchImage
     ssh_public_key: str = Field(
         ...,
         description="+label: SSH Public Key\n+usage=Add Your SSH Public Key, this will be used to authenticate you to the SSH Server. You can find it using `cat ~/.ssh/id_rsa.pub`\n+sort=4",
@@ -1776,6 +1615,7 @@ class Service(BaseService):
         1,
         description="+label=Replicas\n+usage=Deploy multiple instances of your pods to distribute incoming traffic across them, ensuring effective load balancing.\n+icon=fa-clone\n+sort=4",
     )
+    auto_shutdown: Optional[Autoshutdown] = None
     allow_interception: bool = Field(
         False,
         description="+label=Allow intercepts\n+usage=Whether to allow intercepts to be applied for this service.\nThis would inject an additional sidecar in each pod of the service. Not recommended on production",

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/builder/__init__.py

@@ -10,19 +10,17 @@ from truefoundry.deploy.builder.builders import get_builder
 from truefoundry.deploy.builder.builders.tfy_notebook_buildpack.dockerfile_template import (
     NotebookImageBuild,
 )
-from truefoundry.pydantic_v1 import BaseModel
+from truefoundry.pydantic_v1 import BaseModel, Field
 
 
 class _BuildConfig(BaseModel):
-    # I cannot use Field(discriminator="build_config_type") here as
-    # build_config_type in the build configs is not a Literal.
     __root__: Union[
         DockerFileBuild,
         PythonBuild,
         NotebookImageBuild,
         TaskPythonBuild,
         TaskDockerFileBuild,
-    ]
+    ] = Field(discriminator="type")
 
 
 def build(

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/builder/builders/tfy_notebook_buildpack/__init__.py

@@ -13,18 +13,19 @@ __all__ = ["generate_dockerfile_content", "build"]
 
 
 def _convert_to_dockerfile_build_config(
-    build_configuration: NotebookImageBuild,
-    dockerfile_path: str,
+    build_configuration: NotebookImageBuild, local_dir: str
 ) -> DockerFileBuild:
     dockerfile_content = generate_dockerfile_content(
-        build_configuration=build_configuration
+        build_configuration=build_configuration,
+        local_dir=local_dir,
     )
+    dockerfile_path = os.path.join(local_dir, "Dockerfile")
     with open(dockerfile_path, "w", encoding="utf8") as fp:
         fp.write(dockerfile_content)
-
     return DockerFileBuild(
         type="dockerfile",
         dockerfile_path=dockerfile_path,
+        build_context_path=local_dir,
     )
 
 
@@ -35,7 +36,8 @@ def build(
 ):
     with TemporaryDirectory() as local_dir:
         docker_build_configuration = _convert_to_dockerfile_build_config(
-            build_configuration, dockerfile_path=os.path.join(local_dir, "Dockerfile")
+            build_configuration,
+            local_dir=local_dir,
         )
         dockerfile.build(
             tag=tag,

truefoundry-0.3.0rc10/truefoundry/deploy/builder/builders/tfy_notebook_buildpack/dockerfile_template.py

@@ -0,0 +1,66 @@
+import hashlib
+import os
+from typing import Literal, Optional
+
+from mako.template import Template
+
+from truefoundry.pydantic_v1 import BaseModel
+
+
+class NotebookImageBuild(BaseModel):
+    type: Literal["tfy-notebook-buildpack"] = "tfy-notebook-buildpack"
+    base_image_uri: str
+    build_script: Optional[str] = None
+
+
+DOCKERFILE_TEMPLATE = Template(
+    """
+FROM ${base_image_uri}
+USER root
+
+% if build_script_docker_commands is not None:
+${build_script_docker_commands}
+% endif
+
+USER $NB_UID
+"""
+)
+
+
+def generate_build_script_docker_commands(
+    build_script: Optional[str], local_dir: str
+) -> Optional[str]:
+    if not build_script:
+        return None
+    build_script_path = None
+    if build_script:
+        # we add build script's hash to the file name to ensure docker cache invalidation
+        script_hash = hashlib.sha256(build_script.encode("utf-8")).hexdigest()
+        build_script_path = os.path.join(local_dir, f"build-script-{script_hash}.sh")
+        with open(build_script_path, "w") as fp:
+            fp.write(build_script)
+        build_script_path = os.path.relpath(build_script_path, local_dir)
+    run_build_script_command = f"""\
+COPY {build_script_path} /tmp/user-build-script.sh
+RUN mkdir -p /var/log/ && DEBIAN_FRONTEND=noninteractive bash -ex /tmp/user-build-script.sh 2>&1 | tee /var/log/user-build-script-output.log
+"""
+    return run_build_script_command
+
+
+def generate_dockerfile_content(
+    build_configuration: NotebookImageBuild, local_dir: str
+) -> str:
+    build_script_docker_commands = generate_build_script_docker_commands(
+        build_script=build_configuration.build_script,
+        local_dir=local_dir,
+    )
+
+    template_args = {
+        "base_image_uri": build_configuration.base_image_uri,
+        "build_script_docker_commands": build_script_docker_commands,
+    }
+
+    template = DOCKERFILE_TEMPLATE
+
+    dockerfile_content = template.render(**template_args)
+    return dockerfile_content

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/cli/cli.py

@@ -13,6 +13,7 @@ from truefoundry.deploy.cli.commands import (
     get_logout_command,
     get_patch_application_command,
     get_patch_command,
+    get_trigger_command,
 )
 from truefoundry.deploy.cli.config import CliConfig
 from truefoundry.deploy.cli.const import GROUP_CLS
@@ -36,6 +37,7 @@ def create_truefoundry_cli():
     cli.add_command(get_deploy_command())
     cli.add_command(get_patch_application_command())
     cli.add_command(get_delete_command())
+    cli.add_command(get_trigger_command())
 
     if not (sys.platform.startswith("win32") or sys.platform.startswith("cygwin")):
         cli.add_command(get_patch_command())

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/cli/commands/trigger_command.py

@@ -82,6 +82,64 @@ def trigger_job(application_fqn: str, command: Optional[Sequence[str]], params):
     )
 
 
+@click.command(
+    name="workflow",
+    cls=COMMAND_CLS,
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
+)
+@click.option(
+    "--application-fqn",
+    "--application_fqn",
+    type=click.STRING,
+    required=True,
+    help="FQN of the workflow application",
+)
+@click.argument(
+    "inputs",
+    type=click.STRING,
+    nargs=-1,
+    required=False,
+)
+@handle_exception_wrapper
+def trigger_workflow(application_fqn: str, inputs):
+    """
+    Trigger a Workflow on TrueFoundry
+
+        [b]tfy trigger workflow --application-fqn "my-cluster:my-workspace:my-workflow"[/]
+
+    \n
+    Additionally, you can pass inputs (if defined in the workflow)\n\n
+
+    Passing inputs:
+
+        [b]tfy trigger workflow --application-fqn "my-cluster:my-workspace:my-workflow" -- --input1_name input1_value --input2_name input2_value ...[/]
+    """
+    if inputs:
+        inputs_dict = {}
+        if len(inputs) % 2 != 0:
+            raise ClickException(
+                f"Found odd number of argument pairs: {inputs}. "
+                "Perhaps you forgot to pass a value for one of the inputs? "
+                "inputs for workflow should be passed in the "
+                "format `--input1_name input1_value --input2_name input2_value ...`"
+            )
+        for i in range(0, len(inputs), 2):
+            key = inputs[i]
+            value = inputs[i + 1]
+            if not key.startswith("--"):
+                raise ClickException(
+                    f"Got ambiguous argument {key!r} in inputs: {inputs}. "
+                    f"input names should be prefixed with '--' i.e. "
+                    "inputs for workflow should be passed in the "
+                    "format `--input1_name input1_value --input2_name input2_value ...`"
+                )
+            key = key.lstrip("-")
+            inputs_dict[key] = value
+
+    application.trigger_workflow(application_fqn=application_fqn, inputs=inputs)
+
+
 def get_trigger_command():
     trigger_command.add_command(trigger_job)
+    trigger_command.add_command(trigger_workflow)
     return trigger_command

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/lib/clients/servicefoundry_client.py

@@ -616,6 +616,12 @@ class ServiceFoundryServiceClient:
         response = request_handling(res)
         return TriggerJobResult.parse_obj(response)
 
+    def trigger_workflow(self, application_id: str, inputs: Dict[str, Any]):
+        url = f"{self._api_server_url}/{VERSION_PREFIX}/workflow/{application_id}/executions"
+        res = requests.post(url, json=inputs, headers=self._get_header())
+        response = request_handling(res)
+        return response
+
     @check_min_cli_version
     def get_docker_registry_creds(
         self, docker_registry_fqn: str, cluster_id: str

{truefoundry-0.3.0rc8 → truefoundry-0.3.0rc10}/truefoundry/deploy/lib/dao/application.py

@@ -241,3 +241,23 @@ def terminate_job_run(
         job_run_name=job_run_name,
     )
     return response
+
+
+def trigger_workflow(application_fqn: str, inputs: Optional[Dict[str, Any]] = None):
+    inputs = inputs or {}
+    client = ServiceFoundryServiceClient()
+    _application_info = client.get_application_info_by_fqn(
+        application_fqn=application_fqn
+    )
+    application_info = client.get_application_info(
+        application_id=_application_info.applicationId
+    )
+    client.trigger_workflow(
+        application_id=application_info.id,
+        inputs=inputs,
+    )
+    logger.info(f"Started Execution for Workflow: {application_info.name}")
+    executions_page = (
+        f"{client.base_url.strip('/')}/deployments/{application_info.id}?tab=executions"
+    )
+    logger.info(f"You can check the executions at {executions_page}")