XCloud DoPaaS

中文文档 | English version goes here

Notes: Currently, the fully distributed version is being incubation, so it is not a good choice to run directly in the production environment !

One stop solution of PaaS platform based on DevSecOps

Based on SpringCloud/Docker/ServiceMesh(istio), the main modules are: unified asset management center (Cmdb), unified continuous delivery center (distributed compilation CI/CD), Iam Certification Center(Rbac/Oidc/[Saml2])), unified monitoring center (SBA/Zipkin/Promethous), unified configuration center, unified operation center (Elasticjob/Spark/Flink/MR), unified Document Center (Swagger/Rap), unified development center (Lcdp/Autogen), unified private object storage management, unified library management (Git/Nexus(Maven/Image)), Shell-Cli, multiple tool chains (Hdfs/HBase/Phoenix/OSS), instant messaging, lightweight risk control, etc

1. Development and runtime on technology stack(primary)

This project is mainly based on the development of SpringBoot/Cloud/Dubbo, which supports the operation of traditional monomer (standalone) mode and fully distributed micro service (cluster) mode. The source structure is carefully designed as  It's both a platform and a framework demonstration.

• Required dependencies: Spring Boot:2.2 +
  Spring Cloud:2.2 +
  Eureka:1.10 +
  Zipkin:2.15 +
  Jdk:8 +
  Maven:3.5 +
  Mysql:5.6 +

• Optional dependencies:
  Kafka:0.10.0 +
  Zookeeper:3.4.6 +
  DockerCE:18.06 +
  CoreDNS:1.7.0 +
  MinIO:latest
  Elasticsearch(EFK):6.2.3 +
  Shardingsphere-Elasticjob:3.0.0 +

• Developments Guide

2.1 One click automatic deployment(only spring main services are supported, not dependence services)

It is suitable for rapid deployment in server (non container) environment, and build redis cluster, MySQL and other dependent services.

# First, you need to specify some self built dependent services (examples):
export defaultGitBranch=master
export runtimeMysqlUrl='jdbc:mysql://127.0.0.1:3306/dopaas?useUnicode=true&serverTimezone=Asia/Shanghai&characterEncoding=utf-8&useSSL=false&allowMultiQueries=true&autoReconnect=true'
export runtimeMysqlUser='root'
export runtimeMysqlPassword='123456'
export runtimeRedisNodes='127.0.0.1:6379,127.0.0.1:6380,127.0.0.1:6381,127.0.0.1:6379,127.0.0.1:6380,127.0.0.1:6381'
export runtimeRedisPassword='123456'
export runtimeAppSpringProfilesActive='pro' # dev|fat|uat|pro

bash -c "$(curl -L https://raw.githubusercontent.com/wl4g/xcloud-dopaas/master/script/deploy/deploy-boot.sh)"
# or
bash -c "$(curl -L https://gitee.com/wl4g/xcloud-dopaas/raw/master/script/deploy/deploy-boot.sh)"

• Server specs requirements

2.2 Manual compilation and build

It is suitable for build secondary development environment

2.2.1 Editing .m2/settings.xml

<mirror>
    <id>nexus-aliyun</id>
    <mirrorOf>central</mirrorOf>
    <name>Nexus aliyun</name>
    <url>http://maven.aliyun.com/nexus/content/groups/public<url>
</mirror>

2.2.2 Backend compiling

Compile according to the order of project dependency. The mvn -P options are: springExecJar (packaged as a single executable jar) and mvnAssTar (packaged as a general software release package), default.

git clone https://github.com/wl4g/xcloud-component.git # Relatively new upstream (recommended)
# git clone https://gitee.com/wl4g/xcloud-component.git # or
mvn -f xcloud-component -U clean install -DskipTests -T 2C

git clone https://github.com/wl4g/xcloud-iam.git # Relatively new upstream (recommended)
# git clone https://gitee.com/wl4g/xcloud-iam.git # or
mvn -f xcloud-iam -U clean install -DskipTests -T 2C

git clone https://github.com/wl4g/xcloud-dopaas.git # Relatively new upstream (recommended)
# git clone https://gitee.com/wl4g/xcloud-dopaas.git # or
mvn -f xcloud-dopaas -U clean install -DskipTests -T 2C

2.2.3 Frontend compiling

git clone https://github.com/wl4g/xcloud-dopaas-view.git # Relatively new upstream (recommended)
or git clone https://gitee.com/wl4g/xcloud-dopaas-view.git
npm run dev # Development debugging
npm run build # Production building

2.3 Init DB: first, prepare a MySQL5.6+ instance and create a database named dopaas(utf8/utf8)_bin), and then Init DB sql.

Notes: the SQL script should correspond to the source code version. We will update it regularly. It is recommended to use the latest version

2.4 Configure DNS resolutio(C:\Windows\System32\drivers\etc or vim /etc/hosts)

Standalone mode resolution example
Cluster mode resolution example

Note: the domain names used for external services in different environments should correspond to sys_cluster_config.extranet_base_uri table

2.5 Quickly build a redis cluster/docker(or self built)

https://github.com/wl4g/docker-redis-cluster or
https://gitee.com/wl4g/docker-redis-cluster

2.6 Launch and testing access (chrome recommended)

Notes：
a. There is no need to specify any JVM args when trying to start (the default configuration is used). For example, only the configuration of dev environment will be activated by default;
b. Whether it is standalone mode or cluster mode, it can correspond to four environments respectively (dev/fat/uat/pro).

2.6.1 standalone mode starting(dev).

Dopaas unified boot class：com.wl4g.StandaloneDopaas
IAM boot class：com.wl4g.StandaloneIam

2.6.2 cluster mode starting(dev).

Run the following startup classes:

com.wl4g.EurekaServer  
com.wl4g.IamWeb  
com.wl4g.IamFacade  
com.wl4g.IamData  
com.wl4g.CmdbFacade  
com.wl4g.CmdbManager  
com.wl4g.HomeFacade  
com.wl4g.HomeManager  
com.wl4g.LcdpFacade  
com.wl4g.LcdpManager  
com.wl4g.UciFacade  
com.wl4g.UciServer  
com.wl4g.UdmFacade  
com.wl4g.UdmManager  
com.wl4g.UdsFacade  
com.wl4g.UdsManager 
com.wl4g.UmcFacade 
com.wl4g.UmcManager  
com.wl4g.UmcTracker 
com.wl4g.UmcCollector 
com.wl4g.UosFacade  
com.wl4g.UosManager  
com.wl4g.UrmFacade  
com.wl4g.UrmManager  

2.6.3 Testing access (chrome recommended)

http://wl4g.debug    Default account password: root/wl4g.com

2.7 Deployed successful screenshot:

Tips: the screenshot may be slightly different due to the version evolution, if you have any questions, please join the communication group (see the end section)

• More shots

3. Submodule documents

• UCI Unified Continuous Integration Service(CI/CD)
• UMC Unified Monitoring and Operation Center(applications healthing, tracking, alarming, ELK log analysis, etc)
• URM Unified Repository Management(source repo/build repo/image repo)
• UCM Unified Config Management(Online configuration of hot updates such as dataSource, redisClient, etc)
• CMDB Configuration Management Database(hosts, applications, secretKeys, auditing, DNS zone resoluting, etc)
• UDM Unified Document Management(Online APIs/swagger documents, etc)
• LCDP Low Code Development Platform(Automatic generate of multi language/architecture complete projects (e.g springcloud/dubbo/golang/python/vue/angularjs, etc), WebIDE, and various developer tool chains, etc)
• UDS Unified distributed scheduling control center, such as elasticjob/spark/flink task, etc.
• UOS Unified object storage services, based on springcloud development support NativeFS, HDFS, Aliyun OSS, AWS S3, GlusterFS, etc
• UIM Unified instant messaging service, convenient for project personnel to communicate in time, safe distribution of internal data.

4. Other related apps and components documents

• SHELL Shell Cli, adding a hbase-shell-like console to your app
• IAM Unified identity and access management services, support SSO/CAS/oauth2/opensaml etc, It also supports multiple deployment modes(local/cluster/gateway)
• Gateway Enterprise microservice gateway based on spring cloud gateway, Can integrate with CI to realize Canary deployment.

5. Communicate, feedback and contribute?

• Click add to group
• 
• GitHub: https://github.com/wl4g/xcloud-dopaas
• OS China: https://gitee.com/wl4g/xcloud-dopaas
• No matter how strong a person's personal ability is, he can't defeat a team. He hopes that his brothers and sisters can support him and contribute some of his own code to improve it together (^_^).

Share Code?