mirror of
https://github.com/pgsty/minio.git
synced 2026-08-09 15:53:28 +03:00
docs: rebrand the repository documentation, templates and dashboards
README, README_ZH, SECURITY, COMPLIANCE, CONTRIBUTING, NOTICE, code_of_conduct, the vulnerability and PR-etiquette documents, the GitHub issue and pull request templates, and the docs/ tree all present Silo as the product. The Grafana dashboards under docs/metrics/prometheus/grafana/ have their panel titles and descriptions rebranded while every minio_* query, label and expression is left alone, so existing alerts and recording rules keep matching. The distinction the review demanded is applied per hit rather than by search-and-replace: - Product and command text becomes Silo and silo: install and run instructions, systemd examples, compose services, download links, badges. - Protocol and interface text keeps MinIO: MINIO_* variables, minio_* metrics, x-minio-* headers, /minio/* routes, .minio.sys, arn:minio, and API field and error names. - Attribution keeps MinIO and gains the fork's own: the AGPL obligations, original copyright, CREDITS and NOTICE stay, with the modification notice added alongside rather than replacing them. - Historical and third-party references are left as facts, not rewritten for brand tidiness. README and README_ZH each carry an explicit non-affiliation notice, document the side-by-side package migration including the /etc/systemd/system/silo.service.d/10-legacy-user.conf drop-in for keeping a legacy UID/GID, and state that recursive chown is never performed. The trademark attribution uses the policy's approved "based on MinIO technology" wording, not the shortened form the policy rejects. github.com/pgsty/minio links are left in place and labelled transitional. The repository has not been renamed, and rewriting them now would produce documented URLs that 404 until the cutover; they change in the cutover commit together with the goreleaser release target, the OCI source label and the raw-content branch. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
Feng Ruohang
+20
-20
@@ -1,12 +1,12 @@
|
||||
# KMS IAM/Config Encryption
|
||||
|
||||
MinIO supports encrypting config, IAM assets with KMS provided keys. If the KMS is not enabled, MinIO will store the config, IAM data as plain text erasure coded in its backend.
|
||||
Silo supports encrypting config, IAM assets with KMS provided keys. If the KMS is not enabled, Silo will store the config, IAM data as plain text erasure coded in its backend.
|
||||
|
||||
## MinIO KMS Quick Start
|
||||
## Silo KMS Quick Start
|
||||
|
||||
MinIO supports two ways of encrypting IAM and configuration data.
|
||||
Silo supports two ways of encrypting IAM and configuration data.
|
||||
You can either use KES - together with an external KMS - or, much simpler,
|
||||
set the env. variable `MINIO_KMS_SECRET_KEY` and start/restart the MinIO server. For more details about KES and how
|
||||
set the env. variable `MINIO_KMS_SECRET_KEY` and start/restart the Silo server. For more details about KES and how
|
||||
to set it up refer to our [KMS Guide](https://github.com/pgsty/minio/blob/master/docs/kms/README.md).
|
||||
|
||||
Instead of configuring an external KMS you can start with a single key by
|
||||
@@ -33,7 +33,7 @@ export MINIO_KMS_SECRET_KEY=my-minio-key:OSMM+vkKUTCvQs9YL/CVMIMt43HFhkUpqJxTmGl
|
||||
> You can choose an arbitrary name for the key - instead of `my-minio-key`.
|
||||
> Please note that losing the `MINIO_KMS_SECRET_KEY` will cause data loss
|
||||
> since you will not be able to decrypt the IAM/configuration data anymore.
|
||||
For distributed MinIO deployments, specify the *same* `MINIO_KMS_SECRET_KEY` for each MinIO server process.
|
||||
For distributed Silo deployments, specify the *same* `MINIO_KMS_SECRET_KEY` for each Silo server process.
|
||||
|
||||
At any point in time you can switch from `MINIO_KMS_SECRET_KEY` to a full KMS
|
||||
deployment. You just need to import the generated key into KES - for example via
|
||||
@@ -45,7 +45,7 @@ kes key create my-minio-key OSMM+vkKUTCvQs9YL/CVMIMt43HFhkUpqJxTmGl6rYw=
|
||||
|
||||
- For instructions on setting up KES, see the [KES Getting Started guide](https://github.com/minio/kes/wiki/Getting-Started)
|
||||
|
||||
- For instructions on using KES for encrypting the MinIO backend, follow the [KMS Quick Start](https://github.com/pgsty/minio/tree/master/docs/kms). The SSE-S3 configuration setup also supports MinIO KMS backend encryption.
|
||||
- For instructions on using KES for encrypting the Silo backend, follow the [KMS Quick Start](https://github.com/pgsty/minio/tree/master/docs/kms). The SSE-S3 configuration setup also supports Silo KMS backend encryption.
|
||||
|
||||
## FAQ
|
||||
|
||||
@@ -53,14 +53,14 @@ kes key create my-minio-key OSMM+vkKUTCvQs9YL/CVMIMt43HFhkUpqJxTmGl6rYw=
|
||||
|
||||
Before, there were two separate mechanisms - S3 objects got encrypted using a KMS,
|
||||
if present, and the IAM / configuration data got encrypted with the root credentials.
|
||||
Now, MinIO encrypts IAM / configuration and S3 objects with a KMS, if present. This
|
||||
change unified the key-management aspect within MinIO.
|
||||
Now, Silo encrypts IAM / configuration and S3 objects with a KMS, if present. This
|
||||
change unified the key-management aspect within Silo.
|
||||
|
||||
The unified KMS-based approach has several advantages:
|
||||
|
||||
- Key management is now centralized. There is one way to change or rotate encryption keys.
|
||||
There used to be two different mechanisms - one for regular S3 objects and one for IAM data.
|
||||
- Reduced server startup time. For IAM encryption with the root credentials, MinIO had
|
||||
- Reduced server startup time. For IAM encryption with the root credentials, Silo had
|
||||
to use a memory-hard function (Argon2) that (on purpose) consumes a lot of memory and CPU.
|
||||
The new KMS-based approach can use a key derivation function that is orders of magnitudes
|
||||
cheaper w.r.t. memory and CPU.
|
||||
@@ -70,20 +70,20 @@ The unified KMS-based approach has several advantages:
|
||||
and the old credentials had to be removed once the rotation completed. This process is now gone.
|
||||
The root credentials can now be changed easily.
|
||||
|
||||
> Does this mean I need an enterprise KMS setup to run MinIO (securely)?
|
||||
> Does this mean I need an enterprise KMS setup to run Silo (securely)?
|
||||
|
||||
No, MinIO does not depend on any third-party KMS provider. You have three options here:
|
||||
No, Silo does not depend on any third-party KMS provider. You have three options here:
|
||||
|
||||
- Run MinIO without a KMS. In this case all IAM data will be stored in plain-text.
|
||||
- Run MinIO with a single secret key. MinIO supports a static cryptographic key
|
||||
- Run Silo without a KMS. In this case all IAM data will be stored in plain-text.
|
||||
- Run Silo with a single secret key. Silo supports a static cryptographic key
|
||||
that can act as minimal KMS. With this method all IAM data will be stored
|
||||
encrypted. The encryption key has to be passed as environment variable.
|
||||
- Run MinIO with KES (minio/kes) in combination with any supported KMS as
|
||||
secure key store. For example, you can run MinIO + KES + Hashicorp Vault.
|
||||
- Run Silo with KES (minio/kes) in combination with any supported KMS as
|
||||
secure key store. For example, you can run Silo + KES + Hashicorp Vault.
|
||||
|
||||
> What about an exiting MinIO deployment? Can I just upgrade my cluster?
|
||||
> What about an exiting Silo deployment? Can I just upgrade my cluster?
|
||||
|
||||
Yes, MinIO will try to transparently migrate any existing IAM data and either stores
|
||||
Yes, Silo will try to transparently migrate any existing IAM data and either stores
|
||||
it in plaintext (no KMS) or re-encrypts using the KMS.
|
||||
|
||||
> Is this change backward compatible? Will it break my setup?
|
||||
@@ -93,7 +93,7 @@ Hashicorp Vault integration - which has been deprecated already - won't be
|
||||
supported anymore. KES is now mandatory if a third-party KMS should be used.
|
||||
|
||||
Further, since the configuration data is encrypted with the KMS, the KMS
|
||||
configuration itself can no longer be stored in the MinIO config file and
|
||||
configuration itself can no longer be stored in the Silo config file and
|
||||
instead must be provided via environment variables. If you have set your KMS
|
||||
configuration using e.g. the `mc admin config` commands you will need to adjust
|
||||
your deployment.
|
||||
@@ -101,9 +101,9 @@ your deployment.
|
||||
Even though this change is backward compatible we do not expect that it affects
|
||||
the vast majority of deployments in any negative way.
|
||||
|
||||
> Will an upgrade of an existing MinIO cluster impact the SLA of the cluster or will it even cause downtime?
|
||||
> Will an upgrade of an existing Silo cluster impact the SLA of the cluster or will it even cause downtime?
|
||||
|
||||
No, an upgrade should not cause any downtime. However, on the first startup -
|
||||
since MinIO will attempt to migrate any existing IAM data - the boot process may
|
||||
since Silo will attempt to migrate any existing IAM data - the boot process may
|
||||
take slightly longer, but may not be visibly noticeable. Once the migration has
|
||||
completed, any subsequent restart should be as fast as before or even faster.
|
||||
|
||||
Reference in New Issue
Block a user