# airec-instance

Part of **AIREC**

# AIRec Instance Management Console Guide

## Operations Overview

| Operation | Console Entry | Prerequisites | Description |
|------|-----------|---------|------|
| Configure Installation Information | Console > ASI Platform > Onsite Delivery Tools / System Toolbox | Browser with Chrome recommended, Access to OPS1 eth0 IP address, Port 8848 open, ASI agent not yet deployed | Set up installation parameters and upload necessary files such as licenses during system setup. |
| Ignore IP Pool in Deployment Planning | Console > AIRec > Planning Delivery Stage > Implementation Stage > IP Address Allocation | Access to AIRec console with permissions, Active project in implementation stage | Exclude specific IP address pools from automatic planning in the Deployment Planner. |
| Set Installation Tags | Console > Deployment Planner > Server Installation | Server role groups defined, Rack model configured, Known server count | Assign tags to servers to control or customize their installation behavior. |
| Check Control Machine Clone Status | Console > Reports > System Reports | None | Monitor the cloning progress of a control machine during deployment. |
| Check OPS Service Deployment Status | Console > Tasks > Deployment Summary | Access to Apsara Infrastructure Management Framework console, Logon access to OPS1 server | Verify whether the OPS service has been successfully deployed. |
| Terminate Rolling Task | Console > Tasks > Running Tasks | Access to Apsara Infrastructure Management Framework console, Permission to manage tasks and clusters | Cancel or stop an ongoing rolling update or deployment task. |
| Check Cluster Resource Request Status | Console > Apsara Infrastructure Management Framework > Clusters > Dashboard | None | Monitor the status of resource allocation requests for a cluster. |
| Check Rolling Task Failure Information | Console > Apsara Infrastructure Management Framework > Tasks > Running Tasks | None | Inspect detailed error information when a rolling task fails. |
| Check Machine Desired State Status | Operations > Cluster Operations | None | Verify if a machine has reached its desired operational state in the Apsara console. |
| Deploy Cloud Products | Console > Deployment > Cloud Platform Deployment | IDC_CHECK successfully executed | Perform deployment operations for cloud platform products via the console. |
| Deploy Apsara Stack Product | Console > Apsara Stack > Products > Deploy Product | Access to Apsara Stack ASI console, Valid subscription or license | Deploy Apsara Stack products using the ASI console interface. |
| Deployment Preparation | Console > Deployment > Deployment Preparation | Mobile hard disk mounted to /mnt, OPS1 installed, Network ready | Carry out preparatory steps before initiating a deployment process. |
| Start IDC Check | Console > Apsara Stack > Deployment > IDC_CHECK | Software package copied, Network initialized, Final state directory copied | Initiate data center validation checks prior to deployment. |
| Start Delivery | Console > Project Overview > Start Delivery | Access to Apsara Stack Operation console, Correct OPS1 time, Out-of-band credentials | Begin the product delivery workflow after preparation. |
| Hardware Preparation for Private Cloud | Console > Apsara Stack > Deployment Planner > Hardware Preparation | Three physical machines, External clock source, USB drive ready | Prepare physical hardware infrastructure for private cloud deployment. |
| Prepare Toolkit and Installation Package | Console > Apsara Stack ASI > Deployment > Prepare Toolkit and Installation Package | Access to Apsara Stack ASI console, Mobile hard disk, Deployment Planner installed | Set up required toolkits and installation packages for Apsara Stack Agility. |
| Hardware Connection Check | Console > Device Management > Hardware Check | Device powered on, Cables securely attached | Validate physical connections between servers and network devices. |
| Install Operating System for OPS1 | (No console path – physical boot) | OS image from engineers | Perform OS installation on the OPS1 management node. |
| OPS1 Installation | Console > OPS1 > Installation | Private cloud environment, Root access, Network connectivity, Valid license | Complete full installation process for the OPS1 system. |
| Update ZStack License | Console > Apsara Stack Operations and Maintenance Management > Product List > IaaS > ZStack | ZStack product deployed successfully | Apply or renew a ZStack software license through the console. |
| Configure Cloud Products | Deployment Planner > Manage Cloud > Display version list > Cloud Service Configuration > Cloud Products | Customer and pre-sales projects created, Cloud instance imported | Set up and customize cloud product configurations post-deployment. |
| Create Server Software List | Console > AIRec > Server Software List > Create Server Software List | Product models modifiable, Access to Generate server software list page | Define a list of software components to be installed on servers. |
| Data Center Survey | Deployment Planner > Manage Cloud > Display version list > Data Center Investigation | Business planning complete | Upload survey data about the physical data center environment. |
| Device Installation | Console > Device Management > Device Installation | Data center survey uploaded, Templates available | Physically install and register network devices and servers in the system. |
| Edit Global Variables | Apsara Stack Deployment Planner > Cloud Instance Management > Edit Global Variables | Business planning completed | Modify system-wide configuration variables that affect deployment behavior. |
| Download Plan Data and Metadata | Cloud Instance Management > Project List > Display Version List > Operation > Management > Export Planning Data | None | Retrieve deployment plan data and ASI metadata files for offline use or audit. |

## Operation Steps

### Configure Installation Information

**Navigation**: Console > ASI Platform > Onsite Delivery Tools / System Toolbox

**Prerequisites**:
- Browser with Chrome recommended
- Access to OPS1 eth0 IP address
- Port 8848 open for connection
- ASI agent not yet deployed in environment

1. Open your browser  
   - Element: **browser** (text_input) — top of screen  
   - Notes: We recommend using Chrome.

2. Enter the ASI access address in the address bar and press Enter  
   - Element: **Enter** (button) — address bar  
   - Notes: The default port is 8848. Format: IP:8848, e.g., 10.201.*.*:8848.

3. Move the pointer over the **Onsite Delivery Tools** icon and click related tools  
   - Element: **Onsite Delivery Tools** (menu) — main dashboard  
   - Notes: Icons are visible after logging in. Click specific tools from the dropdown.

4. Move the pointer over the **System Toolbox** and click related tools  
   - Element: **System Toolbox** (menu) — main dashboard  
   - Notes: Contains tools like ASI system cleanup, download startup script, install drivers, unlock.

### Ignore IP Pool in Deployment Planning

**Navigation**: Console > AIRec > Planning Delivery Stage > Implementation Stage > IP Address Allocation

**Prerequisites**:
- Access to the AIRec console with appropriate permissions
- An active project in the implementation stage

1. Navigate to the **IP Address Allocation** page in the planning delivery stage  
   - Element: **IP Address Allocation** (link) — left navigation panel  
   - Notes: 

2. Select the **IP Pool Configuration** tab  
   - Element: **IP Pool Configuration** (tab) — top of the page  
   - Notes: 

3. Click the **Ignore or Not** option for the IP address pool that does not need to be planned  
   - Element: **Ignore or Not** (checkbox) — first column of the IP pool row  
   - Notes: If selected, Deployment Planner will skip calculation for this pool even if data is entered. If not selected, the pool must be filled and will be included in planning.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Ignore or Not | checkbox | No | — | Determines whether the IP address pool should be ignored during Deployment Planner calculations. When checked, no input is required and the pool is skipped. |

### Set Installation Tags

**Navigation**: Console > Deployment Planner > Server Installation

**Prerequisites**:
- Server role groups must be defined before setting tags
- Rack model must be configured
- Number of servers to install must be known

1. Configure tags in Table C for server racks  
   - Element: **Business attribute tag** (text_input) — Table C (for server racks only)  
   - Notes: For rack-level tags, enter a single tag name. For network area, use GE or 10 GE. For device slot-level tags, use format: tag:slot1,slot2-3;tag2:slot4-8.

2. Configure tags for server role groups on the Server Installation page  
   - Element: **Tag1** (checkbox) — Server Installation page  
   - Notes: Ensure the number of tagged device slots matches or exceeds the number of servers in the group. Example: Three servers tagged with Tag1 require at least three device slots labeled Tag1.

3. Modify **Rack Model** and click **Automatically Install Servers On Racks**  
   - Element: **Automatically Install Servers On Racks** (button) — top-right corner of the Server Installation page  
   - Notes: If tagged slots equal server count, select 'No Dispersion Requirement for ASWs'. If more slots available and even dispersion is possible, choose a suitable dispersion policy.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Business attribute tag | text | No | — | Enter a custom tag name or network area (GE/10 GE) for the rack-level tag. |
| Rack Model | dropdown | Yes | Standard Rack, High-Density Rack, Custom Rack | Select the rack model to determine installation behavior. |
| Installation Mode | dropdown | Yes | No Dispersion Requirement for ASWs, Even Dispersion, Minimal Dispersion, Custom Dispersion | Choose the installation mode based on the number of tagged device slots and server count. |

### Check Control Machine Clone Status

**Navigation**: Console > Reports > System Reports

1. Log on to the Apsara Infrastructure Management Framework console and navigate to **System Reports**  
   - Element: **Reports** (menu) — top navigation bar  
   - Notes: 

2. Click **Machine Info Report** in the Report column on the System Reports page  
   - Element: **Machine Info Report** (link) — main content area  
   - Notes: The Machine Info Report page appears. If 'GOOD' is displayed in the Machine Status column, the machine is cloned. If 'OS_ERROR' is displayed, the clone failed.

3. Navigate to **Machine Operations** from the top navigation bar  
   - Element: **Operations** (menu) — top navigation bar  
   - Notes: 

4. Select the machine to reclone and click **Machine Operation**  
   - Element: **Machine Operation** (button) — corresponding row on the Machine Operations page  
   - Notes: A dialog box appears with operation options.

5. Select **Reclone** from the dialog box options  
   - Element: **Reclone** (radio) — dialog box  
   - Notes: 

6. Click **Confirm** to execute the reclone operation  
   - Element: **Confirm** (button) — dialog box  
   - Notes: 

### Check OPS Service Deployment Status

**Navigation**: Console > Tasks > Deployment Summary

**Prerequisites**:
- Access to Apsara Infrastructure Management Framework console
- Logon access to OPS1 server

1. Go to the **Deployment Summary** page  
   - Element: **Tasks** (menu) — top navigation bar  
   - Notes: 

2. Click the **Deployment Details** tab  
   - Element: **Deployment Details** (tab) — top navigation panel  
   - Notes: 

3. View deployment progress details for the ops line  
   - Element: **Details** (button) — Deployment Progress column  
   - Notes: Move pointer over tianji line first, then click Details. The pane shows the status of each server role; a tick sign indicates desired state.

4. Run **docker ps -a** command on OPS1  
   - Element: **docker ps -a** (text_input) — terminal/command line  
   - Notes: The output should show all Docker containers for the OPS service as running. Screenshot provided in the document confirms expected output.

### Terminate Rolling Task

**Navigation**: Console > Tasks > Running Tasks

**Prerequisites**:
- Access to the Apsara Infrastructure Management Framework console
- Permission to manage tasks and clusters

1. Log on to the Apsara Infrastructure Management Framework console and navigate to **Running Tasks**  
   - Element: **Tasks** (menu) — top navigation bar  
   - Notes: 

2. Optionally set search conditions to filter clusters  
   - Element: **Set search conditions** (text_input) — main content area  
   - Notes: Screenshot shows search interface with filters.

3. Select the cluster associated with the rolling task to be terminated  
   - Element: **cluster** (checkbox) — task list table  
   - Notes: 

4. Hover over **running** in the Rolling Task Status column and click **View Tasks**  
   - Element: **View Tasks** (link) — Rolling Task Status column  
   - Notes: Task details page appears after clicking.

5. In the Change Task section, open the **Actions** drop-down list and select **Stop** to terminate the task  
   - Element: **Stop** (button) — Actions column  
   - Notes: Screenshot confirms the action button is visible in the dropdown.

### Check Cluster Resource Request Status

**Navigation**: Console > Apsara Infrastructure Management Framework > Clusters > Dashboard

1. Log on to the Apsara Infrastructure Management Framework console and navigate to the cluster dashboard  
   - Element: **Dashboard** (link) — left-side navigation pane  
   - Notes: Move the pointer over the icon next to the cluster and click Dashboard to go to the Cluster Dashboard page.

2. Locate and review the **Cluster Resource Request Status** and **Cluster Resource** sections  
   - Element: **Cluster Resource Request Status** (section) — main content area  
   - Notes: The status of the cluster resource request is displayed in this section. Refer to the screenshot for visual guidance.

### Check Rolling Task Failure Information

**Navigation**: Console > Apsara Infrastructure Management Framework > Tasks > Running Tasks

1. Hover over the cluster icon and click **Dashboard**  
   - Element: **Dashboard** (button) — left navigation pane  
   - Notes: The Cluster Dashboard page appears with visual indicators of cluster status.

2. Right-click the message in the **Msg** column and select **Show More**  
   - Element: **Show More** (context_menu_item) — Cluster Resource Request Status section  
   - Notes: Displays detailed error information for failed resource requests.

3. Log on to the console and navigate to **Tasks > Running Tasks**  
   - Element: **Tasks** (menu) — top navigation bar  
   - Notes: 

4. Hover over the area next to **failed** and click **View Tasks**  
   - Element: **View Tasks** (button) — Running Tasks page  
   - Notes: Opens the Rolling Task page with failure details displayed.

### Check Machine Desired State Status

**Navigation**: Operations > Cluster Operations

1. Log on to the Apsara Infrastructure Management Framework console and navigate to **Cluster Operations**  
   - Element: **Operations** (menu) — top navigation bar  
   - Notes: 

2. Select a project on the **Cluster Operations** page  
   - Element: **Cluster Operations** (link) — main content area  
   - Notes: Look for a cluster where 'Other SR' is displayed in the Final Status of Normal Machines column.

3. Click on **Other SR** to view failure details  
   - Element: **Other SR** (link) — cluster operations table  
   - Notes: A failure details page appears showing server roles and machines not in the desired state. Screenshot included.

4. Click **View Details** in the Actions column to see more information  
   - Element: **View Details** (button) — Actions column  
   - Notes: Screenshot shows the detailed view of the cluster.

5. Click the name of a machine to view its information  
   - Element: **machine name** (link) — machine list  
   - Notes: 

6. Hover over **ERROR** in the SR Running Status column and click **Details** to see the error message  
   - Element: **Details** (button) — SR Running Status column  
   - Notes: Error message appears upon clicking. Screenshot included.

### Deploy Cloud Products

**Navigation**: Console > Deployment > Cloud Platform Deployment

**Prerequisites**:
- IDC_CHECK has been successfully executed

1. Click **Start Deployment** to begin the deployment process  
   - Element: **Start Deployment** (button) — top of the Start Deployment page  
   - Notes: 

2. Navigate to the **Deployment progress** page by clicking **Next**  
   - Element: **Next** (button) — left-side navigation pane  
   - Notes: 

3. View deployment details by clicking **Learn More** on the Deployment Progress page  
   - Element: **Learn More** (link) — Deployment Progress page  
   - Notes: 

4. Log in to the Apsara Infrastructure Management Framework portal via the link at the bottom of the page  
   - Element: **Apsara Infrastructure Management Framework portal link** (link) — bottom of the Deployment Progress page  
   - Notes: 

5. Select **Task > Deployment Overview** from the menu cascade to access the Deployment Overview page  
   - Element: **Task > Deployment Overview** (menu) — Apsara Infrastructure Management Framework portal  
   - Notes: 

6. Click **Deployment Details** at the top of the Deployment Overview page to view detailed deployment status  
   - Element: **Deployment Details** (button) — top of the Deployment Overview page  
   - Notes: 

7. Click the **Dependency** icon to view product dependencies  
   - Element: **Dependency icon** (icon) — Deployment Overview page  
   - Notes: If a product has a dependency, it will only deploy after its dependent product reaches final state.

8. Hover over a role with an alert and click **Details** to view alert-specific information  
   - Element: **Details** (button) — Deployment Progress column  
   - Notes: 

9. Click a role with an alert to view host, status, error cause, and monitoring data  
   - Element: **Role with alert** (link) — Deployment Progress column  
   - Notes: 

10. Click **Terminal** to log in to the host where the role is deployed  
    - Element: **Terminal** (button) — host information panel  
    - Notes: 

11. Click **Monitoring Statistics** to view alarm details  
    - Element: **Monitoring Statistics** (button) — Deployment Overview page  
    - Notes: 

12. After resolving alerts, continue to the next step  
    - Element: **Next** (button) — left-side navigation pane  
    - Notes: 

13. Confirm the deployment report on the **Deployment Completed** page and click **Completed** to finalize  
    - Element: **Completed** (button) — Deployment Completed page  
    - Notes: 

14. Optional: Click **System Toolbox > Unlock** to modify and redeploy if needed  
    - Element: **System Toolbox > Unlock** (menu) — Deployment Completed page  
    - Notes: The page is automatically locked after deployment; unlocking allows re-deployment.

### Deploy Apsara Stack Product

**Navigation**: Console > Apsara Stack > Products > Deploy Product

**Prerequisites**:
- Access to Apsara Stack ASI console with appropriate permissions
- Valid subscription or license for the target product

1. Log in to the Apsara Stack ASI console  
   - Element: **Sign In** (button) — top-right corner  
   - Notes: Use your organization's credentials. Ensure you are in the correct region.

2. Navigate to the **Products** section  
   - Element: **Products** (menu) — left navigation panel  
   - Notes: 

3. Click on **Deploy Product** to start the deployment wizard  
   - Element: **Deploy Product** (button) — main content area  
   - Notes: The deployment wizard will guide you through configuration options.

### Deployment Preparation

**Navigation**: Console > Deployment > Deployment Preparation

**Prerequisites**:
- Mobile hard disk with installation package mounted to /mnt directory
- OPS1 server installed and accessible
- Network configuration ready for initialization

1. Click the **Planning Overview** tab to view and confirm deployment plan information  
   - Element: **Planning Overview** (tab) — main content area  
   - Notes: 

2. Click the **OPS1 Environment Self-check** button to verify the OPS1 installation  
   - Element: **OPS1 Environment Self-check** (button) — left-side navigation pane  
   - Notes: If the result is 'Pass', the environment is normal.

3. Click **Next** in the left-side navigation pane to proceed to the Installation package copy page  
   - Element: **Next** (button) — left-side navigation pane  
   - Notes: 

4. Check that the mobile hard disk is mounted to /mnt and only one lz4 file exists in the directory  
   - Notes: If not, remount or update the lz4_dir field in conf.json.

5. Click the **Installation Package Copy** button to start copying the package  
   - Element: **Installation Package Copy** (button) — main content area  
   - Notes: The process may take a long time. The message 'copied successfully' will appear upon completion.

6. Click **Next** in the left-side navigation pane to enter the Network Initialization page  
   - Element: **Next** (button) — left-side navigation pane  
   - Notes: You can initiate network initialization while copying the package.

7. Click the **Network Initialization** button to start network bootstrap  
   - Element: **Network Initialization** (button) — main content area  
   - Notes: The process takes about half an hour. If it fails after one hour, use the Packet Capture Tool to diagnose.

8. After successful network initialization and package copy, click **Next** to go to the deployment completion page  
   - Element: **Next** (button) — left-side navigation pane  
   - Notes: 

9. Click the **IDC_CHECK** button to proceed to the IDC_CHECK stage  
   - Element: **IDC_CHECK** (button) — main content area  
   - Notes: 

### Start IDC Check

**Navigation**: Console > Apsara Stack > Deployment > IDC_CHECK

**Prerequisites**:
- Software installation package copy completed
- Network initialization successful
- tianji_imports final state directory copied to u_disk
- HTTPS certificate copied to /tmp/certificate4bootstrap

1. Click **Start IDC_CHECK** on the Start IDC_CHECK page  
   - Element: **Start IDC_CHECK** (button) — top of the page  
   - Notes: After clicking, the system begins cloning base machines. The last step is 'Finally Submit The Final State'.

2. Click **Next** in the left-side navigation pane after submitting the final state  
   - Element: **Next** (button) — left-side navigation panel  
   - Notes: This displays the IDC_CHECK Status Display page showing clone progress and status for each machine.

3. Click **Run** to re-clone a machine if it fails  
   - Element: **Run** (button) — on the IDC_CHECK Status Display page  
   - Notes: Only available when a machine's clone status shows failure.

4. Click **Next** after confirming all machines are successfully cloned  
   - Element: **Next** (button) — on the IDC_CHECK Status Display page  
   - Notes: Proceeds to the IDC_CHECK completion page.

5. Click **Cloud Platform Deployment** in the left-side navigation pane  
   - Element: **Cloud Platform Deployment** (link) — left-side navigation panel  
   - Notes: Only proceed after confirming all clone progress is 100% and status is success.

### Start Delivery

**Navigation**: Console > Project Overview > Start Delivery

**Prerequisites**:
- Access to the Apsara Stack Operation console via browser (Chrome recommended)
- Knowledge of the OPS1 eth0 IP address and port 8848
- Correct system time on OPS1
- Server out-of-band username and password

1. Open your browser (Chrome is recommended)  
   - Notes: 

2. Enter the API access address in the address bar, and then press Enter to log on to the Apsara Stack Operation console  
   - Element: **Enter** (text_input) — address bar  
   - Notes: The API accesses the machine group through the eth0 IP address of OPS1. The default port is 8848. The address format is IP:8848, for example, 10.201. *. *:8848.

3. In the **Project Overview** page, confirm the project information and set Cloud Architecture and Delivery Scenario  
   - Element: **Project Overview** (link) — top navigation panel  
   - Notes: See descriptions for key parameters: Cloud Architecture (select Apsara Stack), Delivery Scenario (Standard Delivery Mode or Quick Installation Mode).

4. After completing the configurations, click **Start Delivery**  
   - Element: **Start Delivery** (button) — main content area  
   - Notes: 

5. In the dialog box that appears, confirm the OPS1 system time, server out-of-band user name, and password  
   - Notes: Screenshot shows confirmation fields for system time and credentials.

6. After you confirm that the information is correct, click **Confirm** to enter this delivery  
   - Element: **Confirm** (button) — dialog box  
   - Notes: 

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| OPS1 System Time | text | Yes | — | The current system time on the OPS1 machine must be accurate for delivery to proceed. |
| Server Out-of-Band User Name | text | Yes | — | The username for accessing the server via out-of-band management interface. |
| Server Out-of-Band Password | password | Yes | — | The password for the server out-of-band management account. |

### Hardware Preparation for Private Cloud

**Navigation**: Console > Apsara Stack > Deployment Planner > Hardware Preparation

**Prerequisites**:
- At least three physical machines with specified network port configurations
- External and stable clock source available
- USB flash drive or portable hard disk ready
- Existing OPS2 server uninstalled (tianji-client removed)
- Existing OPS1 server cleaned up if not cloned

1. Locate the **OPS1 physical machine** in Apsara Stack Deployment Planner  
   - Element: **OPS1 physical machine** (link) — Deployment Planner interface  
   - Notes: Deliver the machine to on-site engineers along with the USB flash drive or portable hard disk.

2. Insert the USB flash drive into the USB port of OPS1  
   - Element: **USB port** (text_input) — Front panel of OPS1 physical machine  
   - Notes: Ensure the device is properly inserted before starting or restarting the machine.

3. Start or restart the physical machine  
   - Element: **Power button** (button) — Top-right corner of the machine chassis  
   - Notes: The system will boot from the USB device if configured correctly.

### Prepare Toolkit and Installation Package

**Navigation**: Console > Apsara Stack ASI > Deployment > Prepare Toolkit and Installation Package

**Prerequisites**:
- Access to Apsara Stack ASI console
- Mobile hard disk provided by delivery personnel
- Apsara Stack Deployment Planner installed

1. Navigate to the deployment section in the Apsara Stack ASI console  
   - Element: **Deployment** (menu) — left navigation panel  
   - Notes: 

2. Click on **Prepare Toolkit and Installation Package** in the deployment menu  
   - Element: **Prepare Toolkit and Installation Package** (link) — main content area  
   - Notes: 

3. Review the list of required components and their sources  
   - Notes: The table lists all required packages and how to obtain them. Some require manual creation (e.g., HTTPS certificate directory), while others are downloadable or pre-provided.

### Hardware Connection Check

**Navigation**: Console > Device Management > Hardware Check

**Prerequisites**:
- Device must be powered on
- Cables and connectors must be securely attached

1. Navigate to the **Hardware Connection Check** page  
   - Element: **Hardware Connection Check** (link) — left navigation panel  
   - Notes: Ensure you are in the correct project context before proceeding.

2. Click the **Check Connection** button to start the verification process  
   - Element: **Check Connection** (button) — main content area  
   - Notes: The system will perform a diagnostic scan of all connected hardware components.

### Install Operating System for OPS1

**Navigation**: (No console path – physical boot)

**Prerequisites**:
- You have obtained the operating system image from the onsite engineers.

1. After self-check, manually select the start method according to the machine model, such as F7 for a Foxconn machine or F11 for a Huawei machine. Press F12 as prompted  
   - Element: **Start Menu** (dialog) — top of screen after boot  
   - Notes: A virtual machine is used in the example. The prompt appears after system self-check.

2. On the **Start Menu** window, select **Removable Devices** to choose the USB-based start mode  
   - Element: **Removable Devices** (menu) — in the Start Menu window  
   - Notes: 

3. Load files during installation  
   - Notes: No user interaction required; system automatically loads files.

4. Start the operating system installation  
   - Notes: System begins installation automatically.

5. Run the post-install script  
   - Notes: System runs the script automatically.

6. After installation, plug out the USB flash disk and restart the system  
   - Notes: System displays 'Alibaba Group Enterprise Linux Server release 5.7' after reboot.

### OPS1 Installation

**Navigation**: Console > OPS1 > Installation

**Prerequisites**:
- A private cloud environment with sufficient compute resources
- Root access to the target server
- Network connectivity to the internal registry
- Valid license key for OPS1

1. Navigate to the **OPS1 installation** page  
   - Element: **Installation** (menu) — left navigation panel  
   - Notes: 

2. Upload the license key file  
   - Element: **Upload License Key** (button) — main content area  
   - Notes: The file must be in .lic format and valid.

3. Select the deployment mode (Standard or High Availability)  
   - Element: **Deployment Mode** (dropdown) — configuration section  
   - Notes: High Availability requires at least three nodes.

4. Click **Start Installation**  
   - Element: **Start Installation** (button) — bottom of the page  
   - Notes: The process may take up to 30 minutes.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| License Key | text_input | Yes | — | Enter the license key provided by AIRec support. |
| Deployment Mode | dropdown | Yes | Standard, High Availability | Choose the desired deployment architecture. |
| Node Count | number | No | — | Number of nodes for HA deployment (minimum 3). |

### Update ZStack License

**Navigation**: Console > Apsara Stack Operations and Maintenance Management > Product List > IaaS > ZStack

**Prerequisites**:
- The ZStack product has been deployed successfully.

1. Log on to the ZStack operations console  
   - Element: **product Operations and Maintenance Management** (menu) — left navigation panel  
   - Notes: 

2. Click the user avatar in the upper-right corner and then click **About**  
   - Element: **About** (link) — upper-right corner  
   - Notes: 

3. In the License page, click **Request Code** to save the license request code of the current ZStack management node  
   - Element: **Request Code** (button) — License page  
   - Notes: 

4. Click **More** in the upper-left tab. On the node list, click **Request Code** column to download the license request code for another ZStack management node  
   - Element: **Request Code** (button) — node list  
   - Notes: 

5. Apply for a POC license by providing the two license request codes to PM or CBM  
   - Notes: 

6. Log on to the ZStack operations console  
   - Notes: 

7. On the ZStack page, click the user avatar in the upper-right corner and then click **About**  
   - Element: **About** (link) — upper-right corner  
   - Notes: 

8. Import the POC license for the current ZStack management node  
   - Element: **Upload License** (button) — License page  
   - Notes: 

9. In the **Upload License** dialog box, select the POC license for the current node  
   - Element: **Upload License** (dialog) — dialog box  
   - Notes: 

10. After the license is uploaded, click **Confirm**  
    - Element: **Confirm** (button) — dialog box  
    - Notes: 

11. Import the POC license for another ZStack management node  
    - Element: **Upload license** (button) — Actions column  
    - Notes: 

12. In the **Upload License** dialog box, select the POC license for the node  
    - Element: **Upload License** (dialog) — dialog box  
    - Notes: 

13. After the license is uploaded, click **Confirm**  
    - Element: **Confirm** (button) — dialog box  
    - Notes: 

14. Click the **License** and **More** tab. On both nodes, check License Type, Number of Authorized Physical Machines, Issue Time and Expiration Time etc.  
    - Element: **License** (tab) — top navigation  
    - Notes: 

15. Obtain the IP addresses of all hosts from Apsara Infrastructure Management Framework  
    - Element: **Operations > Cluster Operations** (menu) — left navigation panel  
    - Notes: 

16. In the Cluster Details page, click **Machine Management** to view the information of all physical servers  
    - Element: **Machine Management** (button) — Cluster Details page  
    - Notes: 

17. Obtain the IP address of the added physical server from the ZStack operations console  
    - Element: **hardware facilities > physical Machine** (menu) — left-side navigation pane  
    - Notes: 

18. In the **Physical Machine** page, click **add a physical server**, and then fill in the parameters in the add a physical server page  
    - Element: **add a physical server** (button) — Physical Machine page  
    - Notes: 

19. After configuring the parameters, click **Confirm**  
    - Element: **Confirm** (button) — add a physical server form  
    - Notes: 

20. When adding a physical server, you can click **add a physical server** in the physical Machine page and view the status and progress of the task  
    - Element: **add a physical server** (button) — physical Machine page  
    - Notes: 

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Creation Method | dropdown | Yes | Manual | Select the method to create the physical server. |
| Parameter | text_input | No | — | The recommended naming format is host-IP. When adding through IP range, you set host and the system will automatically add IP. |
| Overview | text_input | No | — | The description of the physical server. We recommend that you set this parameter based on the usage of the physical server, to facilitate recognition. |
| Cluster | dropdown | Yes | — | Click +, and then select the cluster on the right. |
| Type | dropdown | Yes | KVM, x-Dragon | Select the supported KVM or x-Dragon according to the actual situation. |
| Add server IP | dropdown | Yes | IP, IP range | Two approaches are supported: IP or IP range. |
| IOMMU settings for scanning physical machines | checkbox | No | — | Scans the IOMMU of the host to enable GPU passthrough. This check item is not selected by default. |
| Turn off Intel EPT hardware assistance | checkbox | No | — | The Intel EPT hardware assistance feature is enabled. If the CPU model of the server is too old, the ECS instance cannot be created or the created ECS instance cannot be displayed on the console interface. |
| The SSH port | text_input | Yes | — |  |
| Username | text_input | Yes | — |  |
| Password | text_input | Yes | — |  |
| Add more physical machines | checkbox | No | — | When Add Server IP is set to IP, this configuration items is available. Click +. Then, you can add more physical servers. |

### Configure Cloud Products

**Navigation**: Deployment Planner > Manage Cloud > Display version list > Cloud Service Configuration > Cloud Products

**Prerequisites**:
- A customer and pre-sales projects of the customer are created
- A cloud instance is created in Deployment Planner and the pre-sales projects are imported to Deployment Planner

1. Log on to **Deployment Planner**  
   - Element: **Deployment Planner** (link) — top navigation  
   - Notes: 

2. Find the cloud instance and click **Manage Cloud**  
   - Element: **Manage Cloud** (button) — main content area  
   - Notes: 

3. Find the project and click **Display version list** in the Operation column  
   - Element: **Display version list** (button) — Operation column  
   - Notes: 

4. Find the version and click the icon in the **Cloud Service Configuration** column to go to the Cloud Products step  
   - Element: **Cloud Service Configuration** (column header) — Versions list  
   - Notes: Click the icon within this column to navigate

5. Select the cloud product baseline  
   - Element: **Select the cloud product baseline** (text_input) — main content area  
   - Notes: Must confirm major/minor versions and server hardware generation

6. Select the product features under various service categories  
   - Element: **Elastic Computing** (tab) — lower part of the page  
   - Notes: Other tabs include Networking, Database Services, Storage, Large-scale Computing, Big Data, Middleware, Alibaba Cloud Security, Monitoring and O&M, Internal Software Modules (optional)

7. Click **Next** to go to the Server Software List step  
   - Element: **Next** (button) — bottom of the page  
   - Notes: 

### Create Server Software List

**Navigation**: Console > AIRec > Server Software List > Create Server Software List

**Prerequisites**:
- Product models can be modified if necessary
- Access to the Generate server software list page

1. View the server summary on the **Generate server software list** page  
   - Element: **Total Models by NIC** (text_input) — top section of the page  
   - Notes: 

2. View the product capabilities in the **Capability Evaluation** section  
   - Element: **Capability Evaluation** (section) — middle section of the page  
   - Notes: 

3. Click **Edit** in the upper-right corner of the Server section to enter editing mode  
   - Element: **Edit** (button) — upper-right corner of the Server section  
   - Notes: The server software list is initially in Locked state. Clicking Edit switches it to Editing state.

4. Modify the model, actual quantity, and revised quality values of servers  
   - Element: **Server** (section) — main content area  
   - Notes: Actual quantity = Calculated quantity + Revised quantity. Changing one updates the other automatically.

5. Click **Save** and then **Lock** to finalize changes  
   - Element: **Save** (button) — after editing  
   - Notes: 

6. Click **Next** to proceed to the Network Device List step  
   - Element: **Next** (button) — bottom of the page  
   - Notes: 

### Data Center Survey

**Navigation**: Deployment Planner > Manage Cloud > Display version list > Data Center Investigation

**Prerequisites**:
- Confirm that the business planning is complete for the project.

1. Log on to **Deployment Planner**  
   - Element: **Deployment Planner** (link) — top navigation  
   - Notes: 

2. Find the created cloud instance and click **Manage Cloud**  
   - Element: **Manage Cloud** (button) — project list  
   - Notes: 

3. In the project list, find the project and then click **Display version list** in the Operation column  
   - Element: **Display version list** (button) — Operation column  
   - Notes: 

4. In the version list, find the version and then click the icon in the **Data Center Investigation** column to go to the Data Center Investigation step  
   - Element: **Data Center Investigation** (icon) — Data Center Investigation column  
   - Notes: 

5. On the Data Center Investigation page, click **Export Data Center Checked Template** to export the data center survey template  
   - Element: **Export Data Center Checked Template** (button) — upper-left corner  
   - Notes: The template contains the number of racks and all sample data required for the planning. You must enter the rack information in the survey file based on the survey results.

6. Prepare the data center survey file  
   - Notes: Notes about the data center survey file: Device slot range must be continuous; ports can be non-continuous. The mapping between device slots and ports must be one-to-one in sequence.

7. After the data center survey file is prepared, click **Upload Data Center Checked File** in the upper-right corner of the page to upload the data center survey file  
   - Element: **Upload Data Center Checked File** (button) — upper-right corner  
   - Notes: 

8. In the dialog box that appears, click **Select File** to select the file to be uploaded, and then click **Confirm**  
   - Element: **Select File** (button) — dialog box  
   - Notes: 

9. Turn off the **Display Rack Graph** switch and the rack layout graph is converted into a rack information list  
   - Element: **Display Rack Graph** (toggle) — page header  
   - Notes: After the file is uploaded, the rack details are converted into a rack layout graph at the lower part of the page. Network racks are in green, server racks are in orange.

10. After you confirm that the data center and rack information is correct, click **Next** to install the devices  
    - Element: **Next** (button) — bottom of the page  
    - Notes: 

### Device Installation

**Navigation**: Console > Device Management > Device Installation

**Prerequisites**:
- Data center survey file uploaded
- Network device installation table template available
- Server installation information prepared

1. Click **Export Rack Table Template** on the Network Device Installation page  
   - Element: **Export Rack Table Template** (button) — top of the Network Device Installation page  
   - Notes: The template includes required fields: Machine SN, Room, Rack Num, and Rack Position. Room is pre-filled based on the uploaded data center survey file.

2. Fill in relevant information in the exported network device installation table template  
   - Notes: This version does not support automatic delivery of network configurations. ASW configuration must be done manually by field engineers.

3. Click **Import Rack Table** to upload the completed installation table  
   - Element: **Import Rack Table** (button) — top of the Network Device Installation page  
   - Notes: A dialog box appears after clicking; select a file using 'Select File', then click 'Open' and 'OK' to complete upload.

4. Click **Next** to proceed to the Server Installation page  
   - Element: **Next** (button) — bottom of the Network Device Installation page  
   - Notes: Displays product model quantities and installation details.

5. Set the server installation mode  
   - Notes: Two MiniRDS servers must be installed in two separate racks.

6. Set installation tags  
   - Notes: Refer to external documentation for more information on setting installation tags.

7. Click **Automatically Install Servers On Racks** to calculate installation locations  
   - Element: **Automatically Install Servers On Racks** (button) — Server Installation page  
   - Notes: After successful execution, the system displays the number of ASWs and racks used. Hovering over numbers shows detailed information.

8. Export rack table to modify server installation information  
   - Element: **Export Rack Table** (button) — Server Installation page  
   - Notes: Must be performed after successful automatic installation. The exported table contains updated data from Tables A and C.

9. Enter SN and modify Room, Rack No., and Device Slot in the exported table  
   - Notes: Fields can be edited before re-importing.

10. Click **Import Rack Table** to import the modified server installation table  
    - Element: **Import Rack Table** (button) — Server Installation page  
    - Notes: After import, the server installation location updates accordingly.

11. Click **Next** to go to the Network Connection page  
    - Element: **Next** (button) — bottom of the Server Installation page  
    - Notes: Confirms final installation information before proceeding.

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| Machine SN | text | Yes | — | Unique identifier for the network device. |
| Room | dropdown | Yes | Pre-filled from data center survey file | Location where the device will be installed. |
| Rack Num | text | Yes | — | Number of the rack where the device is placed. |
| Rack Position | text | Yes | — | Position within the rack (e.g., slot number). |
| SN | text | Yes | — | Serial number of the server to be installed. |
| Room | dropdown | No | — | Installation room for the server. |
| Rack No. | text | No | — | Rack number for server placement. |
| Device Slot | text | No | — | Slot position within the rack for the server. |

### Edit Global Variables

**Navigation**: Apsara Stack Deployment Planner > Cloud Instance Management > Edit Global Variables

**Prerequisites**:
- Project has completed business planning

1. Log on to the **Apsara Stack Deployment Planner**  
   - Element: **Apsara Stack Deployment Planner** (link) — top navigation panel  
   - Notes: 

2. Locate the created cloud instance topology and click **Manage Cloud Instance**  
   - Element: **Manage Cloud Instance** (button) — main content area  
   - Notes: 

3. Select Region and click **Edit Global Variables**  
   - Element: **Edit Global Variables** (button) — top-right corner  
   - Notes: 

4. Enter relevant information in the **View Global Variables** dialog box  
   - Element: **View Global Variables** (dialog) — center of screen  
   - Notes: Fields include city, internet-domain, intranet-domain, project, version, vpc_customer_private_cidr, stable_clock, defaultLocale, timezone. Values must meet specific format and constraint rules.

5. After editing, click **Save**  
   - Element: **Save** (button) — bottom of dialog  
   - Notes: 

| Parameter | Type | Required | Options/Values | Description |
|-----------|------|----------|----------------|-------------|
| city | text_input | Yes | — | The city where the cloud platform is deployed can be entered as the city where the project is located. Enter English letters. The city name cannot be blank. |
| internet-domain | text_input | Yes | — | The user-side Internet domain name must be provided by the customer and cannot be blank. Cannot be the same as intranet-domain. |
| intranet-domain | text_input | Yes | — | The intranet domain name on the O&M side, which must be provided by the customer and cannot be blank. Cannot be the same as internet-domain. |
| project | text_input | Yes | — | Project name, lowercase English letters or numbers, cannot be blank. Recommended: abbreviation of pinyin. Max 32 characters for AZone. |
| version | text_input | Yes | — | The Apsara Stack version to be deployed on site must be accurate to three sections (x. y. z) and cannot be blank. |
| vpc_customer_private_cidr | text_input | Yes | — | The value must be in the range of vpc_default_private_cidr and in the required format. Square brackets are required. Must not exceed 10 IP network segments. |
| stable_clock | text_input | Yes | — | The IP address of the external and stable clock source that is required by the cloud platform. Provided by customer or purchased separately. |
| defaultLocale | text_input | No | — | The default language of the cloud platform. |
| timezone | dropdown | Yes | Asia/Shanghai, UTC, Europe/London, America/New_York | The time zone of the region. Generally select Asia/Shanghai for projects in mainland China. |

### Download Plan Data and Metadata

**Navigation**: Cloud Instance Management > Project List > Display Version List > Operation > Management > Export Planning Data

1. Find the corresponding project and click **Display Version List**  
   - Element: **Display Version List** (button) — Cloud Instance Management page  
   - Notes: 

2. In the Operation column, click **Management > Export Planning Data**  
   - Element: **Management** (menu) — Operation column  
   - Notes: 

3. Click **Management > Export Planning Data**  
   - Element: **Export Planning Data** (menu) — Operation column  
   - Notes: Screenshot shows export interface: 'Export Plan Data' page

4. Click **Download The API Plan Metadata** to download ASI_DATA.tar  
   - Element: **Download The API Plan Metadata** (button) — Export Plan Data page  
   - Notes: 

5. Click **Download Plan Data** to open the plan data in a new browser tab  
   - Element: **Download Plan Data** (button) — Export Plan Data page  
   - Notes: 

6. Right-click anywhere and select **Save as (A) ...** to download getOutput4TianjiNew.json  
   - Element: **Save as (A) ...** (menu) — Browser context menu  
   - Notes: File saved as getOutput4TianjiNew.json

## FAQ

Q: Where do I find the option to ignore an IP pool during planning?
A: Navigate to Console > AIRec > Planning Delivery Stage > Implementation Stage > IP Address Allocation, then select the IP Pool Configuration tab and check the "Ignore or Not" checkbox for the desired pool.

Q: Can I modify installation tags after they've been applied?
A: Yes, you can return to the Server Installation page in Deployment Planner, click Edit, adjust the tags in the Business attribute tag field, and then Save and Lock the changes.

Q: What should I do if a control machine clone fails?
A: Go to Console > Reports > System Reports > Machine Info Report to identify failed machines (marked as OS_ERROR), then navigate to Machine Operations, select the machine, choose Reclone from the dialog, and confirm.

Q: How do I verify that the OPS service is fully deployed?
A: Check the Deployment Summary page under Tasks in the Apsara console, then view Deployment Details for the ops line. Additionally, run "docker ps -a" on OPS1 to confirm all containers are running.

Q: Is there a way to stop a rolling task that's stuck?
A: Yes, go to Console > Tasks > Running Tasks, locate the cluster, click View Tasks in the Rolling Task Status column, then use the Actions dropdown to select Stop and confirm termination.

## Pricing & Billing

### Billing Model
per_instance_hour

### Price Reference
| Tier | Input Price | Output Price | Other Price |
|------|-------------|--------------|-------------|
| Standard | 0.15 / | |
| Hybrid Cloud Trial | Free | Free | Valid for 3 months, supports up to 10 physical machines |
| POC License | Free | Free | For proof of concept use only |
| Hybrid Cloud Edition | Paid | Paid | Full license with no time limit |
| Standard | 500 / | |
| High Availability | 1000 / | |

### Free Tier
The hybrid cloud trial license is free for 3 months and supports up to 10 physical machines. No free tier for OPS1 installation.

### Billing Notes
- Billing starts after successful installation completion for OPS1. Minimum 1-month commitment.
- POC licenses are temporary and must be replaced with a formal license after acceptance testing.
- The formal license is billed per instance hour.
- For Apsara Stack product deployment, billing is1.