Einrichten Ihrer CLI- und API-Umgebung

Bevor Sie mithilfe der API oder der CLI ein „ IBM® Storage Ceph® as a Service “ erstellen können, müssen Sie Ihre Umgebung einrichten.

Allgemeine Voraussetzungen

Richten Sie Ihr Konto ein, um auf IBM Storage Ceph as a Service zugreifen zu können. Stellen Sie sicher, dass Ihr Konto auf ein gebührenpflichtiges Konto hochgestuft ist.
Halten Sie die Liste der lokalen Endpunkte, die für die Bereitstellung bereitgestellt wurden, griffbereit.

Sie können die Endpunkte als Umgebungsvariablen festlegen.

CLI-Voraussetzungen

Bevor Sie die Befehlszeilenschnittstelle (CLI) nutzen können, müssen Sie die CLI „ IBM Cloud “ sowie das CLI-Plugin „ IBM Storage Ceph as a Service “ installieren.

Stellen Sie sicher, dass Ihre Umgebung, von der aus die Befehlszeilenschnittstelle ausgeführt wird, mit dem lokalen Netzwerk verbunden ist, bevor Sie die Befehlszeilenschnittstelle für die lokale Bereitstellung von IBM Storage Ceph as a Service verwenden.

Installieren Sie die CLI IBM Cloud.
Installieren Sie das IBM Storage Ceph as a Service CLI-Plugin software-defined-storage.
```
ibmcloud plugin install software-defined-storage
```
Die IBM Storage Ceph as a Service-CLI-Aktionen verwenden auch die Aliase sds. Wenn Sie Informationen zur Verwendung der CLI-Befehle benötigen, dann führen Sie die folgenden Befehle aus:
```
ibmcloud sds --help
ibmcloud sds volume-create --help
ibmcloud sds host-create --help
```

Zugriff auf CLI über den API-Endpunkt

Um die CLI so einzustellen, dass sie den API-Endpunkt verwendet, gehen Sie wie folgt vor:

Wenn Sie die IBM Cloud CLI und die zugehörigen Plug-Ins herunterladen möchten, müssen Sie auf das öffentliche Repository zugreifen können, in dem sie sich befinden.

Stellen Sie sicher, dass das IBM Cloud CLI und das IBM Storage Ceph as a Service Plug-in auf die neueste Version aktualisiert sind:
```
ibmcloud update
```
```
ibmcloud plugin update software-defined-storage
```
Um einen API-Endpunkt anzugeben, geben Sie den folgenden Befehl ein:
```
ibmcloud login -a https://cloud.ibm.com
```
Weitere Informationen zu den Details der CLI-Option finden Sie unter ibmcloud login.

IAM-Token einrichten

Bevor Sie die Befehlszeilenschnittstelle (CLI) zum Erstellen Ihrer „ IBM Storage Ceph as a Service “ verwenden können, müssen Sie ein IAM-Token abrufen, den Endpunkt als Variable speichern und sicherstellen, dass Sie Zugriff auf den Dienst „ IBM Storage Ceph as a Service “ haben.

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

API-Voraussetzungen

Bevor Sie die API zum Erstellen Ihrer „ IBM Storage Ceph as a Service “ nutzen können, müssen Sie ein IAM-Token abrufen, den Endpunkt als Variable speichern und sicherstellen, dass Sie Zugriff auf den API-Dienst „ CephaaS “ haben.

Bei den folgenden Beispielen wird der regionale Endpunkt us-south verwendet.

Schritt 1: API-Schlüssel als Variable speichern

Führen Sie den folgenden Befehl aus, um den API-Schlüssel Ihres Kontos in einer Umgebungsvariablen zu speichern. Wenn Sie über keinen API-Schlüssel verfügen, überprüfen Sie den Abschnitt API-Schlüssel erstellen.

apikey="<YOUR_API_KEY>"

Schritt 2: IBM IAM-Token (IAM - Identity and Access Management) abrufen

Führen Sie den folgenden Befehl aus, um mithilfe des JSON-Verarbeitungsprogramms „jq“ ein IAM-Token abzurufen und zu analysieren. Sie können den Befehl so ändern, dass ein anderes Parsing-Tool verwendet wird. Alternativ können Sie den letzten Teil des Befehls entfernen, wenn Sie das Token manuell parsen möchten.

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)'`

Führen Sie echo $IAM_TOKEN aus, um das IAM-Token anzuzeigen. Das Ergebnis sollte wie folgt aussehen:

Bearer <your token>

Vom Berechtigungsheader wird erwartet, dass das Token mit "Bearer" beginnt. Wenn das Ergebnis die Zeichenfolge "Bearer" nicht enthält, aktualisieren Sie die Variable IAM_TOKEN so, dass sie diese Angabe enthält. Diese Beispiele setzen voraus, dass "Bearer" in IAM_TOKEN enthalten ist.

Ein IAM-Token ist bis zu 60 Minuten gültig und kann geändert werden. Nach Ablauf eines Tokens muss ein neues generiert werden. Verwenden Sie die Eigenschaft „expires_in“ für die Gültigkeitsdauer des soeben erstellten IAM-Tokens.

Schritt 3: API-Endpunkt als Variable speichern

Bei $sds_endpoint handelt es sich um eine Umgebungsvariable, die auf den Endpunkt verweist, der Ihnen bei der Konfiguration von IBM Storage Ceph as a Service mitgeteilt wurde. Es ist im URL-Formular. Beispiel: https://sds-cephaas.<cephaas-instance-id>.software-defined-storage.appdomain.cloud:{port number}. Führen Sie den folgenden Befehl aus, um den API-Endpunkt in einer Variablen zu speichern, sodass er zu einem späteren Zeitpunkt in Ihrer Sitzung erneut verwendet werden kann.

Zum Beispiel:

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

Um sicherzustellen, dass diese Variable gespeichert wurde, führen Sie echo $sds_endpoint aus und stellen Sie sicher, dass die Antwort nicht leer ist.

Schritt 4: Überprüfen Sie, ob Sie über API-Zugriff verfügen

Nachdem Sie nun einen Endpunkt und Ihr IAM-Token haben, überprüfen Sie Ihren API-Zugriff über eine der in der API-Referenz beschriebenen APIs.

Wenn unerwartete Ergebnisse auftreten, fügen Sie nach dem Befehl --verbose das Flag curl (Debug) hinzu, um detaillierte Protokollierungsinformationen zu erhalten.