truefoundry 0.4.3__py3-none-any.whl → 0.4.4__py3-none-any.whl

truefoundry/deploy/auto_gen/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  application.json
-#   timestamp: 2024-10-09T13:00:44+00:00
+#   timestamp: 2024-10-16T17:06:03+00:00
 
 from __future__ import annotations
 
@@ -362,13 +362,17 @@ class HelmRepo(BaseModel):
         ...,
         description="+label=Helm repository URL\n+sort=1\n+message=Needs to be a valid URL.",
     )
+    integration_fqn: Optional[str] = Field(
+        None,
+        description='+docs=FQN of the helm repo integration. You can use the FQN of your desired helm integration (or add one)\nin the  Integrations page[Integrations](https://app.truefoundry.tech/integrations) page\n+label=Helm repo integration\n+sort=2\n+usage=FQN of the helm repo integration. If you can\'t find your integration here,\nadd it through the [Integrations](/integrations) page\n+uiType=IntegrationSelect\n+uiProps={"integrationType":"helm-repo"}',
+    )
     chart: str = Field(
         ...,
-        description='+label=Chart name\n+sort=2\n+usage=The helm chart name\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
+        description='+label=Chart name\n+sort=3\n+usage=The helm chart name\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
     )
     version: str = Field(
         ...,
-        description='+label=Version\n+sort=3\n+usage=Helm chart version\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
+        description='+label=Version\n+sort=4\n+usage=Helm chart version\n+uiType=InputSelect\n+uiProps={"creatable":true, "searchable":true}',
     )
 
 
@@ -472,6 +476,31 @@ class JobAlert(BaseModel):
     )
 
 
+class Claim(BaseModel):
+    key: str
+    values: List[str]
+
+
+class JwtAuthCreds(BaseModel):
+    """
+    +label=JWT Authentication
+    +usage=Configure JWT-based authentication using JWKS
+    """
+
+    type: Literal["jwt_auth"] = Field(..., description="+value=jwt_auth")
+    issuer: str = Field(
+        ..., description="+label=Issuer\n+usage=The issuer of the JWT tokens"
+    )
+    jwksUri: str = Field(
+        ...,
+        description="+label=JWKS URI\n+usage=The URI of the JSON Web Key Set (JWKS) containing the public keys",
+    )
+    claims: Optional[List[Claim]] = Field(
+        None,
+        description="+label=Claims\n+usage=List of key-value pairs of claims to verify in the JWT token",
+    )
+
+
 class KafkaMetricConfig(BaseModel):
     type: Literal["kafka"] = Field(..., description="+value=kafka")
     lag_threshold: conint(ge=1) = Field(
@@ -655,6 +684,10 @@ class OCIRepo(BaseModel):
     oci_chart_url: constr(
         regex=r"^(((oci):\/\/)?(?:www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}(?:[-a-zA-Z0-9()@:%_\+.~#?&\/=]*))$"
     ) = Field(..., description="+label=OCI chart URL\n+message=Need to be a valid URL.")
+    integration_fqn: 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) page\n+label=Container Registry\n+usage=FQN of the container registry. If you can\'t find your registry here,\nadd it through the [Integrations](/integrations) page\n+uiType=IntegrationSelect\n+uiProps={"integrationType":"docker-registry"}',
+    )
     version: str = Field(..., description="+label=Version\n+usage=Helm chart version")
 
 
@@ -736,7 +769,9 @@ class Port(BaseModel):
         None,
         description="+label=Rewrite Path to\n+usage=Rewrite the path prefix to a different path.\nIf `path` is `/v1/api` and `rewrite_path_to` is `/api`. The URI in the HTTP request `http://0.0.0.0:8080/v1/api/houses` will be rewritten to `http://0.0.0.0:8080/api/houses` before the request is forwarded your service.\nDefaults to `/`.\nThis is only applicable if `path` is given.\n+message=Should begin and end with a forward slash (/). Each part can can contain alphabets, digits and hypen, must begin and end with an alphanumeric characters. Parts should be separated by forward slashes (/)",
     )
-    auth: Optional[BasicAuthCreds] = None
+    auth: Optional[Union[BasicAuthCreds, JwtAuthCreds]] = Field(
+        None, description="+usage=Username and Password for service auth"
+    )
 
 
 class PythonBuild(BaseModel):

truefoundry/deploy/builder/builders/tfy_notebook_buildpack/dockerfile_template.py

@@ -50,7 +50,7 @@ def generate_build_script_docker_commands(
     all_environment_variables = " ".join(environment_variables)
     run_build_script_command = f"""\
 COPY {build_script_path} /tmp/user-build-script.sh
-RUN {buildkit_secret_mounts} mkdir -p /var/log/ && {all_environment_variables} bash -ex /tmp/user-build-script.sh 2>&1 | tee /var/log/user-build-script-output.log
+RUN {buildkit_secret_mounts} mkdir -p /var/log/ && {all_environment_variables} bash -ex /tmp/user-build-script.sh 2>&1 | tee /var/log/user-build-script-output.log && test ${{PIPESTATUS[0]}} -eq 0
 """
     return run_build_script_command
 

truefoundry/deploy/builder/builders/tfy_python_buildpack/dockerfile_template.py

@@ -3,7 +3,7 @@ from typing import Dict, List, Optional
 
 from mako.template import Template
 
-from truefoundry.common.constants import TFY_CLI_PYTHONBUILD_PYTHON_IMAGE_REPO_ENV_KEY
+from truefoundry.common.constants import ENV_VARS
 from truefoundry.deploy.auto_gen.models import PythonBuild
 from truefoundry.deploy.builder.constants import (
     PIP_CONF_BUILDKIT_SECRET_MOUNT,
@@ -156,9 +156,7 @@ def generate_dockerfile_content(
         apt_packages=build_configuration.apt_packages
     )
     template_args = {
-        "python_image_repo": os.getenv(
-            TFY_CLI_PYTHONBUILD_PYTHON_IMAGE_REPO_ENV_KEY, DEFAULT_PYTHON_IMAGE_REPO
-        ),
+        "python_image_repo": ENV_VARS.TFY_PYTHONBUILD_PYTHON_IMAGE_REPO,
         "python_version": build_configuration.python_version,
         "apt_install_command": apt_install_command,
         "requirements_path": requirements_path,

truefoundry/deploy/lib/clients/servicefoundry_client.py

@@ -48,6 +48,7 @@ from truefoundry.pydantic_v1 import parse_obj_as
 
 DEPLOYMENT_LOGS_SUBSCRIBE_MESSAGE = "DEPLOYMENT_LOGS"
 BUILD_LOGS_SUBSCRIBE_MESSAGE = "BUILD_LOGS"
+MAX_RETRIES_WORKFLOW_TRIGGER = 3
 
 if TYPE_CHECKING:
     from truefoundry.deploy.auto_gen.models import Application
@@ -597,7 +598,7 @@ class ServiceFoundryServiceClient(BaseServiceFoundryServiceClient):
     def trigger_workflow(self, application_id: str, inputs: Dict[str, Any]):
         url = f"{self._api_server_url}/{VERSION_PREFIX}/workflow/{application_id}/executions"
         body = {"inputs": inputs}
-        response = session_with_retries().post(
+        response = session_with_retries(retries=MAX_RETRIES_WORKFLOW_TRIGGER).post(
             url, json=body, headers=self._get_header()
         )
         response = request_handling(response)

truefoundry/deploy/lib/model/entity.py

@@ -32,7 +32,6 @@ class Base(BaseModel):
 class Entity(Base):
     createdAt: datetime.datetime = Field(repr=False)
     updatedAt: datetime.datetime = Field(repr=False)
-    createdBy: str = Field(repr=False)
 
 
 class Workspace(Entity):
@@ -56,7 +55,6 @@ class Workspace(Entity):
             "cluster_fqn": self.clusterId,
             "created_at": self.createdAt,
             "updated_at": self.updatedAt,
-            "created_by": self.createdBy,
         }
 
 
@@ -161,7 +159,6 @@ class Deployment(Entity):
             "cluster_fqn": cluster_fqn,
             "created_at": self.createdAt,
             "updated_at": self.updatedAt,
-            "created_by": self.createdBy,
         }
 
     class Config:
@@ -208,7 +205,6 @@ class Application(Entity):
             "cluster_fqn": self.workspace.clusterId,
             "created_at": self.createdAt,
             "updated_at": self.updatedAt,
-            "created_by": self.createdBy,
         }
 
 

truefoundry/deploy/python_deploy_codegen.py

@@ -1,15 +1,16 @@
 import ast
 import io
+import json
 import re
-from typing import List
+from typing import Dict, List, Optional
 
 from rich.console import Console
 from rich.pretty import pprint
 
-from truefoundry.deploy import Application
+from truefoundry.deploy import Application, LocalSource
 
 
-def generate_code(
+def generate_deployment_code(
     symbols_to_import: List[str],
     application_type: str,
     spec_repr: str,
@@ -106,9 +107,16 @@ def convert_deployment_config_to_python(workspace_fqn: str, application_spec: di
     Convert a deployment config to a python file that can be used to deploy to a workspace
     """
     application = Application.parse_obj(application_spec)
-    application_type = application.__root__.type
-
-    spec_repr = get_python_repr(application.__root__)
+    application_obj = application.__root__
+    application_type = application_obj.type
+    if (
+        hasattr(application_obj, "image")
+        and application_obj.image.type == "build"
+        and application_obj.image.build_source.type == "remote"
+    ):
+        application_obj.image.build_source = LocalSource(local_build=False)
+
+    spec_repr = get_python_repr(application_obj)
     spec_repr = replace_enums_with_values(spec_repr)
     spec_repr = remove_none_type_fields(spec_repr)
     spec_repr = remove_type_field(spec_repr)
@@ -120,7 +128,7 @@ def convert_deployment_config_to_python(workspace_fqn: str, application_spec: di
     if "GitSource" in symbols_to_import:
         symbols_to_import.append("LocalSource")
 
-    generated_code = generate_code(
+    generated_code = generate_deployment_code(
         symbols_to_import=symbols_to_import,
         application_type=application_type,
         spec_repr=spec_repr,
@@ -131,3 +139,67 @@ def convert_deployment_config_to_python(workspace_fqn: str, application_spec: di
         generated_code = add_local_source_comment(generated_code)
 
     return generated_code
+
+
+def generate_python_snippet_for_trigger_job(
+    application_fqn: str, command: Optional[str], params: Optional[Dict[str, str]]
+):
+    job_run_python_template = """\
+from truefoundry.deploy import trigger_job
+
+response = trigger_job(
+  application_fqn="{{application_fqn}}",
+  # You can pass command or params, but not both
+  # command={{command}}
+  # params={{params}}
+)
+
+print(response.jobRunName)
+"""
+    output_python_str = job_run_python_template.replace(
+        "{{application_fqn}}", application_fqn
+    )
+
+    if command is not None:
+        output_python_str = output_python_str.replace("# command", "command")
+        output_python_str = output_python_str.replace("{{command}}", repr(command))
+    else:
+        output_python_str = output_python_str.replace(
+            "{{command}}", "<Enter Command Here>"
+        )
+
+    if params is not None:
+        output_python_str = output_python_str.replace("# params", "params")
+        output_python_str = output_python_str.replace("{{params}}", repr(params))
+    else:
+        output_python_str = output_python_str.replace(
+            "{{params}}", "<Enter Params(key-value pairs) here as python dict>"
+        )
+
+    return output_python_str
+
+
+def generate_curl_snippet_for_trigger_job(
+    control_plane_url: str,
+    application_id: str,
+    command: Optional[str],
+    params: Optional[Dict[str, str]],
+):
+    job_run_curl_request_template = """curl -X 'POST' \\
+  '{{control_plane_url}}/api/svc/v1/jobs/trigger' \\
+  -H 'accept: */*' \\
+  -H 'Authorization: Bearer <Paste your API key here. You can generate it from the Settings Page>' \\
+  -H 'Content-Type: application/json' \\
+  -d '{
+  "applicationId": "{{application_id}}",
+  "input": {{input}}
+}'
+"""
+    output_curl_str = job_run_curl_request_template.replace(
+        "{{control_plane_url}}", control_plane_url.rstrip("/")
+    )
+    output_curl_str = output_curl_str.replace("{{application_id}}", application_id)
+    output_curl_str = output_curl_str.replace(
+        "{{input}}", json.dumps({"command": command, "params": params}, indent=2)
+    )
+    return output_curl_str