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
2026-08-06 08:49:30 +08:00
parent 6613c2a3cb
commit fd2ca1c6d2
94 changed files with 1613 additions and 1347 deletions
+17 -17
View File
@@ -1,15 +1,15 @@
# Cluster Metrics
MinIO collects the following metrics at the cluster level.
Silo collects the following metrics at the cluster level.
Metrics may include one or more labels, such as the server that calculated that metric.
These metrics can be obtained from any MinIO server once per collection by using the following URL:
These metrics can be obtained from any Silo server once per collection by using the following URL:
```shell
https://HOSTNAME:PORT/minio/v2/metrics/cluster
```
Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
Replace ``HOSTNAME:PORT`` with the hostname of your Silo deployment.
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
## Audit Metrics
@@ -66,8 +66,8 @@ For deployments behind a load balancer, use the load balancer hostname instead o
| Name | Description |
|:--------------------------------------------------|:-----------------------------------------------|
| `minio_cluster_nodes_offline_total` | Total number of MinIO nodes offline. |
| `minio_cluster_nodes_online_total` | Total number of MinIO nodes online. |
| `minio_cluster_nodes_offline_total` | Total number of Silo nodes offline. |
| `minio_cluster_nodes_online_total` | Total number of Silo nodes online. |
| `minio_cluster_write_quorum` | Maximum write quorum across all pools and sets |
| `minio_cluster_health_status` | Get current cluster health status |
| `minio_cluster_health_erasure_set_healing_drives` | Count of healing drives in the erasure set |
@@ -188,8 +188,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
| Name | Description |
|:------------------------------|:---------------------------------------|
| `minio_software_commit_info` | Git commit hash for the MinIO release. |
| `minio_software_version_info` | MinIO Release tag for the server. |
| `minio_software_commit_info` | Git commit hash for the Silo release. |
| `minio_software_version_info` | Silo Release tag for the server. |
## Drive Metrics
@@ -246,8 +246,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
| Name | Description |
|:-------------------------------------------|:----------------------------------------------------------------------------------------------------------------|
| `minio_node_file_descriptor_limit_total` | Limit on total number of open file descriptors for the MinIO Server process. |
| `minio_node_file_descriptor_open_total` | Total number of open file descriptors by the MinIO Server process. |
| `minio_node_file_descriptor_limit_total` | Limit on total number of open file descriptors for the Silo Server process. |
| `minio_node_file_descriptor_open_total` | Total number of open file descriptors by the Silo Server process. |
| `minio_node_go_routine_total` | Total number of go routines running. |
| `minio_node_io_rchar_bytes` | Total bytes read by the process from the underlying storage system including cache, /proc/[pid]/io rchar. |
| `minio_node_io_read_bytes` | Total bytes read by the process from the underlying storage system, /proc/[pid]/io read_bytes. |
@@ -256,8 +256,8 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
| `minio_node_process_cpu_total_seconds` | Total user and system CPU time spent in seconds by the process. |
| `minio_node_process_resident_memory_bytes` | Resident memory size in bytes. |
| `minio_node_process_virtual_memory_bytes` | Virtual memory size in bytes. |
| `minio_node_process_starttime_seconds` | Start time for MinIO process per node, time in seconds since Unix epoc. |
| `minio_node_process_uptime_seconds` | Uptime for MinIO process per node in seconds. |
| `minio_node_process_starttime_seconds` | Start time for Silo process per node, time in seconds since Unix epoc. |
| `minio_node_process_uptime_seconds` | Uptime for Silo process per node in seconds. |
## Scanner Metrics
@@ -274,17 +274,17 @@ For deployments with [bucket](https://silo.pgsty.com/administration/bucket-repli
# Bucket Metrics
MinIO collects the following metrics at the bucket level.
Silo collects the following metrics at the bucket level.
Each metric includes the ``bucket`` label to identify the corresponding bucket.
Metrics may include one or more additional labels, such as the server that calculated that metric.
These metrics can be obtained from any MinIO server once per collection by using the following URL:
These metrics can be obtained from any Silo server once per collection by using the following URL:
```shell
https://HOSTNAME:PORT/minio/v2/metrics/bucket
```
Replace ``HOSTNAME:PORT`` with the hostname of your MinIO deployment.
Replace ``HOSTNAME:PORT`` with the hostname of your Silo deployment.
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
## Distribution Metrics
@@ -354,17 +354,17 @@ For deployments with [Site Replication](https://silo.pgsty.com/operations/replic
# Resource Metrics
MinIO collects the following resource metrics at the node level.
Silo collects the following resource metrics at the node level.
Each metric includes the `server` label to identify the corresponding node.
Metrics may include one or more additional labels, such as the drive path, interface name, etc.
These metrics can be obtained from any MinIO server once per collection by using the following URL:
These metrics can be obtained from any Silo server once per collection by using the following URL:
```shell
https://HOSTNAME:PORT/minio/v2/metrics/resource
```
Replace `HOSTNAME:PORT` with the hostname of your MinIO deployment.
Replace `HOSTNAME:PORT` with the hostname of your Silo deployment.
For deployments behind a load balancer, use the load balancer hostname instead of a single node hostname.
## Drive Resource Metrics