return proper types, add env var example file, exports

Author: tamirse

datacrunch/containers/__init__.py

@@ -0,0 +1,24 @@
+from .containers import (
+    EnvVar,
+    EnvVarType,
+    ContainerRegistryType,
+    ContainerDeploymentStatus,
+    HealthcheckSettings,
+    EntrypointOverridesSettings,
+    VolumeMount,
+    VolumeMountType,
+    Container,
+    ContainerRegistryCredentials,
+    ContainerRegistrySettings,
+    ComputeResource,
+    ScalingPolicy,
+    QueueLoadScalingTrigger,
+    UtilizationScalingTrigger,
+    ScalingTriggers,
+    ScalingOptions,
+    Deployment,
+    ReplicaInfo,
+    Secret,
+    RegistryCredential,
+    ContainersService,
+)

datacrunch/containers/containers.py

@@ -332,17 +332,17 @@ def update_deployment_scaling_options(self, deployment_name: str, scaling_option
         )
         return ScalingOptions.from_dict(response.json())
 
-    def get_deployment_replicas(self, deployment_name: str) -> Dict:
+    def get_deployment_replicas(self, deployment_name: str) -> ReplicaInfo:
         """Get deployment replicas
 
         :param deployment_name: name of the deployment
         :type deployment_name: str
         :return: replicas information
-        :rtype: Dict
+        :rtype: ReplicaInfo
         """
         response = self.client.get(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/replicas")
-        return response.json()
+        return [ReplicaInfo.from_dict(replica) for replica in response.json()["list"]]
 
     def purge_deployment_queue(self, deployment_name: str) -> None:
         """Purge deployment queue
@@ -371,55 +371,75 @@ def resume_deployment(self, deployment_name: str) -> None:
         self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/resume")
 
-    def get_deployment_environment_variables(self, deployment_name: str) -> Dict:
+    def get_deployment_environment_variables(self, deployment_name: str) -> Dict[str, List[EnvVar]]:
         """Get deployment environment variables
 
         :param deployment_name: name of the deployment
         :type deployment_name: str
-        :return: environment variables
-        :rtype: Dict
+        :return: dictionary mapping container names to their environment variables
+        :rtype: Dict[str, List[EnvVar]]
         """
         response = self.client.get(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables")
-        return response.json()
-
-    def add_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
+        result = {}
+        for item in response.json():
+            container_name = item["container_name"]
+            env_vars = item["env"]
+            result[container_name] = [EnvVar.from_dict(
+                env_var) for env_var in env_vars]
+        return result
+
+    def add_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[EnvVar]) -> Dict[str, List[EnvVar]]:
         """Add environment variables to a container
 
         :param deployment_name: name of the deployment
         :type deployment_name: str
         :param container_name: name of the container
         :type container_name: str
         :param env_vars: environment variables to add
-        :type env_vars: List[Dict]
+        :type env_vars: List[EnvVar]
         :return: updated environment variables
-        :rtype: Dict
+        :rtype: Dict[str, List[EnvVar]]
         """
         response = self.client.post(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables",
-            {"container_name": container_name, "env": env_vars}
+            {"container_name": container_name, "env": [
+                env_var.to_dict() for env_var in env_vars]}
         )
-        return response.json()
-
-    def update_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[Dict]) -> Dict:
+        result = {}
+        for item in response.json():
+            container_name = item["container_name"]
+            env_vars = item["env"]
+            result[container_name] = [EnvVar.from_dict(
+                env_var) for env_var in env_vars]
+        return result
+
+    def update_deployment_environment_variables(self, deployment_name: str, container_name: str, env_vars: List[EnvVar]) -> Dict[str, List[EnvVar]]:
         """Update environment variables of a container
 
         :param deployment_name: name of the deployment
         :type deployment_name: str
         :param container_name: name of the container
         :type container_name: str
         :param env_vars: updated environment variables
-        :type env_vars: List[Dict]
+        :type env_vars: List[EnvVar]
         :return: updated environment variables
-        :rtype: Dict
+        :rtype: Dict[str, List[EnvVar]] 
         """
         response = self.client.patch(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables",
-            {"container_name": container_name, "env": env_vars}
+            {"container_name": container_name, "env": [
+                env_var.to_dict() for env_var in env_vars]}
         )
-        return response.json()
-
-    def delete_deployment_environment_variables(self, deployment_name: str, container_name: str, env_var_names: List[str]) -> Dict:
+        result = {}
+        item = response.json()
+        container_name = item["container_name"]
+        env_vars = item["env"]
+        result[container_name] = [EnvVar.from_dict(
+            env_var) for env_var in env_vars]
+        return result
+
+    def delete_deployment_environment_variables(self, deployment_name: str, container_name: str, env_var_names: List[str]) -> Dict[str, List[EnvVar]]:
         """Delete environment variables from a container
 
         :param deployment_name: name of the deployment
@@ -429,13 +449,19 @@ def delete_deployment_environment_variables(self, deployment_name: str, containe
         :param env_var_names: names of environment variables to delete
         :type env_var_names: List[str]
         :return: remaining environment variables
-        :rtype: Dict
+        :rtype: Dict[str, List[EnvVar]]
         """
         response = self.client.delete(
             f"{CONTAINER_DEPLOYMENTS_ENDPOINT}/{deployment_name}/environment-variables",
             {"container_name": container_name, "env": env_var_names}
         )
-        return response.json()
+        result = {}
+        for item in response.json():
+            container_name = item["container_name"]
+            env_vars = item["env"]
+            result[container_name] = [EnvVar.from_dict(
+                env_var) for env_var in env_vars]
+        return result
 
     def get_compute_resources(self) -> List[ComputeResource]:
         """Get available compute resources

examples/containers/environment_variables_example.py

@@ -0,0 +1,100 @@
+"""
+This example demonstrates how to manage environment variables for container deployments.
+It shows how to:
+1. Get environment variables for a deployment
+2. Add new environment variables to a container
+3. Update existing environment variables
+4. Delete environment variables
+"""
+
+import os
+from datacrunch.containers import EnvVar, EnvVarType
+from datacrunch import DataCrunchClient
+from typing import Dict, List
+
+DATACRUNCH_CLIENT_ID = os.environ.get('DATACRUNCH_CLIENT_ID')
+DATACRUNCH_CLIENT_SECRET = os.environ.get('DATACRUNCH_CLIENT_SECRET')
+
+# Initialize DataCrunch client
+datacrunch_client = DataCrunchClient(client_id=DATACRUNCH_CLIENT_ID,
+                                     client_secret=DATACRUNCH_CLIENT_SECRET)
+
+# Example deployment and container names
+DEPLOYMENT_NAME = "my-deployment"
+CONTAINER_NAME = "main"
+
+
+def print_env_vars(env_vars: Dict[str, List[EnvVar]]) -> None:
+    """Helper function to print environment variables"""
+    print("\nCurrent environment variables:")
+    for container_name, vars in env_vars.items():
+        print(f"\nContainer: {container_name}")
+        for var in vars:
+            print(f"  {var.name}: {var.value_or_reference_to_secret} ({var.type})")
+
+
+def main():
+    # First, let's get the current environment variables
+    print("Getting current environment variables...")
+    env_vars = datacrunch_client.containers.get_deployment_environment_variables(
+        DEPLOYMENT_NAME)
+    print_env_vars(env_vars)
+
+    # Create a new secret
+    secret_name = "my-secret-key"
+    datacrunch_client.containers.create_secret(
+        secret_name,
+        "my-secret-value"
+    )
+
+    # Add new environment variables
+    print("\nAdding new environment variables...")
+    new_env_vars = [
+        EnvVar(
+            name="API_KEY",
+            value_or_reference_to_secret=secret_name,
+            type=EnvVarType.SECRET
+        ),
+        EnvVar(
+            name="DEBUG",
+            value_or_reference_to_secret="true",
+            type=EnvVarType.PLAIN
+        )
+    ]
+
+    env_vars = datacrunch_client.containers.add_deployment_environment_variables(
+        deployment_name=DEPLOYMENT_NAME,
+        container_name=CONTAINER_NAME,
+        env_vars=new_env_vars
+    )
+    print_env_vars(env_vars)
+
+    # Update existing environment variables
+    print("\nUpdating environment variables...")
+    updated_env_vars = [
+        EnvVar(
+            name="DEBUG",
+            value_or_reference_to_secret="false",
+            type=EnvVarType.PLAIN
+        ),
+    ]
+
+    env_vars = datacrunch_client.containers.update_deployment_environment_variables(
+        deployment_name=DEPLOYMENT_NAME,
+        container_name=CONTAINER_NAME,
+        env_vars=updated_env_vars
+    )
+    print_env_vars(env_vars)
+
+    # Delete environment variables
+    print("\nDeleting environment variables...")
+    env_vars = datacrunch_client.containers.delete_deployment_environment_variables(
+        deployment_name=DEPLOYMENT_NAME,
+        container_name=CONTAINER_NAME,
+        env_var_names=["DEBUG"]
+    )
+    print_env_vars(env_vars)
+
+
+if __name__ == "__main__":
+    main()