Skip to content

Commit

Permalink
Manual update
Browse files Browse the repository at this point in the history
  • Loading branch information
@guohongze
guohongze committed Mar 13, 2019
1 parent 6dff2db commit 667ed40
Show file tree
Hide file tree
Showing 5 changed files with 181 additions and 185 deletions.
172 changes: 86 additions & 86 deletions static/docs/Manual.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,65 +196,66 @@ <h2>Install 安装部署<a class="headerlink" href="#install" title="永久链
</div>
<div class="section" id="id1">
<h3>服务端安装：<a class="headerlink" href="#id1" title="永久链接至标题"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 1.1、下载代码
git clone https://github.com/guohongze/adminset.git
1.2、执行安装脚本-自动（推荐安装方式）
adminset/install/server/auto_install.sh
如果手动安装则跳过此步。
关闭防火墙
访问：http://your_server_ip
使用用户名admin 密码Adminset123
1.3、执行安装脚本-手动(不建议，如果使用自动安装则跳过此步骤)
1.3.1 adminset/install/server/server_install.sh
安装过程需要输入管理员数据库等交互信息，如果安装中断再次执行server_install.sh即可.
安装过程中会生成rsa密钥，位于/root/.ssh 目录下，如果已经存在，忽略即可。
1.3.2、手动安装交互信息说明
1）如果系统开启了selinux会提示：Do you want to disabled selinux?[yes/no]
选择yes。(默认yes)
2）YUM源选择提示do you want to use an internet yum repository?[yes/no]
没有本地的yum源请选择yes，如果有本地的YUM源（包括epel源）请选择no。(默认值yes)
3）数据库选择提示：do you want to create a new mysql database?[yes/no]
本地没有数据库选择yes自动下载安装mariadb数据库，如已经存在mysql或mariadb数据库选择no，然后填写相关信息主机、端口、用户名、密码。(默认值yes)
4）mongodb选择提示：do you want to create a new Mongodb?[YES/no]
本地没有mongodb选择yes自动下载安装mongodb数据库，如已经存在mongodb数据库选择no，然后填写相关信息主机、端口、用户名、密码。(默认值yes)
5）创建超管用户提示，please create your adminset&#39; super admin: 输入超管用户名、邮件、密码。
6）访问：
http://your_server_ip
使用自己在安装过程中创建的super admin用户名密码
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>1.1、下载代码
git clone https://github.com/guohongze/adminset.git
1.2、执行安装脚本-自动（推荐安装方式）
adminset/install/server/auto_install.sh
如果手动安装则跳过此步。
关闭防火墙
访问：http://your_server_ip
使用用户名admin 密码Adminset123

1.3、执行安装脚本-手动(不建议，如果使用自动安装则跳过此步骤)
1.3.1 adminset/install/server/server_install.sh
安装过程需要输入管理员数据库等交互信息，如果安装中断再次执行server_install.sh即可.
安装过程中会生成rsa密钥，位于/root/.ssh 目录下，如果已经存在，忽略即可。
1.3.2、手动安装交互信息说明
1）如果系统开启了selinux会提示：Do you want to disabled selinux?[yes/no]
选择yes。(默认yes)
2）YUM源选择提示do you want to use an internet yum repository?[yes/no]
没有本地的yum源请选择yes，如果有本地的YUM源（包括epel源）请选择no。(默认值yes)
3）数据库选择提示：do you want to create a new mysql database?[yes/no]
本地没有数据库选择yes自动下载安装mariadb数据库，如已经存在mysql或mariadb数据库选择no，然后填写相关信息主机、端口、用户名、密码。(默认值yes)
4）mongodb选择提示：do you want to create a new Mongodb?[YES/no]
本地没有mongodb选择yes自动下载安装mongodb数据库，如已经存在mongodb数据库选择no，然后填写相关信息主机、端口、用户名、密码。(默认值yes)
5）创建超管用户提示，please create your adminset&#39; super admin: 输入超管用户名、邮件、密码。
6）访问：
http://your_server_ip
使用自己在安装过程中创建的super admin用户名密码
</pre></div>
</div>
</div>
<div class="section" id="id2">
<h3>客户端安装<a class="headerlink" href="#id2" title="永久链接至标题"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 说明：为保证注册IP是管理IP（后续会被ansible等调用），客户端的IP抓取目前使用主机名解析，否则报错。 如：主机名为cn-bj-web01 请在/etc/hosts中加入相应的解析 192.168.x.x cn-bj-web01，这样再执行adminset_agent.py 可以保证正常运行。 centos7不进行解析也可获取主机IP.
#### step1: 修改文件install/client/adminset_agent.py :
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>说明：为保证注册IP是管理IP（后续会被ansible等调用），客户端的IP抓取目前使用主机名解析，否则报错。 如：主机名为cn-bj-web01 请在/etc/hosts中加入相应的解析 192.168.x.x cn-bj-web01，这样再执行adminset_agent.py 可以保证正常运行。 centos7不进行解析也可获取主机IP.

step1: 准备安装
修改文件install/client/adminset_agent.py :
客户端正常使用需要修改脚本中的两个字段：
token = &#39;HPcWR7l4NJNJ&#39; #token是上传到服务器的密钥可以在WEB界面的系统配置中自定义&lt;br&gt;
server_ip = &#39;192.168.47.130&#39; #此项目为adminset server的IP地址，支持域名&lt;br&gt;

#### step2: 拷贝install/client/ 目录到客户机的任意位置并执行:

step2: 执行安装
拷贝install/client/ 目录到客户机的任意位置并执行:
cd client
/bin/bash install.sh

#### step3: 客户端管理

step3: 客户端管理
service adminsetd start|stop|restart|status
客户端会被默认安装在/var/opt/adminset/client/ 目录下
agent日志文件/var/opt/adminset/client/agent.log
agent默认每3600秒上传一次资产和硬件信息，可以在adminset_agent.py中自定义
agent每周一凌晨会清空所有之前生成的日志，如需要历史日志，请自行备份。
注意：客户端全部功能需要配置服务器到客户端的ssh免密登录。
注意：客户端全部功能需要配置服务器到客户端的ssh免密登录。
</pre></div>
</div>
</div>
<div class="section" id="ssh">
<h3>自动免密钥登陆（此功能为可选，可以手动建立SSH信任）<a class="headerlink" href="#ssh" title="永久链接至标题"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 如果实现全自动ssh免密登入客户机需要如下几个条件：
1）客户机的所有密码都相同。
2）在服务器的配置管理&gt;密钥设置ssh password中写入客户机的密码并保存。
3）这样当客户机第一次上报资产信息到服务器中去会自动触发ssh密钥分发，自动分发成功能后ansible等其它功能不需要手动再配置ssh免密登陆。
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>如果实现全自动ssh免密登入客户机需要如下几个条件：
1）客户机的所有密码都相同。
2）在服务器的配置管理&gt;密钥设置ssh password中写入客户机的密码并保存。
3）这样当客户机第一次上报资产信息到服务器中去会自动触发ssh密钥分发，自动分发成功能后ansible等其它功能不需要手动再配置ssh免密登陆。
</pre></div>
</div>
</div>
Expand All @@ -280,27 +281,27 @@ <h2>站点导航用法<a class="headerlink" href="#id4" title="永久链接至
</div>
<div class="section" id="id5">
<h2>资产管理<a class="headerlink" href="#id5" title="永久链接至标题"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 主机表(host)：
每个主机选择一相对应的机房。
机架表(cabinet)：
一个机柜包含多个主机。
机房表(idc)：
一个机房包含多个机柜。
属组表(group):
每个主机可以属于不同的组，多对多关系。
组的作用在于任务编排模块的功能在调用组时的依据，比如ansible管理目标机器以组为单为时。
组与主机的设置是多对多，属于逻辑组。
组可以被角色调用，用于授权用户可以使用这些组中的主机WEBSSH功能。
install/client/adminset_agent.py 开启后会自动上报主机相关信息到CMDB
获取主机信息
http://your_server_ip/cmdb/get/host/?token=your_token&amp;name=host_name
获取所有主机：
http://your_server_ip/cmdb/get/host/?token=your_token&amp;name=all
获取组信息：
http://your_server_ip/cmdb/get/group/?token=your_token&amp;name=group_name
获取所有组：
http://your_server_ip/cmdb/get/group/?token=your_token&amp;name=all
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>主机表(host)：
每个主机选择一相对应的机房。
机架表(cabinet)：
一个机柜包含多个主机。
机房表(idc)：
一个机房包含多个机柜。
属组表(group):
每个主机可以属于不同的组，多对多关系。
组的作用在于任务编排模块的功能在调用组时的依据，比如ansible管理目标机器以组为单为时。
组与主机的设置是多对多，属于逻辑组。
组可以被角色调用，用于授权用户可以使用这些组中的主机WEBSSH功能。

install/client/adminset_agent.py 开启后会自动上报主机相关信息到CMDB
获取主机信息
http://your_server_ip/cmdb/get/host/?token=your_token&amp;name=host_name
获取所有主机：
http://your_server_ip/cmdb/get/host/?token=your_token&amp;name=all
获取组信息：
http://your_server_ip/cmdb/get/group/?token=your_token&amp;name=group_name
获取所有组：
http://your_server_ip/cmdb/get/group/?token=your_token&amp;name=all
</pre></div>
</div>
<div class="section" id="id6">
Expand All @@ -316,22 +317,21 @@ <h3>资产的导入出导出：<a class="headerlink" href="#id6" title="永久
</div>
<div class="section" id="id7">
<h2>应用管理<a class="headerlink" href="#id7" title="永久链接至标题"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 一、应用管理
1.1 产品线，一个产品线包含多个项目，表关系为一对多。每个产品线或项目有负责人是多对一。
1.2 项目管理
1）源类型，必须与源地址对应，如源码服务器为gitlab选择git，svn选择svn
2）源地址将会对持续交付产生影响，持续交付中的部署动作将会调用这些信息作为源文件的下载信息。
支持svn svn协议 如 svn://svn.adminset.com/project
支持svn http协议 如 http(s)://svn.adminset.com/project
支持git ssh协议 如 git@gitlab.com/website/project.git 使用ssh协议时请确认相关密钥已经加入到git服务器相应账号中。
支持git http协议 如 http(s)://github.com/website/project.git
支持git http协议 如 http(s)://username@gitlab.com/website/project.git
3）程序部署路径为程序部署在目标服务器的路径，程序将调用rsync做全量或增量同步。
格式举例: /data/www/project
4）配置文件路径功能暂时没有实装，留空白，或加上只相当于注释作用。
1.3 认证管理
1）此条目与持续交付模块中的条目里的“认证信息”有关，如果在创建条目则会显示在持续交付模块的认证信息中。
2）此条目与webssh的用户名密码和端口有关，如果要使用WEBSSH功能必须指定相关认证信息。
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>1 产品线，一个产品线包含多个项目，表关系为一对多。每个产品线或项目有负责人是多对一。
2 项目管理
2.1）源类型，必须与源地址对应，如源码服务器为gitlab选择git，svn选择svn
2.2）源地址将会对持续交付产生影响，持续交付中的部署动作将会调用这些信息作为源文件的下载信息。
支持svn svn协议 如 svn://svn.adminset.com/project
支持svn http协议 如 http(s)://svn.adminset.com/project
支持git ssh协议 如 git@gitlab.com/website/project.git 使用ssh协议时请确认相关密钥已经加入到git服务器相应账号中。
支持git http协议 如 http(s)://github.com/website/project.git
支持git http协议 如 http(s)://username@gitlab.com/website/project.git
2.3）程序部署路径为程序部署在目标服务器的路径，程序将调用rsync做全量或增量同步。
格式举例: /data/www/project
2.4）配置文件路径功能暂时没有实装，留空白，或加上只相当于注释作用。
3 认证管理
3.1）此条目与持续交付模块中的条目里的“认证信息”有关，如果在创建条目则会显示在持续交付模块的认证信息中。
3.2）此条目与webssh的用户名密码和端口有关，如果要使用WEBSSH功能必须指定相关认证信息。
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -447,19 +447,19 @@ <h2>权限管理<a class="headerlink" href="#id11" title="永久链接至标题"
</div>
<div class="section" id="id12">
<h3>权限系统最佳实践：<a class="headerlink" href="#id12" title="永久链接至标题"></a></h3>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> 1）左边主菜单栏会根据用户权限自动显示或隐藏。
2）所有功能按钮会根据用户权限自动显示或隐藏。
3）如果要显示左边菜单栏只需要在用户的任何一个相关权限内包括左边主菜单栏的关键字即可。
示例：包括权限URL /cmdb/asset/ 将自动显示资产管理/主机管理菜单
4）制作用户权限列表可以参考浏览器中显示的URL
/cmdb/idc/ 显示IDC显面
/cmdb/cabinet/ 显示机柜管理
/cmdb/group/ 显示属组管理
5）普通用户默认没有任何功能，也就不显示任何功能按钮，只有在进行授权以后相应按钮才会出现。
增加 /cmdb/assetadd/ 会显示资产添加按钮并自动显示。
增加 /cmdb/assetdel/ 会显示主机删除按钮并自动显示。
增加 /cmdb/assetedit/ 会显示主机编辑按钮并自动显示。
6）源代码中每个app中的url.py文件可以做为授权URL的参考文件。
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>1）左边主菜单栏会根据用户权限自动显示或隐藏。
2）所有功能按钮会根据用户权限自动显示或隐藏。
3）如果要显示左边菜单栏只需要在用户的任何一个相关权限内包括左边主菜单栏的关键字即可。
示例：包括权限URL /cmdb/asset/ 将自动显示资产管理/主机管理菜单
4）制作用户权限列表可以参考浏览器中显示的URL
/cmdb/idc/ 显示IDC显面
/cmdb/cabinet/ 显示机柜管理
/cmdb/group/ 显示属组管理
5）普通用户默认没有任何功能，也就不显示任何功能按钮，只有在进行授权以后相应按钮才会出现。
增加 /cmdb/assetadd/ 会显示资产添加按钮并自动显示。
增加 /cmdb/assetdel/ 会显示主机删除按钮并自动显示。
增加 /cmdb/assetedit/ 会显示主机编辑按钮并自动显示。
6）源代码中每个app中的url.py文件可以做为授权URL的参考文件。
</pre></div>
</div>
</div>
Expand Down
9 changes: 3 additions & 6 deletions static/docs/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ <h2>开发环境<a class="headerlink" href="#id1" title="永久链接至标题">
<div class="section" id="id2">
<h2>服务端安装<a class="headerlink" href="#id2" title="永久链接至标题"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>生产服务器建议 4核CPU，6G内存以上.
学习测试建议 2核CPU，2G内存以上.&lt;
学习测试建议 2核CPU，2G内存以上.
服务器操作系统版本要求 centos7.2 centos7.4
安装之前请关闭防火墙
</pre></div>
Expand Down Expand Up @@ -235,11 +235,8 @@ <h2>访问<a class="headerlink" href="#id4" title="永久链接至标题">¶</a>
</div>
<div class="section" id="id5">
<h2>说明<a class="headerlink" href="#id5" title="永久链接至标题"></a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>使用参考，&lt;a href=&quot;https://github.com/guohongze/adminset/blob/master/docs/Manual.md&quot;&gt;使用说明&lt;/a&gt;
功能参考，&lt;a href=&quot;https://github.com/guohongze/adminset/wiki/AdminSet&quot;&gt;功能预览&lt;/a&gt;
FAQ参考，&lt;a href=&quot;https://github.com/guohongze/adminset/wiki/FAQ&quot;&gt;常见问题&lt;/a&gt;
</pre></div>
</div>
<p>使用手册，<a href="http://115.28.147.154/static/docs/">使用手册</a><br>
FAQ参考，<a href="https://github.com/guohongze/adminset/wiki/FAQ">常见问题</a></p>
</div>
<div class="section" id="demo">
<h2>demo<a class="headerlink" href="#demo" title="永久链接至标题"></a></h2>
Expand Down
Loading

0 comments on commit 667ed40

Please sign in to comment.