az aro

  • Référence

Gérer les clusters Azure Red Hat OpenShift.

Commandes

Nom Description Type Statut
az aro create

Créez un cluster.

 Core GA
az aro delete

Supprimez un cluster.

 Core GA
az aro get-admin-kubeconfig

Répertorier l’administrateur kubeconfig d’un cluster.

 Core GA
az aro get-versions

Répertorier les versions disponibles pour l’installation.

 Core GA
az aro list

Répertorier les clusters.

 Core GA
az aro list-credentials

Répertoriez les informations d’identification d’un cluster.

 Core GA
az aro show

Obtenez les détails d’un cluster.

 Core GA
az aro update

Mettez à jour un cluster.

 Core GA
az aro validate

Validez les autorisations requises pour créer un cluster.

 Core GA
az aro wait

Attendez qu’un cluster atteigne un état souhaité.

 Core GA

az aro create

Modifier

Créez un 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]

Exemples

Créez un cluster.

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

Créez un cluster avec une version d’OpenShift prise en charge.

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

Créez un cluster avec 5 nœuds de calcul et un secret d’extraction 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

Créez un cluster privé.

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

Paramètres obligatoires

--master-subnet

Nom ou ID du sous-réseau de réseau virtuel maître. Si le nom est fourni, --vnet doit être fourni.

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--worker-subnet

Nom ou ID du sous-réseau de réseau virtuel worker. Si le nom est fourni, --vnet doit être fourni.

Paramètres facultatifs

--apiserver-visibility

Visibilité du serveur d’API.

valeurs acceptées: Private, Public
valeur par défaut: Public
--client-id

ID client du principal du service de cluster.

--client-secret

Clé secrète client du principal du service de cluster.

--cluster-resource-group

Groupe de ressources du cluster.

--disk-encryption-set

ResourceID du DiskEncryptionSet à utiliser pour les machines virtuelles maître et Worker.

--domain

Domaine du cluster.

--enable-preconfigured-nsg

Utilisez des groupes de sécurité réseau préconfigurés. Valeur par défaut : False.

valeurs acceptées: false, true
valeur par défaut: False
--fips --fips-validated-modules

Utilisez des modules de chiffrement validés FIPS. Valeur par défaut : False.

valeurs acceptées: false, true
valeur par défaut: False
--ingress-visibility

Visibilité de l’entrée.

valeurs acceptées: Private, Public
valeur par défaut: Public
--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

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

Chiffrement au niveau de l’indicateur d’hôte pour les machines virtuelles principales. Valeur par défaut : False.

valeurs acceptées: false, true
valeur par défaut: False
--master-vm-size

Taille des machines virtuelles principales.

valeur par défaut: Standard_D8s_v3
--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--outbound-type

Type de cluster sortant. Doit être « Loadbalancer » ou « UserDefinedRouting ».

valeur par défaut: Loadbalancer
--pod-cidr

CIDR du réseau de pods. Doit être un minimum de /18 ou plus.

valeur par défaut: 10.128.0.0/14
--pull-secret

Secret d’extraction du cluster.

--service-cidr

CIDR du réseau de service. Doit être un minimum de /18 ou plus.

valeur par défaut: 172.30.0.0/16
--tags

Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.

--version

Version OpenShift à utiliser pour la création du cluster.

--vnet

Nom ou ID du réseau virtuel. Si le nom est fourni, --vnet-resource-group doit être fourni.

--vnet-resource-group

Nom du groupe de ressources de réseau virtuel.

--worker-count

Nombre de machines virtuelles worker.

valeur par défaut: 3
--worker-enc-host --worker-encryption-at-host

Chiffrement au niveau de l’indicateur d’hôte pour les machines virtuelles worker. Valeur par défaut : False.

valeurs acceptées: false, true
valeur par défaut: False
--worker-vm-disk-size-gb

Taille du disque en Go de machines virtuelles worker.

valeur par défaut: 128
--worker-vm-size

Taille des machines virtuelles de travail.

valeur par défaut: Standard_D4s_v3
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro delete

Modifier

Supprimez un cluster.

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

Exemples

Supprimez un cluster.

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--yes -y

Ne pas demander de confirmation.

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro get-admin-kubeconfig

Modifier

Répertorier l’administrateur kubeconfig d’un cluster.

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

Exemples

Répertorier l’administrateur kubeconfig d’un cluster. La valeur par défaut consiste à l’enregistrer dans un fichier nommé « kubeconfig ».

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--file -f

Chemin d’accès au fichier dans lequel kubeconfig doit être enregistré. Par défaut : kubeconfig dans le répertoire local.

valeur par défaut: kubeconfig
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro get-versions

Modifier

Répertorier les versions disponibles pour l’installation.

az aro get-versions --location

Exemples

Répertoriez les versions d’installation disponibles pour la région USA Est.

az aro get-versions --location eastus

Répertoriez les versions d’installation disponibles pour la région USA Est avec une sortie mise en forme de table.

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

Paramètres obligatoires

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro list

Modifier

Répertorier les clusters.

az aro list [--resource-group]

Exemples

Répertorier les clusters.

az aro list

Répertorier les clusters avec vue table.

az aro list -o table

Paramètres facultatifs

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro list-credentials

Modifier

Répertoriez les informations d’identification d’un cluster.

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

Exemples

Répertoriez les informations d’identification d’un cluster.

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro show

Modifier

Obtenez les détails d’un cluster.

az aro show --name
            --resource-group

Exemples

Obtenez les détails d’un cluster.

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro update

Modifier

Mettez à jour un cluster.

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

Exemples

Mettez à jour un cluster.

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--client-id

ID client du principal du service de cluster.

--client-secret

Clé secrète client du principal du service de cluster.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

valeur par défaut: False
--refresh-credentials

Actualisez les informations d’identification de l’application de cluster.

valeurs acceptées: false, true
valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro validate

Modifier

Validez les autorisations requises pour créer un 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]

Exemples

Validez les autorisations.

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

Valider les autorisations et la version d’OpenShift

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

Paramètres obligatoires

--master-subnet

Nom ou ID du sous-réseau de réseau virtuel maître. Si le nom est fourni, --vnet doit être fourni.

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--worker-subnet

Nom ou ID du sous-réseau de réseau virtuel worker. Si le nom est fourni, --vnet doit être fourni.

Paramètres facultatifs

--client-id

ID client du principal du service de cluster.

--client-secret

Clé secrète client du principal du service de cluster.

--cluster-resource-group

Groupe de ressources du cluster.

--disk-encryption-set

ResourceID du DiskEncryptionSet à utiliser pour les machines virtuelles maître et Worker.

--location -l

Emplacement. Valeurs provenant de : az account list-locations. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>.

--pod-cidr

CIDR du réseau de pods. Doit être un minimum de /18 ou plus.

--service-cidr

CIDR du réseau de service. Doit être un minimum de /18 ou plus.

--version

Version OpenShift à utiliser pour la création du cluster.

--vnet

Nom ou ID du réseau virtuel. Si le nom est fourni, --vnet-resource-group doit être fourni.

--vnet-resource-group

Nom du groupe de ressources de réseau virtuel.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az aro wait

Modifier

Attendez qu’un cluster atteigne un état souhaité.

Si une opération sur un cluster a été interrompue ou démarrée --no-wait, utilisez cette commande pour attendre qu’elle se termine.

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

Paramètres obligatoires

--name -n

Nom du cluster.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

valeur par défaut: False
--exists

Attendez que la ressource existe.

valeur par défaut: False
--interval

Intervalle d’interrogation en secondes.

valeur par défaut: 30
--timeout

Délai maximal d’attente en secondes.

valeur par défaut: 3600
--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.