OpenPitrix

OpenPitrix 安装

OpenPitrix 支持 all-in-one 、 Kubernetes 和 Helm Chart 三种部署模式。

All-in-One 模式

All-in-One 模式，即单节点部署，需要预先安装 Docker 、 Docker-Compose 、 Make 等依赖软件。

Kubernetes 模式

部署到 Kubernetes 集群环境中， OpenPitrix 可作为基于 Kubernetes 的一个应用管理系统。

Helm-Chart 模式

将 OpenPitrix 以 Helm Chart 的方式部署到 Kubernetes 集群环境中，需要预先安装 Helm Client 和 Tille 。

All-in-One 模式

All-in-One 模式部署由 Docker-Compose 的方式启动运行项目，Compose 能够定义和运行多个 Docker 容器的应用，允许用户通过一个单独的 docker-compose.yml 模板文件（YAML 格式）来定义一组相关联的应用容器为一个项目（project），通过子命令可对项目中的一组容器进行便捷地生命周期管理。

第一步: 准备环境

主机环境

需要准备一台满足最小资源要求的主机节点开始 all-in-one 模式的部署。

CPU	Memory	磁盘
1 核	1 G	10 G

软件环境

All-in-One 模式需要依赖以下软件，请预先在主机中安装符合以下版本要求的软件:

软件需求	最低版本
Docker	18.03.0-ce
Docker-Compose	1.21.0
Make	3.81

说明：若主机已安装 Kubernetes 环境，可能会造成 docker 容器之间网络不通。

第二步: 准备 OpenPitrix 安装包

可通过 wget 命令从 GitHub 指定的 URL 下载 OpenPitrix v0.4.1 的 Docker Compose 安装文件。

$ wget https://github.com/openpitrix/openpitrix/releases/download/v0.4.1/openpitrix-v0.4.1-docker-compose.tar.gz

解压安装包：

$ tar -zxf openpitrix-v0.4.1-docker-compose.tar.gz

第三步: 部署 OpenPitrix

进入 openpitrix 安装目录，编译项目。该过程需要拉取多个 OpenPitrix 的 docker 镜像，拉取镜像和安装速度与网络也有关系，需要等待几分钟。

$ cd openpitrix-v0.4.1-docker-compose/
$ make

第四步: 验证

查看所有容器的运行状况，正常情况下所有容器状态应该如下所示，确保 OpenPitrix 相关的镜像都已经成功创建：

$ docker-compose ps
             Name                            Command                  State                           Ports
--------------------------------------------------------------------------------------------------------------------------------
openpitrix-account-service        account-service                  Exit 0
openpitrix-am-db-ctrl             flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-am-db-init             sh -c /flyway/sql/ddl/ddl_ ...   Exit 0
openpitrix-am-service             am serve                         Exit 0
openpitrix-api-gateway            api-gateway                      Up             0.0.0.0:9100->9100/tcp
openpitrix-app-db-ctrl            flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-app-manager            app-manager                      Up
openpitrix-attachment-db-ctrl     flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-attachment-manager     attachment-manager               Up
openpitrix-category-manager       category-manager                 Up
openpitrix-cluster-db-ctrl        flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-cluster-manager        cluster-manager                  Up
openpitrix-dashboard              npm run prod:serve               Up             0.0.0.0:8000->8000/tcp, 0.0.0.0:9300->9300/tcp
openpitrix-db                     docker-entrypoint.sh --low ...   Up             0.0.0.0:13306->3306/tcp
openpitrix-db-init                sh -c /flyway/sql/ddl/ddl_ ...   Exit 0
openpitrix-etcd                   etcd --data-dir /data --li ...   Up             0.0.0.0:12379->2379/tcp, 2380/tcp
openpitrix-iam-db-ctrl            flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-im-db-ctrl             flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-im-db-init             sh -c /flyway/sql/ddl/ddl_ ...   Exit 0
openpitrix-im-service             im serve                         Exit 0
openpitrix-isv-db-ctrl            flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-isv-manager            isv-manager                      Up
openpitrix-job-db-ctrl            flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-job-manager            job-manager                      Up
openpitrix-minio                  sh -c mkdir -p /data/openp ...   Up (healthy)   0.0.0.0:19000->9000/tcp
openpitrix-notification           notification                     Exit 0
openpitrix-notification-db-ctrl   flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-notification-db-init   sh -c /flyway/sql/ddl/ddl_ ...   Exit 0
openpitrix-pilot-service          pilot -config=/opt/openpit ...   Up             0.0.0.0:9110->9110/tcp, 0.0.0.0:9114->9114/tcp
openpitrix-repo-db-ctrl           flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-repo-indexer           repo-indexer                     Up
openpitrix-repo-manager           repo-manager                     Up
openpitrix-rp-aliyun              runtime-provider                 Up
openpitrix-rp-aws                 runtime-provider                 Up
openpitrix-rp-kubernetes          runtime-provider                 Up
openpitrix-rp-manager             runtime-provider-manager         Up
openpitrix-rp-qingcloud           runtime-provider                 Up
openpitrix-runtime-db-ctrl        flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-runtime-manager        runtime-manager                  Up
openpitrix-task-db-ctrl           flyway -url=jdbc:mysql://o ...   Exit 0
openpitrix-task-manager           task-manager                     Up

您可以通过浏览器，使用集群中任一节点的 IP 地址和 Dashboard 端口号即 <NodeIP>:8000 可在集群内部访问 Dashboard，如 http://192.168.100.10:8000。

若需要在外网访问，在云平台需要在端口转发规则中将上述的内网端口 8000 转发到源端口 8000，然后在防火墙开放这个源端口，确保外网流量可以通过该端口。

提示：例如在 QingCloud 平台配置端口转发和防火墙规则，则可以参考云平台配置端口转发和防火墙。

然后可以通过 <EIP>:8000 的方式访问控制台，如：http://139.198.111.111:8000，即可进入 OpenPitrix dashboard。

OpenPitrix 部署成功后，点击右上角登录，可使用下表管理员默认的用户名和密码登录 OpenPitrix 控制台体验，建议先参考快速入门的示例文档，将帮助您快速上手 OpenPitrix。

角色	用户名	密码
管理员	admin@op.com	passw0rd

查看 API Gateway 服务

以上显示 api-gateway 对外暴露的是 9100 端口，同上，查看 OpenPitrix API 界面，可通过端口转发和开放防火墙后，即可在公网访问 Swagger UI，如 http://139.198.111.111:9100/swagger-ui/。OpenPitrix API 文档请参考 API。

清理环境

若需要卸载 OpenPitrix 清理环境，在项目文件目录下，执行以下命令，停止并删除 OpenPitrix 所有服务，请谨慎操作。

$ docker compose-down