Интерфейс командной строки DeckCrew CLI

Для использования DeckCrew CLI необходимо зайти на узел развёртывания.

Выполните команду для получения справки по использованию DeckCrew CLI:

dctl --help

`global`

`set`

Установить глобальные настройки для развёртывания:

dctl global set [--interactive {true,false}]

Параметр	Описание
–interactive	Настроить интерактивный режим работы cotea. По умолчанию: true

`node`

`list`

Посмотреть список baremetal узлов в системе:

dctl node list

`create`

Завести данные о baremetal узле в системе при помощи BMC или SSH:

dctl node create [--no-bmc] [--bmc-type {ipmi,idrac,ilo}]
                 [--user USER] [--address ADDRESS]
                 [--password PASSWORD] [--pxe-mac PXE_MAC]
                 name

Параметр	Описание
name	Имя узла в системе
–no-bmc	Не использовать BMC для узла. По умолчанию: false
–bmc-type	Тип BMC. По умолчанию: ipmi (Только для BMC) Один из: ipmi, idrac, ilo
–user	Имя пользователя BMC или SSH
–address	IPv4 адрес BMC или SSH
–password	Пароль BMC или SSH
–pxe-mac	MAC адрес PXE интерфейса (Только для BMC)

`show`

Посмотреть данные о baremetal узле в системе:

dctl node show name

Параметр	Описание
name	Имя узла в системе

`delete`

Удалить baremetal узел из системы:

dctl node delete name

Параметр	Описание
name	Имя узла в системе

`storage`

Управление хранилищами для развёртываний типа OpenStack.

`list`

Посмотреть список хранилищ в системе:

dctl storage list

`create`

Создать новое хранилище:

dctl storage create [-h] --type {ceph,iscsi,nfs,sanlock,tatlin} [--property PROPERTY] name

Параметр	Описание
name	Имя хранилища
-type	Тип хранилища. Один из: ceph, iscsi, nfs, sanlock, tatlin
–property	Дополнительные свойства хранилища.

`show`

Посмотреть данные о хранилище:

dctl storage show name

Параметр	Описание
name	Имя хранилища

`delete`

Удалить хранилище из системы:

dctl storage delete name

Параметр	Описание
name	Имя хранилища

`network`

`list`

Посмотреть данные о сетях в системе:

dctl network list

`import`

Использовать кастомный файл с данными о сетях:

dctl network import --file FILE

Параметр	Описание
name	Имя узла в системе

`add`

Добавить новую сеть:

dctl network add [--mtu MTU] [--non-vip] [--service-net-map-replace SERVICE_NET_MAP_REPLACE]
                 --ip-subnet IP_SUBNET [--vlan VLAN] [--gateway-ip GATEWAY_IP] [--routes ROUTES]
                 [--allocation-pools ALLOCATION_POOLS]
                 network

Параметр	Описание
network	Имя новой сети
–mtu	MTU для сети. По умолчанию: 1500
–non-vip	Удалить тег VIP для сети. По умолчанию: false
–service-net-map- replace	Использовать сеть в качестве замены для сетей по умолчанию для сопоставления сервисов.
–ip-subnet	CIDR сети
–vlan	Номер VLAN
–gateway-ip	Адрес шлюза
–routes	Дополнительные маршруты
–allocation-pools	Пул используемых адресов. Используйте формат JSON

`delete`

Удалить сеть из системы:

dctl network delete network

Параметр	Описание
network	Имя сети

`netplan`

Сетевые планы позволяют управлять топологией сети и виртуальными интерфейсами на узлах.

В системе есть заранее подготовленные сетевые планы, которые можно использовать для развёртывания.

Пользователь может создавать свои сетевые планы, которые будут использоваться при развёртывании.

Сетевые планы представлены в формате os-net-config, который является инструментом для настройки сетевых интерфейсов от OpenStack.

`list`

Посмотреть список сетевых планов:

dctl netplan list [--public] [--default] [--instance INSTANCE]

Без аргументов отображаются только публичные сетевые планы, созданные пользователем. Можно использовать несколько аргументов одновременно.

Параметр	Описание
–public	Показать список публичных планов, созданных пользователем
–default	Показать список сетевых планов из Ansible роли tripleo_network_config
–instance	Показать список приватных планов, созданных пользователем

`create`

Создать новый сетевой план:

dctl netplan create [--instance INSTANCE] name

По умолчанию создаётся публичный сетевой план. Если указан параметр --instance, то создаётся приватный сетевой план для развёртывания.

Параметр	Описание
name	Имя нового сетевого плана
–instance	Имя развёртывания для создания приватного плана

`delete`

Удалить сетевой план:

dctl netplan delete name

Параметр	Описание
name	Имя сетевого плана

`vif`

Управление виртуальными интерфейсами сетевого плана

`list`

Посмотреть список виртуальных интерфейсов сетевого плана:

dctl netplan vif list name

Параметр	Описание
name	Имя сетевого плана

`add`

Добавить виртуальный интерфейс в сетевой план:

dctl netplan vif add --type TYPE
                     [--network NETWORK] [--with-routes] [--member-of MEMBER_OF]
                     [--property PROPERTY]
                     name vif_name

Параметр	Описание
name	Имя сетевого плана
vif_name	Имя виртуального интерфейса. Соответствует названию интерфейса в системе
–type	Тип виртуального интерфейса. Например: interface, vlan, ovs_bridge, …
–network	Имя сети для адресации виртуального интерфейса из списка заведённых сетей в системе. Например: external, internal_api, …
–with -routes	Добавить маршруты при изменении адресации виртуального интерфейса. Например, адрес шлюза.
–member-of	Добавить виртуальный интерфейс к другому интерфейсу. Например, interface можно добавить в ovs_bond
–property	Дополнительные свойства виртуального интерфейса.

`remove`

Удалить виртуальный интерфейс из сетевого плана:

dctl netplan vif remove name vif_name

Параметр	Описание
name	Имя сетевого плана
vif_name	Имя виртуального интерфейса

`show`

Посмотреть данные виртуального интерфейса сетевого плана:

dctl netplan vif show name vif_name

Параметр	Описание
name	Имя сетевого плана
vif_name	Имя виртуального интерфейса

`set`

Установить параметры виртуального интерфейса сетевого плана:

dctl netplan vif set [--network NETWORK] [--with-routes] [--member-of MEMBER_OF] [--property PROPERTY] name vif_name

Параметр	Описание
name	Имя сетевого плана
vif_name	Имя виртуального интерфейса
–network	Имя сети для адресации виртуального интерфейса из списка заведённых сетей в системе. Например: external, internal_api, …
–with -routes	Добавить маршруты при изменении адресации виртуального интерфейса. Например, адрес шлюза.
–member- of	Добавить виртуальный интерфейс к другому интерфейсу. Например, interface можно добавить в ovs_bond
–property	Дополнительные свойства виртуального интерфейса.

`unset`

Удалить параметры виртуального интерфейса сетевого плана:

dctl netplan vif unset [--network] [--member-of] [--property name] name vif_name

Параметр	Описание
name	Имя сетевого плана
vif_name	Имя виртуального интерфейса
–network	Удалить назначенную адресацию из сети
–member-of	Удалить привязку интерфейса к другому интерфейсу
–property	Удалить свойство виртуального интерфейса

`image`

`image list`

Посмотреть список образов для Ironic узлов:

dctl image list

`instance`

`list`

Посмотреть список всех развёртываний:

dctl instance list

`create`

Создать шаблоны развёртывания:

dctl instance create [--type {ceph,adminpoint,demo,openstack}] instance_name

Параметр	Описание
instance_name	Имя развёртывания
–type	Тип развёртывания. По умолчанию: openstack. Один из: openstack, ceph, demo, adminpoint

`show`

Посмотреть данные о развёртывании:

dctl instance show instance_name

Параметр	Описание
instance_name	Имя развёртывания

`delete`

Удалить развёртывание:

dctl instance delete [--templates] [--deployment] instance_name

Параметр	Описание
instance_name	Имя развёртывания
–templates	Удалить шаблоны развёртывания
–deployment	Удалить все ресурсы связанные с развёртыванием. Это действие выключит все узлы, использованные при развёртывании.

`deploy`

Запустить один из этапов развёртывания в screen:

dctl instance deploy instance_name {networks,vips,servers,known_hosts,services,stop}

Параметр	Описание
instance_name	Имя развёртывания
networks	Запустить создание сетей
vips	Запустить создание портов для VIP адресов
servers	Запустить развёртывание узлов и настройку сетей на узлах
known_hosts	Добавить развёрнутые узлы в .ssh/known_hosts
services	Запустить развёртывание сервисов на узлах
stop	Остановить развёртывание

`apply`

Запустить все этапы развёртывания в интерактивном режиме:

dctl instance apply instance_name

Параметр	Описание
instance_name	Имя развёртывания

`update`

Пересоздать контейнер на узлах с обновлением образа контейнера:

usage: dctl instance update [--host HOST | --role ROLE]
                            [--container CONTAINER] [--command COMMAND]
                            [--templates] [--finish]
                            [--packages] [--repo REPO] [--no-use-deploy-images]
                            [--pcs-service {haproxy,galera,rabbitmq,cinder,redis}]
                            name
positional arguments:
  name                  Instance name

options:
  -h, --help            show this help message and exit
  --host HOST           Node name to operate on.
  --role ROLE           Role for nodes to operate on.
  --container CONTAINER
                        Container name.
  --command COMMAND     Update container running command. Only for --container
  --templates           Update instance templates.
  --finish              Finish updating templates. Only for --templates
  --packages            Update instance packages.
  --repo REPO           Specify updates repo. Only for --packages
  --no-use-deploy-images
                        Disable using deploy images for searching packages. This may be unreliable as
                        packages are only updated without installing new ones. Only for --packages
  --pcs-service {haproxy,galera,rabbitmq,cinder,redis}
                        Pacemaker service name to update container for.

Параметр	Описание
name	Имя развёртывания
–host	Имя узла
–role	Имя роли
–container	Имя контейнера
–command	Изменить команду старта при пересоздании контейнера
–templates	Флаг для обновления шаблонов
–finish	Флаг для завершения обновления шаблонов (только в случае ошибки обновления)
–packages	Флаг для обновления пакетов
–repo	Репозиторий для обновления пакетов
–no-use- deploy-images	Не использовать образы для развёртывания при поиске пакетов
–pcs-service	Имя сервиса Pacemaker для обновления контейнера Один из: haproxy, galera, rabbitmq, cinder, redis

`node list`

Посмотреть список назначенных для развёртывания узлов:

dctl instance node list instance_name

Параметр	Описание
instance_name	Имя развёртывания

`node add`

Добавить узел в развёртывание:

dctl instance node add --role ROLE [--hostname HOSTNAME] [--image IMAGE]
                       [--network-plan NETWORK_PLAN]
                       [--default-route-network DEFAULT_ROUTE_NETWORK]
                       [--fixed-ip FIXED_IP]
                       instance_name node_name

Параметр	Описание
in stance_name	Имя развёртывания
node_name	Имя baremetal узла (в режиме managed) или желаемый хостней (в режиме unmanaged)
–role	Роль узла, соответствующая списку устанавливаемых сервисов
–hostname	Хостнейм узла. По умолчанию: значение назначается системой исходя из имени роли и развёртывания
–image	Путь до образа. Используется в режиме managed. Значение по умолчанию определяется ролью.
–network- plan	Сетевой план для настройки сетей на узле. Значение по умолчанию определяется ролью.
–default- route- network	Сеть для назначения шлюза при настройке сетей. Значение по умолчанию определяется ролью.
–fixed-ip	Желаемый IP адрес в определённой сети назначенной узлу. Требуется в режиме unmanaged для сети ctlplane. По умолчанию адреса назначаются сервисом Neutron на узле развёртывания.

`node remove`

Отцепить узел от развёртывания:

dctl instance node remove instance_name node_name

Параметр	Описание
instance_name	Имя развёртывания
node_name	Имя узла

`role show`

Посмотреть настройки по умолчанию для узлов роли:

dctl instance role show instance_name role_name

Параметр	Описание
instance_name	Имя развёртывания
role_name	Имя роли

`role set`

Назначить настройки по умолчанию для узлов роли:

dctl instance role set [--image IMAGE] [--network-plan NETWORK_PLAN] [--default-route-network DEFAULT_ROUTE_NETWORK] [--network NETWORK] instance_name role_name

Параметр	Описание
instance_name	Имя развёртывания
role_name	Имя роли
–image	Путь до образа для узлов роли
–network-plan	Сетевой план для узлов роли
–default-route-network	Сеть шлюза для узлов роли
–network NETWORK	Добавить сеть для сетевого плана

`role unset`

Удалить настройки по умолчанию для узлов роли:

dctl instance role unset [--image] [--network-plan] [--default-route-network] [--network NETWORK] instance_name role_name

Параметр	Описание
instance_name	Имя развёртывания
role_name	Имя роли
–image	Удалить назначенный образ для узлов роли
–network-plan	Удалить сетевой план назначенный для узлов роли
–default-route-network	Удалить сеть шлюза назначенную для узлов роли
–network	Удалить сеть для сетевого плана

`backend list`

Посмотреть список бэкендов для развёртывания:

dctl instance backend list name

Параметр	Описание
name	Имя развёртывания

`backend add`

Добавить бэкенд для развёртывания:

dctl instance backend add --service {cinder,glance,nova} name storage/backend_type

Параметр	Описание
name	Имя развёртывания
–service	Сервис для которого добавляется бэкенд Один из: cinder, glance, nova
storage/backend_type	Тип бэкенда или имя хранилища

`backend remove`

Удалить бэкенд из развёртывания:

dctl instance backend remove --service {cinder,glance,nova} name storage/backend_type

Параметр	Описание
name	Имя развёртывания
–service	Сервис для которого удаляется бэкенд Один из: cinder, glance, nova
storage/backend_type	Тип бэкенда или имя хранилища

`backend support`

Показать список доступных бэкендов для облака:

dctl instance backend support [--service {cinder,glance,nova}] name

Параметр	Описание
name	Имя развёртывания
–service	Уточнить имя сервиса Один из: cinder, glance, nova

`vip list`

Посмотреть список виртуальных IP адресов для развёртывания:

dctl instance vip list instance_name

Параметр	Описание
instance_name	Имя развёртывания

`vip add`

Добавить виртуальный IP адрес:

dctl instance vip add [--ip-address IP_ADDRESS] instance_name network_name

Параметр	Описание
instance_name	Имя развёртывания
network_name	Имя сети
–ip-address	Желаемый IP адрес

`vip delete`

Удалить виртуальный IP адрес:

dctl instance vip delete instance_name network_name

Параметр	Описание
instance_name	Имя развёртывания
network_name	Имя сети

`password list`

Посмотреть список паролей для развёртывания:

dctl instance password list instance_name

Параметр	Описание
instance_name	Имя развёртывания

`password generate`

Сгенерировать пароли для развёртывания:

dctl instance password generate instance_name

Параметр	Описание
instance_name	Имя развёртывания

`password show`

Get password for the instance deployment Посмотреть пароль для развёртывания:

dctl instance password show instance_name password_name

Параметр	Описание
instance_name	Имя развёртывания
password_name	Имя параметра

`password set`

Установить пароль для развёртывания:

dctl instance password set instance_name password_name password_value

Параметр	Описание
instance_name	Имя развёртывания
password_name	Имя параметра
password_value	Значение для параметра

`feature list`

Посмотреть доступные функции для развёртывания:

dctl instance feature list [--enabled] instance_name

Параметр	Описание
instance_name	Имя развёртывания
–enabled	Show only enabled features for the instance. Default: false

`feature add`

Добавить функцию для развёртывания:

dctl instance feature add instance_name feature_name

Параметр	Описание
instance_name	Имя развёртывания
feature_name	Имя функции

`feature remove`

Удалить функцию из развёртывания:

dctl instance feature remove instance_name feature_name

Параметр	Описание
instance_name	Имя развёртывания
feature_name	Имя функции

`feature set`

Установить параметры функции для развёртывания:

dctl instance feature set instance_name feature_name parameter

Параметр	Описание
instance_name	Имя развёртывания
feature_name	Имя функции
parameter	Имя и значение параметра. Формат: key=value

`feature show`

Посмотреть параметры функции для развёртывания:

dctl instance feature show instance_name feature_name

Параметр	Описание
instance_name	Имя развёртывания
feature_name	Имя функции

`advanced show`

Посмотреть расширенные настройки для развёртывания (только для экспертов):

dctl instance advanced show instance_name

Параметр	Описание
instance_name	Имя развёртывания

`advanced set`

Установить расширенные настройки для развёртывания (только для экспертов):

dctl instance advanced set instance_name parameter

Параметр	Описание
instance_name	Имя развёртывания
parameter	Имя и значение параметра. Формат: key=value

`backup`

Создать резервную копию данных на узлах развёртывания:

dctl instance backup [--host HOST | --role ROLE]
                     [--all]
                     [--config] [--mysql] [--logs] [--data]
                     name

Параметр	Описание
name	Имя развёртывания
–host	Имя узла
–role	Имя роли
–all	Создать резервную копию всех данных
–config	Создать резервную копию конфигурационных файлов
–mysql	Создать резервную копию базы данных MySQL
–logs	Создать резервную копию логов
–data	Создать резервную копию данных сервисов

`cloud`

`cloud prepare`

Создать минимальные ресурсы для OpenStack: типы инстансов, образы, сети, роутер, ключ SSH:

dctl cloud prepare [--flavors FLAVORS] [--images IMAGES] [--public-network PUBLIC_NETWORK]
 cloud_name

Параметр		Описание
cloud_name		Имя развёртывания
–flavors		Параметры типов инстансов: max_multiplier, disk_sfx, extra_specs. По умолчанию: max_multiplier=8, disk_sfx=disk, extra_specs=None. Используйте `hdd` или `ssd` в зависимости от типа дисков на узлах
–images \| Список файлов и директорий с образами
–publuc-network \| Параметры публичной сети: vlan_id, cidr, gateway, pool_start, pool_end. Cidr обязателен. Если нет vlan_id то будет использован тип сети `flat`. Если нет gateway, то параметр не будет использован. Если нет pool_start и pool_end, то pool_start/end будет установлен как 10-й IP адрес сначала/концы указанного CIDR.

`update`

`packages`

Обновить минимальный набор пакетов на узле undercloud:

dctl update packages [--repo REPO]

Параметр	Описание
–repo	Репозиторий для обновления пакетов

`undercloud`

Обновить все пакеты на узле и систему undercloud:

dctl update undercloud [--repo REPO] [--use-deploy-image]

Параметр	Описание
–repo	Репозиторий для обновления пакетов
–use-deploy- image	Использовать образ для развёртывания при поиске пакетов

`instances`

Обновить развёртывания: минимально необходимые пакеты на узле развёртывания, шаблоны развёртываний, пакеты на узлах, сервисы развёртываний:

dctl update instances [-h] [--repo REPO] [--use-deploy-image] [name ...]

Параметр	Описание
name …	Имена развёртываний. Если не указаны, будут обновлены все развёртывания
–repo	Репозиторий для обновления пакетов
–use-deploy- image	Использовать образ для развёртывания при поиске пакетов

Интерфейс командной строки DeckCrew CLI

global

set

node

list

create

show

delete

storage

list

create

show

delete

network

list

import

add

delete

netplan

list

create

delete

vif

list

add

remove

show

set

unset

image

image list

instance

list

create

show

delete

deploy

apply

update

node list

node add

node remove

role show

role set

role unset

backend list

backend add

backend remove

backend support

vip list

vip add

vip delete

password list

password generate

password show

password set

feature list

feature add

feature remove

feature set

feature show

advanced show

advanced set

backup

cloud

cloud prepare

update

packages

undercloud

instances

`global`

`set`

`node`

`list`

`create`

`show`

`delete`

`storage`

`list`

`create`

`show`

`delete`

`network`

`list`

`import`

`add`

`delete`

`netplan`

`list`

`create`

`delete`

`vif`

`list`

`add`

`remove`

`show`

`set`

`unset`

`image`

`image list`

`instance`

`list`

`create`

`show`

`delete`

`deploy`

`apply`

`update`

`node list`

`node add`

`node remove`

`role show`

`role set`

`role unset`

`backend list`

`backend add`

`backend remove`

`backend support`

`vip list`

`vip add`

`vip delete`

`password list`

`password generate`

`password show`

`password set`

`feature list`

`feature add`

`feature remove`

`feature set`

`feature show`

`advanced show`

`advanced set`

`backup`

`cloud`

`cloud prepare`

`update`

`packages`

`undercloud`

`instances`