Compartilhar via

az aro

  • Referência

Gerenciar clusters do Azure Red Hat OpenShift.

Comandos

Nome Description Tipo Status
az aro create

Criar um cluster.

 Núcleo GA
az aro delete

Excluir um cluster.

 Núcleo GA
az aro get-admin-kubeconfig

Listar admin kubeconfig de um cluster.

 Núcleo GA
az aro get-versions

Listar versões disponíveis para instalação.

 Núcleo GA
az aro list

Listar clusters.

 Núcleo GA
az aro list-credentials

Listar credenciais de um cluster.

 Núcleo GA
az aro show

Obtenha os detalhes de um cluster.

 Núcleo GA
az aro update

Atualizar um cluster.

 Núcleo GA
az aro validate

Validar as permissões necessárias para criar um cluster.

 Núcleo GA
az aro wait

Aguarde até que um cluster atinja o estado desejado.

 Núcleo GA

az aro create

Editar

Criar um cluster.

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 {false, true}]
              [--ingress-visibility {Private, Public}]
              [--location]
              [--master-enc-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 {false, true}]
              [--worker-vm-disk-size-gb]
              [--worker-vm-size]

Exemplos

Criar um cluster.

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

Crie um cluster com uma versão compatível do OpenShift.

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

Crie um cluster com 5 nós de computação e segredo de pull da 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

Crie um cluster privado.

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

Parâmetros Exigidos

--master-subnet

Nome ou ID da sub-rede mestre vnet. Se o nome for fornecido, --vnet deve ser fornecido.

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--worker-subnet

Nome ou ID da sub-rede vnet do trabalhador. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

--apiserver-visibility

Visibilidade do servidor de API.

valores aceitos: Private, Public
valor padrão: Public
--client-id

ID do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

ResourceID do DiskEncryptionSet a ser usado para VMs mestre e de trabalho.

--domain

Domínio do cluster.

--enable-preconfigured-nsg

Use NSGs pré-configurados. Padrão: false.

valores aceitos: false, true
valor padrão: False
--fips --fips-validated-modules

Use módulos de criptografia validados pelo FIPS. Padrão: false.

valores aceitos: false, true
valor padrão: False
--ingress-visibility

Visibilidade de entrada.

valores aceitos: Private, Public
valor padrão: Public
--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

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

Criptografia no sinalizador de host para VMs mestres. Padrão: false.

valores aceitos: false, true
valor padrão: False
--master-vm-size

Tamanho das VMs mestres.

valor padrão: Standard_D8s_v3
--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--outbound-type

Tipo de cluster de saída. Deve ser "Loadbalancer" ou "UserDefinedRouting".

valor padrão: Loadbalancer
--pod-cidr

CIDR da rede pod. Deve ser um mínimo de /18 ou maior.

valor padrão: 10.128.0.0/14
--pull-secret

Extrair segredo do cluster.

--service-cidr

CIDR da rede de serviços. Deve ser um mínimo de /18 ou maior.

valor padrão: 172.30.0.0/16
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

--version

Versão do OpenShift a ser usada para a criação de clusters.

--vnet

Nome ou ID do vnet. Se o nome for fornecido, --vnet-resource-group deve ser fornecido.

--vnet-resource-group

Nome do grupo de recursos vnet.

--worker-count

Contagem de VMs de trabalho.

valor padrão: 3
--worker-enc-host --worker-encryption-at-host

Criptografia no sinalizador de host para VMs de trabalho. Padrão: false.

valores aceitos: false, true
valor padrão: False
--worker-vm-disk-size-gb

Tamanho do disco em GB de VMs de trabalho.

valor padrão: 128
--worker-vm-size

Tamanho das VMs de trabalho.

valor padrão: Standard_D4s_v3
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro delete

Editar

Excluir um cluster.

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

Exemplos

Excluir um cluster.

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--yes -y

Não solicite confirmação.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro get-admin-kubeconfig

Editar

Listar admin kubeconfig de um cluster.

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

Exemplos

Listar admin kubeconfig de um cluster. O padrão é salvá-lo em um arquivo chamado "kubeconfig".

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--file -f

Caminho para o arquivo onde kubeconfig deve ser salvo. Padrão: kubeconfig no diretório local.

valor padrão: kubeconfig
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro get-versions

Editar

Listar versões disponíveis para instalação.

az aro get-versions --location

Exemplos

Listar versões de instalação disponíveis para a região Leste dos EUA.

az aro get-versions --location eastus

Listar versões de instalação disponíveis para a região Leste dos EUA com saída formatada em tabela.

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

Parâmetros Exigidos

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro list

Editar

Listar clusters.

az aro list [--resource-group]

Exemplos

Listar clusters.

az aro list

Listar clusters com modo de exibição de tabela.

az aro list -o table

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro list-credentials

Editar

Listar credenciais de um cluster.

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

Exemplos

Listar credenciais de um cluster.

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro show

Editar

Obtenha os detalhes de um cluster.

az aro show --name
            --resource-group

Exemplos

Obtenha os detalhes de um cluster.

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro update

Editar

Atualizar um cluster.

az aro update --name
              --resource-group
              [--client-id]
              [--client-secret]
              [--no-wait]
              [--refresh-credentials {false, true}]

Exemplos

Atualizar um cluster.

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--client-id

ID do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

--no-wait

Não aguarde a conclusão da operação de execução longa.

valor padrão: False
--refresh-credentials

Atualize as credenciais do aplicativo de cluster.

valores aceitos: false, true
valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro validate

Editar

Validar as permissões necessárias para criar um cluster.

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]

Exemplos

Validar permissões.

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

Validar permissões e versão do OpenShift

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

Parâmetros Exigidos

--master-subnet

Nome ou ID da sub-rede mestre vnet. Se o nome for fornecido, --vnet deve ser fornecido.

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--worker-subnet

Nome ou ID da sub-rede vnet do trabalhador. Se o nome for fornecido, --vnet deve ser fornecido.

Parâmetros Opcionais

--client-id

ID do cliente da entidade de serviço de cluster.

--client-secret

Segredo do cliente da entidade de serviço de cluster.

--cluster-resource-group

Grupo de recursos do cluster.

--disk-encryption-set

ResourceID do DiskEncryptionSet a ser usado para VMs mestre e de trabalho.

--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--pod-cidr

CIDR da rede pod. Deve ser um mínimo de /18 ou maior.

--service-cidr

CIDR da rede de serviços. Deve ser um mínimo de /18 ou maior.

--version

Versão do OpenShift a ser usada para a criação de clusters.

--vnet

Nome ou ID do vnet. Se o nome for fornecido, --vnet-resource-group deve ser fornecido.

--vnet-resource-group

Nome do grupo de recursos vnet.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az aro wait

Editar

Aguarde até que um cluster atinja o estado desejado.

Se uma operação em um cluster foi interrompida ou iniciada com --no-waito , use este comando para aguardar a conclusão.

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

Parâmetros Exigidos

--name -n

Nome do cluster.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--created

Aguarde até criar com 'provisioningState' em 'Succeeded'.

valor padrão: False
--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

valor padrão: False
--exists

Aguarde até que o recurso exista.

valor padrão: False
--interval

Intervalo de sondagem em segundos.

valor padrão: 30
--timeout

Espera máxima em segundos.

valor padrão: 3600
--updated

Aguarde até que seja atualizado com provisioningState em 'Succeeded'.

valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.