Chapter 10. Multicloud Object Gateway bucket replication

Procedure

1. Apply the following YAML:

   apiVersion: noobaa.io/v1alpha1
   kind: BucketClass
   metadata:
     labels:
       app: <desired-app-label>
     name: <desired-bucketclass-name>
     namespace: <desired-namespace>
   spec:
     placementPolicy:
       tiers:
       - backingstores:
         - <backingstore>
         placement: Spread
     replicationPolicy: [{ "rule_id": "<rule id>", "destination_bucket": "first.bucket", "filter": {"prefix": "<object name prefix>"}}]

   This YAML is an example that creates a placement bucket class. Each Object bucket claim (OBC) object that is uploaded to the bucket is filtered based on the prefix and is replicated to first.bucket.

   <desired-app-label>

   Specify a label for the app.

   <desired-bucketclass-name>

   Specify the bucket class name.

   <desired-namespace>

   Specify the namespace in which the bucket class gets created.

   <backingstore>

   Specify the name of a backingstore. You can pass many backingstores.

   "rule_id"

   Specify the ID number of the rule, for example, {"rule_id": "rule-1"}.

   "destination_bucket"

   Specify the name of the destination bucket, for example, {"destination_bucket": "first.bucket"}.

   "prefix"

   Is optional. The prefix of the object keys gets replicated. You can leave it empty, for example, {"prefix": ""}.

Procedure

1. In the OpenShift Web Console, navigate to Storage Object Storage Object Bucket Claims.
2. Click Create ObjectBucketClaim.
3. Enter the name of ObjectBucketName and select StorageClass and BucketClass.
4. Select the Enable replication check box to enable replication.
5. In the Replication policy section, select the Optimize replication using event logs checkbox.

6. Enter the name of the bucket that will contain the logs under Event log Bucket.

   If the logs are not stored in the root of the bucket, provide the full path without s3://

7. Enter a prefix to replicate only the objects whose name begins with the given prefix.

Procedure

1. Create a secret with credentials to be used by the namespacestores.

   apiVersion: v1
   kind: Secret
   metadata:
     name: <namespacestore-secret-name>
   type: Opaque
   data:
       TenantID: <AZURE TENANT ID ENCODED IN BASE64>
       ApplicationID: <AZURE APPLICATIOM ID ENCODED IN BASE64>
       ApplicationSecret: <AZURE APPLICATION SECRET ENCODED IN BASE64>
       LogsAnalyticsWorkspaceID: <AZURE LOG ANALYTICS WORKSPACE ID ENCODED IN BASE64>
       AccountName: <AZURE ACCOUNT NAME ENCODED IN BASE64>
       AccountKey: <AZURE ACCOUNT KEY ENCODED IN BASE64>

2. Create a NamespaceStore backed by a container created in Azure.

   For more information, see Adding a namespace bucket using the OpenShift Container Platform user interface.

3. Create a new Namespace-Bucketclass and OBC that utilizes it.
4. Check the object bucket name by looking in the YAML of target OBC, or by listing all S3 buckets, for example, - s3 ls.

5. Use the following template to apply an Azure replication policy on your source OBC by adding the following in its YAML, under .spec:

   replicationPolicy:'{"rules":[ {"rule_id":"ID goes here", "sync_deletions": "<true or false>"", "destination_bucket":object bucket name"}
    ], "log_replication_info":{"endpoint_type":"AZURE"}}'

   sync_deletion

   Specify a boolean value, true or false.

   destination_bucket

   Make sure to use the name of the object bucket, and not the claim. The name can be retrieved using the s3 ls command, or by looking for the value in an OBC’s YAML.

Verification steps

1. Write objects to the source bucket.
2. Wait until MCG replicates them.
3. Delete the objects from the source bucket.
4. Verify the objects were removed from the target bucket.

Procedure

1. In the OpenShift Web Console, navigate to Storage Object Storage Object Bucket Claims.
2. Click Create new Object bucket claim.
3. (Optional) In the Replication rules section, select the Sync deletion checkbox for each rule separately.

4. Enter the name of the bucket that will contain the logs under Event log Bucket.

   If the logs are not stored in the root of the bucket, provide the full path without s3://

5. Enter a prefix to replicate only the objects whose name begins with the given prefix.

Procedure

1. Create a data bucket where you can upload the objects.

   odf nb bucket create data.bucket

2. Create a log bucket where you want to store the logs for bucket operations by using the following command:

   odf nb bucket create log.bucket

3. Configure bucket logging on data bucket with log bucket in one of the following ways:

   • Using the NooBaa API

     odf nb api bucket_api put_bucket_logging '{
        "name": "data.bucket",
        "log_bucket": "log.bucket",
        "log_prefix": "data-bucket-logs"
     }'

   • Using the S3 API

     alias s3api_alias='AWS_ACCESS_KEY_ID=$NOOBAA_ACCESS_KEY AWS_SECRET_ACCESS_KEY=$NOOBAA_SECRET_KEY aws --endpoint https://localhost:10443 --no-verify-ssl s3api'

     1. Create a file called setlogging.json in the following format:

        {
          "LoggingEnabled": {
             "TargetBucket": "<log-bucket-name>",
             "TargetPrefix": "<prefix/empty-string>"
          }
        }

     2. Run the following command:

        s3api_alias put-bucket-logging --endpoint <ep> --bucket <source-bucket> --bucket-logging-status file://setlogging.json --no-verify-ssl

4. Verify if the bucket logging is set for the data bucket in one of the following ways:

   • Using the NooBaa API

     odf nb api bucket_api get_bucket_logging '{
        "name": "data.bucket"
     }'

   • Using the S3 API

     s3api_alias get-bucket-logging --no-verify-ssl --endpoint <ep> --bucket <source-bucket>

     The S3 operations can take up to 24 hours to get recorded in the logs bucket. The following example shows the recorded logs and how to download them:

     Example

     s3_alias cp s3://logs.bucket/data-bucket-logs/logs.bucket.bucket_data-bucket-logs_1719230150.log - | tail -n 2
     
     Jun 24 14:00:02 10-XXX-X-XXX.sts.openshift-storage.svc.cluster.local  {"noobaa_bucket_logging":"true","op":"GET","bucket_owner":"operator@noobaa.io","source_bucket":"data.bucket","object_key":"/data.bucket?list-type=2&prefix=data-bucket-logs&delimiter=%2F&encoding-type=url","log_bucket":"logs.bucket","remote_ip":"100.XX.X.X","request_uri":"/data.bucket?list-type=2&prefix=data-bucket-logs&delimiter=%2F&encoding-type=url","request_id":"luv2XXXX-ctyg2k-12gs"} Jun 24 14:00:06 10-XXX-X-XXX.s3.openshift-storage.svc.cluster.local  {"noobaa_bucket_logging":"true","op":"PUT","bucket_owner":"operator@noobaa.io","source_bucket":"data.bucket","object_key":"/data.bucket/B69EC83F-0177-44D8-A8D1-4A10C5A5AB0F.file","log_bucket":"logs.bucket","remote_ip":"100.XX.X.X","request_uri":"/data.bucket/B69EC83F-0177-44D8-A8D1-4A10C5A5AB0F.file","request_id":"luv2XXXX-9syea5-x5z"}

5. (Optional) To disable bucket logging, use the following command:

   odf nb api bucket_api delete_bucket_logging '{
      "name": "data.bucket"
   }'