Поделиться через

az aro

Управление кластерами Azure Red Hat OpenShift.

Команды

Имя Описание Тип Состояние
az aro create

Создание кластера.

 Core GA
az aro delete

Удаление кластера.

 Core GA
az aro get-admin-kubeconfig

Перечисление kubeconfig администратора кластера.

 Core GA
az aro get-versions

Список версий, доступных для установки.

 Core GA
az aro list

Вывод списка кластеров.

 Core GA
az aro list-credentials

Вывод списка учетных данных кластера.

 Core GA
az aro show

Получение сведений о кластере.

 Core GA
az aro update

Обновление кластера.

 Core GA
az aro validate

Проверка разрешений, необходимых для создания кластера.

 Core GA
az aro wait

Подождите, пока кластер достигнет требуемого состояния.

 Core GA

az aro create

Изменить

Создание кластера.

az aro create --master-subnet
              --name
              --resource-group
              --worker-subnet
              [--apiserver-visibility {Private, Public}]
              [--client-id]
              [--client-secret]
              [--cluster-resource-group]
              [--disk-encryption-set]
              [--domain]
              [--enable-preconfigured-nsg {false, true}]
              [--fips --fips-validated-modules {false, true}]
              [--ingress-visibility {Private, Public}]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--location]
              [--master-enc-host --master-encryption-at-host {false, true}]
              [--master-vm-size]
              [--no-wait]
              [--outbound-type]
              [--pod-cidr]
              [--pull-secret]
              [--service-cidr]
              [--tags]
              [--version]
              [--vnet]
              [--vnet-resource-group]
              [--worker-count]
              [--worker-enc-host --worker-encryption-at-host {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

Примеры

Создание кластера.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Создайте кластер с поддерживаемой версией OpenShift.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Создайте кластер с 5 вычислительными узлами и секретом извлечения Red Hat.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --worker-count 5 --pull-secret pullsecret.txt

Создайте частный кластер.

az aro create --resource-group MyResourceGroup --name MyCluster --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --apiserver-visibility Private --ingress-visibility Private

Обязательные параметры

--master-subnet

Имя или идентификатор главной подсети виртуальной сети. Если указано имя, --vnet необходимо указать.

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--worker-subnet

Имя или идентификатор подсети рабочей виртуальной сети. Если указано имя, --vnet необходимо указать.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--apiserver-visibility

Видимость сервера API.

Свойство Значение
Default value: Public
Допустимые значения: Private, Public
--client-id

Идентификатор клиента субъекта-службы кластера.

--client-secret

Секрет клиента субъекта-службы кластера.

--cluster-resource-group

Группа ресурсов кластера.

--disk-encryption-set

ResourceID набора DiskEncryptionSet, который будет использоваться для главных и рабочих виртуальных машин.

--domain

Домен кластера.

--enable-preconfigured-nsg

Используйте предварительно настроенные группы безопасности сети.

Свойство Значение
Default value: False
Допустимые значения: false, true
--fips --fips-validated-modules

Используйте проверенные модули шифрования FIPS.

Свойство Значение
Default value: False
Допустимые значения: false, true
--ingress-visibility

Видимость входящего трафика.

Свойство Значение
Default value: Public
Допустимые значения: Private, Public
--lb-ip-count --load-balancer-managed-outbound-ip-count

Требуемое количество исходящих IP-адресов IPv4, созданных и управляемых Azure для общедоступной подсистемы балансировки нагрузки кластера.

--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--master-enc-host --master-encryption-at-host

Шифрование по флагу узла для главных виртуальных машин.

Свойство Значение
Default value: False
Допустимые значения: false, true
--master-vm-size

Размер главных виртуальных машин.

Свойство Значение
Default value: Standard_D8s_v5
--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--outbound-type

Исходящий тип кластера. Должно быть loadbalancer или UserDefinedRouting.

Свойство Значение
Default value: Loadbalancer
--pod-cidr

CIDR сети pod. Должно быть не менее /18 или больше.

Свойство Значение
Default value: 10.128.0.0/14
--pull-secret

Секрет извлечения кластера.

--service-cidr

CIDR сети служб. Должно быть не менее /18 или больше.

Свойство Значение
Default value: 172.30.0.0/16
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--version

Версия OpenShift, используемая для создания кластера.

--vnet

Имя или идентификатор виртуальной сети. Если указано имя, --vnet-resource-group необходимо указать.

--vnet-resource-group

Имя группы ресурсов виртуальной сети.

--worker-count

Количество рабочих виртуальных машин.

Свойство Значение
Default value: 3
--worker-enc-host --worker-encryption-at-host

Шифрование по флагу узла для рабочих виртуальных машин.

Свойство Значение
Default value: False
Допустимые значения: false, true
--worker-vm-disk-size-gb

Размер диска в ГБ рабочих виртуальных машин.

Свойство Значение
Default value: 128
--worker-vm-size

Размер рабочих виртуальных машин.

Свойство Значение
Default value: Standard_D4s_v5
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro delete

Изменить

Удаление кластера.

az aro delete --name
              --resource-group
              [--no-wait]
              [--yes]

Примеры

Удаление кластера.

az aro delete --name MyCluster --resource-group MyResourceGroup

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--yes -y

Не запрашивать подтверждение.

Свойство Значение
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro get-admin-kubeconfig

Изменить

Перечисление kubeconfig администратора кластера.

az aro get-admin-kubeconfig --name
                            --resource-group
                            [--file]

Примеры

Перечисление kubeconfig администратора кластера. Значение по умолчанию — сохранить его в файле с именем Kubeconfig.

az aro get-admin-kubeconfig --name MyCluster --resource-group MyResourceGroup

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--file -f

Путь к файлу, в котором следует сохранить kubeconfig. По умолчанию: kubeconfig в локальном каталоге.

Свойство Значение
Default value: kubeconfig
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro get-versions

Изменить

Список версий, доступных для установки.

az aro get-versions --location

Примеры

Список версий установки, доступных для региона "Восточная часть США".

az aro get-versions --location eastus

Список версий установки, доступных для региона "Восточная часть США" с форматированными выходными данными таблицы.

az aro get-versions --location eastus -o table

Обязательные параметры

--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro list

Изменить

Вывод списка кластеров.

az aro list [--resource-group]

Примеры

Вывод списка кластеров.

az aro list

Вывод списка кластеров с представлением таблицы.

az aro list -o table

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro list-credentials

Изменить

Вывод списка учетных данных кластера.

az aro list-credentials --name
                        --resource-group

Примеры

Вывод списка учетных данных кластера.

az aro list-credentials --name MyCluster --resource-group MyResourceGroup

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro show

Изменить

Получение сведений о кластере.

az aro show --name
            --resource-group

Примеры

Получение сведений о кластере.

az aro show --name MyCluster --resource-group MyResourceGroup

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro update

Изменить

Обновление кластера.

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--lb-ip-count --load-balancer-managed-outbound-ip-count]
              [--no-wait]
              [--refresh-credentials {false, true}]

Примеры

Обновление кластера.

az aro update --name MyCluster --resource-group MyResourceGroup

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--client-id

Идентификатор клиента субъекта-службы кластера.

--client-secret

Секрет клиента субъекта-службы кластера.

--lb-ip-count --load-balancer-managed-outbound-ip-count

Требуемое количество исходящих IP-адресов IPv4, созданных и управляемых Azure для общедоступной подсистемы балансировки нагрузки кластера.

--no-wait

Не ожидать завершения длительной операции.

Свойство Значение
Default value: False
--refresh-credentials

Обновите учетные данные приложения кластера.

Свойство Значение
Default value: False
Допустимые значения: false, true
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro validate

Изменить

Проверка разрешений, необходимых для создания кластера.

az aro validate --master-subnet
                --name
                --resource-group
                --worker-subnet
                [--client-id]
                [--client-secret]
                [--cluster-resource-group]
                [--disk-encryption-set]
                [--location]
                [--pod-cidr]
                [--service-cidr]
                [--version]
                [--vnet]
                [--vnet-resource-group]

Примеры

Проверка разрешений.

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet

Проверка разрешений и версия OpenShift

az aro validate --resource-group MyGroup --name MyName --vnet MyVnet --master-subnet MyMasterSubnet --worker-subnet MyWorkerSubnet --version X.Y.Z

Обязательные параметры

--master-subnet

Имя или идентификатор главной подсети виртуальной сети. Если указано имя, --vnet необходимо указать.

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--worker-subnet

Имя или идентификатор подсети рабочей виртуальной сети. Если указано имя, --vnet необходимо указать.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--client-id

Идентификатор клиента субъекта-службы кластера.

--client-secret

Секрет клиента субъекта-службы кластера.

--cluster-resource-group

Группа ресурсов кластера.

--disk-encryption-set

ResourceID набора DiskEncryptionSet, который будет использоваться для главных и рабочих виртуальных машин.

--location -l

Location. Значения из az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--pod-cidr

CIDR сети pod. Должно быть не менее /18 или больше.

--service-cidr

CIDR сети служб. Должно быть не менее /18 или больше.

--version

Версия OpenShift, используемая для создания кластера.

--vnet

Имя или идентификатор виртуальной сети. Если указано имя, --vnet-resource-group необходимо указать.

--vnet-resource-group

Имя группы ресурсов виртуальной сети.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az aro wait

Изменить

Подождите, пока кластер достигнет требуемого состояния.

Если операция в кластере была прервана или запущена --no-wait, используйте эту команду, чтобы дождаться завершения.

az aro wait --name
            --resource-group
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Обязательные параметры

--name -n

Имя кластера.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Необязательные параметры

Следующие параметры являются необязательными, но в зависимости от контекста один или несколько могут потребоваться для успешного выполнения команды.

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

Свойство Значение
Группа параметров: Wait Condition Arguments
--deleted

Дождитесь удаления.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--exists

Подождите, пока ресурс не существует.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
--interval

Интервал опроса в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 30
--timeout

Максимальное ожидание в секундах.

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Свойство Значение
Группа параметров: Wait Condition Arguments
Default value: False
Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Формат вывода.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False