docs-web-logo
使用指南

Agent配置管理

Agent管理是公有云对接企业内部应用服务的解决方案之一，通过企业侧安装Agent实现公有云上 OneID 和企业内部数据源、认证源等系统的互通互联。

本文档将指导您如何配置Agent。完成配置之后，您可以通过Agent连接您的认证源或者数据源，将企业数据源中数据同步至OneID目录中或使用企业认证源完成用户的认证。

为了满足您安装部署环境的要求，Agent管理提供了多种操作系统以及多种CPU的安装包。

第一步：OneID侧Agent创建。

1）登录OneID管理后台，在设置模块下点击「Agent管理」，进入页面后，点击「添加Agent」。 img 2）在Agent创建页面，输入「Agent名称」、「Agent描述」，然后点击「确认」，创建Agent。 img 3）创建成功后，自动进入到Agent详情页，点击「下载安装包」。 img 4）进入【安装包】选择页面，选择您需要部署的环境对应的安装包。（提示：目前Agent安装包支持Linux（AMD64）、Linux（ARM64）和Windows（AMD64）三种类型过安装包，具体安装包安装方式请参考第二步：客户侧Agent部署） img 5）点击「下载配置文件」按钮，进行配置文件下载。（提示：配置文件内含agent连接鉴权使用的私钥信息，OneID侧出于安全考虑不保存Agent私钥，因此配置文件仅可以下载一次，请下载后谨慎保管配置文件，如丢失则无法找回。） img

第二步：客户侧Agent部署

1.Agent安装环境准备及安装包下载

1）您需要准备一台Linux或windows环境机器作为agent安装机器。

推荐配置：

  1CPU：2CODE               
  2内存：1G以上       
  3硬盘：500M以上

最低配置：

  1CPU：1CODE               
  2内存：500M       
  3硬盘：200M

2）登录OneID管理后台，在设置模块下点击「Agent管理」，进入页面后，选择下方您准备的部署环境对应的安装包，点击「复制链接」。（提示：您也可以参考在第一步中，进入到Agent详情页进行复制） 推荐您使用复制链接方式进行下载，您也可以直接点击「安装包」，将安装包下载到本地，再拷贝到目标安装服务器上。 img 3）登录到目标服务器上输入复制链接进行下载。window环境在浏览器输入复制链接进行下载。Linux环境使用wget命令进行下载。 img

2. Agent安装

2.1 Linux环境安装

注意：agent安装在linux环境下，是通过systemd来管理agent服务，所以需要具备systemd和root权限。

1）根据上一步下载地址，找到已下载的安装包 img 2）给安装包进行授权，授权命令如下：

  1chmod +X 安装包名字

img 3）安装agent。安装命令如下：

  1./安装包名字

img 4）显示如图所示，即为安装成功： img

2.2 windows环境安装

注意：agent安装在windows环境下，是通过系统的服务管理器来管理agent服务，所以需要具备管理员权限。

1）根据上一步下载地址，找到已下载的安装包 img 2）右键使用「以管理员身份运行」安装包进行安装 img 3）显示如图所示，即为安装成功： img

3. Agent配置及启动

3.1 Linux配置及启动

1）导入配置文件。将第一步下载的配置文件导入到以下目录中：

  1/etc/oneid/agent/conf

2）修改配置文件名字为：config.json img 3）启动agent。启动命令如下：

  1service oneid-agent start

4）检查agent启动状态。检查命令如下：

  1service oneid-agent status

显示如图所示，即为启动成功 img

3.2 Windows配置及启动

1）导入配置文件。将第一步下载的配置文件导入到以下目录中：

  1C:\Program Files\oneid\agent\conf

2）修改配置文件名字为：config.json img 3）双击「start-oneid-agent」启动agent。 img 4）进入「任务管理器」，检查agent启动状态。 img

第三步：Agent常见运维。

1.Linux运维知识

  1启动：service oneid-agent start               
  2停止：service oneid-agent stop        
  3查看状态：service oneid-agent status
  4安装目录： /etc/oneid/agent
  5配置文件目录： /etc/oneid/agent/conf/config.json
  6日志目录： /etc/oneid/agent/log

2.Windows运维知识

  1启动：双击start-oneid-agent              
  2停止：双击stop-oneid-agent       
  3查看状态：打开任务管理器，查看「oneid-agent」服务状态
  4安装目录： C:\Program Files\oneid\agent
  5配置文件目录： C:\Program Files\oneid\agent\conf 
  6日志目录： C:\Program Files\oneid\agent\log

第四步：Agent管理配置。

1.agent定时及手动查看状态

1）Agent支持定时查看运行状态功能，您可以在agent列表页、agent详情页中查看当前agent的运行状态。（注意：agent每隔5分钟定时查看状态） img 2）如果您需要立即查看当前agent状态，请在agent详情页点击「手动测试」 img

2.agent自动升级

为了满足客户对于agent能力提升要求，agent将不定期进行更新。因此，agent提供了自动更新功能，当您开启定时更新功能，系统将依据您所配置的时间周期进行定时更新。 img

FAQ

1）Q：为什么管理端创建三个agent之后不能继续创建了？

A：OneID限制每个租户最多创建三个agent，每个agent可以被多个数据源、认证源同时使用。

2）Q：为什么在Linux环境安装报错？

A：1、请检查是否具备了root和systemd权限；2、请检查是否给安装包进行了授权；3、请检查安装部署包是否和安装环境一致。

3）Q：为什么配置文件下载一次不能继续下载？

A：配置文件内含agent连接鉴权使用的私钥信息，OneID侧出于安全考虑不保存Agent私钥，因此配置文件仅可以下载一次，请下载后谨慎保管配置文件，如丢失则无法找回。

4）Q：为什么我的agent已经在运行了，管理端还是显示未运行？

A：Agent运行状态是每隔5分钟定时检查的，中间可能存在时间差。如需立即检查agent状态，请进入到agent详情中，点击「手动测试」。