From c8cf3d552d669cb6ce6722cd87a9e5acf0bfb938 Mon Sep 17 00:00:00 2001 From: aozeliu Date: Fri, 9 Oct 2020 14:06:14 +0800 Subject: [PATCH] update README --- README.md | 151 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 139 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 55c03b1..b393097 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,147 @@ -#### 从命令行创建一个新的仓库 +# Wellcome to Cloudeploy +## How this documentation is organized +> Introductions of Cloudeploy. -```bash -touch README.md -git init -git add README.md -git commit -m "first commit" -git remote add origin https://git.trustie.net/aozeliu/Cloudeploy.git -git push -u origin master +> Requirements and installation + +> Demo Case + +> License + +------------ + +## What is Cloudeploy？ +Cloudeploy is an online platform for deploying and configuring cloud based applications.User can easily achieve the following functions without high level specific domain knowledge. + +> * Continuous deployment and configuration for cloud based applications(such as Tomcat,Nginx,MySQL etc.) . +> * Management of cloud based components on topology relations and consistency of parameters. +> * Health monitor and report for middleware instances. +> * Dynamic scale on numbers of middleware instances. +> * Fault Self-tolerance for instances. + +## How to install Cloudeploy? +Required Files : +``` +Cloudeploy.zip +cloudeploy.sql +ConsulAgent.zip + +``` +Overview:The Frame of this platform consists of two part: agent cluster and servers, as the figure1 shows. + +Figure-1: +![framework][1] +[1]:https://raw.githubusercontent.com/xpxstar/Cloudeploy/master/doc-image/framwork.jpg "framework for cloudeploy" + +### 1.Install agent cluster +Agent cluster consists of at least three computers(agent 1-3 in figure1), which are hosts of cloud based applications. For every agent, the environment is built as follows. + +``` +OS：Liunx-x64 +Java (version >= 7.0) +docker(version >= 1.9)[Download and Install](https://docs.docker.com/engine/installation/linux/) +consul(version >= 0.6)[Download and Install](https://www.consul.io/intro/getting-started/install.html) ``` -#### 从命令行推送已经创建的仓库 +#### (1)Docker +>start docker with listening socket of tcp: -```bash -git remote add origin https://git.trustie.net/aozeliu/Cloudeploy.git -git push -u origin master +```shell +docker daemon -H tcp://0.0.0.0:2375 & +``` +>download images that needed: + +```shell +docker pull xpxstar/mysql +docker pull xpxstar/tomcat +docker pull docker.io/nginx +``` +#### (2)consul +>unzip consulAgent.zip to directory of　"／opt" + +>start consul on agent1、agent2 with model of server and add itself to consul cluster. + +```shell +consul agent -server -data-dir /opt/data/ -ui-dir /opt/ui -bootstrap-expect 2 -node=node1 -dc=dc1 -bind= -client=0.0.0.0 & +consul join +``` +>start consul on agent3 and other agent with model of agent,and add itself to consul cluster +``` +consul agent -data-dir /opt/data/ -ui-dir /opt/ui -node=node3 -dc=dc1 -bind= -client=0.0.0.0 & +consul join ``` +#### (3)consul-template + +>start consul-template on agent: + +``` +/opt/consul-template -config /opt/agent/consul-template --consul 0.0.0.0:8500 -retry=1s & +``` +#### (4)consulAgent + +>start consulAgent.jar with the following command: + +``` +java -jar /opt/agent/consulAgent-0.0.1-SNAPSHOT.jar +``` + +###### notice: you should open some ports through firewall of agent.： +``` +2375,3306,8300,8301,8301,8400,8500,8600,8380 +``` +### 2.Install Servers +There are Web server,Database server,File server.The OS of server hosts can be linux or windows.And You can install them in the same host as you like. +>Environment of Host A: + +``` +MySQL(version >= 5.1) [Download and Install](http://dev.mysql.com/downloads/mysql/) +``` +start mysql and create database named cloudeploy.Import cloudeploy.sql into database to build data structures. + +>Environment of Host B and C +Here we can put file servr and web server into the same Host, named Host B + + +``` +JAVA (version >= 7.0) +Tomcat (version>=7.0.30) [Download and Install] (https://tomcat.apache.org/download-70.cgi) +``` +>unzip cloudapp.zip to directory of "$TOMCAT_PATH/webapps",edit configure files： + +Cloudeploy/WEB-INF/classes/application.properties: +``` +jdbc.url= +consul_host= +``` +Cloudeploy/WEB-INF/lib/configs.properties: +``` +deploy.server.host= +server.root=http://:8080/cloudapp +``` +>start tomcat to finish installation + +``` +sh $TOMCAT_PATH/bin/startup.sh +``` + +## User Demo Guide +To see document/Demo.mp4 + +## Develpment based on Cloudeploy + +Server project of Cloudeploy_app is develped by java with maven,so just import the project into Eclipse in maven environment. + +Client Agent project( https://github.com/xpxstar/ConsulAgent) of ConsulAgent is a normal java project. + +see： +>document/design document.pdf + +>document/requirement document.pdf + +FAQ: +Support By Pershing [xupeixing14@otcaix.iscas.ac.cn] + +with License under GNU showing in LICENSE.