Bereitstellung einer App, die COS nutzt

Sie können einen Persistent Volume Claim (PVC) erstellen, um IBM Cloud Object Storage für Ihren Cluster einzurichten.

Abhängig von den Einstellungen, die Sie im PVC auswählen, können Sie IBM Cloud Object Storage auf folgende Weise einrichten:

• Dynamische Bereitstellung: Wenn Sie das PVC erstellen, werden das zugehörige persistente Volume (PV) und der Bucket in Ihrer IBM Cloud Object Storage-Service-Instanz automatisch angelegt.
• Statische Bereitstellung: Sie können in Ihrem PVC auf einen vorhandenen Bucket in Ihrer IBM Cloud Object Storage-Service-Instanz verweisen. Wenn Sie den PVC erstellen, wird nur der übereinstimmende PV automatisch erstellt und mit vorhandenen Bucket in IBM Cloud Object Storage verknüpft.

Vorbereitende Schritte:

• Erstellen Sie Ihre IBM Cloud Object Storage-Serviceinstanz und bereiten Sie sie vor.
• Erstellen Sie einen geheimen Schlüssel, um Ihre IBM Cloud Object Storage-Serviceberechtigungsnachweise zu speichern.
• Entscheiden Sie über die Konfiguration Ihres IBM Cloud Object Storage.

Gehen Sie wie folgt vor, um IBM Cloud Object Storage zu Ihrem Cluster hinzuzufügen:

1. Erstellen Sie eine Konfigurationsdatei, um Ihren Persistent Volume Claim (PVC) zu definieren. Wenn Sie Ihre Anmeldedaten für IBM Cloud Object Storage zu den Standard-Speicherklassen hinzufügen, geben Sie Ihr Geheimnis nicht im PVC an.

   kind: PersistentVolumeClaim
   apiVersion: v1
   metadata:
     name: <name> # Enter the name of the PVC.
     namespace: <namespace> # Enter the namespace where you want to create the PVC. The PVC must be created in the same namespace where you created the Kubernetes secret for your service credentials and where you want to run your pod.
     annotations:
       ibm.io/auto-create-bucket: "<true_or_false>"
       ibm.io/auto-delete-bucket: "<true_or_false>"
       ibm.io/bucket: "<bucket_name>"
       ibm.io/object-path: "<bucket_subdirectory>"
       ibm.io/quota-limit: "true/false" # Disable or enable a quota limit for your PVC. To use this annotation you must specify the -set quotaLimit=true option during installation.
       ibm.io/endpoint: "https://<s3fs_service_endpoint>"
       ibm.io/tls-cipher-suite: "default"
       ibm.io/secret-name: "<secret_name>" # The name of your Kubernetes secret that you created.
       ibm.io/secret-namespace: "<secret-namespace>" # By default, the COS plug-in searches for your secret in the same namespace where you create the PVC. If you created your secret in a namespace other than the namespace where you want to create your PVC, enter the namespace where you created your secret.
       ibm.io/add-mount-param: "<option-1>,<option-2>" # s3fs mount options
       ibm.io/access-policy-allowed-ips: "XX.XXX.XX.XXX, XX.XX.XX.XXX, XX.XX.XX.XX" # A csv of allow listed IPs.
       ibm.io/bucket-versioning: "false" # Set to true to enable bucket versioning.
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: <size>
     storageClassName: <storage_class>
   

   ibm.io/auto-create-bucket

   Wählen Sie eine der folgenden Optionen aus.

   true: Wenn Sie den PVC erstellen, werden der PV und das Bucket in Ihrer IBM Cloud Object Storage-Serviceinstanz automatisch erstellt. Wählen Sie diese Option aus, um ein neues Bucket in Ihrer IBM Cloud Object Storage-Serviceinstanz zu erstellen. Beachten Sie, dass die Serviceberechtigungsnachweise Ausgabeprogramm-Berechtigungen haben müssen, um das Bucket automatisch zu erstellen.

   false: Wählen Sie diese Option aus, um auf Daten in einem vorhandenen Bucket zuzugreifen. Wenn Sie den PVC erstellen, wird der PV automatisch erstellt und mit dem Bucket verknüpft, den Sie in ibm.io/bucket angeben.

   ibm.io/auto-delete-bucket

   Wählen Sie eine der folgenden Optionen aus.

   true: Ihre Daten, das Bucket und der PV werden automatisch entfernt, wenn Sie den PVC löschen. Ihre IBM Cloud Object Storage-Serviceinstanz bleibt bestehen und wird nicht gelöscht. Wenn Sie diese Option auf true setzen, müssen Sie ibm.io/auto-create-bucket: true und ibm.io/bucket: "" festlegen, sodass Ihr Bucket automatisch mit einem Namen im Format tmp-s3fs-xxxx erstellt wird.

   false: Wenn Sie den PVC löschen, wird der PV automatisch gelöscht, aber Ihre Daten und das Bucket in Ihrer IBM Cloud Object Storage-Serviceinstanz bleiben erhalten. Um auf Ihre Daten zugreifen zu können, müssen Sie einen neuen PVC mit dem Namen des vorhandenen Buckets erstellen.

   ibm.io/bucket

   Wählen Sie eine der folgenden Optionen aus.

   Wenn ibm.io/auto-create-bucket auf true festgelegt ist: Geben Sie den Namen des Buckets ein, das Sie in IBM Cloud Object Storage erstellen wollen. Wenn außerdem ibm.io/auto-delete-bucket auf true gesetzt ist, muss dieses Feld leer bleiben, damit Ihrem Bucket automatisch ein Name im Format tmp-s3fs-xxxx zugewiesen wird. Der Name muss in IBM Cloud Object Storage eindeutig sein.

   Wenn ibm.io/auto-create-bucket auf false festgelegt ist: Geben Sie den Namen des vorhandenen Buckets ein, auf das Sie im Cluster zugreifen möchten.

   ibm.io/object-path

   Optional: Geben Sie den Namen des vorhandenen Unterverzeichnisses in Ihrem Bucket ein, das angehängt werden soll. Verwenden Sie diese Option, wenn nur ein Unterverzeichnis und nicht das gesamte Bucket angehängt werden soll. Um ein Unterverzeichnis anzuhängen, müssen Sie ibm.io/auto-create-bucket: "false" festlegen und den Namen des Buckets in ibm.io/bucket angeben.

   ibm.io/quota-limit

   Damit diese Annotation verwendet werden kann, müssen Sie während der Installation die Option --set quotaLimit=true angeben. Wenn Sie diese Anmerkung verwenden möchten, aber --set quotaLimit=true während der Installation nicht angegeben hat installieren Sie das Helm-Diagramm erneut.

   Wenn „ ibm.io/quota-limit “ auf „ true “ gesetzt ist, legt Ihr PVC die maximal für den Bucket verfügbare Speicherkapazität (in Byte) auf der Grundlage der von Ihnen angegebenen Größe „ storage: <size> “ fest.

   Wenn ibm.io/quota-limit auf false gesetzt ist, wird das Kontingent für Ihren PVC nicht erzwungen. Dies bedeutet, dass die tatsächliche Speichermenge in Byte die storage: <size> überschreitet, die Sie abhängig von Ihrer App angegeben haben.

   ibm.io/endpoint

   Wenn Sie Ihre IBM Cloud Object Storage-Serviceinstanz an einer Position erstellt haben, die sich von der Ihres Clusters unterscheidet, geben Sie den Private- oder Public-Cloud-Serviceendpunkt Ihrer IBM Cloud Object Storage-Serviceinstanz ein, den Sie verwenden möchten. Weitere Informationen und eine Übersicht über die verfügbaren Serviceendpunkte finden Sie unter Zusätzliche Endpunktinformationen. Das Helm-Plug-in ibmc ruft standardmäßig automatisch Ihre Clusterposition ab und erstellt die Speicherklasse unter Verwendung von IBM Cloud Object Storage-Private-Cloud-Serviceendpunkten, die Ihrer Clusterposition entsprechen. Befindet sich Ihr klassischer Cluster in einer Metro mit mehreren Zonen, wie z. B. dal10, wird der Endpunkt des IBM Cloud Object Storage-Private-Cloud-Dienstes für die Metro mit mehreren Zonen, wie z. B. Dallas, verwendet. Führen Sie oc describe storageclass <storageclassname> aus, um zu überprüfen, ob der Serviceendpunkt in Ihren Speicherklassen mit dem Serviceendpunkt Ihrer Serviceinstanz übereinstimmt. Stellen Sie sicher, dass Sie Ihren Serviceendpunkt im Format https://<s3fs_private_service_endpoint> für private Cloud-Serviceendpunkte oder http://<s3fs_public_service_endpoint> für öffentliche Cloud-Serviceendpunkte eingeben. Wenn der Serviceendpunkt in Ihrer Speicherklasse mit dem Serviceendpunkt Ihrer IBM Cloud Object Storage-Serviceinstanz übereinstimmt, schließen Sie die Option ibm.io/endpoint nicht in Ihre PVC YAML-Datei ein.

   ibm.io/add-mount-param

   Geben Sie Mountoptionen für Ihre s3fs Fuse-Datenträger ein. Beispiel: ibm.io/add-mount-param: "del_cache,retries=6". Eine Liste der Optionen finden Sie auf den Man-Pages zu s3fs.

   ibm.io/access-policy-allowed-ips

   Geben Sie eine durch Kommas getrennte Liste mit IPs ein, die auf Ihre Datenträger zugreifen können. Beispiel: ibm.io/access-policy-allowed-ips: "XX.XXX.XX.XXX, XX.XX.XX.XXX, XX.XX.XX.XX".

   storage

   Geben Sie im Abschnitt Spezifikationen – Ressourcenanforderungen die Größe Ihres IBM Cloud Object Storage-Buckets in Gigabyte ein. Der tatsächlich von Ihnen in IBM Cloud Object Storage genutzte Speicherplatz kann davon abweichen und wird gemäß der Preistabelle abgerechnet. Wenn Sie beim Installieren des Plug-ins Kontingente aktiviert haben, entspricht das Kontingent für Ihr Bucket dieser Größe.

   storageClassName

   Wählen Sie eine der folgenden Optionen aus.

   Wenn ibm.io/auto-create-bucket: "true": Geben Sie die Speicherklasse ein, die Sie für Ihr neues Bucket verwenden möchten.

   Wenn ibm.io/auto-create-bucket: "false": Geben Sie die Speicherklasse ein, die Sie zum Erstellen Ihres vorhandenen Buckets verwendet haben.

   Wenn Sie das Bucket in Ihrer IBM Cloud Object Storage-Serviceinstanz manuell erstellt oder sich nicht an die von Ihnen verwendete Speicherklasse erinnern können, suchen Sie Ihre Serviceinstanz im IBM Cloud-Dashboard und überprüfen Sie die Klasse und Position Ihres vorhandenen Buckets. Verwenden Sie anschließend die entsprechende Speicherklasse. Der in Ihrer Speicherklasse festgelegte IBM Cloud Object Storage-API-Endpunkt basiert auf der Region, in der sich Ihr Cluster befindet. Wenn Sie auf einen Bucket zugreifen möchten, der sich in einer anderen Region befindet als die, in der sich Ihr Cluster befindet, müssen Sie eine eigene Speicherklasse erstellen und den für Ihren Bucket geeigneten API-Endpunkt verwenden.

   ibm.io/secret-name

   Geben Sie den Namen des geheimen Schlüssels ein, der die IBM Cloud Object Storage-Berechtigungsnachweise enthält, die Sie zuvor erstellt haben. Wenn Sie Ihre IBM Cloud Object Storage-Berechtigungsnachweise zu den Standardspeicherklassen hinzufügen, dürfen Sie keine geheimen Schlüssel im PVC auflisten. Wenn Sie die Key Protect-Verschlüsselung beim Erstellen neuer Buckets aus PVCs in Ihrem Cluster integrieren möchten, müssen Sie den CRN des Rootschlüssels einschließen, wenn Sie Ihren geheimen IBM Cloud Object Storage-Schlüssel erstellen. Beachten Sie, dass die Verschlüsselung Key Protect nicht zu vorhandenen Buckets hinzugefügt werden kann.

   secret-namespace

   Standardmäßig sucht das COS-Plugin Ihren geheimen Schlüssel in demselben Namensbereich, in dem Sie den PVC erstellen. Wenn Sie Ihren geheimen Schlüssel in einem anderen Namensbereich erstellt haben als dem, in dem Sie Ihr PVC erstellen wollen, geben Sie den Namensbereich an, in dem Sie Ihren geheimen Schlüssel erstellt haben.

   ibm.io/bucket-versioning

   Die Versionierung von Buckets ist false standardmäßig aktiviert. Setzen Sie diese Option auf true, um die Bucket-Versionierung zu aktivieren. Setzen Sie diese Option auf false, um die Versionierung für einen Bucket zu deaktivieren, in dem die Versionierung aktiviert ist. Beachten Sie, dass die Dienstanmeldeinformationen über die Berechtigung Manager oder Writer verfügen müssen, um die Bucketversionierung für den Bucket zu aktivieren oder zu deaktivieren. Weitere Informationen finden Sie unter Erste Schritte mit der Versionsverwaltung.

2. Erstellen Sie die PVC in Ihrem Cluster.

   oc apply -f filepath/pvc.yaml
   

3. Überprüfen Sie, ob Ihr PVC erstellt und an den persistenten Datenträger (PV) gebunden wurde.

   oc get pvc
   

   Beispielausgabe

   NAME                  STATUS    VOLUME                                     CAPACITY   ACCESS MODES   STORAGECLASS                     AGE
   s3fs-test-pvc         Bound     pvc-b38b30f9-1234-11e8-ad2b-t910456jbe12   8Gi        RWO            ibmc-s3fs-standard-cross-region  1h
   

4. Optional: Wenn Sie als Benutzer ohne Rootberechtigung auf Ihre Daten zugreifen möchten oder Dateien zu einem vorhandenen IBM Cloud Object Storage-Bucket direkt über die Konsole oder die API hinzugefügt haben, stellen Sie sicher, dass den Dateien die richtige Berechtigung zugewiesen wird, sodass Ihre App die Dateien nach Bedarf erfolgreich lesen und aktualisieren kann.

5. Um den PV an Ihre Bereitstellung anzuhängen, erstellen Sie eine .yaml-Konfigurationsdatei und geben Sie den PVC an, der den persistenten Datenträger bindet.

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: <deployment_name>
     labels:
       app: <deployment_label>
   spec:
     selector:
       matchLabels:
         app: <app_name>
     template:
       metadata:
         labels:
           app: <app_name>
       spec:
         containers:
         - image: <image_name>
           name: <container_name>
           securityContext:
             runAsUser: <non_root_user>
           volumeMounts:
           - name: <volume_name>
             mountPath: /<file_path>
         volumes:
         - name: <volume_name>
           persistentVolumeClaim:
             claimName: <pvc_name>
   

   app

   Geben Sie im Abschnitt 'metadata' eine Bezeichnung für die Bereitstellung ein.

   matchLabels.app und labels.app

   Geben Sie im Abschnitt "spec" unter "selector" und im Abschnitt "spec" unter "template" -> "metadata" eine Bezeichnung für Ihre App ein.

   image

   Der Name des Container-Image, das Sie verwenden möchten. Führen Sie ibmcloud cr image-list aus, um die verfügbaren Images in Ihrem IBM Cloud Container Registry-Konto aufzulisten.

   name

   Der Name des Containers, den Sie in Ihrem Cluster bereitstellen möchten.

   runAsUser

   Unter "spec" im Abschnitt "containers" -> "securityContext" können Sie den Wert für "runAsUser" festlegen.

   mountPath

   Geben Sie unter "spec" im Abschnitt "containers" -> "volumeMounts" den absoluten Pfad des Verzeichnisses ein, in dem der Datenträger innerhalb des Containers per Mount angehängt wird. Wenn Sie ein Volume für verschiedene Apps gemeinsam nutzen möchten, können Sie für jede Ihrer Apps Volume-Unterpfade angeben.

   volumeMounts.name

   Geben Sie unter "spec" im Abschnitt "containers" -> "volumeMounts" den Namen des Datenträgers ein, der an Ihren Pod angehängt werden soll.

   volumes.name

   Geben Sie im Abschnitt 'volumes' den Namen des Datenträgers ein, der an Ihren Pod angehängt werden soll. Dieser Name ist in der Regel mit volumeMounts/name identisch.

   claimName

   Geben Sie im Abschnitt 'volumes: persistentVolumeClaim' den Namen des PVC ein, der den physischen Datenträger (PV) bindet, den Sie verwenden möchten.