ManagementCli

Fabric控制框架管理CLI，用于在Kafka上进行管理操作

概述

管理CLI通过Kafka与各种CF组件进行通信，以查询和执行各种管理操作。以下是迄今为止支持的操作列表

要求

Python 3.7+

先决条件

确保以下已安装

• virtualenv
• virtualenvwrapper

安装

有多个安装选项。对于CF开发，建议的方法是从GitHub MASTER分支安装

$ mkvirtualenv mgmtcli
$ workon mgmtcli
$ pip install git+https://github.com/fabric-testbed/ManagementCli.git

用于包含在工具中等，请使用PyPi

$ mkvirtualenv mgmtcli
$ workon mgmtcli
$ pip install fabric-mgmt-cli

配置

管理CLI期望用户设置FABRIC_MGMT_CLI_CONFIG_PATH环境变量，从中选择config.yml。如果没有设置环境变量，它将尝试在用户的主目录中查找config.yml。

此外，用户应将Fabric身份令牌或Fabric刷新令牌传递给所有命令。或者，用户应设置至少一个环境变量FABRIC_ID_TOKEN和FABRIC_REFRESH_TOKEN。

创建默认内容如下的config.yml。

用户应更新以下参数

• Kafka集群参数
• 具有Kafka主题的CF对等节点
• 日志文件位置

runtime:
  - kafka-topic: managecli-topic
  - kafka-server: broker1:9092
  - kafka-schema-registry-url: http://schemaregistry:8081
  - kafka-key-schema: /etc/fabric/message_bus/schema/key.avsc
  - kafka-value-schema: /etc/fabric/message_bus/schema/message.avsc
  - kafka-ssl-ca-location:  /etc/fabric/message_bus/ssl/cacert.pem
  - kafka-ssl-certificate-location:  /etc/fabric/message_bus/ssl/client.pem
  - kafka-ssl-key-location:  /etc/fabric/message_bus/ssl/client.key
  - kafka-ssl-key-password:  fabric
  - kafka-security-protocol: SSL
  - kafka-group-id: fabric-cf
  - kafka-sasl-mechanism:
  - kafka-sasl-producer-username:
  - kafka-sasl-producer-password:
  - kafka-sasl-consumer-username:
  - kafka-sasl-consumer-password:

logging:
  ## The directory in which actor should create log files.
  ## This directory will be automatically created if it does not exist.
  - log-directory: /var/log/managecli

  ## The filename to be used for actor's log file.
  - log-file: manage.log

  ## The default log level for actor.
  - log-level: DEBUG

  ## actor rotates log files. You may specify how many archived log files to keep here.
  - log-retain: 5

  ## actor rotates log files after they exceed a certain size.
  ## You may specify the file size that results in a log file being rotated here.
  - log-size: 5000000

  - logger: managecli
auth:
  - name: managecli
  - guid: managecli-guid
  - credmgr-host: https://dev-2.fabric_mgmt_cli-testbed.net/

peers:
  - peer:
    - name: orchestrator
    - type: orchestrator
    - guid: orchestrator-guid
    - kafka-topic: orchestrator-topic
  - peer:
    - name: net1-am
    - guid: net1-am-guid
    - type: authority
    - kafka-topic: net1-am-topic
  - peer:
    - name: site1-am
    - guid: site1-am-guid
    - type: authority
    - kafka-topic: site1-am-topic
  - peer:
      - name: broker
      - guid: broker-guid
      - type: broker
      - kafka-topic: broker-topic

用法

管理CLI支持显示和管理命令

$ fabric-mgmt-cli
Usage: fabric-mgmt-cli [OPTIONS] COMMAND [ARGS]...

Options:
  -v, --verbose
  --help         Show this message and exit.

Commands:
  delegations  Delegation management
  maintenance  Maintenance Operations
  net          Dataplane network management
  slices       Slice management
  slivers      Sliver management

委托命令

支持的委托命令列表如下

$ fabric-mgmt-cli delegations
Usage: fabric-mgmt-cli delegations [OPTIONS] COMMAND [ARGS]...

  Delegation management

Options:
  --help  Show this message and exit.

Commands:
  claim    Claim delegation(s) from AM to Broker
  close    Closes delegation for an actor
  query    Get delegation(s) from an actor
  reclaim  Reclaim delegation(s) from Broker to AM
  remove   Removes sliver for an actor

切片命令

支持的切片命令列表如下

$ fabric-mgmt-cli slices
Usage: fabric-mgmt-cli slices [OPTIONS] COMMAND [ARGS]...

  Slice management

Options:
  --help  Show this message and exit.

Commands:
  close          Closes slice for an actor
  query          Get slice(s) from an actor
  remove         Removes slice for an actor
  removealldead  Removes slice for an actor

Sliver命令

支持的Sliver命令列表如下

$ fabric-mgmt-cli slivers
Usage: fabric-mgmt-cli slivers [OPTIONS] COMMAND [ARGS]...

  Sliver management

Options:
  --help  Show this message and exit.

Commands:
  close   Closes sliver for an actor
  query   Get sliver(s) from an actor
  remove  Removes sliver for an actor

维护命令

支持的维护命令列表如下

$ fabric-mgmt-cli maintenance
Usage: fabric-mgmt-cli maintenance [OPTIONS] COMMAND [ARGS]...

  Maintenance Operations

Options:
  --help  Show this message and exit.

Commands:
  site     Change Maintenance modes (PreMaint, Maint, Active) for a
           specific...

  testbed  Change Maintenance modes (PreMaint, Maint, Active) for the...

示例

注意：特定项目/用户仍然可以通过传递以下参数进行配置

• 允许用户电子邮件地址的逗号分隔列表在--users参数中
• 允许项目ID的命令分隔列表在--projects参数中

更改测试台维护模式

将测试台移动到预维护模式。

$ fabric-mgmt-cli maintenance testbed --actor orchestrator --mode PreMaint --deadline '2022-12-26T22:29:51.214418+00:00' --end '2022-12-30T22:29:51.214418+00:00'

将测试台移动到维护模式。

$ fabric-mgmt-cli maintenance testbed --actor orchestrator --mode Maint

将测试台移动到活动模式

$ fabric-mgmt-cli maintenance testbed --actor orchestrator --mode Active

更改站点维护模式

将站点移动到预维护模式。

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode PreMaint --deadline '2022-12-26T22:29:51.214418+00:00' --end '2022-12-30T22:29:51.214418+00:00'

将站点移动到维护模式。

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode Maint

将站点移动到活动模式

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode Active

更改工作维护模式

将工作移动到预维护模式。

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode PreMaint --deadline '2022-12-26T22:29:51.214418+00:00' --end '2022-12-30T22:29:51.214418+00:00' --workers renc-w1.fabric-testbed.net

将工作移动到维护模式。

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode Maint --workers renc-w1.fabric-testbed.net

将工作移动到活动模式

$ fabric-mgmt-cli maintenance site --name RENC --actor orchestrator --mode Active --workers renc-w1.fabric-testbed.net

网络管理命令

支持的网络管理命令列表如下

$ fabric-mgmt-cli net
Usage: fabric-mgmt-cli net [OPTIONS] COMMAND [ARGS]...

  Dataplane network management

Options:
  --help  Show this message and exit.

Commands:
  create  Create a new network service
  delete  Delete an existing network service by name
  show    Subgroup for network information commands
  sync    Control NSO device synchronization