Skip to content

AI Service Module

The aiservice module provides functions for AI/ML service management and configuration.

aiservice

Functions

listAiServiceInstances(dynClient)

Retrieve all AI Service instances from the OpenShift cluster.

This function queries the cluster for AIServiceApp custom resources and returns a list of all AI Service instances found.

Parameters:

Name Type Description Default
dynClient DynamicClient

OpenShift dynamic client for cluster API interactions.

 required

Returns:

Name Type Description
list list

A list of dictionaries representing AI Service instances. Returns an empty list if no instances are found or if errors occur.
Source code in src/mas/devops/aiservice.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def listAiServiceInstances(dynClient: DynamicClient) -> list:
    """
    Retrieve all AI Service instances from the OpenShift cluster.

    This function queries the cluster for AIServiceApp custom resources and returns
    a list of all AI Service instances found.

    Args:
        dynClient (DynamicClient): OpenShift dynamic client for cluster API interactions.

    Returns:
        list: A list of dictionaries representing AI Service instances.
              Returns an empty list if no instances are found or if errors occur.
    """
    return listInstances(dynClient, "aiservice.ibm.com/v1", "AIServiceApp")

verifyAiServiceInstance(dynClient, instanceId)

Verify that a specific AI Service instance exists in the cluster.

This function checks if an AIServiceApp custom resource with the given instance ID exists in the expected namespace. It handles various error conditions including missing instances, missing CRDs, and authorization failures.

Parameters:

Name Type Description Default
dynClient DynamicClient

OpenShift dynamic client for cluster API interactions.

 required
instanceId str

The unique identifier of the AI Service instance to verify.

 required

Returns:

Name Type Description
bool bool

True if the instance exists and is accessible, False otherwise. Returns False if the instance is not found, the CRD doesn't exist, or authorization fails.
Source code in src/mas/devops/aiservice.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def verifyAiServiceInstance(dynClient: DynamicClient, instanceId: str) -> bool:
    """
    Verify that a specific AI Service instance exists in the cluster.

    This function checks if an AIServiceApp custom resource with the given instance ID
    exists in the expected namespace. It handles various error conditions including
    missing instances, missing CRDs, and authorization failures.

    Args:
        dynClient (DynamicClient): OpenShift dynamic client for cluster API interactions.
        instanceId (str): The unique identifier of the AI Service instance to verify.

    Returns:
        bool: True if the instance exists and is accessible, False otherwise.
              Returns False if the instance is not found, the CRD doesn't exist,
              or authorization fails.
    """
    try:
        aiserviceAPI = dynClient.resources.get(api_version="aiservice.ibm.com/v1", kind="AIServiceApp")
        aiserviceAPI.get(name=instanceId, namespace=f"aiservice-{instanceId}")
        return True
    except NotFoundError:
        print("NOT FOUND")
        return False
    except ResourceNotFoundError:
        # The AIServiceApp CRD has not even been installed in the cluster
        print("RESOURCE NOT FOUND")
        return False
    except UnauthorizedError as e:
        logger.error(f"Error: Unable to verify AI Service instance due to failed authorization: {e}")
        return False

listAiServiceTenantInstances(dynClient)

Retrieve all AI Service Tenant instances from the OpenShift cluster.

This function queries the cluster for AIServiceTenant custom resources and returns a list of all tenant instances found across all AI Service instances.

Parameters:

Name Type Description Default
dynClient DynamicClient

OpenShift dynamic client for cluster API interactions.

 required

Returns:

Name Type Description
list list

A list of dictionaries representing AI Service Tenant instances. Returns an empty list if no tenant instances are found or if errors occur.
Source code in src/mas/devops/aiservice.py 
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def listAiServiceTenantInstances(dynClient: DynamicClient) -> list:
    """
    Retrieve all AI Service Tenant instances from the OpenShift cluster.

    This function queries the cluster for AIServiceTenant custom resources and returns
    a list of all tenant instances found across all AI Service instances.

    Args:
        dynClient (DynamicClient): OpenShift dynamic client for cluster API interactions.

    Returns:
        list: A list of dictionaries representing AI Service Tenant instances.
              Returns an empty list if no tenant instances are found or if errors occur.
    """
    return listInstances(dynClient, "aiservice.ibm.com/v1", "AIServiceTenant")

verifyAiServiceTenantInstance(dynClient, instanceId, tenantId)

Verify that a specific AI Service Tenant exists in the cluster.

This function checks if an AIServiceTenant custom resource with the given instance ID and tenant ID exists in the expected namespace. The tenant resource name follows the pattern "aiservice-{instanceId}-{tenantId}".

Parameters:

Name Type Description Default
dynClient DynamicClient

OpenShift dynamic client for cluster API interactions.

 required
instanceId str

The unique identifier of the AI Service instance.

 required
tenantId str

The unique identifier of the tenant within the AI Service instance.

 required

Returns:

Name Type Description
bool bool

True if the tenant exists and is accessible, False otherwise. Returns False if the tenant is not found, the CRD doesn't exist, or authorization fails.
Source code in src/mas/devops/aiservice.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
def verifyAiServiceTenantInstance(dynClient: DynamicClient, instanceId: str, tenantId: str) -> bool:
    """
    Verify that a specific AI Service Tenant exists in the cluster.

    This function checks if an AIServiceTenant custom resource with the given instance ID
    and tenant ID exists in the expected namespace. The tenant resource name follows the
    pattern "aiservice-{instanceId}-{tenantId}".

    Args:
        dynClient (DynamicClient): OpenShift dynamic client for cluster API interactions.
        instanceId (str): The unique identifier of the AI Service instance.
        tenantId (str): The unique identifier of the tenant within the AI Service instance.

    Returns:
        bool: True if the tenant exists and is accessible, False otherwise.
              Returns False if the tenant is not found, the CRD doesn't exist,
              or authorization fails.
    """
    try:
        aiserviceTenantAPI = dynClient.resources.get(api_version="aiservice.ibm.com/v1", kind="AIServiceTenant")
        aiserviceTenantAPI.get(name=f"aiservice-{instanceId}-{tenantId}", namespace=f"aiservice-{instanceId}")
        return True
    except NotFoundError:
        print("NOT FOUND")
        return False
    except ResourceNotFoundError:
        # The AIServiceApp CRD has not even been installed in the cluster
        print("RESOURCE NOT FOUND")
        return False
    except UnauthorizedError as e:
        logger.error(f"Error: Unable to verify AI Service Tenant due to failed authorization: {e}")
        return False

getAiserviceChannel(dynClient, instanceId)

Retrieve the update channel for an AI Service instance.

This function queries the Operator Lifecycle Manager (OLM) subscription for the AI Service instance to determine which update channel it is subscribed to.

Parameters:

Name Type Description Default
dynClient DynamicClient

OpenShift dynamic client for cluster API interactions.

 required
instanceId str

The unique identifier of the AI Service instance.

 required

Returns:

Name Type Description
str str | None

The channel name (e.g., "v1.0", "stable") if the subscription exists, None if the subscription is not found.
Source code in src/mas/devops/aiservice.py 
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
def getAiserviceChannel(dynClient: DynamicClient, instanceId: str) -> str | None:
    """
    Retrieve the update channel for an AI Service instance.

    This function queries the Operator Lifecycle Manager (OLM) subscription for the
    AI Service instance to determine which update channel it is subscribed to.

    Args:
        dynClient (DynamicClient): OpenShift dynamic client for cluster API interactions.
        instanceId (str): The unique identifier of the AI Service instance.

    Returns:
        str: The channel name (e.g., "v1.0", "stable") if the subscription exists,
             None if the subscription is not found.
    """
    aiserviceSubscription = getSubscription(dynClient, f"aiservice-{instanceId}", "ibm-aiservice")
    if aiserviceSubscription is None:
        return None
    else:
        return aiserviceSubscription.spec.channel