Skip to main content

Example 7: Compliant ILM policy for S3 Object Lock

Contributors

You can use the S3 bucket, ILM rules, and ILM policy in this example as a starting point when defining an ILM policy to meet the object protection and retention requirements for objects in buckets with S3 Object Lock enabled.

Note If you used the legacy Compliance feature in previous StorageGRID releases, you can also use this example to help manage any existing buckets that have the legacy Compliance feature enabled.
Caution The following ILM rules and policy are only examples. There are many ways to configure ILM rules. Before activating a new policy, simulate it to confirm it will work as intended to protect content from loss.

Bucket and objects for S3 Object Lock example

In this example, an S3 tenant account named Bank of ABC has used the Tenant Manager to create a bucket with S3 Object Lock enabled to store critical bank records.

Bucket definition Example value

Tenant Account Name

Bank of ABC

Bucket Name

bank-records

Bucket Region

us-east-1 (default)

Each object and object version that is added to the bank-records bucket will use the following values for retain-until-date and legal hold settings.

Setting for each object Example value

retain-until-date

"2030-12-30T23:59:59Z" (December 30, 2030)

Each object version has its own retain-until-date setting. This setting can be increased, but not decreased.

legal hold

"OFF" (Not in effect)

A legal hold can be placed or lifted on any object version at any time during the retention period. If an object is under a legal hold, the object can't be deleted even if the retain-until-date has been reached.

ILM rule 1 for S3 Object Lock example: Erasure-coding profile with bucket matching

This example ILM rule applies only to the S3 tenant account named Bank of ABC. It matches any object in the bank-records bucket and then uses erasure coding to store the object on Storage Nodes at three data center sites using a 6+3 erasure-coding profile. This rule satisfies the requirements of buckets with S3 Object Lock enabled: a copy is kept on Storage Nodes from day 0 to forever, using Ingest time as the reference time.

Rule definition Example value

Rule name

Compliant Rule: EC Objects in bank-records Bucket - Bank of ABC

Tenant Account

Bank of ABC

Bucket Name

bank-records

Advanced filter

Object Size (MB) greater than 1

Note: This filter ensures that erasure coding is not used for objects 1 MB or smaller.

Rule definition Example value

Reference time

Ingest time

Placements

From day 0 store forever

Erasure-coding profile

  • Create an erasure-coded copy on Storage Nodes at three data center sites

  • Uses 6+3 erasure-coding scheme

ILM rule 2 for S3 Object Lock example: Non-compliant rule

This example ILM rule initially stores two replicated object copies on Storage Nodes. After one year, it stores one copy on a Cloud Storage Pool forever. Because this rule uses a Cloud Storage Pool, it is not compliant and will not apply to the objects in buckets with S3 Object Lock enabled.

Rule definition Example value

Rule name

Non-compliant rule: Use Cloud Storage Pool

Tenant accounts

Not specified

Bucket name

Not specified, but will only apply to buckets that don't have S3 Object Lock (or the legacy Compliance feature) enabled.

Advanced filter

Not specified

Rule definition Example value

Reference time

Ingest time

Placements

  • On Day 0, keep two replicated copies on Storage Nodes in Data Center 1 and Data Center 2 for 365 days

  • After 1 year, keep one replicated copy in a Cloud Storage Pool forever

ILM rule 3 for S3 Object Lock example: Default rule

This example ILM rule copies object data to storage pools in two data centers. This compliant rule is designed to be the default rule in the ILM policy. It does not include any filters, does not use the Noncurrent reference time, and satisfies the requirements of buckets with S3 Object Lock enabled: two object copies are kept on Storage Nodes from day 0 to forever, using Ingest as the reference time.

Rule definition Example value

Rule name

Default compliant rule: Two Copies Two Data Centers

Tenant account

Not specified

Bucket name

Not specified

Advanced filter

Not specified

Rule definition Example value

Reference time

Ingest time

Placements

From Day 0 to forever, keep two replicated copies—​one on Storage Nodes in Data Center 1 and one on Storage Nodes in Data Center 2.

Compliant ILM policy for S3 Object Lock example

To create an ILM policy that will effectively protect all objects in your system, including those in buckets with S3 Object Lock enabled, you must select ILM rules that satisfy the storage requirements for all objects. Then, you must simulate and activate the policy.

Add rules to the policy

In this example, the ILM policy includes three ILM rules, in the following order:

  1. A compliant rule that uses erasure coding to protect objects greater than 1 MB in a specific bucket with S3 Object Lock enabled. The objects are stored on Storage Nodes from day 0 to forever.

  2. A non-compliant rule that creates two replicated object copies on Storage Nodes for a year and then moves one object copy to a Cloud Storage Pool forever. This rule does not apply to buckets with S3 Object Lock enabled because it uses a Cloud Storage Pool.

  3. The default compliant rule that creates two replicated object copies on Storage Nodes from day 0 to forever.

Simulate the policy

After you have added rules to your policy, chosen a default compliant rule, and arranged the other rules, you should simulate the policy by testing objects from the bucket with S3 Object Lock enabled and from other buckets. For example, when you simulate the example policy, you would expect test objects to be evaluated as follows:

  • The first rule will only match test objects that are greater than 1 MB in the bucket bank-records for the Bank of ABC tenant.

  • The second rule will match all objects in all non-compliant buckets for all other tenant accounts.

  • The default rule will match these objects:

    • Objects 1 MB or smaller in the bucket bank-records for the Bank of ABC tenant.

    • Objects in any other bucket that has S3 Object Lock enabled for all other tenant accounts.

Activate the policy

When you are completely satisfied that the new policy protects object data as expected, you can activate it.