Configuration de votre environnement CLI et API

Avant de pouvoir créer une « IBM® Storage Ceph® as a Service » à l'aide de l'API ou de l'interface en ligne de commande (CLI), vous devez configurer votre environnement.

Conditions générales préalables

Créez votre compte pour accéder à IBM Storage Ceph as a Service. Vérifiez que votre compte a été mis à niveau vers un compte payant.
Assurez-vous d'avoir à portée de main la liste des terminaux sur site qui ont été fournis pour le déploiement.

Vous pouvez définir les points de terminaison en tant que variables d'environnement.

Prérequis pour l'interface de ligne de commande (CLI)

Avant de pouvoir utiliser l'interface de ligne de commande (CLI), vous devez installer la CLI « IBM Cloud » ainsi que le plug-in CLI « IBM Storage Ceph as a Service ».

Assurez-vous que votre environnement à partir duquel le CLI sera exécuté est connecté au réseau sur site avant d'utiliser le CLI sur le déploiement sur site de IBM Storage Ceph as a Service.

Installez l'interface de ligne de commande(IBM Cloud)
Installer le plug-in CLI IBM Storage Ceph as a Service software-defined-storage.
```
ibmcloud plugin install software-defined-storage
```
Les actions CLI d' IBM Storage Ceph as a Service utilisent également les alias sds. Pour savoir comment utiliser les commandes CLI, vous pouvez exécuter :
```
ibmcloud sds --help
ibmcloud sds volume-create --help
ibmcloud sds host-create --help
```

Accéder à CLI via le point de terminaison de l'API

Pour configurer l'interface de ligne de commande afin qu'elle utilise le point de terminaison de l'API, procédez comme suit :

Si vous avez besoin de télécharger le CLI IBM Cloud et les plug-ins associés, vous devez être en mesure d'accéder au dépôt public où ils se trouvent.

Assurez-vous que le CLI IBM Cloud et le plug-in IBM Storage Ceph as a Service sont mis à jour avec la dernière version :
```
ibmcloud update
```
```
ibmcloud plugin update software-defined-storage
```
Pour spécifier un point de terminaison API, entrez la commande suivante :
```
ibmcloud login -a https://cloud.ibm.com
```
Pour plus d'informations sur les détails de l'option CLI, consultez ibmcloud login.

Configuration du jeton IAM

Avant de pouvoir utiliser l'interface de ligne de commande (CLI) pour créer votre IBM Storage Ceph as a Service, vous devez obtenir un jeton IAM, enregistrer le point de terminaison dans une variable et vérifier que vous disposez d'un accès au service IBM Storage Ceph as a Service.

IAM_TOKEN=$(ibmcloud iam oauth-tokens --output json | jq -r '.iam_token)

Prérequis d'API

Avant de pouvoir utiliser l'API pour créer votre IBM Storage Ceph as a Service, vous devez obtenir un jeton IAM, enregistrer le point de terminaison dans une variable et vérifier que vous disposez d'un accès au service API CephaaS.

Les exemples suivants utilisent le point d'extrémité régional us-south.

Etape 1 : stockez votre clé d'API sous forme de variable

Exécutez la commande suivante pour stocker la clé d'API pour votre compte dans une variable d'environnement. Si vous n'avez pas de clé d'API, voir Création d'une clé d'API.

apikey="<YOUR_API_KEY>"

Etape 2 : obtenez un jeton IBM IAM (Identity and Access Management)

Exécutez la commande suivante pour récupérer et analyser un jeton IAM à l'aide de l'utilitaire de traitement JSON jq. Vous pouvez modifier la commande pour utiliser un autre outil d'analyse syntaxique ou supprimer la dernière partie de la commande si vous préférez analyser manuellement le jeton.

IAM_TOKEN=`curl -k -X POST \
  --header "Content-Type: application/x-www-form-urlencoded" \
  --header "Accept: application/json" \
  --data-urlencode "grant_type=urn:ibm:params:oauth:grant-type:apikey" \
  --data-urlencode "apikey=$apikey" \
  "https://iam.cloud.ibm.com/identity/token"  |jq -r '(.token_type + " " + .access_token)'`

Pour afficher le jeton IAM, exécutez echo $IAM_TOKEN. Le résultat doit être similaire au code suivant :

Bearer <your token>

L'en-tête d'autorisation s'attend à ce que le jeton commence par "Bearer". Si le résultat n'inclut pas "Bearer", mettez à jour la variable IAM_TOKEN pour l'inclure. Ces exemples supposent que "Bearer" est inclus dans le jeton IAM_TOKEN.

Un jeton IAM est valide jusqu'à 60 minutes et peut être modifié. Lorsqu'un jeton expire, vous devez en générer un nouveau. Utilisez la propriété « expires_in » pour définir la date d'expiration du jeton IAM que vous venez de créer.

Etape 3 : stockez le point d'extrémité d'API en tant que variable

$sds_endpoint est une variable d'environnement qui pointe vers le point de terminaison qui vous a été fourni lors de la configuration de IBM Storage Ceph as a Service. Il se présente sous la forme d' URL. Par exemple, https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}. Exécutez la commande suivante pour stocker le point d'extrémité d'API dans une variable afin qu'elle puisse être réutilisée ultérieurement dans votre session.

Exemple :

sds_api_endpoint="https://sds-cephaas.936481b2-379d-4ca6-94ed-4dc1911d749f.software-defined-storage.appdomain.cloud:33173"

Pour vérifier que cette variable a été sauvegardée, exécutez echo $sds_endpoint et assurez-vous que la réponse n'est pas vide.

Étape 4 : Vérifiez que vous disposez d'un accès à l'API

Maintenant que vous avez un point de terminaison et votre jeton IAM, vérifiez votre accès à l'API via l'une des API décrites dans la référence API.

Si vous rencontrez des résultats inattendus, ajoutez l'indicateur --verbose (debug) après la commande curl pour obtenir des informations de journalisation détaillées.