The document provides guidance to install the ote-stack platform on AI Edge Blueprint, which covers the information of hardware requirement, prerequisite software and the detailed step. The ote-stack platform can be installed on Kubernetes or on a system with Docker support. The IEC cluster, which is based on Kubernetes, is chosen to be the edge infrastructure for AI Edge. The installation guide of IEC R2 can be got in here.
The guide shows step by step to deploy ote-stack platform with one edge cluster as well as add a new edge cluster to management.
Apache 2.0 license
The guide covers the details of pre-installation requirements, installation steps and uninstallation guide. The installation steps should be executed before the prerequisites and pre-installation requirements are ready. In addition, one IEC edge cluster with 3 nodes needs to be prepared in advance.
The Deployment Architecture uses one IEC edge cluster with 3 nodes as the basic infrastructure and the ote-stack platform will installed on the cluster.
This section describes the requirements for building IEC edge infrastructure and ote-stack platform. At least three edge nodes are needed to build the edge infrastructure.
HW Aspect | Requirement |
---|---|
1 Jumpserver | A physical or virtualized machine that has direct network connectivity to the edge nodes. |
CPU | Minimum 1 socket for IEC and 2 socket for ote-stack components and usecase test (each cluster node) |
RAM | Minimum 4GB/server (Depending on usecase work load) |
Disk | Minimum 20GB (each cluster node) |
Networks | Mininum 1 |
3 Huawei TaiShan 2280 Arm Server are required:
Processor | 2*Kunpeng 920 processor |
RAM | 12*32G-DDR4-2666MT/s |
Storage | 3*3.5 inch 4000G SATA and 1*2.5 inch 3200G NVMe SSD |
Network | 1 onboard network card, each card supports 4*GE port or 4*10GE port or 4*25GE port |
Refer TaiShan 2280 Server User Guide here
A mysql database is required to store the related metadata of OTE models, like users, businesses, projects, apps, deployments, clusters, nodes, etc. The database `sys_ote_manage_platform` is consists of following tables:
Following the installation steps below, a new mysql database container, which contains the configuration and db tables of OTE, will be deployed to edge cluster. If you need to store the OTE metadata in your own database, you can execute the following schema script to create the database and the related tables.
The following schema scripts will help you to generate the database for OTE-stack.
CREATE DATABASE sys_ote_manage_platform; USE sys_ote_manage_platform; SET names utf8; CREATE TABLE IF NOT EXISTS `tb_system_config` ( `key` varchar(64) NOT NULL, `value` varchar(64) NOT NULL, PRIMARY KEY (`key`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='system configuration'; CREATE TABLE IF NOT EXISTS `tb_business_info` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(64) NOT NULL COMMENT 'business name', `namespace` varchar(64) NOT NULL DEFAULT '' COMMENT 'namespace', `user_id` bigint(20) unsigned NOT NULL COMMENT 'user id', `introduce` varchar(512) NOT NULL COMMENT 'business introduction', `objective` varchar(512) NOT NULL COMMENT 'resource requirements', `scale` varchar(512) NOT NULL COMMENT 'business scale', `comment` varchar(512) NOT NULL DEFAULT '' COMMENT 'review comments', `status` tinyint NOT NULL DEFAULT 0 COMMENT 'status', `update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `create_time` TIMESTAMP NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`name`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; CREATE TABLE IF NOT EXISTS `tb_ote_web_users` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `uid` varchar(50) COLLATE utf8_unicode_ci NOT NULL COMMENT 'user id', `namespace` varchar(64) COLLATE utf8_unicode_ci DEFAULT '' COMMENT 'namespace', `user_name` varchar(50) COLLATE utf8_unicode_ci DEFAULT '' COMMENT 'username', `display_name` varchar(50) COLLATE utf8_unicode_ci DEFAULT '' COMMENT 'nickname', `real_name` varchar(50) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'real name', `password` varchar(60) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'password', `email` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'email', `phone` varchar(11) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'phone', `status` tinyint(4) unsigned NOT NULL DEFAULT '3' COMMENT 'status: 0:pending,1:reviewed,2:failed,3:forbidden,', `is_admin` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT 'is admin', `role` tinyint unsigned NOT NULL DEFAULT '0' COMMENT 'role:0:unauthorized,1:general manager,2:admin,3:super admin', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `created_at` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY `tb_ote_web_users_uid_unique` (`uid`) USING BTREE, UNIQUE KEY `tb_ote_web_users_phone_unique` (`phone`) USING BTREE, UNIQUE KEY `tb_ote_web_users_user_name_unique` (`user_name`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; CREATE TABLE IF NOT EXISTS `tb_ote_web_repository_users` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `namespace` varchar(64) NOT NULL DEFAULT '' COMMENT 'namespace', `repository_uid` bigint(20) unsigned DEFAULT '0' COMMENT 'uid', `repository_username` varchar(50) COLLATE utf8_unicode_ci NOT NULL COMMENT 'username', `repository_email` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'email', `repository_password` varchar(255) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'password', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `created_at` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`namespace`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='harbor user'; CREATE TABLE IF NOT EXISTS `tb_ote_web_third_repository` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `namespace` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'user namespace', `repository_id` varchar(50) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'repository id', `repository_url` varchar(500) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'repository addr', `repository_username` varchar(50) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'username, `repository_password` varchar(255) COLLATE utf8_unicode_ci NOT NULL COMMENT 'passwoed', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `created_at` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`namespace`, `repository_id`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci COMMENT='third repo'; CREATE TABLE IF NOT EXISTS `tb_ote_cluster_label` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `cluster_name` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'cluster name', `label` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'label', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `created_at` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`cluster_name`, `label`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; CREATE TABLE IF NOT EXISTS `tb_ote_node_label` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `cluster_name` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'cluste', `node_name` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'nodename', `label` varchar(64) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'node label', `updated_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `created_at` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY (`cluster_name`, `node_name`, `label`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; CREATE TABLE IF NOT EXISTS `tb_app_info` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `namespace` varchar(64) NOT NULL COMMENT 'namespace', `app_name` varchar(64) NOT NULL COMMENT 'app_name', `main_version` varchar(32) NOT NULL COMMENT 'major version', `version_count` int(11) NOT NULL COMMENT 'minor version', `image` varchar(256) NOT NULL COMMENT 'image', `repository_id` varchar(64) NOT NULL DEFAULT '' COMMENT 'repository_id', `port` varchar(1024) NOT NULL DEFAULT '0' COMMENT 'port', `env` varchar(1024) NOT NULL DEFAULT '' COMMENT 'env', `volume` varchar(1024) NOT NULL DEFAULT '' COMMENT 'volume', `dependence` varchar(1024) NOT NULL DEFAULT '' COMMENT '', `replicas` int(10) NOT NULL DEFAULT '1' COMMENT 'replicas', `command` varchar(512) NOT NULL DEFAULT '' COMMENT 'command', `deploy_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'deploy_type: 0:deployment, 1:daemonset', `gpu` int(10) NOT NULL DEFAULT '0', `request_cpu` int(10) NOT NULL DEFAULT '80', `request_mem` int(10) NOT NULL DEFAULT '4096', `limit_cpu` int(10) NOT NULL DEFAULT '80', `limit_mem` int(10) NOT NULL DEFAULT '4096', `min_replicas` int(10) NOT NULL DEFAULT '1', `max_replicas` int(10) NOT NULL DEFAULT '5', `is_hpa` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'is_hpa:0:no,1:yes', `hpa_target_cpu` int(10) NOT NULL DEFAULT '80', `hpa_target_mem` int(10) NOT NULL DEFAULT '4096', `min_ready_seconds` int(10) NOT NULL DEFAULT '10', `max_surge` int(10) NOT NULL DEFAULT '1', `max_unavailable` int(10) NOT NULL DEFAULT '0', `status` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'statur:0:init,1:success,2:fail,3:logical del,4:del', `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT , `create_time` timestamp NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY `namespace` (`namespace`,`app_name`,`main_version`,`version_count`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; CREATE TABLE IF NOT EXISTS `tb_deploy_info` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `name` varchar(128) NOT NULL COMMENT 'name', `namespace` varchar(64) NOT NULL COMMENT 'namespace', `app_name` varchar(64) NOT NULL COMMENT 'app_name', `version` varchar(48) NOT NULL COMMENT 'version', `cluster` varchar(64) NOT NULL COMMENT 'cluster', `node_label` varchar(64) NOT NULL DEFAULT 'all', `status` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'status', `editable` tinyint(4) NOT NULL DEFAULT '1' COMMENT 'editable: 0:no,1:yes', `running` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'running: 0:no,1:yes', `deploy_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'deploy_type: 0:new,1:upgrade,2:rollback,3:del', `comment` varchar(256) NOT NULL DEFAULT '' COMMENT 'comment', `audit_comment` varchar(256) NOT NULL DEFAULT '' COMMENT 'audit_comment', `error_message` varchar(256) NOT NULL DEFAULT '' COMMENT 'error_message', `update_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `create_time` timestamp NOT NULL, `execute_time` timestamp NOT NULL, PRIMARY KEY (`id`), KEY `name` (`namespace`,`name`), KEY `namespace` (`namespace`,`app_name`,`cluster`,`version`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; CREATE TABLE IF NOT EXISTS tb_domain_info ( `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT, `namespace` varchar(64) NOT NULL COMMENT 'namespace', `domain` varchar(128) NOT NULL COMMENT 'domain', `used_count` int NOT NULL DEFAULT 0 COMMENT 'used_count', `update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `create_time` TIMESTAMP NOT NULL, PRIMARY KEY(`id`), KEY(`namespace`), UNIQUE KEY(`domain`) ) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8; CREATE TABLE IF NOT EXISTS tb_ingress_info ( `id` BIGINT UNSIGNED NOT NULL AUTO_INCREMENT, `namespace` varchar(64) NOT NULL COMMENT 'namespace', `domain` varchar(128) NOT NULL COMMENT 'domain', `uri` varchar(128) NOT NULL COMMENT 'uri', `is_rewrite` int8 NOT NULL DEFAULT 0 COMMENT '', `deploy_name` varchar(64) NOT NULL COMMENT 'deploy name', `status` tinyint(4) NOT NULL DEFAULT '0' COMMENT 'status', `unique_key` varchar(64) NOT NULL DEFAULT 'unique key', `update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `create_time` TIMESTAMP NOT NULL, PRIMARY KEY(`id`), UNIQUE KEY(`namespace`,`unique_key`) ) ENGINE = InnoDB DEFAULT CHARACTER SET = utf8; CREATE TABLE IF NOT EXISTS `tb_alert_info` ( `id` bigint(20) unsigned NOT NULL AUTO_INCREMENT, `instance` varchar(100) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'alert host', `ipaddr` varchar(20) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'alert ip', `alert_name` varchar(100) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'alert name', `alert_user` varchar(50) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'alert user', `limit_value` varchar(10) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'alert limit value', `current_value` varchar(20) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'current alert value', `description` varchar(1000) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'description', `generator_url` varchar(500) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT '', `status` varchar(10) COLLATE utf8_unicode_ci NOT NULL DEFAULT '' COMMENT 'status', `update_time` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, `create_time` TIMESTAMP NOT NULL, PRIMARY KEY (`id`), UNIQUE KEY(`instance`, `alert_name`,`create_time`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci; |
Software requirements:
The prerequisites software should be ready.
N/A
Copy the kubeconfig file of IEC cluster to directory /root/.kube/config.
Clone the AIEdge git repo and edit the configuration file (interface_conf) by setting:
git clone https://gerrit.akraino.org/r/aiedge.git cd ote-stack/aiedge/deployments vim interface_conf |
Compile cluster controller, controller manager and shim components following below scripts. Then docker push the output image to a docker repository which is set in the interface_conf file.
bash build/build.sh build_image |
Other components are not source code released currently but released as docker images, and they can be pull from docker hub. Make sure that the docker repository set in the configuration file have all docker images required by ote-stack platform.
Simply start the installation script with default parameters in the same directory:
# create yaml file based on interface_conf sh create_yml.sh start # apply yaml file to cluster sh apply_yml.sh start |
All components of ote-stack will be installed on the IEC edge. But some components can be replaced with external ones outside the cluster through changing the parameter of yaml file. For example, the open-api server can connect to an existing mysql server by modifying the parameters `mysqlHost` and `mysqlPort` in file deployments/open-api/open-api.yml and commenting out the line to deploy mysql.
After executing the installation script, the ote-stack web platform will be deployed on the node1_name set in the configuration file and expose port 8995. Now you can open the website through URL http://<node1_name_ip>:8995/ to use ote-stack. Below is the the index page of OTE.
When ote-stack runs, a super administrator will be created. The username and password can be modified by changing parameters `superAdminName` and `superAdminPassword` in file deployments/open-api/open-api.yml. Note that the initial username and password of admin, only works for the first time when ote-stack starts.
If there is another cluster that needs to be added to the ote-stack, some components should be deployed on the edge to connect with root cluster:
Please refer section Bare Metal Deployment Guide for deployment, the installation can run successfully in virtual hardware too.
N/A
N/A
N/A
Please refer the section "Pre-Installation Requirements" in wiki IEC Type1&2 Installation Guide for R2 and make sure the environment requirements met.
Please prepare three arm servers and build a edge cluster according to wiki IEC Type1&2 Installation Guide for R2.
N/A
N/A
N/A
Verify manually:
Or Run installation and verify scripts through CI/CD.
N/A
N/A
N/A
# remove all components deployed in edge cluster sh apply_yml.sh stop |
MySQL data will be persisted on disk /home/work/ote/mysql-data/. You can use command `rm` to clean up the residual data.
N/A
N/A
N/A
N/A
N/A
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/