docs: 添加lbagent-deploy API描述

This commit is contained in:
Yousong Zhou
2019-07-25 12:54:42 +00:00
parent c88eae5261
commit ba143eff90
4 changed files with 74 additions and 1 deletions
@@ -0,0 +1,32 @@
post:
summary: 部署和更新转发实例上的守护程序
description: |
部署前,需要先准备好keystone账号,用于lbagent程序访问api服务同步配置信息
keystone账号通过host.vars指定,描述如下
- `user`, 用户名
- `pass`,密码
- `proj`,项目名,一般情况下该值应当为`system`
当`deploy_method`为`yum`时,需要同时指定yum源相关的言火日王
- `repo_base_url`,一般情况下该值应当为`https://controller-host-ip/yumrepo`
- `repo_sslverify`,默认为0,表示不校验仓库tls证书
若`repo_base_url`使用https,且使用自签名证书时一般情况下应当关闭tls证书校验
该操作依赖ansibleserver执行具体的部署任务。对应的ansibleplaybook任务id记录在deployment.ansibleplaybook,可通过这个ID获得部署执行的结果
parameters:
- $ref: "../parameters/loadbalancer.yaml#/loadbalancerAgentId"
- name: params
in: body
schema:
$ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentDeployRequest"
responses:
200:
description: 变更后的转发实例信息
schema:
$ref: "../schemas/loadbalancer.yaml#/LoadbalancerAgentResponse"
tags:
- loadbalanceragents