az aro

  • Referencia

Administración de clústeres de Red Hat OpenShift en Azure.

Comandos

Nombre Description Tipo Estado
az aro create

Cree un clúster.

 Core GA
az aro delete

Elimine un clúster.

 Core GA
az aro get-admin-kubeconfig

Enumerar kubeconfig de administrador de un clúster.

 Core GA
az aro get-versions

Enumera las versiones disponibles para la instalación.

 Core GA
az aro list

Enumerar clústeres.

 Core GA
az aro list-credentials

Enumerar las credenciales de un clúster.

 Core GA
az aro show

Obtenga los detalles de un clúster.

 Core GA
az aro update

Actualizar un clúster.

 Core GA
az aro validate

Valide los permisos necesarios para crear un clúster.

 Core GA
az aro wait

Espere a que un clúster alcance un estado deseado.

 Core GA

az aro create

Editar

Cree un clúster.

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]

Ejemplos

Cree un clúster.

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

Cree un clúster con una versión compatible de OpenShift.

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

Cree un clúster con 5 nodos de proceso y un secreto de extracción de 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

Cree un clúster 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 requeridos

--master-subnet

Nombre o identificador de la subred de red virtual maestra. Si se proporciona el nombre, --vnet se debe proporcionar.

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--worker-subnet

Nombre o identificador de la subred de red virtual de trabajo. Si se proporciona el nombre, --vnet se debe proporcionar.

Parámetros opcionales

--apiserver-visibility

Visibilidad del servidor de API.

valores aceptados: Private, Public
valor predeterminado: Public
--client-id

Identificador de cliente de la entidad de servicio del clúster.

--client-secret

Secreto de cliente de la entidad de servicio del clúster.

--cluster-resource-group

Grupo de recursos del clúster.

--disk-encryption-set

ResourceID del objeto DiskEncryptionSet que se usará para las máquinas virtuales maestras y de trabajo.

--domain

Dominio del clúster.

--enable-preconfigured-nsg

Use grupos de seguridad de red preconfigurados. Valor predeterminado: False.

valores aceptados: false, true
valor predeterminado: False
--fips --fips-validated-modules

Use módulos de criptografía validados por FIPS. Valor predeterminado: False.

valores aceptados: false, true
valor predeterminado: False
--ingress-visibility

Visibilidad de entrada.

valores aceptados: Private, Public
valor predeterminado: Public
--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

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

Cifrado en la marca de host para máquinas virtuales maestras. Valor predeterminado: False.

valores aceptados: false, true
valor predeterminado: False
--master-vm-size

Tamaño de las máquinas virtuales maestras.

valor predeterminado: Standard_D8s_v3
--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--outbound-type

Tipo de clúster saliente. Debe ser "Loadbalancer" o "UserDefinedRouting".

valor predeterminado: Loadbalancer
--pod-cidr

CIDR de la red de pods. Debe ser un mínimo de /18 o superior.

valor predeterminado: 10.128.0.0/14
--pull-secret

Secreto de extracción del clúster.

--service-cidr

CIDR de la red de servicio. Debe ser un mínimo de /18 o superior.

valor predeterminado: 172.30.0.0/16
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--version

Versión de OpenShift que se usará para la creación del clúster.

--vnet

Nombre o identificador de la red virtual. Si se proporciona el nombre, --vnet-resource-group se debe proporcionar.

--vnet-resource-group

Nombre del grupo de recursos de red virtual.

--worker-count

Recuento de máquinas virtuales de trabajo.

valor predeterminado: 3
--worker-enc-host --worker-encryption-at-host

Cifrado en la marca de host para máquinas virtuales de trabajo. Valor predeterminado: False.

valores aceptados: false, true
valor predeterminado: False
--worker-vm-disk-size-gb

Tamaño del disco en GB de máquinas virtuales de trabajo.

valor predeterminado: 128
--worker-vm-size

Tamaño de las máquinas virtuales de trabajo.

valor predeterminado: Standard_D4s_v3
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro delete

Editar

Elimine un clúster.

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

Ejemplos

Elimine un clúster.

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--yes -y

No solicita confirmación.

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro get-admin-kubeconfig

Editar

Enumerar kubeconfig de administrador de un clúster.

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

Ejemplos

Enumerar kubeconfig de administrador de un clúster. El valor predeterminado es guardarlo en un archivo denominado "kubeconfig".

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--file -f

Ruta de acceso al archivo donde se debe guardar kubeconfig. Valor predeterminado: kubeconfig en el directorio local.

valor predeterminado: kubeconfig
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro get-versions

Editar

Enumera las versiones disponibles para la instalación.

az aro get-versions --location

Ejemplos

Enumere las versiones de instalación disponibles para la región Este de EE. UU.

az aro get-versions --location eastus

Enumere las versiones de instalación disponibles para la región Este de EE. UU. con salida con formato de tabla.

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

Parámetros requeridos

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro list

Editar

Enumerar clústeres.

az aro list [--resource-group]

Ejemplos

Enumerar clústeres.

az aro list

Enumeración de clústeres con vista de tabla.

az aro list -o table

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro list-credentials

Editar

Enumerar las credenciales de un clúster.

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

Ejemplos

Enumerar las credenciales de un clúster.

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro show

Editar

Obtenga los detalles de un clúster.

az aro show --name
            --resource-group

Ejemplos

Obtenga los detalles de un clúster.

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro update

Editar

Actualizar un clúster.

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

Ejemplos

Actualizar un clúster.

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--client-id

Identificador de cliente de la entidad de servicio del clúster.

--client-secret

Secreto de cliente de la entidad de servicio del clúster.

--no-wait

No espere hasta que finalice la operación de ejecución prolongada.

valor predeterminado: False
--refresh-credentials

Actualice las credenciales de la aplicación de clúster.

valores aceptados: false, true
valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro validate

Editar

Valide los permisos necesarios para crear un clúster.

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]

Ejemplos

Validar permisos.

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

Validación de permisos y versión de OpenShift

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

Parámetros requeridos

--master-subnet

Nombre o identificador de la subred de red virtual maestra. Si se proporciona el nombre, --vnet se debe proporcionar.

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--worker-subnet

Nombre o identificador de la subred de red virtual de trabajo. Si se proporciona el nombre, --vnet se debe proporcionar.

Parámetros opcionales

--client-id

Identificador de cliente de la entidad de servicio del clúster.

--client-secret

Secreto de cliente de la entidad de servicio del clúster.

--cluster-resource-group

Grupo de recursos del clúster.

--disk-encryption-set

ResourceID del objeto DiskEncryptionSet que se usará para las máquinas virtuales maestras y de trabajo.

--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--pod-cidr

CIDR de la red de pods. Debe ser un mínimo de /18 o superior.

--service-cidr

CIDR de la red de servicio. Debe ser un mínimo de /18 o superior.

--version

Versión de OpenShift que se usará para la creación del clúster.

--vnet

Nombre o identificador de la red virtual. Si se proporciona el nombre, --vnet-resource-group se debe proporcionar.

--vnet-resource-group

Nombre del grupo de recursos de red virtual.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az aro wait

Editar

Espere a que un clúster alcance un estado deseado.

Si se interrumpió una operación en un clúster o se inició con --no-wait, use este comando para esperar a que se complete.

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

Parámetros requeridos

--name -n

Nombre del clúster.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros opcionales

--created

Espere hasta que se cree con "provisioningState" en "Succeeded".

valor predeterminado: False
--custom

Espere hasta que la condición cumpla una consulta JMESPath personalizada. Por ejemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Espere hasta que se elimine.

valor predeterminado: False
--exists

Espere hasta que exista el recurso.

valor predeterminado: False
--interval

Intervalo de sondeo en segundos.

valor predeterminado: 30
--timeout

Espera máxima en segundos.

valor predeterminado: 3600
--updated

Espere hasta que se actualice con provisioningState en "Succeeded".

valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.