fix: the versioning/object lock documentation appropriately (#9988)
- Move the bucket level features into `docs/bucket` directory - fix issue template and simplify some of themmaster
Harshavardhana
4 years ago
committed by
GitHub
parent
fa211f6a10
commit
60417950c7
@ -0,0 +1,57 @@ |
||||
# Bucket Lifecycle Configuration Quickstart Guide [](https://slack.min.io) [](https://hub.docker.com/r/minio/minio/) |
||||
|
||||
Enable object lifecycle configuration on buckets to setup automatic deletion of objects after a specified number of days or a specified date. |
||||
|
||||
## 1. Prerequisites |
||||
- Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide). |
||||
- Install `mc` - [mc Quickstart Guide](https://docs.minio.io/docs/minio-client-quickstart-guide.html) |
||||
|
||||
## 2. Enable bucket lifecycle configuration |
||||
|
||||
- Create a bucket lifecycle configuration which expires the objects under the prefix `old/` on `2020-01-01T00:00:00.000Z` date and the objects under `temp/` after 7 days. |
||||
- Enable bucket lifecycle configuration using `mc`: |
||||
|
||||
```sh |
||||
$ mc ilm import play/testbucket |
||||
{ |
||||
"Rules": [ |
||||
{ |
||||
"Expiration": { |
||||
"Date": "2020-01-01T00:00:00.000Z" |
||||
}, |
||||
"ID": "OldPictures", |
||||
"Filter": { |
||||
"Prefix": "old/" |
||||
}, |
||||
"Status": "Enabled" |
||||
}, |
||||
{ |
||||
"Expiration": { |
||||
"Days": 7 |
||||
}, |
||||
"ID": "TempUploads", |
||||
"Filter": { |
||||
"Prefix": "temp/" |
||||
}, |
||||
"Status": "Enabled" |
||||
} |
||||
] |
||||
} |
||||
|
||||
Lifecycle configuration imported successfully to `play/testbucket`. |
||||
``` |
||||
|
||||
- List the current settings |
||||
``` |
||||
$ mc ilm list play/testbucket |
||||
ID | Prefix | Enabled | Expiry | Date/Days | Transition | Date/Days | Storage-Class | Tags |
||||
------------|----------|------------|--------|--------------|--------------|------------------|------------------|------------------ |
||||
OldPictures | old/ | ✓ | ✓ | 1 Jan 2020 | ✗ | | | |
||||
------------|----------|------------|--------|--------------|--------------|------------------|------------------|------------------ |
||||
TempUploads | temp/ | ✓ | ✓ | 7 day(s) | ✗ | | | |
||||
------------|----------|------------|--------|--------------|--------------|------------------|------------------|------------------ |
||||
``` |
||||
|
||||
## Explore Further |
||||
- [MinIO | Golang Client API Reference](https://docs.min.io/docs/golang-client-api-reference.html#SetBucketLifecycle) |
||||
- [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) |
||||
@ -0,0 +1,60 @@ |
||||
# Object Lock and Immutablity Guide [](https://slack.min.io) |
||||
|
||||
MinIO server allows WORM for specific objects or by configuring a bucket with default object lock configuration that applies default retention mode and retention duration to all objects. This makes objects in the bucket immutable i.e. delete of the version are not allowed until an expiry specified in the bucket's object lock configuration or object retention. |
||||
|
||||
Object locking requires locking to be enabled on a bucket at the time of bucket creation, object locking also automatically enables versioning on the bucket. In addition, a default retention period and retention mode can be configured on a bucket to be applied to objects created in that bucket. |
||||
|
||||
Independent of retention, an object can also be under legal hold. This effectively disallows all deletes of an object under legal hold until the legal hold is removed by an API call. |
||||
|
||||
## Get Started |
||||
|
||||
### 1. Prerequisites |
||||
|
||||
- Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide) |
||||
- Install `awscli` - [Installing AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) |
||||
|
||||
### 2. Set bucket WORM configuration |
||||
|
||||
WORM on a bucket is enabled by setting object lock configuration. This configuration is applied to existing and new objects in the bucket. Below is an example sets `Governance` mode and one day retention time from object creation time of all objects in `mybucket`. |
||||
|
||||
```sh |
||||
$ awscli s3api put-object-lock-configuration --bucket mybucket --object-lock-configuration 'ObjectLockEnabled=\"Enabled\",Rule={DefaultRetention={Mode=\"GOVERNANCE\",Days=1}}' |
||||
``` |
||||
|
||||
### Set object lock |
||||
|
||||
PutObject API allows setting per object retention mode and retention duration using `x-amz-object-lock-mode` and `x-amz-object-lock-retain-until-date` headers. This takes precedence over any bucket object lock configuration w.r.t retention. |
||||
|
||||
```sh |
||||
aws s3api put-object --bucket testbucket --key lockme --object-lock-mode GOVERNANCE --object-lock-retain-until-date "2019-11-20" --body /etc/issue |
||||
``` |
||||
|
||||
See https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html for AWS S3 spec on object locking and permissions required for object retention and governance bypass overrides. |
||||
|
||||
### Set legal hold on an object |
||||
|
||||
PutObject API allows setting legal hold using `x-amz-object-lock-legal-hold` header. |
||||
|
||||
```sh |
||||
aws s3api put-object --bucket testbucket --key legalhold --object-lock-legal-hold-status ON --body /etc/issue |
||||
``` |
||||
|
||||
See https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html for AWS S3 spec on object locking and permissions required for specifying legal hold. |
||||
|
||||
## Concepts |
||||
- If an object is under legal hold, it cannot be deleted unless the legal hold is explicitly removed for the respective version id. DeleteObjectVersion() would fail otherwise. |
||||
- In `Compliance` mode, objects cannot be deleted by anyone until retention period is expired for the respective version id. If user has requisite governance bypass permissions, an object's retention date can be extended in `Compliance` mode. |
||||
- Once object lock configuration is set to a bucket |
||||
- New objects inherit the retention settings of the bucket object lock configuration automatically |
||||
- Retention headers can be optionally set when uploading objects |
||||
- Explicitly calling PutObjectRetention API call on the object |
||||
- *MINIO_NTP_SERVER* environment variable can be set to remote NTP server endpoint if system time is not desired for setting retention dates. |
||||
- **Object locking feature is only available in erasure coded and distributed erasrue coded setups**. |
||||
|
||||
## Explore Further |
||||
|
||||
- [Use `mc` with MinIO Server](https://docs.min.io/docs/minio-client-quickstart-guide) |
||||
- [Use `aws-cli` with MinIO Server](https://docs.min.io/docs/aws-cli-with-minio) |
||||
- [Use `s3cmd` with MinIO Server](https://docs.min.io/docs/s3cmd-with-minio) |
||||
- [Use `minio-go` SDK with MinIO Server](https://docs.min.io/docs/golang-client-quickstart-guide) |
||||
- [The MinIO documentation website](https://docs.min.io) |
||||
@ -1,59 +0,0 @@ |
||||
# Object Lifecycle Configuration Quickstart Guide [](https://slack.min.io) [](https://hub.docker.com/r/minio/minio/) |
||||
|
||||
Enable object lifecycle configuration on buckets to setup automatic deletion of objects after a specified number of days or a specified date. |
||||
|
||||
## 1. Prerequisites |
||||
- Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide). |
||||
- Install AWS Cli - [Installing AWS Command Line Interface](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) |
||||
|
||||
|
||||
## 2. Enable bucket lifecycle configuration |
||||
|
||||
1. Create a bucket lifecycle configuration which expires the objects under the prefix `uploads/2015` on `2020-01-01T00:00:00.000Z` date and the objects under `temporary-uploads/` after 7 days. Generate it as shown below: |
||||
|
||||
```sh |
||||
$ cat >bucket-lifecycle.json << EOF |
||||
{ |
||||
"Rules": [ |
||||
{ |
||||
"Expiration": { |
||||
"Date": "2020-01-01T00:00:00.000Z" |
||||
}, |
||||
"ID": "Delete very old messenger pictures", |
||||
"Filter": { |
||||
"Prefix": "uploads/2015/" |
||||
}, |
||||
"Status": "Enabled" |
||||
}, |
||||
{ |
||||
"Expiration": { |
||||
"Days": 7 |
||||
}, |
||||
"ID": "Delete temporary uploads", |
||||
"Filter": { |
||||
"Prefix": "temporary-uploads/" |
||||
}, |
||||
"Status": "Enabled" |
||||
} |
||||
] |
||||
} |
||||
EOF |
||||
``` |
||||
|
||||
2. Enable bucket lifecycle configuration using `aws-cli`: |
||||
|
||||
```sh |
||||
$ export AWS_ACCESS_KEY_ID="your-access-key" |
||||
$ export AWS_SECRET_ACCESS_KEY="your-secret-key" |
||||
$ aws s3api put-bucket-lifecycle-configuration --bucket your-bucket --endpoint-url http://minio-server-address:port --lifecycle-configuration file://bucket-lifecycle.json |
||||
``` |
||||
|
||||
3. Verify that the configuration has been added |
||||
|
||||
```sh |
||||
$ aws s3api get-bucket-lifecycle-configuration --bucket your-bucket --endpoint-url http://minio-server-address:port |
||||
``` |
||||
|
||||
## Explore Further |
||||
- [MinIO | Golang Client API Reference](https://docs.min.io/docs/golang-client-api-reference.html#SetBucketLifecycle) |
||||
- [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) |
||||
@ -1,56 +0,0 @@ |
||||
# Object Lock and Immutablity [](https://slack.min.io) |
||||
|
||||
MinIO server allows selectively specify WORM for specific objects or configuring a bucket with default object lock configuration that applies default retention mode and retention duration to all incoming objects. Essentially, this makes objects in the bucket immutable i.e. delete and overwrite are not allowed till stipulated time specified in the bucket's object lock configuration or object retention. |
||||
|
||||
Object locking requires locking to be enabled on a bucket at the time of bucket creation. In addition, a default retention period and retention mode can be configured on a bucket to be applied to objects created in that bucket. |
||||
|
||||
Independently of retention, an object can also be under legal hold. This effectively disallows all deletes and overwrites of an object under legal hold until the hold is lifted. |
||||
|
||||
## Get Started |
||||
|
||||
### 1. Prerequisites |
||||
|
||||
Install MinIO - [MinIO Quickstart Guide](https://docs.min.io/docs/minio-quickstart-guide). |
||||
|
||||
### 2. Set bucket WORM configuration |
||||
|
||||
WORM on a bucket is enabled by setting object lock configuration. This configuration is applied to existing and new objects in the bucket. Below is an example sets `Governance` mode and one day retention time from object creation time of all objects in `mybucket`. |
||||
|
||||
```sh |
||||
$ awscli s3api put-object-lock-configuration --bucket mybucket --object-lock-configuration 'ObjectLockEnabled=\"Enabled\",Rule={DefaultRetention={Mode=\"GOVERNANCE\",Days=1}}' |
||||
``` |
||||
|
||||
### Set object lock |
||||
|
||||
PutObject API allows setting per object retention mode and retention duration using `x-amz-object-lock-mode` and `x-amz-object-lock-retain-until-date` headers. This takes precedence over any bucket object lock configuration w.r.t retention. |
||||
|
||||
```sh |
||||
aws s3api put-object --bucket testbucket --key lockme --object-lock-mode GOVERNANCE --object-lock-retain-until-date "2019-11-20" --body /etc/issue |
||||
``` |
||||
|
||||
See https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html for AWS S3 spec on object locking and permissions required for object retention and governance bypass overrides. |
||||
|
||||
### Set legal hold on an object |
||||
|
||||
PutObject API allows setting legal hold using `x-amz-object-lock-legal-hold` header. |
||||
|
||||
```sh |
||||
aws s3api put-object --bucket testbucket --key legalhold --object-lock-legal-hold-status ON --body /etc/issue |
||||
``` |
||||
|
||||
See https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html for AWS S3 spec on object locking and permissions required for specifying legal hold. |
||||
|
||||
> NOTE: |
||||
> - If an object is under legal hold, it cannot be overwritten unless the legal hold is explicitly removed. |
||||
> - In `Compliance` mode, objects cannot be overwritten or deleted by anyone until retention period is expired. If user has requisite governance bypass permissions, an object's retention date can be extended in `Compliance` mode. |
||||
> - Currently `Governance` mode does not allow overwriting an existing object as versioning is not available in MinIO. However, if user has requisite `Governance` bypass permissions, an object in `Governance` mode can be overwritten. |
||||
> - Once object lock configuration is set to a bucket, new objects inherit the retention settings of the bucket object lock configuration (if set) or the retention headers set in the PUT request or set with PutObjectRetention API call |
||||
> - *MINIO_NTP_SERVER* environment variable can be set to remote NTP server endpoint if system time is not desired for setting retention dates. |
||||
|
||||
## Explore Further |
||||
|
||||
- [Use `mc` with MinIO Server](https://docs.min.io/docs/minio-client-quickstart-guide) |
||||
- [Use `aws-cli` with MinIO Server](https://docs.min.io/docs/aws-cli-with-minio) |
||||
- [Use `s3cmd` with MinIO Server](https://docs.min.io/docs/s3cmd-with-minio) |
||||
- [Use `minio-go` SDK with MinIO Server](https://docs.min.io/docs/golang-client-quickstart-guide) |
||||
- [The MinIO documentation website](https://docs.min.io) |
||||
Loading…
Reference in new issue