CLIMC工具

命令行工具CLIMC

CLIMC（Command Line Interface for Management of Cloud）是基于云管平台SDK Golang实现的命令行工具，主要提供给运维人员使用。CLIMC命令通过向后端服务发送API请求，可以对整个云管平台进行运维管理。

CLIMC安装配置

云联壹云 安装完成后，用户可以在First Node节点和climc容器中使用climc命令，其中First Node节点需要进行初始化配置才可以正常使用。

CLIMC初始化配置

云管平台安装完成后，First Node节点上默认已安装了climc工具，用户可以直接执行初始化命令即可使用climc工具，设置方法如下：

1. 以root用户通过ssh远程连接First Node节点。

2. 执行以下命令初始化climc工具，该命令只对当前登录对话有效，当用户退出对话或注销系统后，该命令将会失效，需要用户重新执行以下命令初始化climc工具。

   $ source <(ocadm cluster rcadmin)
   

3. 为了避免每次连接控制节点都需要初始化climc工具，推荐将初始化工具命令添加到 ~/.bash_profile中。

   $ echo 'source <(ocadm cluster rcadmin)' >> ~/.bash_profile &&source ~/.bash_profile
   

4. 后续用户使用root用户远程连接First Node节点后都可以使用climc工具，其他用户不可用。

验证CLIMC工具

在First Node节点使用Climc命令

在First Node节点输入以下命令，验证是否可以使用climc工具运维管理 云联壹云 平台。

# 命令行模式查看云管平台上创建的虚拟机列表
$ climc server-list 

# 交互模式查看云管平台上创建的虚拟机列表
$ climc
climc> server-list  

注意

若执行climc命令时，出现”Error: Missing OS_AUTH_URL“的错误提示，请在控制节点再次执行“source <(ocadm cluster rcadmin)”命令。

在Climc容器中使用Climc命令

1. 在First Node节点上查看climc容器的名称。

$ kubectl get pods -n onecloud |grep climc 

2. 执行以下命令进入climc容器内部使用climc命令。

$ kubectl exec -n onecloud default-climc-85687594fd-jdfpx -it /bin/sh
# 命令行模式使用Climc命令
$ climc server-list
# 交互模式使用climc命令
$ climc 
climc > server-list

CLIMC工具使用介绍

CLIMC模式

CLIMC有两种模式，一种是交互模式，一种是命令模式。

交互模式

在命令行模式下直接输入climc，不带任何参数回车，即可进入climc的交互模式。

在交互模式下系统会自动提示命令，按tab键会补全最匹配的命令和参数名称。

命令模式

命令模式即在命令行下输入climc并带额定的参数获取相应的结果。该模式默认不支持自动补全功能，可通过设置以下命令启用参数自动补全功能。

# 启用bash命令行参数自动补全
$ source <(climc --completion bash)  

如需持久化使用参数补全功能，建议将该命令放到~/.bashrc或 ~/.bash_profile中自动初始化环境。

$ echo 'source <(climc --completion bash)' >> ~/.bash_profile && source ~/.bash_profile

CLIMC用途

CLIMC工具是基于云管平台SDK Golang实现的命令行工具，主要提供给运维人员使用。主要用途如下：

• 实现通过命令行对云管平台进行操作。
• 通过脚本调用climc命令，从而较便捷地实现运维自动化的功能。

命令运行一次

$ climc server-list

命令作为bash function/script 的一部分

for id in e572c089-2202-4070-8f07-e8f460d0fb91 b8212514-ec2f-4baa-b230-8143629b5e12 b2af470f-94e7-4b49-a82e-0e1305ba6121
do
    climc server-update --delete enable $i
    climc server-delete $i
done

REPL

$ climc 
climc> server-list

• 自动补全
• 参数提示
• 管道

功能模块

$ climc --help |pcregrep '^\s{8}\S+$' |tr '-' ' ' |awk '{print $1}' |sort |uniq -c|sort -nr
     37 server
     34 host
     14 project
     11 user
     10 network
     10 disk
      9 schedtag
      9 image
      9 dns
      8 vcenter
      8 monitortemplate
      8 domain
      6 storage
      ...

sub-command syntax - server-delete

Action:

• C server-create
• R server-show, server-list
• U server-update
• D server-delete

对结果再次处理

举例：累加 name 含 dev 的所有虚机的 cpu 个数。

$ climc
climc> server-list --admin --filter name.like(%dev%)
+--------------------------------------+-------------------+---------+------------+-----------+------------+---------+-----------+
|  ID  |       Name| Status  | vcpu_count | vmem_size | Hypervisor | os_type | is_system |
+--------------------------------------+-------------------+---------+------------+-----------+------------+---------+-----------+
| 232bafee-6c62-4263-ad0a-2e5017726678 | lzx-centos7-dev01 | running | 8  | 8092      | kvm| Linux   | false     |
| 44453773-f27a-4ac6-b44b-4e786e6dbf21 | rex-dev-1727      | running | 4  | 3072      | kvm| | false     |
+--------------------------------------+-------------------+---------+------------+-----------+------------+---------+-----------+
 
 
climc> server-list --admin --filter name.like(%dev%) |awk '$8 ~ /[0-9]/ {sum+= $8}  END {print sum}'
12

Debug 模式

$ climc --debug server-list

颜色约定

• Request 使用黄色
• CURL 使用 蓝绿色
• 根据状态码，200
• 可以参考以下代码：

if this.debug {
    yellow("Request", method, endpoint+url, req.Header, body)
    curlCmd, _ := http2curl.GetCurlCommand(req)
    cyan("CURL:", curlCmd)
}
...
if this.debug {
    if resp.StatusCode < 300 {green("Status:", resp.StatusCode)green(resp.Header)
    } else if resp.StatusCode < 400 {yellow("Status:", resp.StatusCode)yellow(resp.Header)
    } else {red("Status:", resp.StatusCode)red(resp.Header)
    }
}

其中curl

$ curl -X 'GET' -d '' -H 'Content-Type: application/json' -H 'User-Agent: yunioncloud-go/201708' -H 'X-Auth-Token: gAAAAABa1_r4fzEumxPuvSR_W9ImV-mvDFVPxMmME4c2m5a7ODQ6M7HODDdOwI6IOVkS3pE5L0kJmR5Kvv9WHie_Cutd0xwTAJ8YtPfS9QopLZYgdMcUIRDNtFe-oB9-ZG1KWNAOaQL7fElXCNUJOY-sI0doXLcjzVnwUT0RyucfI65fAUDT9j8' 'http://192.168.0.101:8888/servers?details=false&limit=20'

参考：

• 请参考HTTP权威指南(中文版)，获取更多HTTP请求知识
• 请参考curl用法详解，掌握更多curl常用命令

CLIMC命令

常用命令

• climc帮助

climc> --help      
Usage: climc [--help|-h] [--debug] [--version] [--timeout TIMEOUT] [--secure] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-project-name OS_PROJECT_NAME] [--os-domain-name OS_DOMAIN_NAME] [--os-auth-url OS_AUTH_URL] [--os-region-name OS_REGION_NAME] [--os-zone-name OS_ZONE_NAME] [--os-endpoint-type {publicURL,internalURL,adminURL}] [--kube-config KUBE_CONFIG] [--helm-state-dir HELM_STATE_DIR] <SUBCOMMAND> ...

• 查看某个命令的用法

climc> help notify
Usage: climc notify [--group] [--remark REMARK] <UID> <CONTACTTYPE> <TOPIC> <{normal,important,fatal}> <MSG>

Send a notification to someone

Positional arguments:
    <UID>The user you wanna sent to (Keystone User ID)
    <CONTACTTYPE>User's contacts type
    <TOPIC>Title or topic of the notification
    <{normal,important,fatal}>Priority of the notification
    <MSG>The content of the notification

Optional arguments:
    [--group]Send to group
    [--remark REMARK]Remark or description of the notification

• 新建虚拟机

climc> server-create
Usage: climc server-create [--disk DISK] [--net NETWORK] [--isolated-device ISOLATED_DEVICE] [--keypair KEYPAIR] [--iso IMAGE_ID] [--ncpu <SERVER_CPU_COUNT>] [--vga {std,vmware,cirrus,qxl}] [--vdi {vnc,spice}] [--bios {BIOS,UEFI}] [--desc <DESCRIPTION>] [--boot <BOOT_DEVICE>] [--allow-delete] [--shutdown-behavior <SHUTDOWN_BEHAVIOR>] [--auto-start] [--zone ZONE] [--host HOST] [--sched-tag <KEY:VALUE>] [--deploy DEPLOY] [--group GROUP] [--project PROJECT] [--user USER] [--system] [--hypervisor {kvm,esxi,baremetal,container,aliyun}] [--task-notify] [--count COUNT] [--dry-run] [--raid-config RAID_CONFIG] <NAME> <MEMORY>

• 新建用户

climc> user-create
Usage: climc user-create [--domain DOMAIN] [--desc DESC] [--password PASSWORD] [--displayname DISPLAYNAME] [--email EMAIL] [--mobile MOBILE] [--enabled] [--disabled] <NAME>

命令列表