Chapitre 8. À PROPOS DE ROSA CLI


8.1. Débuter avec le ROSA CLI

8.1.1. À propos de la ROSA CLI

À l’aide du Red Hat OpenShift Service sur AWS (ROSA) interface de ligne de commande (CLI), la commande rosa, pour créer, mettre à jour, gérer et supprimer des clusters et des ressources ROSA.

8.1.2. Installation de la ROSA CLI

Installez et configurez le ROSA CLI (rosa) sur votre hôte d’installation.

Procédure

  1. Installez et configurez les derniers CLI AWS (aws).

    1. Suivez la documentation AWS Command Line Interface pour installer et configurer le CLI AWS pour votre système d’exploitation.

      Indiquez aws_access_key_id, aws_secret_access_key et région dans le fichier .aws/credentials. Consultez les bases de configuration AWS dans la documentation AWS.

      Note

      En option, vous pouvez utiliser la variable d’environnement AWS_DEFAULT_REGION pour définir la région AWS par défaut.

    2. Interrogez l’API AWS pour vérifier si le CLI AWS est installé et configuré correctement:

      $ aws sts get-caller-identity  --output text
      Copy to Clipboard Toggle word wrap

      Exemple de sortie

      <aws_account_id>    arn:aws:iam::<aws_account_id>:user/<username>  <aws_user_id>
      Copy to Clipboard Toggle word wrap

  2. Consultez la dernière version de la ROSA CLI (rosa) pour votre système d’exploitation à partir de la page Téléchargements sur OpenShift Cluster Manager.
  3. Extrayez le fichier binaire rosa de l’archive téléchargée. L’exemple suivant extrait le binaire d’une archive tar Linux:

    $ tar xvf rosa-linux.tar.gz
    Copy to Clipboard Toggle word wrap
  4. Ajoutez rosa à votre chemin. Dans l’exemple suivant, le répertoire /usr/local/bin est inclus dans le chemin d’accès de l’utilisateur:

    $ sudo mv rosa /usr/local/bin/rosa
    Copy to Clipboard Toggle word wrap
  5. Assurez-vous que le ROSA CLI est correctement installé en interrogeant la version rosa:

    $ rosa version
    Copy to Clipboard Toggle word wrap

    Exemple de sortie

    1.2.15
    Your ROSA CLI is up to date.
    Copy to Clipboard Toggle word wrap

  6. Facultatif: Activer la réalisation de l’onglet pour le ROSA CLI. Avec l’achèvement de l’onglet activé, vous pouvez appuyer deux fois sur la touche Tab pour compléter automatiquement les sous-commandes et recevoir des suggestions de commande:

    • Activer l’achèvement de l’onglet persistant pour Bash sur un hôte Linux:

      1. Générez un fichier de configuration d’achèvement de l’onglet rosa pour Bash et enregistrez-le dans votre répertoire /etc/bash_completion.d/:

        # rosa completion bash > /etc/bash_completion.d/rosa
        Copy to Clipboard Toggle word wrap
      2. Ouvrez un nouveau terminal pour activer la configuration.
    • Activer l’achèvement de l’onglet persistant pour Bash sur un hôte macOS:

      1. Générez un fichier de configuration d’achèvement de l’onglet rosa pour Bash et enregistrez-le dans votre répertoire /usr/local/etc/bash_completion.d/:

        $ rosa completion bash > /usr/local/etc/bash_completion.d/rosa
        Copy to Clipboard Toggle word wrap
      2. Ouvrez un nouveau terminal pour activer la configuration.
    • Afin de permettre l’achèvement de l’onglet persistant pour Zsh:

      1. Lorsque l’achèvement de l’onglet n’est pas activé pour votre environnement Zsh, activez-le en exécutant la commande suivante:

        $ echo "autoload -U compinit; compinit" >> ~/.zshrc
        Copy to Clipboard Toggle word wrap
      2. Générez un fichier de configuration d’achèvement de l’onglet rosa pour Zsh et enregistrez-le dans le premier répertoire de votre chemin d’accès:

        $ rosa completion zsh > "${fpath[1]}/_rosa"
        Copy to Clipboard Toggle word wrap
      3. Ouvrez un nouveau terminal pour activer la configuration.
    • Afin de permettre l’achèvement persistant de l’onglet pour les poissons:

      1. Générez un fichier de configuration d’achèvement de l’onglet rosa pour les poissons et enregistrez-le dans votre répertoire ~/.config/fish/completions/

        $ rosa completion fish > ~/.config/fish/completions/rosa.fish
        Copy to Clipboard Toggle word wrap
      2. Ouvrez un nouveau terminal pour activer la configuration.
    • Activer l’achèvement de l’onglet persistant pour PowerShell:

      1. Générez un fichier de configuration d’achèvement de l’onglet rosa pour PowerShell et enregistrez-le dans un fichier nommé rosa.ps1:

        PS> rosa completion powershell | Out-String | Invoke-Expression
        Copy to Clipboard Toggle word wrap
      2. Sourcez le fichier rosa.ps1 à partir de votre profil PowerShell.
    Note

    Consultez le menu d’aide pour plus d’informations sur la configuration de l’onglet rosa en exécutant la commande rosa Complete --help.

8.1.3. Configuration du ROSA CLI

Les commandes suivantes permettent de configurer le service OpenShift Red Hat sur AWS (ROSA) CLI, rosa.

8.1.3.1. connexion

Connectez-vous à votre compte Red Hat, enregistrant les informations d’identification dans le fichier de configuration rosa. Lorsque vous vous connectez, vous devez fournir un jeton. Copiez votre jeton à partir de la page de jeton ROSA.

Le ROSA CLI (rosa) cherche un jeton dans l’ordre de priorité suivant:

  1. Arguments en ligne de commande
  2. La variable d’environnement ROSA_TOKEN
  3. Le fichier de configuration rosa
  4. Interactive à partir d’une invite de ligne de commande

Syntaxe

$ rosa login [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.1. Arguments
L’optionDéfinition

--client-id

L’identifiant client OpenID (string). Défaut: Cloud-services

--client-secret

Le secret client OpenID (string).

--insécurité

Active la communication non sécurisée avec le serveur. Cette désactivation de la vérification des certificats TLS et des noms d’hôte.

--scope

La portée OpenID (chaîne). Dans le cas où cette option est utilisée, elle remplace les portées par défaut. Cela peut être répété plusieurs fois pour spécifier plusieurs portées. Défaut: openid

--jeton

Accède ou rafraîchit le jeton (corde).

--token-url

L’URL de jeton OpenID (string). Défaut: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

Expand
Tableau 8.2. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

--profil

Indique un profil AWS (corde) à partir de votre fichier d’identification.

8.1.3.2. logout

Déconnectez-vous de Rosa. La connexion supprime également le fichier de configuration rosa.

Syntaxe

$ rosa logout [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.3. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

--profil

Indique un profil AWS (corde) à partir de votre fichier d’identification.

8.1.3.3. contrôlez les autorisations

Assurez-vous que les autorisations AWS requises pour créer un cluster ROSA sont configurées correctement:

Syntaxe

$ rosa verify permissions [arguments]
Copy to Clipboard Toggle word wrap

Note

Cette commande vérifie les autorisations uniquement pour les clusters qui n’utilisent pas le service AWS Security Token (STS).

Expand
Tableau 8.4. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

--région

La région AWS (chaîne) dans laquelle exécuter la commande. Cette valeur remplace la variable d’environnement AWS_REGION.

--profil

Indique un profil AWS (corde) à partir de votre fichier d’identification.

Exemples

Assurez-vous que les autorisations AWS sont configurées correctement:

$ rosa verify permissions
Copy to Clipboard Toggle word wrap

Assurez-vous que les autorisations AWS sont configurées correctement dans une région spécifique:

$ rosa verify permissions --region=us-west-2
Copy to Clipboard Toggle word wrap

8.1.3.4. contrôle du quota

Il vérifie que les quotas AWS sont configurés correctement pour votre région par défaut.

Syntaxe

$ rosa verify quota [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.5. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

--région

La région AWS (chaîne) dans laquelle exécuter la commande. Cette valeur remplace la variable d’environnement AWS_REGION.

--profil

Indique un profil AWS (corde) à partir de votre fichier d’identification.

Exemples

Assurez-vous que les quotas AWS sont configurés correctement pour la région par défaut:

$ rosa verify quota
Copy to Clipboard Toggle word wrap

Assurez-vous que les quotas AWS sont configurés correctement dans une région spécifique:

$ rosa verify quota --region=us-west-2
Copy to Clipboard Toggle word wrap

8.1.3.5. à télécharger rosa

Cliquez ici pour télécharger la dernière version compatible de la rosa CLI.

Après avoir téléchargé rosa, extraire le contenu de l’archive et l’ajouter à votre chemin.

Syntaxe

$ rosa download rosa [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.6. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

8.1.3.6. des logiciels similaires à oc

Cliquez ici pour télécharger la dernière version compatible de OpenShift Container Platform CLI (oc).

Après avoir téléchargé oc, vous devez extraire le contenu de l’archive et l’ajouter à votre chemin.

Syntaxe

$ rosa download oc [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.7. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

Exemple :

Les outils client de oc:

$ rosa download oc
Copy to Clipboard Toggle word wrap

8.1.3.7. vérifier oc

Il vérifie que l’OpenShift Container Platform CLI (oc) est correctement installé.

Syntaxe

$ rosa verify oc [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.8. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

Exemple :

Vérifier les outils clients oc:

$ rosa verify oc
Copy to Clipboard Toggle word wrap

8.1.4. Initialisation de ROSA

La commande init permet d’initialiser Red Hat OpenShift Service sur AWS (ROSA) uniquement si vous utilisez des non-STS.

8.1.4.1. init

Effectuez une série de vérifications pour vérifier que vous êtes prêt à déployer un cluster ROSA.

La liste des vérifications comprend les éléments suivants:

  • Contrôle pour voir que vous vous êtes connecté (voir login)
  • Contrôle que vos identifiants AWS sont valides
  • Contrôle de la validité de vos autorisations AWS (voir vérification des autorisations)
  • Contrôle que vos niveaux de quotas AWS sont suffisamment élevés (voir vérifier le quota)
  • Exécute une simulation de cluster pour s’assurer que la création de clusters fonctionnera comme prévu
  • Contrôle que l’utilisateur osdCcsAdmin a été créé dans votre compte AWS
  • Contrôle que l’outil de ligne de commande OpenShift Container Platform est disponible sur votre système

Syntaxe

$ rosa init [arguments]
Copy to Clipboard Toggle word wrap

Expand
Tableau 8.9. Arguments
L’optionDéfinition

--région

La région AWS (chaîne) dans laquelle vérifier le quota et les autorisations. Cette valeur remplace la variable d’environnement AWS_REGION uniquement lors de l’exécution de la commande init, mais elle ne modifie pas votre configuration AWS CLI.

--supprimer

Supprime le modèle de pile qui est appliqué à votre compte AWS lors de la commande init.

--client-id

L’identifiant client OpenID (string). Défaut: Cloud-services

--client-secret

Le secret client OpenID (string).

--insécurité

Active la communication non sécurisée avec le serveur. Cette désactivation de la vérification des certificats TLS et des noms d’hôte.

--scope

La portée OpenID (chaîne). Dans le cas où cette option est utilisée, elle remplace complètement les portées par défaut. Cela peut être répété plusieurs fois pour spécifier plusieurs portées. Défaut: openid

--jeton

Accède ou rafraîchit le jeton (corde).

--token-url

L’URL de jeton OpenID (string). Défaut: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

Expand
Tableau 8.10. Arguments optionnels hérités des commandes parentes
L’optionDéfinition

--aider

Affiche l’aide pour cette commande.

--debug

Active le mode débogage.

--profil

Indique un profil AWS (corde) à partir de votre fichier d’identification.

Exemples

Configurez votre compte AWS pour autoriser les clusters ROSA:

$ rosa init
Copy to Clipboard Toggle word wrap

Configurez un nouveau compte AWS à l’aide des identifiants OpenShift Cluster Manager préexistants:

$ rosa init --token=$OFFLINE_ACCESS_TOKEN
Copy to Clipboard Toggle word wrap

8.1.5. À l’aide d’un script Bash

Ceci est un exemple de flux de travail de la façon d’utiliser un script Bash avec le Red Hat OpenShift Service sur AWS (ROSA) CLI, rosa.

Conditions préalables

Assurez-vous que les identifiants AWS sont disponibles comme l’une des options suivantes:

  • Le profil AWS
  • Les variables d’environnement (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)

Procédure

  1. Initialisez rosa en utilisant un jeton hors ligne Red Hat OpenShift Cluster Manager de Red Hat:

    $ rosa init --token=<token>
    Copy to Clipboard Toggle word wrap
  2. Créer le cluster ROSA:

    $ rosa create cluster --cluster-name=<cluster_name>
    Copy to Clipboard Toggle word wrap
  3. Ajouter un fournisseur d’identité (IDP):

    $ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
    Copy to Clipboard Toggle word wrap
  4. Ajouter un utilisateur dédié-admin:

    $ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
    Copy to Clipboard Toggle word wrap

8.1.6. La mise à jour du ROSA CLI

La mise à jour de la dernière version compatible de la ROSA CLI (rosa).

Procédure

  1. Confirmez qu’une nouvelle version de la ROSA CLI (rosa) est disponible:

    $ rosa version
    Copy to Clipboard Toggle word wrap

    Exemple de sortie

    1.2.12
    There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
    Copy to Clipboard Toggle word wrap

  2. La dernière version compatible de la ROSA CLI:

    $ rosa download rosa
    Copy to Clipboard Toggle word wrap

    Cette commande télécharge une archive appelée rosa-*.tar.gz dans le répertoire actuel. Le nom exact du fichier dépend de votre système d’exploitation et de l’architecture du système.

  3. Extraire le contenu de l’archive:

    $ tar -xzf rosa-linux.tar.gz
    Copy to Clipboard Toggle word wrap
  4. Installez la nouvelle version de la ROSA CLI en déplaçant le fichier extrait dans votre chemin. Dans l’exemple suivant, le répertoire /usr/local/bin est inclus dans le chemin d’accès de l’utilisateur:

    $ sudo mv rosa /usr/local/bin/rosa
    Copy to Clipboard Toggle word wrap

La vérification

  • Assurez-vous que la nouvelle version de ROSA est installée.

    $ rosa version
    Copy to Clipboard Toggle word wrap

    Exemple de sortie

    1.2.15
    Your ROSA CLI is up to date.
    Copy to Clipboard Toggle word wrap

Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat