feat: capture arccontainerstorage in support bundle

azext_edge/edge/_help.py

@@ -12,6 +12,7 @@
 from .providers.edge_api import MQ_ACTIVE_API
 from .providers.support_bundle import (
     COMPAT_AKRI_APIS,
+    COMPAT_ARCCONTAINERSTORAGE_APIS,
     COMPAT_CLUSTER_CONFIG_APIS,
     COMPAT_DEVICEREGISTRY_APIS,
     COMPAT_MQTT_BROKER_APIS,
@@ -58,6 +59,7 @@ def load_iotops_help():
             - {COMPAT_DEVICEREGISTRY_APIS.as_str()}
             - {COMPAT_CLUSTER_CONFIG_APIS.as_str()}
             - {COMPAT_DATAFLOW_APIS.as_str()}
+            - {COMPAT_ARCCONTAINERSTORAGE_APIS.as_str()}
 
             Note: logs from evicted pod will not be captured, as they are inaccessible. For details
             on why a pod was evicted, please refer to the related pod and node files.
@@ -79,6 +81,10 @@ def load_iotops_help():
         - name: Include mqtt broker traces in the support bundle. This is an alias for stats trace fetch capability.
           text: >
             az iot ops support create-bundle --ops-service broker --broker-traces
+
+        - name: Include arc container storage resources in the support bundle.
+          text: >
+            az iot ops support create-bundle --ops-service acs
     """
 
     helps[

azext_edge/edge/common.py

@@ -154,6 +154,7 @@ class OpsServiceType(ListableEnum):
     billing = "billing"
     dataflow = "dataflow"
     schemaregistry = "schemaregistry"
+    arccontainerstorage = "acs"
 
     @classmethod
     def list_check_services(cls):

azext_edge/edge/providers/edge_api/__init__.py

@@ -14,8 +14,10 @@
 from .deviceregistry import DEVICEREGISTRY_API_V1, DeviceRegistryResourceKinds
 from .dataflow import DATAFLOW_API_V1B1, DataflowResourceKinds
 from .meta import META_API_V1B1, MetaResourceKinds
+from .arccontainerstorage import ARCCONTAINERSTORAGE_API_V1
 
 __all__ = [
+    "ARCCONTAINERSTORAGE_API_V1",
     "CLUSTER_CONFIG_API_V1",
     "EdgeResourceApi",
     "EdgeApiManager",

azext_edge/edge/providers/edge_api/arccontainerstorage.py

@@ -0,0 +1,12 @@
+# coding=utf-8
+# ----------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License file in the project root for license information.
+# ----------------------------------------------------------------------------------------------
+
+from .base import EdgeResourceApi
+
+
+ARCCONTAINERSTORAGE_API_V1 = EdgeResourceApi(
+    group="arccontainerstorage.azure.net", version="v1", moniker="arccontainerstorage"
+)

azext_edge/edge/providers/support/arccontainerstorage.py

@@ -0,0 +1,95 @@
+# coding=utf-8
+# ----------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License file in the project root for license information.
+# ----------------------------------------------------------------------------------------------
+
+from functools import partial
+from typing import Iterable, Optional
+
+from knack.log import get_logger
+
+from ..edge_api import ARCCONTAINERSTORAGE_API_V1, EdgeResourceApi
+from .base import (
+    DAY_IN_SECONDS,
+    assemble_crd_work,
+    process_daemonsets,
+    process_deployments,
+    process_persistent_volume_claims,
+    process_replicasets,
+    process_services,
+    process_v1_pods,
+)
+
+logger = get_logger(__name__)
+
+STORAGE_DIRECTORY_PATH = ARCCONTAINERSTORAGE_API_V1.moniker
+# TODO: Use common label once it is ready
+STORAGE_NAMESPACE = "azure-arc-containerstorage"
+
+
+def fetch_deployments():
+    return process_deployments(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+    )
+
+
+def fetch_replicasets():
+    return process_replicasets(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+    )
+
+
+def fetch_pods(since_seconds: int = DAY_IN_SECONDS):
+    return process_v1_pods(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+        since_seconds=since_seconds,
+    )
+
+
+def fetch_daemonsets():
+    return process_daemonsets(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+    )
+
+
+def fetch_services():
+    return process_services(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+    )
+
+
+def fetch_peristent_volume_claims():
+    return process_persistent_volume_claims(
+        directory_path=STORAGE_DIRECTORY_PATH,
+        namespace=STORAGE_NAMESPACE,
+    )
+
+
+support_runtime_elements = {
+    "daemonsets": fetch_daemonsets,
+    "deployments": fetch_deployments,
+    "persistentvolumeclaims": fetch_peristent_volume_claims,
+    "replicasets": fetch_replicasets,
+    "services": fetch_services,
+}
+
+
+def prepare_bundle(
+    log_age_seconds: int = DAY_IN_SECONDS,
+    apis: Optional[Iterable[EdgeResourceApi]] = None,
+) -> dict:
+    acs_to_run = {}
+
+    if apis:
+        acs_to_run.update(assemble_crd_work(apis=apis, namespace=STORAGE_NAMESPACE))
+
+    support_runtime_elements["pods"] = partial(fetch_pods, since_seconds=log_age_seconds)
+    acs_to_run.update(support_runtime_elements)
+
+    return acs_to_run

azext_edge/edge/providers/support/base.py

@@ -57,6 +57,7 @@ def process_crd(
     plural: str,
     directory_path: str,
     file_prefix: Optional[str] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     result: dict = get_custom_objects(
         group=group,
@@ -70,7 +71,8 @@ def process_crd(
     processed = []
     namespaces = []
     for r in result.get("items", []):
-        namespace = r["metadata"]["namespace"]
+        if not namespace:
+            namespace = r["metadata"]["namespace"]
         namespaces.append(namespace)
         name = r["metadata"]["name"]
         processed.append(
@@ -92,6 +94,7 @@ def process_v1_pods(
     prefix_names: Optional[List[str]] = None,
     pod_prefix_for_init_container_logs: Optional[List[str]] = None,
     exclude_prefixes: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     from kubernetes.client.models import V1Pod
 
@@ -102,7 +105,10 @@ def process_v1_pods(
     if not prefix_names:
         prefix_names = []
 
-    pods: V1PodList = v1_api.list_pod_for_all_namespaces(label_selector=label_selector)
+    if namespace:
+        pods: V1PodList = v1_api.list_namespaced_pod(namespace=namespace, label_selector=label_selector)
+    else:
+        pods: V1PodList = v1_api.list_pod_for_all_namespaces(label_selector=label_selector)
 
     if exclude_prefixes:
         pods = exclude_resources_with_prefix(pods, exclude_prefixes)
@@ -186,11 +192,18 @@ def process_deployments(
     label_selector: Optional[str] = None,
     prefix_names: Optional[List[str]] = None,
     exclude_prefixes: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     v1_apps = client.AppsV1Api()
-    deployments: V1DeploymentList = v1_apps.list_deployment_for_all_namespaces(
-        label_selector=label_selector, field_selector=field_selector
-    )
+
+    if namespace:
+        deployments: V1DeploymentList = v1_apps.list_namespaced_deployment(
+            namespace=namespace, label_selector=label_selector, field_selector=field_selector
+        )
+    else:
+        deployments: V1DeploymentList = v1_apps.list_deployment_for_all_namespaces(
+            label_selector=label_selector, field_selector=field_selector
+        )
 
     return _process_kubernetes_resources(
         directory_path=directory_path,
@@ -237,11 +250,18 @@ def process_services(
     label_selector: Optional[str] = None,
     prefix_names: Optional[List[str]] = None,
     exclude_prefixes: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     v1_api = client.CoreV1Api()
-    services: V1ServiceList = v1_api.list_service_for_all_namespaces(
-        label_selector=label_selector, field_selector=field_selector
-    )
+
+    if namespace:
+        services: V1ServiceList = v1_api.list_namespaced_service(
+            namespace=namespace, label_selector=label_selector, field_selector=field_selector
+        )
+    else:
+        services: V1ServiceList = v1_api.list_service_for_all_namespaces(
+            label_selector=label_selector, field_selector=field_selector
+        )
 
     return _process_kubernetes_resources(
         directory_path=directory_path,
@@ -257,9 +277,16 @@ def process_replicasets(
     label_selector: Optional[str] = None,
     prefix_names: Optional[List[str]] = None,
     exclude_prefixes: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     v1_apps = client.AppsV1Api()
-    replicasets: V1ReplicaSetList = v1_apps.list_replica_set_for_all_namespaces(label_selector=label_selector)
+
+    if namespace:
+        replicasets: V1ReplicaSetList = v1_apps.list_namespaced_replica_set(
+            namespace=namespace, label_selector=label_selector
+        )
+    else:
+        replicasets: V1ReplicaSetList = v1_apps.list_replica_set_for_all_namespaces(label_selector=label_selector)
 
     return _process_kubernetes_resources(
         directory_path=directory_path,
@@ -275,11 +302,18 @@ def process_daemonsets(
     field_selector: Optional[str] = None,
     label_selector: Optional[str] = None,
     prefix_names: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     v1_apps = client.AppsV1Api()
-    daemonsets: V1DaemonSetList = v1_apps.list_daemon_set_for_all_namespaces(
-        label_selector=label_selector, field_selector=field_selector
-    )
+
+    if namespace:
+        daemonsets: V1DaemonSetList = v1_apps.list_namespaced_daemon_set(
+            namespace=namespace, label_selector=label_selector, field_selector=field_selector
+        )
+    else:
+        daemonsets: V1DaemonSetList = v1_apps.list_daemon_set_for_all_namespaces(
+            label_selector=label_selector, field_selector=field_selector
+        )
 
     return _process_kubernetes_resources(
         directory_path=directory_path,
@@ -359,11 +393,18 @@ def process_persistent_volume_claims(
     field_selector: Optional[str] = None,
     label_selector: Optional[str] = None,
     prefix_names: Optional[List[str]] = None,
+    namespace: Optional[str] = None,
 ) -> List[dict]:
     v1_api = client.CoreV1Api()
-    pvcs: V1PersistentVolumeClaimList = v1_api.list_persistent_volume_claim_for_all_namespaces(
-        label_selector=label_selector, field_selector=field_selector
-    )
+
+    if namespace:
+        pvcs: V1PersistentVolumeClaimList = v1_api.list_namespaced_persistent_volume_claim(
+            namespace=namespace, label_selector=label_selector, field_selector=field_selector
+        )
+    else:
+        pvcs: V1PersistentVolumeClaimList = v1_api.list_persistent_volume_claim_for_all_namespaces(
+            label_selector=label_selector, field_selector=field_selector
+        )
 
     return _process_kubernetes_resources(
         directory_path=directory_path,
@@ -417,6 +458,7 @@ def assemble_crd_work(
     apis: Iterable[EdgeResourceApi],
     file_prefix_map: Optional[Dict[str, str]] = None,
     directory_path: Optional[str] = None,
+    namespace: Optional[str] = None,
 ) -> dict:
     if not file_prefix_map:
         file_prefix_map = {}
@@ -435,6 +477,7 @@ def assemble_crd_work(
                 plural=api._kinds[kind],  # TODO: optimize
                 directory_path=directory_path,
                 file_prefix=file_prefix,
+                namespace=namespace,
             )
 
     return result
@@ -473,9 +516,7 @@ def _capture_pod_container_logs(
         for capture_previous in capture_previous_log_runs:
             try:
                 logger_debug_previous = "previous run " if capture_previous else ""
-                logger.debug(
-                    f"Reading {logger_debug_previous}log from pod {pod_name} container {container.name}"
-                )
+                logger.debug(f"Reading {logger_debug_previous}log from pod {pod_name} container {container.name}")
                 log: str = v1_api.read_namespaced_pod_log(
                     name=pod_name,
                     namespace=pod_namespace,
@@ -542,12 +583,8 @@ def _process_kubernetes_resources(
     return processed
 
 
-def exclude_resources_with_prefix(
-    resources: K8sRuntimeResources, exclude_prefixes: List[str]
-) -> K8sRuntimeResources:
+def exclude_resources_with_prefix(resources: K8sRuntimeResources, exclude_prefixes: List[str]) -> K8sRuntimeResources:
     for prefix in exclude_prefixes:
-        resources.items = [
-            resource for resource in resources.items if not resource.metadata.name.startswith(prefix)
-        ]
+        resources.items = [resource for resource in resources.items if not resource.metadata.name.startswith(prefix)]
 
     return resources

azext_edge/edge/providers/support_bundle.py

@@ -21,6 +21,7 @@
     DEVICEREGISTRY_API_V1,
     DATAFLOW_API_V1B1,
     META_API_V1B1,
+    ARCCONTAINERSTORAGE_API_V1,
     EdgeApiManager,
 )
 
@@ -36,6 +37,7 @@
 COMPAT_DEVICEREGISTRY_APIS = EdgeApiManager(resource_apis=[DEVICEREGISTRY_API_V1])
 COMPAT_DATAFLOW_APIS = EdgeApiManager(resource_apis=[DATAFLOW_API_V1B1])
 COMPAT_META_APIS = EdgeApiManager(resource_apis=[META_API_V1B1])
+COMPAT_ARCCONTAINERSTORAGE_APIS = EdgeApiManager(resource_apis=[ARCCONTAINERSTORAGE_API_V1])
 
 
 def build_bundle(
@@ -59,6 +61,7 @@ def build_bundle(
     from .support.arcagents import prepare_bundle as prepare_arcagents_bundle
     from .support.meta import prepare_bundle as prepare_meta_bundle
     from .support.schemaregistry import prepare_bundle as prepare_schema_registry_bundle
+    from .support.arccontainerstorage import prepare_bundle as prepare_arccontainerstorage_bundle
 
     def collect_default_works(
         pending_work: dict,
@@ -104,6 +107,10 @@ def collect_default_works(
             "apis": None,
             "prepare_bundle": prepare_schema_registry_bundle,
         },
+        OpsServiceType.arccontainerstorage.value: {
+            "apis": COMPAT_ARCCONTAINERSTORAGE_APIS,
+            "prepare_bundle": prepare_arccontainerstorage_bundle,
+        },
     }
 
     for service_moniker, api_info in api_map.items():