VGS客户端
vgs-cli的Python项目详细描述
VGS客户端
在vgs保险库中配置路由的命令行工具
要求
- Python3
安装
要安装最新版本,请输入:
pip install vgs-cli
帮助
要调用帮助指令,请运行vgs --help
或vgs -h
认证
vgs cli提供的所有命令都需要mfa验证。
要进行身份验证,请运行vgs authenticate
命令。然后输入仪表板凭据并在浏览器中进行身份验证。然后返回终端并继续使用vgs cli。
如果遇到错误,则需要运行vgs authenticate
,因为会话已过期,请重新验证。
可能会要求您允许在操作系统密码管理系统(Mac OS X密钥链、Linux保密服务、Windows凭据保管库)中存储数据。
要删除经过身份验证的会话,请键入:
vgs logout
命令
参数
Name | Description | Mandatory | Default value |
---|---|---|---|
^{ | Tenant identifier of a vault | Yes | |
^{ | VGS environment. Possible values are ^{ | No | sandbox |
全部转储
此命令以可读的yaml格式将路由转储到stdout。为了方便起见,我们建议将输出重定向到文件。
vgs --tenant=tnteipi8liw --environment=sandbox route --dump-all
建议使用命令
vgs --tenant=tnteipi8liw --environment=sandbox route --dump-all > tnteipi8liw.yml
样本输出看起来
data:-attributes:created_at:'2018-07-17T16:50:37'destination_override_endpoint:https://httpbin.verygoodsecurity.ioentries:-classifiers:{}config:condition:ANDexpression:nullrules:-condition:nullexpression:field:PathInfooperator:equalstype:stringvalues:[/post]rules:null-condition:nullexpression:field:ContentTypeoperator:equalstype:stringvalues:[application/json]rules:[]id:a46b73e5-df5a-4780-bc01-9e19b1aa04bcid_selector:nulloperation:REDACToperations:nullphase:REQUESTpublic_token_generator:UUIDtargets:[body]token_manager:PERSISTENTtransformer:JSON_PATHtransformer_config:[$.secret]host_endpoint:(.*)\.verygoodproxy\.comid:6153b3fc-f869-4fdd-824f-5ed6b1e393c5port:443protocol:httpsource_endpoint:'*'updated_at:'2018-07-17T16:50:50'id:6153b3fc-f869-4fdd-824f-5ed6b1e393c5type:rule_chain-attributes:created_at:'2018-07-17T16:53:01'destination_override_endpoint:'*'entries:[]host_endpoint:(.*)id:d6c86a9f-c85c-4ced-9998-16b050541f84port:443protocol:httpsource_endpoint:'*'updated_at:'2018-07-17T16:53:01'id:d6c86a9f-c85c-4ced-9998-16b050541f84type:rule_chainversion:1
全部同步
此命令将更新同步到回上游的路由。它需要一个带有通过stdin的路由的yaml文档。
重要
要使此命令工作,应保持以下条件
- yaml文档应该是
dump-all
以前输出的结果。 - 您只能对原始yaml文档中的实体进行更改,并且必须保持id不变。
vgs --tenant=tnteipi8liw --environment=sandbox route --sync-all < tnteipi8liw.yml
此命令还可用于将路由从沙盒迁移到Live。如果不存在,则命令将在活环境中创建路由。
vgs --tenant=tnt3lmevlos --environment=live route --sync-all < tnteipi8liw.yml
版本
打印当前的cli版本。
vgs version
典型情况
将路由从沙盒环境迁移到Live
- 沙盒租户:
tnt_sandbox
- 活租户:
tnt_live
本地转储来自沙盒保管库的路由
vgs --tenant=tnt_sandbox --environment=sandbox route --dump-all > tnt_sandbox.yml
在活动保险库中重新创建路由
vgs --tenant=tnt_live --environment=live route --sync-all < tnt_sandbox.yml
从本地活动环境转储新路由。我们建议将它们保存在单独的文件中
vgs --tenant=tnt_live --environment=live route --dump-all > tnt_live.yml
如果需要,在
tnt_live.yml
中更新迁移的路由。通常,您可能需要更改测试时使用的某些上游配置。将更改同步回tnt_live
vgs --tenant=tnt_live --environment=live route --sync-all < tnt_live.yml
修改已迁移路由的上游主机以匹配实时API。典型的示例是在迁移后在实时路由上将开发环境切换到生产环境。