feat: Adding label as cli command for cloud deployment (#5467)

* Adding label as cli command for deployment

* adding documentation on cli deployment labels

Author: sean-hickey-wf

docs/source/scale-with-bentocloud/deployment/configure-deployments.rst

@@ -89,6 +89,38 @@ To list available instance types on your BentoCloud account, run:
 
     Choose the instance type that best fits the performance requirements and resource demands of your application. The instance type should be compatible with the deployment environment and supported by the underlying infrastructure.
 
+Labels
+^^^^^^
+You can add labels to your Deployment for better organization and management. Labels are key-value pairs that help you categorize and filter your Deployments based on specific attributes.
+
+.. tab-set::
+
+    .. tab-item:: BentoML CLI
+
+        To add labels via the BentoML CLI, you can use the ``--label`` option:
+
+        .. code-block:: bash
+
+            bentoml deploy --label key1=value1 --label key2=value2
+
+    .. tab-item:: Python API
+
+        When using the Python API, labels are specified through the ``labels`` parameter, which accepts a list of dictionaries. Each dictionary in the list represents a single label. Here's an example:
+
+        .. code-block:: python
+
+            import bentoml
+
+            bentoml.deployment.create(
+                bento="./path_to_your_project",
+                labels=[
+                    {"key": "key1", "value": "value1"},  # First label
+                    {"key": "key2", "value": "value2"}   # Second label
+                ]
+            )
+
+Once set, you can use these labels to filter and manage your Deployments in the BentoCloud dashboard or via the BentoML CLI.
+
 Environment variables
 ^^^^^^^^^^^^^^^^^^^^^
 

src/bentoml/_internal/cloud/deployment.py

@@ -72,6 +72,7 @@ class DeploymentConfigParameters:
     scaling_max: int | None = None
     instance_type: str | None = None
     strategy: str | None = None
+    labels: t.List[dict[str, str]] | None = None
     envs: t.List[dict[str, t.Any]] | None = None
     secrets: t.List[str] | None = None
     extras: dict[str, t.Any] | None = None
@@ -119,6 +120,7 @@ def verify(self, create: bool = True):
                     ("cluster", self.cluster),
                     ("access_authorization", self.access_authorization),
                     ("envs", self.envs if self.envs else None),
+                    ("labels", self.labels if self.labels else None),
                     ("secrets", self.secrets),
                     ("dev", self.dev),
                 ]

src/bentoml/deployment.py

@@ -38,6 +38,7 @@ def create(
     instance_type: str | None = ...,
     strategy: str | None = ...,
     envs: t.List[EnvItemSchema] | t.List[dict[str, t.Any]] | None = ...,
+    labels: t.List[LabelItemSchema] | t.List[dict[str, str]] | None = ...,
     extras: dict[str, t.Any] | None = ...,
 ) -> Deployment: ...
 
@@ -75,6 +76,7 @@ def create(
     instance_type: str | None = None,
     strategy: str | None = None,
     envs: t.List[EnvItemSchema] | t.List[dict[str, t.Any]] | None = None,
+    labels: t.List[LabelItemSchema] | t.List[dict[str, str]] | None = None,
     extras: dict[str, t.Any] | None = None,
     config_dict: dict[str, t.Any] | None = None,
     config_file: str | None = None,
@@ -103,6 +105,14 @@ def create(
             if envs is not None
             else None
         ),
+        labels=(
+            [
+                attr.asdict(item) if isinstance(item, LabelItemSchema) else item
+                for item in labels
+            ]
+            if labels is not None
+            else None
+        ),
         extras=extras,
         config_dict=config_dict,
         config_file=config_file,
@@ -177,6 +187,9 @@ def update(
         | t.List[dict[str, t.Any]]
         | None
     ) = None,
+    labels: (
+        t.List[LabelItemSchema] | t.List[dict[str, str]] | t.List[dict[str, str]] | None
+    ) = None,
     secrets: t.List[str] | None = None,
     extras: dict[str, t.Any] | None = None,
     config_dict: dict[str, t.Any] | None = None,
@@ -201,6 +214,14 @@ def update(
             if envs is not None
             else None
         ),
+        labels=(
+            [
+                attr.asdict(item) if isinstance(item, LabelItemSchema) else item
+                for item in labels
+            ]
+            if labels is not None
+            else None
+        ),
         secrets=secrets,
         extras=extras,
         config_dict=config_dict,

src/bentoml_cli/deployment.py

@@ -49,6 +49,22 @@ def raise_deployment_config_error(err: BentoMLException, action: str) -> t.NoRet
     ) from None
 
 
+def convert_label_to_dict(label: tuple[str] | None) -> list[dict[str, str]] | None:
+    if label is None:
+        return None
+    collected_labels: list[dict[str, str]] = []
+    if label:
+        for item in label:
+            if "=" in item:
+                name, value = item.split("=", 1)
+            else:
+                raise CLIException(
+                    f"Invalid label format '{item}'. Expected format is key=value."
+                )
+            collected_labels.append({"key": name, "value": value})
+    return collected_labels
+
+
 def convert_env_to_dict(env: tuple[str] | None) -> list[dict[str, str]] | None:
     if env is None:
         return None
@@ -110,6 +126,12 @@ def convert_env_to_dict(env: tuple[str] | None) -> list[dict[str, str]] | None:
     ),
     help="Deployment strategy",
 )
+@click.option(
+    "--label",
+    type=click.STRING,
+    help="List of labels pass by --label key=value --label ...",
+    multiple=True,
+)
 @click.option(
     "--env",
     type=click.STRING,
@@ -158,6 +180,7 @@ def deploy_command(
     scaling_max: int | None,
     instance_type: str | None,
     strategy: str | None,
+    label: tuple[str] | None,
     env: tuple[str] | None,
     secret: tuple[str] | None,
     config_file: str | t.TextIO | None,
@@ -180,6 +203,7 @@ def deploy_command(
         instance_type=instance_type,
         strategy=strategy,
         env=env,
+        label=label,
         secret=secret,
         config_file=config_file,
         config_dict=config_dict,
@@ -361,6 +385,12 @@ def deployment_command():
     ),
     help="Deployment strategy",
 )
+@click.option(
+    "--label",
+    type=click.STRING,
+    help="List of labels pass by --label key=value --label ...",
+    multiple=True,
+)
 @click.option(
     "--env",
     type=click.STRING,
@@ -397,6 +427,7 @@ def update(  # type: ignore
     scaling_max: int | None,
     instance_type: str | None,
     strategy: str | None,
+    label: tuple[str] | None,
     env: tuple[str] | None,
     secret: tuple[str] | None,
     config_file: t.TextIO | None,
@@ -422,6 +453,7 @@ def update(  # type: ignore
         instance_type=instance_type,
         strategy=strategy,
         envs=convert_env_to_dict(env),
+        labels=convert_label_to_dict(label),
         secrets=list(secret) if secret else None,
         config_file=config_file,
         config_dict=cfg_dict,
@@ -482,6 +514,12 @@ def update(  # type: ignore
     ),
     help="Deployment strategy",
 )
+@click.option(
+    "--label",
+    type=click.STRING,
+    help="List of labels pass by --label key=value --label ...",
+    multiple=True,
+)
 @click.option(
     "--env",
     type=click.STRING,
@@ -518,6 +556,7 @@ def apply(  # type: ignore
     scaling_max: int | None,
     instance_type: str | None,
     strategy: str | None,
+    label: tuple[str] | None,
     env: tuple[str] | None,
     secret: tuple[str] | None,
     config_file: str | t.TextIO | None,
@@ -541,6 +580,7 @@ def apply(  # type: ignore
         scaling_min=scaling_min,
         instance_type=instance_type,
         strategy=strategy,
+        labels=convert_label_to_dict(label),
         envs=convert_env_to_dict(env),
         secrets=list(secret) if secret else None,
         config_file=config_file,
@@ -853,6 +893,7 @@ def create_deployment(
     scaling_max: int | None = None,
     instance_type: str | None = None,
     strategy: str | None = None,
+    label: tuple[str] | None = None,
     env: tuple[str] | None = None,
     secret: tuple[str] | None = None,
     config_file: str | t.TextIO | None = None,
@@ -875,6 +916,7 @@ def create_deployment(
         scaling_min=scaling_min,
         instance_type=instance_type,
         strategy=strategy,
+        labels=convert_label_to_dict(label),
         envs=convert_env_to_dict(env),
         secrets=list(secret) if secret else None,
         config_file=config_file,