Chapitre 8. À PROPOS DE ROSA CLI
8.1. Débuter avec le ROSA CLI Copier lienLien copié sur presse-papiers!
8.1.1. À propos de la ROSA CLI Copier lienLien copié sur presse-papiers!
À 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 Copier lienLien copié sur presse-papiers!
Installez et configurez le ROSA CLI (rosa) sur votre hôte d’installation.
Procédure
Installez et configurez les derniers CLI AWS (aws).
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.
NoteEn option, vous pouvez utiliser la variable d’environnement AWS_DEFAULT_REGION pour définir la région AWS par défaut.
Interrogez l’API AWS pour vérifier si le CLI AWS est installé et configuré correctement:
aws sts get-caller-identity --output text
$ aws sts get-caller-identity --output text
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
<aws_account_id> arn:aws:iam::<aws_account_id>:user/<username> <aws_user_id>
<aws_account_id> arn:aws:iam::<aws_account_id>:user/<username> <aws_user_id>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
- 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.
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
$ tar xvf rosa-linux.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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
$ sudo mv rosa /usr/local/bin/rosa
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Assurez-vous que le ROSA CLI est correctement installé en interrogeant la version rosa:
rosa version
$ rosa version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
1.2.15 Your ROSA CLI is up to date.
1.2.15 Your ROSA CLI is up to date.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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:
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
# rosa completion bash > /etc/bash_completion.d/rosa
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Ouvrez un nouveau terminal pour activer la configuration.
Activer l’achèvement de l’onglet persistant pour Bash sur un hôte macOS:
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
$ rosa completion bash > /usr/local/etc/bash_completion.d/rosa
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Ouvrez un nouveau terminal pour activer la configuration.
Afin de permettre l’achèvement de l’onglet persistant pour Zsh:
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
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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"
$ rosa completion zsh > "${fpath[1]}/_rosa"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Ouvrez un nouveau terminal pour activer la configuration.
Afin de permettre l’achèvement persistant de l’onglet pour les poissons:
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
$ rosa completion fish > ~/.config/fish/completions/rosa.fish
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Ouvrez un nouveau terminal pour activer la configuration.
Activer l’achèvement de l’onglet persistant pour PowerShell:
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
PS> rosa completion powershell | Out-String | Invoke-Expression
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Sourcez le fichier rosa.ps1 à partir de votre profil PowerShell.
NoteConsultez 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 Copier lienLien copié sur presse-papiers!
Les commandes suivantes permettent de configurer le service OpenShift Red Hat sur AWS (ROSA) CLI, rosa.
8.1.3.1. connexion Copier lienLien copié sur presse-papiers!
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:
- Arguments en ligne de commande
- La variable d’environnement ROSA_TOKEN
- Le fichier de configuration rosa
- Interactive à partir d’une invite de ligne de commande
Syntaxe
rosa login [arguments]
$ rosa login [arguments]
L’option | Dé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 |
L’option | Dé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 Copier lienLien copié sur presse-papiers!
Déconnectez-vous de Rosa. La connexion supprime également le fichier de configuration rosa.
Syntaxe
rosa logout [arguments]
$ rosa logout [arguments]
L’option | Dé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 Copier lienLien copié sur presse-papiers!
Assurez-vous que les autorisations AWS requises pour créer un cluster ROSA sont configurées correctement:
Syntaxe
rosa verify permissions [arguments]
$ rosa verify permissions [arguments]
Cette commande vérifie les autorisations uniquement pour les clusters qui n’utilisent pas le service AWS Security Token (STS).
L’option | Dé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
$ rosa verify permissions
Assurez-vous que les autorisations AWS sont configurées correctement dans une région spécifique:
rosa verify permissions --region=us-west-2
$ rosa verify permissions --region=us-west-2
8.1.3.4. contrôle du quota Copier lienLien copié sur presse-papiers!
Il vérifie que les quotas AWS sont configurés correctement pour votre région par défaut.
Syntaxe
rosa verify quota [arguments]
$ rosa verify quota [arguments]
L’option | Dé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
$ rosa verify quota
Assurez-vous que les quotas AWS sont configurés correctement dans une région spécifique:
rosa verify quota --region=us-west-2
$ rosa verify quota --region=us-west-2
8.1.3.5. à télécharger rosa Copier lienLien copié sur presse-papiers!
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]
$ rosa download rosa [arguments]
L’option | Définition |
---|---|
--aider | Affiche l’aide pour cette commande. |
--debug | Active le mode débogage. |
8.1.3.6. des logiciels similaires à oc Copier lienLien copié sur presse-papiers!
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]
$ rosa download oc [arguments]
L’option | Définition |
---|---|
--aider | Affiche l’aide pour cette commande. |
--debug | Active le mode débogage. |
Exemple :
Les outils client de oc:
rosa download oc
$ rosa download oc
8.1.3.7. vérifier oc Copier lienLien copié sur presse-papiers!
Il vérifie que l’OpenShift Container Platform CLI (oc) est correctement installé.
Syntaxe
rosa verify oc [arguments]
$ rosa verify oc [arguments]
L’option | Définition |
---|---|
--aider | Affiche l’aide pour cette commande. |
--debug | Active le mode débogage. |
Exemple :
Vérifier les outils clients oc:
rosa verify oc
$ rosa verify oc
8.1.4. Initialisation de ROSA Copier lienLien copié sur presse-papiers!
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 Copier lienLien copié sur presse-papiers!
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]
$ rosa init [arguments]
L’option | Dé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 |
L’option | Dé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
$ rosa init
Configurez un nouveau compte AWS à l’aide des identifiants OpenShift Cluster Manager préexistants:
rosa init --token=$OFFLINE_ACCESS_TOKEN
$ rosa init --token=$OFFLINE_ACCESS_TOKEN
8.1.5. À l’aide d’un script Bash Copier lienLien copié sur presse-papiers!
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
Initialisez rosa en utilisant un jeton hors ligne Red Hat OpenShift Cluster Manager de Red Hat:
rosa init --token=<token>
$ rosa init --token=<token>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Créer le cluster ROSA:
rosa create cluster --cluster-name=<cluster_name>
$ rosa create cluster --cluster-name=<cluster_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Ajouter un fournisseur d’identité (IDP):
rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
$ rosa create idp --cluster=<cluster_name> --type=<identity_provider> [arguments]
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Ajouter un utilisateur dédié-admin:
rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
$ rosa grant user dedicated-admin --user=<idp_user_name> --cluster=<cluster_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
8.1.6. La mise à jour du ROSA CLI Copier lienLien copié sur presse-papiers!
La mise à jour de la dernière version compatible de la ROSA CLI (rosa).
Procédure
Confirmez qu’une nouvelle version de la ROSA CLI (rosa) est disponible:
rosa version
$ rosa version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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/
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 Copied! Toggle word wrap Toggle overflow La dernière version compatible de la ROSA CLI:
rosa download rosa
$ rosa download rosa
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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.
Extraire le contenu de l’archive:
tar -xzf rosa-linux.tar.gz
$ tar -xzf rosa-linux.tar.gz
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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
$ sudo mv rosa /usr/local/bin/rosa
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
La vérification
Assurez-vous que la nouvelle version de ROSA est installée.
rosa version
$ rosa version
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Exemple de sortie
1.2.15 Your ROSA CLI is up to date.
1.2.15 Your ROSA CLI is up to date.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow