small refactor, create registry credentials example

Author: tamirse

datacrunch/containers/containers.py

@@ -489,29 +489,74 @@ def get_registry_credentials(self) -> List[RegistryCredential]:
         response = self.client.get(CONTAINER_REGISTRY_CREDENTIALS_ENDPOINT)
         return [RegistryCredential.from_dict(credential) for credential in response.json()]
 
-    def add_registry_credentials(self, name: str, registry_type: ContainerRegistryType, username: str, access_token: str) -> RegistryCredential:
+    def add_registry_credentials(
+        self,
+        name: str,
+        registry_type: ContainerRegistryType,
+        username: str = None,
+        access_token: str = None,
+        service_account_key: str = None,
+        docker_config_json: str = None,
+        access_key_id: str = None,
+        secret_access_key: str = None,
+        region: str = None,
+        ecr_repo: str = None
+    ) -> None:
         """Add registry credentials
 
         :param name: name of the credentials
         :type name: str
         :param registry_type: type of registry (e.g. ContainerRegistryType.DOCKERHUB)
         :type registry_type: ContainerRegistryType
-        :param username: registry username
+        :param username: registry username (required for DOCKERHUB and GITHUB)
         :type username: str
-        :param access_token: registry access token
+        :param access_token: registry access token (required for DOCKERHUB and GITHUB)
         :type access_token: str
-        :return: created registry credential
-        :rtype: RegistryCredential
+        :param service_account_key: service account key JSON string (required for GCR)
+        :type service_account_key: str
+        :param docker_config_json: docker config JSON string (required for CUSTOM)
+        :type docker_config_json: str
+        :param access_key_id: AWS access key ID (required for AWS_ECR)
+        :type access_key_id: str
+        :param secret_access_key: AWS secret access key (required for AWS_ECR)
+        :type secret_access_key: str
+        :param region: AWS region (required for AWS_ECR)
+        :type region: str
+        :param ecr_repo: ECR repository URL (required for AWS_ECR)
+        :type ecr_repo: str
         """
         data = {
             "name": name,
-            "registry_type": registry_type.value,
-            "username": username,
-            "access_token": access_token
+            "type": registry_type.value
         }
-        response = self.client.post(
-            CONTAINER_REGISTRY_CREDENTIALS_ENDPOINT, data)
-        return RegistryCredential.from_dict(response.json())
+
+        # Add specific parameters based on registry type
+        if registry_type == ContainerRegistryType.DOCKERHUB or registry_type == ContainerRegistryType.GITHUB:
+            if not username or not access_token:
+                raise ValueError(
+                    f"Username and access_token are required for {registry_type.value} registry type")
+            data["username"] = username
+            data["access_token"] = access_token
+        elif registry_type == ContainerRegistryType.GCR:
+            if not service_account_key:
+                raise ValueError(
+                    "service_account_key is required for GCR registry type")
+            data["service_account_key"] = service_account_key
+        elif registry_type == ContainerRegistryType.AWS_ECR:
+            if not all([access_key_id, secret_access_key, region, ecr_repo]):
+                raise ValueError(
+                    "access_key_id, secret_access_key, region, and ecr_repo are required for AWS_ECR registry type")
+            data["access_key_id"] = access_key_id
+            data["secret_access_key"] = secret_access_key
+            data["region"] = region
+            data["ecr_repo"] = ecr_repo
+        elif registry_type == ContainerRegistryType.CUSTOM:
+            if not docker_config_json:
+                raise ValueError(
+                    "docker_config_json is required for CUSTOM registry type")
+            data["docker_config_json"] = docker_config_json
+
+        self.client.post(CONTAINER_REGISTRY_CREDENTIALS_ENDPOINT, data)
 
     def delete_registry_credentials(self, credentials_name: str) -> None:
         """Delete registry credentials

examples/containers/registry_credentials_example.py

@@ -0,0 +1,78 @@
+import os
+from datacrunch import DataCrunchClient
+from datacrunch.containers.containers import ContainerRegistryType
+
+# Environment variables
+DATACRUNCH_CLIENT_ID = os.environ.get('DATACRUNCH_CLIENT_ID')
+DATACRUNCH_CLIENT_SECRET = os.environ.get('DATACRUNCH_CLIENT_SECRET')
+
+# Initialize DataCrunch client
+client = DataCrunchClient(client_id=DATACRUNCH_CLIENT_ID,
+                          client_secret=DATACRUNCH_CLIENT_SECRET)
+
+# Example 1: DockerHub Credentials
+client.containers.add_registry_credentials(
+    name="my-dockerhub-creds",
+    registry_type=ContainerRegistryType.DOCKERHUB,
+    username="your-dockerhub-username",
+    access_token="your-dockerhub-access-token"
+)
+print("Created DockerHub credentials")
+
+# Example 2: GitHub Container Registry Credentials
+client.containers.add_registry_credentials(
+    name="my-github-creds",
+    registry_type=ContainerRegistryType.GITHUB,
+    username="your-github-username",
+    access_token="your-github-token"
+)
+print("Created GitHub credentials")
+
+# Example 3: Google Container Registry (GCR) Credentials
+# For GCR, you need to provide a service account key JSON string
+gcr_service_account_key = """{
+  "type": "service_account",
+  "project_id": "your-project-id",
+  "private_key_id": "private-key-id",
+  "private_key": "-----BEGIN PRIVATE KEY-----\\nYOUR_PRIVATE_KEY_HERE\\n-----END PRIVATE KEY-----\\n",
+  "client_email": "your-service-account@your-project.iam.gserviceaccount.com",
+  "client_id": "client-id",
+  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+  "token_uri": "https://oauth2.googleapis.com/token",
+  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
+  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/your-service-account%40your-project.iam.gserviceaccount.com"
+}"""
+
+client.containers.add_registry_credentials(
+    name="my-gcr-creds",
+    registry_type=ContainerRegistryType.GCR,
+    service_account_key=gcr_service_account_key
+)
+print("Created GCR credentials")
+
+# Example 4: AWS ECR Credentials
+client.containers.add_registry_credentials(
+    name="my-aws-ecr-creds",
+    registry_type=ContainerRegistryType.AWS_ECR,
+    access_key_id="your-aws-access-key-id",
+    secret_access_key="your-aws-secret-access-key",
+    region="us-west-2",
+    ecr_repo="123456789012.dkr.ecr.us-west-2.amazonaws.com"
+)
+print("Created AWS ECR credentials")
+
+# Example 5: Custom Registry Credentials
+custom_docker_config = """{
+  "auths": {
+    "your-custom-registry.com": {
+      "auth": "base64-encoded-username-password"
+    }
+  }
+}"""
+
+client.containers.add_registry_credentials(
+    name="my-custom-registry-creds",
+    registry_type=ContainerRegistryType.CUSTOM,
+    docker_config_json=custom_docker_config
+)
+print("Created Custom registry credentials")