mirror of
https://github.com/pgsty/minio.git
synced 2026-07-22 13:40:22 +03:00
cleanup markdown docs across multiple files (#14296)
enable markdown-linter
This commit is contained in:
+12
-4
@@ -6,7 +6,8 @@ MinIO uses a key-management-system (KMS) to support SSE-S3. If a client requests
|
||||
|
||||
MinIO supports multiple KMS implementations via our [KES](https://github.com/minio/kes#kes) project. We run a KES instance at `https://play.min.io:7373` for you to experiment and quickly get started. To run MinIO with a KMS just fetch the root identity, set the following environment variables and then start your MinIO server. If you havn't installed MinIO, yet, then follow the MinIO [install instructions](https://docs.min.io/docs/minio-quickstart-guide) first.
|
||||
|
||||
#### 1. Fetch the root identity
|
||||
### 1. Fetch the root identity
|
||||
|
||||
As the initial step, fetch the private key and certificate of the root identity:
|
||||
|
||||
```sh
|
||||
@@ -15,7 +16,7 @@ curl -sSL --tlsv1.2 \
|
||||
-O 'https://raw.githubusercontent.com/minio/kes/master/root.cert'
|
||||
```
|
||||
|
||||
#### 2. Set the MinIO-KES configuration
|
||||
### 2. Set the MinIO-KES configuration
|
||||
|
||||
```sh
|
||||
export MINIO_KMS_KES_ENDPOINT=https://play.min.io:7373
|
||||
@@ -24,7 +25,7 @@ export MINIO_KMS_KES_CERT_FILE=root.cert
|
||||
export MINIO_KMS_KES_KEY_NAME=my-minio-key
|
||||
```
|
||||
|
||||
#### 3. Start the MinIO Server
|
||||
### 3. Start the MinIO Server
|
||||
|
||||
```sh
|
||||
export MINIO_ROOT_USER=minio
|
||||
@@ -39,6 +40,7 @@ minio server ~/export
|
||||
## Configuration Guides
|
||||
|
||||
A typical MinIO deployment that uses a KMS for SSE-S3 looks like this:
|
||||
|
||||
```
|
||||
┌────────────┐
|
||||
│ ┌──────────┴─┬─────╮ ┌────────────┐
|
||||
@@ -61,7 +63,6 @@ The main difference between various MinIO-KMS deployments is the KMS implementat
|
||||
| [Google Cloud Platform SecretManager](https://github.com/minio/kes/wiki/GCP-SecretManager) | Cloud KMS. MinIO in combination with a managed KMS installation |
|
||||
| [FS](https://github.com/minio/kes/wiki/Filesystem-Keystore) | Local testing or development (**Not recommended for production**) |
|
||||
|
||||
|
||||
The MinIO-KES configuration is always the same - regardless of the underlying KMS implementation. Checkout the MinIO-KES [configuration example](https://github.com/minio/kes/wiki/MinIO-Object-Storage).
|
||||
|
||||
### Further references
|
||||
@@ -72,27 +73,34 @@ The MinIO-KES configuration is always the same - regardless of the underlying KM
|
||||
- [Understand the KES server concepts](https://github.com/minio/kes/wiki/Concepts)
|
||||
|
||||
## Auto Encryption
|
||||
|
||||
Auto-Encryption is useful when MinIO administrator wants to ensure that all data stored on MinIO is encrypted at rest.
|
||||
|
||||
### Using `mc encrypt` (recommended)
|
||||
|
||||
MinIO automatically encrypts all objects on buckets if KMS is successfully configured and bucket encryption configuration is enabled for each bucket as shown below:
|
||||
|
||||
```
|
||||
mc encrypt set sse-s3 myminio/bucket/
|
||||
```
|
||||
|
||||
Verify if MinIO has `sse-s3` enabled
|
||||
|
||||
```
|
||||
mc encrypt info myminio/bucket/
|
||||
Auto encryption 'sse-s3' is enabled
|
||||
```
|
||||
|
||||
### Using environment (not-recommended)
|
||||
|
||||
MinIO automatically encrypts all objects on buckets if KMS is successfully configured and following ENV is enabled:
|
||||
|
||||
```
|
||||
export MINIO_KMS_AUTO_ENCRYPTION=on
|
||||
```
|
||||
|
||||
### Verify auto-encryption
|
||||
|
||||
> Note that auto-encryption only affects requests without S3 encryption headers. So, if a S3 client sends
|
||||
> e.g. SSE-C headers, MinIO will encrypt the object with the key sent by the client and won't reach out to
|
||||
> the configured KMS.
|
||||
|
||||
Reference in New Issue
Block a user