Konfiguration des IBM Cloud Object Storage-Treibers für Satellite-Cluster
Erfahren Sie, wie Sie den IBM Cloud Object Storage-Treiber in Ihren Satellite-Clustern bereitstellen, um Daten bei verschiedenen Anbietern von Cloud-Speicher im S3-compatible zu erstellen und darauf zuzugreifen, darunter IBM, AWS, Wasabi und Azure.
Bevor Sie Speichervorlagen in Clustern an Ihrem Standort bereitstellen können, müssen Sie Satellite Config einrichten, indem Sie in der Konsole die Option Enable cluster admin access for Satellite Config (Cluster-Administrationszugriff für Config aktivieren ) auswählen oder bei der Erstellung Ihres Clusters die Option --enable-config-admin angeben.
Sie können den Satellite Speicherdienst nicht auf Ressourcengruppen ausweiten. Wenn Sie jedoch andere Ressourcen wie Standorte und Cluster zu Ressourcengruppen zusammenfassen, müssen Sie Satellite reader und link administrator role für alle Ressourcen im Konto hinzufügen.
Voraussetzungen
-
Erstellen Sie eine Gruppe von Serviceberechtigungsnachweisen in Ihrem Objektspeicherprovider.
-
Erstellen Sie einen geheimen Schlüssel, der Ihre s3-Berechtigungsnachweise enthält.
Geheimen Schlüssel in Ihrem Cluster erstellen, der Ihre Berechtigungsnachweise für den Objektspeicher enthält
Erstellen Sie den geheimen Kubernetes-Schlüssel in Ihrem Cluster, der Ihre Serviceberechtigungsnachweise enthält.
-
Führen Sie die auf Ihrem Objektspeicherprovider basierenden Schritte aus, um einen geheimen Schlüssel in Ihrem Cluster zu erstellen. Wenn Sie Ihren geheimen Schlüssel erstellen, werden alle Werte automatisch in Base64 codiert. Im folgenden Beispiel lautet der Name des Geheimnisses
cos-write-access.-
IBM Cloud Object Storage
-
Ermitteln Sie die ID Ihrer Service-Instanz.
ibmcloud resource service-instance <service_name> | grep GUID -
Erstellen Sie den geheimen Schlüssel in Ihrem Cluster.
oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=API-KEY --from-literal=service-instance-id=SERVICE-INSTANCE-ID
-
-
AWS oder Wasabi
oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=access-key=ACCESS-KEY-ID --from-literal=secret-key=SECRET-ACCESS-KEY ``` -
Konfiguration in der Konsole erstellen und zuordnen
-
Wählen Sie in der Standortkonsole den Standort aus, an dem Sie eine Speicherkonfiguration erstellen möchten.
-
Wählen Sie Speicher > Speicherkonfiguration erstellen aus
-
Geben Sie einen Namen für Ihre Konfiguration ein.
-
Wählen Sie den Speichertyp aus.
-
Wählen Sie die Version aus und klicken Sie auf Weiter
-
Wenn der von Ihnen ausgewählte Speichertyp benutzerdefinierte Parameter akzeptiert, geben Sie sie auf der Registerkarte Parameter ein.
-
Wenn der von Ihnen ausgewählte Speichertyp geheime Schlüssel erfordert, geben Sie sie auf der Registerkarte Geheime Schlüssel ein.
-
Überprüfen Sie auf der Registerkarte Speicherklassen die Speicherklassen, die von der Konfiguration implementiert werden, oder erstellen Sie eine angepasste Speicherklasse.
-
Wählen Sie auf der Registerkarte Service zuordnen den Service aus, dem Sie Ihre Konfiguration zuordnen wollen.
-
Klicken Sie auf Abschließen, um Ihre Speicherkonfiguration zuzuordnen.
Konfiguration in der Befehlszeilenschnittstelle erstellen
-
Überprüfen Sie die Parameterreferenz für die Vorlagenversion, die Sie verwenden wollen.
-
Melden Sie sich bei der IBM Cloud-CLI an.
ibmcloud login -
Listen Sie Ihre Satellite Standorte auf und notieren Sie die Spalte
Managed from.ibmcloud sat location ls -
Wählen Sie die Region
Managed fromIhrer Position Satellite aus. Beispiel: Fürwdc-Zielus-east. Weitere Informationen finden Sie unter Satellite Regionen.ibmcloud target -r us-east -
Wenn Sie eine andere Ressourcengruppe als
defaultverwenden, wählen Sie sie aus.ibmcloud target -g RESOURCE_GROUP -
Kopieren Sie einen der folgenden Beispielbefehle für die Vorlagenversion, die Sie verwenden möchten. Weitere Informationen zu dem Befehl finden Sie unter
ibmcloud sat storage config createin der Befehlsreferenz.Beispielbefehl zum Erstellen einer Konfiguration der Version 2.2.
ibmcloud sat storage config create --location LOCATION --name NAME --template-name ibm-object-storage-plugin --template-version 2.2 --param "helm-release-name=HELM-RELEASE-NAME" --param "parameters=PARAMETERS" --param "license=LICENSE" --param "s3provider=S3PROVIDER" --param "cos-storageclass=COS-STORAGECLASS" --param "cos-endpoint=COS-ENDPOINT" -
Passen Sie den Befehl basierend auf den Einstellungen an, die Sie verwenden möchten.
-
Führen Sie den Befehl aus, um eine Konfiguration zu erstellen.
-
Überprüfen Sie, ob Ihre Konfiguration erstellt wurde.
ibmcloud sat storage config get --config CONFIG
Konfiguration in der API erstellen
-
Generieren Sie einen API-Schlüssel und fordern Sie anschließend ein Aktualisierungstoken an. Weitere Informationen finden Sie im Abschnitt zur Generierung eines IBM Cloud IAM-Token mithilfe eines API-Schlüssels.
-
Überprüfen Sie die Parameterreferenz für die Vorlagenversion, die Sie verwenden wollen.
-
Kopieren Sie eine der folgenden Beispielanforderungen und ersetzen Sie die Variablen, die Sie verwenden möchten.
Beispielanforderung zum Erstellen einer Konfiguration der Version 2.2.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createStorageConfigurationByController" -H "accept: application/json" -H "Authorization: TOKEN" -H "Content-Type: application/json" -d "{ \"config-name\": \"string\", \"controller\": \"string\", \"storage-class-parameters\": [ { \"additionalProp1\": \"string\", \"additionalProp2\": \"string\", \"additionalProp3\": \"string\" } ], \"storage-template-name\": \"ibm-object-storage-plugin\", \"storage-template-version\": \"2.2\", \"update-assignments\": true, \"user-config-parameters\": { \"entry.name\": \"HELM-RELEASE-NAME\", { \"entry.name\": \"PARAMETERS\", { \"entry.name\": \"LICENSE\", { \"entry.name\": \"S3PROVIDER\", { \"entry.name\": \"COS-STORAGECLASS\", { \"entry.name\": \"COS-ENDPOINT\",\"user-secret-parameters\": }
Erstellen einer Zuweisung in der CLI
-
Listen Sie Ihre Speicherkonfigurationen auf und notieren Sie sich die Speicherkonfiguration, die Sie Ihren Clustern zuweisen möchten.
ibmcloud sat storage config ls -
Rufen Sie die ID des Clusters, der Clustergruppe oder des Dienstes ab, dem Sie Speicher zuweisen möchten.
Um sicherzustellen, dass Ihr Cluster bei Satellite Config oder zum Erstellen von Gruppen registriert ist, lesen Sie die Informationen im Abschnitt Cluster für die Verwendung mit Satellite Configeinrichten.
Beispielbefehl zum Auflisten von Clustergruppen.
ibmcloud sat group lsBeispielbefehl zum Auflisten von Clustern.
ibmcloud oc cluster ls --provider satelliteBeispielbefehl zum Auflisten von Satellite-Services.
ibmcloud sat service ls --location LOCATION -
Ordnen Sie Ihre Speicherkonfiguration dem Cluster, der Gruppe bzw. dem Service zu, den Sie zuvor abgerufen haben. Weitere Informationen finden Sie unter dem Befehl
ibmcloud sat storage assignment create.Beispielbefehl zum Zuordnen einer Konfiguration zu einer Clustergruppe.
ibmcloud sat storage assignment create --group GROUP --config CONFIG --name NAMEBeispielbefehl für die Zuordnung einer Konfiguration zu einem Cluster
ibmcloud sat storage assignment create --cluster CLUSTER --config CONFIG --name NAMEBeispielbefehl zum Zuordnen einer Konfiguration zu einem Service-Cluster.
ibmcloud sat storage assignment create --service-cluster-id CLUSTER --config CONFIG --name NAME -
Überprüfen Sie, ob Ihre Zuweisung erstellt wurde.
ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER)
Speicherzuordnung in der API erstellen
-
Kopieren Sie eine der folgenden Beispielanforderungen:
Beispielanforderung zum Zuordnen einer -Konfiguration zu einem Cluster.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignmentByCluster" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"CLUSTER-ID\", \"controller\": \"LOCATION-ID\", \"name\": \"ASSIGNMENT-NAME\"}"Beispielanforderung zum Zuordnen der Konfiguration zu einer Clustergruppe.
curl -X POST "https://containers.cloud.ibm.com/global/v2/storage/satellite/createAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"channelName\": \"CONFIGURATION-NAME\", \"cluster\": \"string\", \"groups\": [ \"CLUSTER-GROUP\" ], \"name\": \"ASSIGNMENT-NAME\"}" -
Ersetzen Sie die Variablen durch Ihre Details und führen Sie die Anforderung aus.
-
Überprüfen Sie, ob die Zuordnung erstellt wurde, indem Sie Ihre Zuordnungen auflisten.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignments" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Speicherzuordnungen in der Konsole aktualisieren
Sie können die Satellite-Konsole verwenden, um die neuesten Patchaktualisierungen auf Ihre Zuordnungen anzuwenden.
-
Wählen Sie auf der Seite Positionen in der Satellite-KonsoleIhren Standort aus.
-
Klicken Sie auf die Registerkarte Speicher, um Ihre Konfigurationen anzuzeigen.
-
Klicken Sie auf die Konfiguration, die Sie aktualisieren möchten.
-
Klicken Sie auf das Informationssymbol Informationen (i), um die letzte Überarbeitung oder Programmkorrektur anzuwenden.
-
Optional: Aktivieren Sie automatische Patchaktualisierungen für Ihre Speicherzuordnung. Die Aktivierung automatischer Patchaktualisierungen stellt sicher, dass Ihre Zuordnung immer über die neuesten Sicherheitskorrekturen verfügt.
Wenn Sie automatische Patchaktualisierungen aktivieren, müssen Sie die Hauptaktualisierungen dennoch manuell anwenden.
Zuordnungen in der Befehlszeilenschnittstelle manuell aktualisieren
Aktualisieren Sie eine Zuordnung, um die neueste Speichervorlagenrevision zu verwenden.
-
Listen Sie Ihre Satellite-Speicherzuordnungen auf und notieren Sie sich die Satellite-Zuordnung, für die Sie ein Upgrade durchführen möchten.
ibmcloud sat storage assignment ls -
Listen Sie die Satellite-Speichervorlagen auf, um die neuesten verfügbaren Versionen anzuzeigen.
ibmcloud sat storage template ls -
Aktualisieren Sie die Satellite-Zuordnung.
Beispielbefehl für das Upgrade einer Zuordnung.
ibmcloud sat storage assignment upgrade --assignment ASSIGNMENT
Automatische Patchaktualisierungen für Konfigurationen und Zuordnungen in der Befehlszeilenschnittstelle aktivieren
Sie können die sat storage assignment autopatch enable-CLI verwenden, um automatische Patchaktualisierungen für Ihre Zuordnungen zu aktivieren. Durch die Aktivierung automatischer Patchaktualisierungen werden die neuesten Speichervorlagenrevisionen
(Patches) automatisch angewendet. Sie müssen wichtige Aktualisierungen dennoch manuell anwenden.
-
Listen Sie Ihre Satellite-Speicherkonfigurationen auf. Notieren Sie sich die Konfigurations-ID.
ibmcloud sat storage assignment ls -
Führen Sie einen der folgenden Beispielbefehle aus, um automatische Patchaktualisierungen für Ihre Konfiguration und die zugehörigen Zuordnungen zu aktivieren. Geben Sie die Konfigurations-ID ein, die Sie im vorherigen Schritt abgerufen haben.
Beispielbefehl zum Aktivieren automatischer Patchaktualisierungen für eine Zuordnung.
ibmcloud sat storage assignment autopatch enable --config CONFIG (--all | --assignment ASSIGNMENT-ID [--assignment ASSIGNMENT-ID])Beispielbefehl zum Aktivieren automatischer Patchaktualisierungen für alle Speicherzuordnungen in einer bestimmten Konfiguration.
ibmcloud sat storage assignment autopatch enable --config CONFIG --allBeispielbefehl zum Inaktivieren der automatischen Patchaktualisierungen für alle Zuordnungen in einer bestimmten Konfiguration.
ibmcloud sat storage assignment autopatch disable --config CONFIG --allBeispielbefehl zum Inaktivieren von automatischen Patchaktualisierungen für eine einzelne Zuordnung und eine bestimmte Konfiguration
ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-IDBeispielbefehl zum Inaktivieren automatischer Patchaktualisierungen für eine Mehrfachzuordnung und eine bestimmte Konfiguration.
ibmcloud sat storage assignment autopatch disable --config CONFIG --assignment ASSIGNMENT-ID --assignment ASSIGNMENT-ID
Upgrade für Konfiguration und Zuordnungen in der API durchführen
Sie können die /v2/storage/satellite/updateAssignment-API verwenden, um Ihre Zuordnungen mit neuen Clustern oder Clustergruppen
zu aktualisieren. Setzen Sie updateConfigVersion auf true, um die Revisionsaktualisierung anzuwenden.
-
Kopieren Sie die folgende Beispielanforderung und ersetzen Sie die Variablen für die Clustergruppen und Zuordnungen, die Sie aktualisieren wollen.
curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/updateAssignment" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d "{ \"groups\": [ \"CLUSTER-GROUPS\" ], \"name\": \"ASSIGNMENT-NAME\", \"updateConfigVersion\": true, \"uuid\": \"ASSIGNMENT-ID\"}" -
Führen Sie die Anforderung aus.
-
Rufen Sie die Details Ihrer Zuordnung ab, um die Aktualisierung zu überprüfen.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Automatische Patchaktualisierungen für Zuordnungen in der API aktivieren
Sie können die /v2/storage/satellite/setAssignmentAutoupgrade-API verwenden, um automatische Patchaktualisierungen für Ihre Zuordnungen zu aktivieren. Durch die Aktivierung automatischer Patchaktualisierungen werden die neuesten
Speichervorlagenrevisionen (Patches) automatisch angewendet. Sie müssen wichtige Aktualisierungen dennoch manuell anwenden.
-
Kopieren Sie die folgende Beispielanforderung und ersetzen Sie die Variablen für die Clustergruppen und Zuordnungen, die Sie aktualisieren wollen.
curl -X PATCH "https://containers.cloud.ibm.com/global/v2/storage/satellite/setAssignmentAutoupgrade" -H "accept: application/json" -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" -d { "config": "string", "controller": "string", "autopatch": boolean,"assignment" : { "all": boolean, "uuid": ["string", "string", ...], } } -
Führen Sie die Anforderung aus.
-
Rufen Sie die Details Ihrer Zuordnung ab, um das Upgrade zu überprüfen.
curl -X GET "https://containers.cloud.ibm.com/global/v2/storage/satellite/getAssignment?uuid=ASSIGNMENT-ID" -H "accept: application/json" -H "Authorization: Bearer TOKEN"
Bereitstellung einer App, die IBM Cloud Object Storage nutzt
Mit dem Treiber ibm-object-s3fs können Sie PVCs erstellen, die Sie in Ihren Cluster-Workloads verwenden können.
-
Erstellen Sie einen PVC, der auf Ihre Objektspeicherkonfiguration verweist.
kind: PersistentVolumeClaim apiVersion: v1 metadata: name: demo #Enter a name for your PVC. namespace: default annotations: ibm.io/auto-create-bucket: "false" ibm.io/auto-delete-bucket: "false" ibm.io/bucket: BUCKET-NAME #Enter the name of your object storage bucket. ibm.io/secret-name: SECRET-NAME #Enter the name of the secret you created earlier. ibm.io/secret-namespace: NAMESPACE #Enter the namespace where you want to create the PVC. spec: accessModes: - ReadWriteOnce resources: requests: storage: 10Gi storageClassName: ibmc-s3fs-cos #The storage class that you want to use. -
Erstellen Sie die PVC in Ihrem Cluster.
oc apply -f pvc-cos.yaml -
Erstellen Sie eine YAML-Konfigurationsdatei für einen Pod, der das von Ihnen erstellte PVC einbindet.
apiVersion: v1 kind: Pod metadata: name: demo-pod namespace: default spec: securityContext: runAsUser: 2000 fsGroup: 2000 volumes: - name: demo-vol persistentVolumeClaim: claimName: demo containers: - name: test image: nginxinc/nginx-unprivileged imagePullPolicy: Always volumeMounts: - name: demo-vol mountPath: /mnt/cosvol -
Erstellen Sie den Pod in Ihrem Cluster.
oc apply -f demo-pod.yaml -
Überprüfen Sie, ob der Pod bereitgestellt wurde. Beachten Sie, dass es einige Minuten dauern kann, bis Ihre App in den Status 'Aktiv' (
Running) wechselt.oc get podsNAME READY STATUS RESTARTS AGE demo-pod 1/1 Running 0 2m58s -
Überprüfen Sie, ob die App auf Ihren Blockspeicherdatenträger schreiben kann, indem Sie sich bei Ihrem Pod anmelden.
oc exec demo-pod -- bash -c "touch /mnt/cosvol/test.txt && ls /mnt/cosvol" test.txt
Entfernen der IBM Cloud Object Storage-Speicherkonfiguration über die Konsole
- Wählen Sie im Dashboard für den Satellite-Speicher die Speicherkonfiguration aus, die gelöscht werden soll.
- Wählen Sie Aktionen > Löschen aus
- Geben Sie den Namen Ihrer Speicherkonfiguration ein.
- Wählen Sie Löschen aus.
IBM Cloud Object Storage-Speicherkonfiguration über die Befehlszeile entfernen
Wenn Sie Ihre IBM Cloud Object Storage-Konfiguration nicht mehr benötigen, können Sie Ihre Apps, PVCs, PVs und Zuordnungen aus Ihren Clustern entfernen.
-
Listen Sie Ihre Speicherzuweisungen auf und ermitteln Sie diejenige, die für Ihren Cluster verwendet wurde.
ibmcloud sat storage assignment ls (--cluster CLUSTER | --config CONFIG | --location LOCATION | --service-cluster-id CLUSTER) -
Entfernen Sie die Zuweisung. Nachdem die Zuordnung entfernt wurde, werden die Treiberpods und -Speicherklassen aus allen Clustern entfernt, die Teil der Speicherzuordnung waren.
ibmcloud sat storage assignment rm --assignment <assignment_ID> -
Überprüfen Sie, ob der Treiber aus dem Cluster entfernt wurde.
- Listen Sie die Speicherklassen in Ihrem Cluster auf und überprüfen Sie, ob die Speicherklassen entfernt werden.
oc get sc ``` 1. Listen Sie die Pods im Namensbereich `kube-system` auf und überprüfen Sie, ob die Speichertreiber-Pods entfernt werden. ```sh {: pre} oc get pods -n kube-system | grep cos ``` -
Optional: Entfernen Sie die Speicherkonfiguration.
- Listen Sie die Speicherkonfigurationen auf.
ibmcloud sat storage config ls ``` 1. Entfernen Sie die Speicherkonfiguration. ```sh {: pre} ibmcloud sat storage config rm --config <config_name> ```
Parameterreferenz
2.2-Parameterreferenz
| Anzeigename | CLI-Option | Typ | Beschreibung | Standardwert |
|---|---|---|---|---|
| Releasename | helm-release-name |
Konfiguration | Releasename des Helm-Diagramms. | ibm-object-storage-plugin |
| Zusätzliche Parameter für Helm-Diagramm | parameters |
Konfiguration | Zusätzliche Parameter für Helm-Diagramm. | Nicht zutreffend |
| Lizenz für das Object Storage-Plug-in | license |
Konfiguration | Lizenz für das Object Storage-Plug-in: Apache-Lizenz Version 2.0. Setzen Sie den Wert auf 'true', um die Lizenz zu akzeptieren und das Plug-in zu installieren. | Nicht zutreffend |
| Object Storage-Provider | s3provider |
Konfiguration | Verfügbare Provider sind 'IBM', 'AWS' und 'Wasabi '. Für andere Provider als diese müssen Sie den Parameter für den 'Object Storage-Serviceendpunkt' angeben. | Nicht zutreffend |
| Object Storage-Region | cos-storageclass |
Konfiguration | Geben Sie die Region ein, in der sich Ihre Object Storage-Instanz befindet. Informationen zu IBM COS-Regionen finden Sie unter https://ibm.biz/cos-endpoints-list. Informationen zu Wasabi finden Sie unter https://ibm.biz/wasabi-endpoints. Informationen zu AWS finden Sie unter https://ibm.biz/aws-endpoints. | Nicht zutreffend |
| Object Storage-Servicendpunkt | cos-endpoint |
Konfiguration | Object Storage-Serviceendpunkt. Erforderlich, wenn Sie andere Object Storage-Provider als IBM, AWS oder Wasabi verwenden. Wenn beide festgelegt sind, wird 'Object Storage-Provider' bevorzugt. | Nicht zutreffend |
Speicherklassenreferenz für IBM Cloud Object Storage
| Speicherklassenname | Datenträgerbindungsmodus | Beibehalten |
|---|---|---|
ibm-s3fs-cos |
Sofort | Falsch |
ibm-s3fs-cos-perf |
Sofort | Falsch |
Hilfe und Unterstützung für IBM Cloud Object Storage anfordern
Wenn Sie IBM Cloud Object Storage verwenden, probieren Sie die folgenden Ressourcen aus, bevor Sie einen Support-Fall eröffnen.
- Sehen Sie sich die FAQs in der Dokumentation zuBlock Storage for VPC an.
- Lesen Sie die Dokumentation zur Fehlerbehebung, um allgemeine Probleme zu beheben und zu beheben.
- Überprüfen Sie den Status der IBM Cloud-Plattform und der Ressourcen auf der Statusseite.
- Überprüfen Sie Stack Overflow, um festzustellen, ob andere Benutzer dasselbe Problem hatten. Versehen Sie Fragen mit den Tags
ibm-cloudundCOS. - Wenn ein Problem mit Block Storage for VPCauftritt, senden Sie eine Support-Anforderung an den IBM Cloud® Support.