#Install Alauda AI

#Downloading the violet tool

First, we need to download the violet tool if not present on the machine.

Log into the Web Console and switch to the Administrator view:

1. Click Marketplace / Upload Packages.
2. Click Download Packaging and Listing Tool.
3. Locate the right OS / CPU architecture under Execution Environment.
4. Click Download to download the violet tool.
5. Run chmod +x ${PATH_TO_THE_VIOLET_TOOL} to make the tool executable.

#Uploading package

Save the following script in uploading-ai-cluster-packages.sh first, then read the comments below to update environment variables for configuration in that script.

#!/usr/bin/env bash
export PLATFORM_ADDRESS=https://platform-address  
export PLATFORM_ADMIN_USER=<admin>
export PLATFORM_ADMIN_PASSWORD=<admin-password>
export CLUSTER=<cluster-name>

export AI_CLUSTER_OPERATOR_NAME=<path-to-aml-operator-tarball>
export KNATIVE_OPERATOR_PKG_NAME=<path-to-knative-operator-tarball>

VIOLET_EXTRA_ARGS=()
IS_EXTERNAL_REGISTRY=

# If the image registry type of destination cluster is not platform built-in (external private or public repository).
# Additional configuration is required (uncomment following line):
# IS_EXTERNAL_REGISTRY=true
if [[ "${IS_EXTERNAL_REGISTRY}" == "true" ]]; then
    REGISTRY_ADDRESS=<external-registry-url>
    REGISTRY_USERNAME=<registry-username>
    REGISTRY_PASSWORD=<registry-password>

    VIOLET_EXTRA_ARGS+=(
        --dst-repo "${REGISTRY_ADDRESS}"
        --username "${REGISTRY_USERNAME}"
        --password "${REGISTRY_PASSWORD}"
    )
fi

# Push **Alauda AI Cluster** operator package to destination cluster
violet push \
    ${AI_CLUSTER_OPERATOR_NAME} \
    --platform-address=${PLATFORM_ADDRESS} \
    --platform-username=${PLATFORM_ADMIN_USER} \
    --platform-password=${PLATFORM_ADMIN_PASSWORD} \
    --clusters=${CLUSTER} \
    ${VIOLET_EXTRA_ARGS[@]}

# Push **Knative Operator** package to destination cluster
violet push \
    ${KNATIVE_OPERATOR_PKG_NAME} \
    --platform-address=${PLATFORM_ADDRESS} \
    --platform-username=${PLATFORM_ADMIN_USER} \
    --platform-password=${PLATFORM_ADMIN_PASSWORD} \
    --clusters=${CLUSTER} \
    ${VIOLET_EXTRA_ARGS[@]}

After configuration, execute the script file using bash ./uploading-ai-cluster-packages.sh to upload both Alauda AI and Knative Operator.

#Procedure

In Administrator view:

1. Click Marketplace / OperatorHub.

2. At the top of the console, from the Cluster dropdown list, select the destination cluster where you want to install Alauda AI.

3. Select Alauda AI, then click Install.

   Install Alauda AI window will pop up.

4. Then in the Install Alauda AI window.

5. Leave Channel unchanged.

6. Check whether the Version matches the Alauda AI version you want to install.

7. Leave Installation Location unchanged, it should be aml-operator by default.

8. Select Manual for Upgrade Strategy.

9. Click Install.

#Verification

Confirm that the Alauda AI tile shows one of the following states:

• Installing: installation is in progress; wait for this to change to Installed.
• Installed: installation is complete.

#Procedure

In Administrator view:

1. Click Marketplace / OperatorHub.

2. At the top of the console, from the Cluster dropdown list, select the destination cluster where you want to install.

3. Search for and select Knative Operator, then click Install.

   Install Knative Operator window will pop up.

4. Then in the Install Knative Operator window.

5. Leave Channel unchanged.

6. Check whether the Version matches the Knative Operator version you want to install.

7. Leave Installation Location unchanged.

8. Select Manual for Upgrade Strategy.

9. Click Install.

#Verification

Confirm that the Knative Operator tile shows one of the following states:

• Installing: installation is in progress; wait for this to change to Installed.
• Installed: installation is complete.

#Procedure

1. Create the knative-serving namespace.

   kubectl create ns knative-serving

2. In the Administrator view, navigate to Operators -> Installed Operators.

3. Select the Knative Operator.

4. Under Provided APIs, locate KnativeServing and click Create Instance.

5. Switch to YAML view.

6. Replace the content with the following YAML:

7. Click Create.

   apiVersion: operator.knative.dev/v1beta1
   kind: KnativeServing
   metadata:
     name: knative-serving
     namespace: knative-serving
   spec:
     # For ACP 4.0, use version 1.18.1
     # For ACP 4.1 and above, use version 1.19.6
     version: "1.18.1"
     config:
       deployment:
         registries-skipping-tag-resolving: kind.local,ko.local,dev.local,private-registry
       domain:
         example.com: ""
       features:
         kubernetes.podspec-affinity: enabled
         kubernetes.podspec-hostipc: enabled
         kubernetes.podspec-hostnetwork: enabled
         kubernetes.podspec-init-containers: enabled
         kubernetes.podspec-nodeselector: enabled
         kubernetes.podspec-persistent-volume-claim: enabled
         kubernetes.podspec-persistent-volume-write: enabled
         kubernetes.podspec-securitycontext: enabled
         kubernetes.podspec-tolerations: enabled
         kubernetes.podspec-volumes-emptydir: enabled
         queueproxy.resource-defaults: enabled
       network:
         domain-template: '{{.Name}}.{{.Namespace}}.{{.Domain}}'
         ingress-class: kourier.ingress.networking.knative.dev
     ingress:
       kourier:
         enabled: true

#Procedure

In Administrator view:

1. Click Marketplace / OperatorHub.

2. At the top of the console, from the Cluster dropdown list, select the destination cluster where you want to install the Alauda AI Operator.

3. Select Alauda AI, then Click.

4. In the Alauda AI page, click All Instances from the tab.

5. Click Create.

   Select Instance Type window will pop up.

6. Locate the AmlCluster tile in Select Instance Type window, then click Create.

   Create AmlCluster form will show up.

7. Keep default unchanged for Name.

8. Select Deploy Flavor from dropdown:

   1. single-node for non HA deployments.
   2. ha-cluster for HA cluster deployments (Recommended for production).

9. Set KServe Mode to Managed.

10. Input a valid domain for Domain field.

    INFO

    This domain is used by ingress gateway for exposing model serving services. Most likely, you will want to use a wildcard name, like *.example.com.

    You can specify the following certificate types by updating the Domain Certificate Type field:

    • Provided
    • SelfSigned
    • ACPDefaultIngress

    By default, the configuration uses SelfSigned certificate type for securing ingress traffic to your cluster, the certificate is stored in the knative-serving-cert secret that is specified in the Domain Certificate Secret field.

11. (Optional) If you want to enable Knative functionality, in the Serverless Configuration section, set Knative Serving Provider to Operator.

    INFO

    If you installed the Knative Operator to enable Serverless functionality in the previous steps, provide the following parameters to integrate it:

    • APIVersion: operator.knative.dev/v1beta1
    • Kind: KnativeServing
    • Name: knative-serving
    • Namespace: knative-serving

    If you are not using Knative functionality, leave the Knative Serving Provider as Removed (or empty) and the remaining parameters blank.

12. Under Gitlab section:

    1. Type the URL of self-hosted Gitlab for Base URL.
    2. Type cpaas-system for Admin Token Secret Namespace.
    3. Type aml-gitlab-admin-token for Admin Token Secret Name.

13. Review above configurations and then click Create.

#Verification

Check the status field from the AmlCluster resource which named default:

kubectl get amlcluster default

Should returns Ready:

NAME      READY   REASON
default   True    Succeeded

#Procedure

In Administrator view:

1. Click Marketplace / OperatorHub.
2. At the top of the console, from the Cluster dropdown list, select the destination cluster where Alauda AI is installed.
3. Select Alauda AI, then click the All Instances tab.
4. Locate the default instance and click Update.
5. In the update form, locate the Serverless Configuration section.
6. Set BuiltIn Knative Serving to Removed.
7. Click Update to apply the changes.