mirror of
https://github.com/pgsty/minio.git
synced 2026-08-10 00:03:29 +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
+14
-13
@@ -1,4 +1,4 @@
|
||||
# MinIO Server Debugging Guide [](https://slack.min.io) [](https://hub.docker.com/r/minio/minio/)
|
||||
# Silo Server Debugging Guide [](https://hub.docker.com/r/pgsty/silo/)
|
||||
|
||||
## HTTP Trace
|
||||
|
||||
@@ -7,41 +7,41 @@ HTTP tracing can be enabled by using [`mc admin trace`](https://silo.pgsty.com/r
|
||||
Example:
|
||||
|
||||
```sh
|
||||
minio server /data
|
||||
silo server /data
|
||||
```
|
||||
|
||||
Default trace is succinct only to indicate the API operations being called and the HTTP response status.
|
||||
|
||||
```sh
|
||||
mc admin trace myminio
|
||||
mc admin trace mysilo
|
||||
```
|
||||
|
||||
To trace entire HTTP request
|
||||
|
||||
```sh
|
||||
mc admin trace --verbose myminio
|
||||
mc admin trace --verbose mysilo
|
||||
```
|
||||
|
||||
To trace entire HTTP request and also internode communication
|
||||
|
||||
```sh
|
||||
mc admin trace --all --verbose myminio
|
||||
mc admin trace --all --verbose mysilo
|
||||
```
|
||||
|
||||
## Subnet Health
|
||||
|
||||
Subnet Health diagnostics help ensure that the underlying infrastructure that runs MinIO is configured correctly, and is functioning properly. This test is one-shot long running one, that is recommended to be run as soon as the cluster is first provisioned, and each time a failure scenario is encountered. Note that the test incurs majority of the available resources on the system. Care must be taken when using this to debug failure scenario, so as to prevent larger outages. Health tests can be triggered using `mc support diagnostics` command.
|
||||
Subnet Health diagnostics help ensure that the underlying infrastructure that runs Silo is configured correctly, and is functioning properly. This test is one-shot long running one, that is recommended to be run as soon as the cluster is first provisioned, and each time a failure scenario is encountered. Note that the test incurs majority of the available resources on the system. Care must be taken when using this to debug failure scenario, so as to prevent larger outages. Health tests can be triggered using `mc support diagnostics` command.
|
||||
|
||||
Example:
|
||||
|
||||
```sh
|
||||
minio server /data{1...4}
|
||||
silo server /data{1...4}
|
||||
```
|
||||
|
||||
The command takes no flags
|
||||
|
||||
```sh
|
||||
mc support diagnostics myminio/
|
||||
mc support diagnostics mysilo/
|
||||
```
|
||||
|
||||
The output printed will be of the form
|
||||
@@ -72,10 +72,11 @@ Metadata is stored in `xl.meta` files for erasure coded objects. Each disk in th
|
||||
|
||||
### Installing xl-meta
|
||||
|
||||
To install, [Go](https://golang.org/dl/) must be installed. Once installed, execute this to install the binary:
|
||||
With Go installed, build the diagnostic tool from the same Silo source revision
|
||||
as the server:
|
||||
|
||||
```bash
|
||||
go install github.com/minio/minio/docs/debugging/xl-meta@latest
|
||||
go build -o "$(go env GOPATH)/bin/xl-meta" ./docs/debugging/xl-meta
|
||||
```
|
||||
|
||||
### Using xl-meta
|
||||
@@ -84,7 +85,7 @@ Executing `xl-meta` will look for an `xl.meta` in the current folder and decode
|
||||
|
||||
### Remotely Inspecting backend data
|
||||
|
||||
`mc support inspect` allows collecting files based on *path* from all backend drives. Matching files will be collected in a zip file with their respective host+drive+path. A MinIO host from October 2021 or later is required for full functionality. Syntax is `mc support inspect ALIAS/path/to/files`. This can for example be used to collect `xl.meta` from objects that are misbehaving. To collect `xl.meta` from a specific object, for example placed at `ALIAS/bucket/path/to/file.txt` append `/xl.meta`, for instance `mc support inspect ALIAS/bucket/path/to/file.txt/xl.meta`. All files can be collected, so this can also be used to retrieve `part.*` files, etc.
|
||||
`mc support inspect` allows collecting files based on *path* from all backend drives. Matching files will be collected in a zip file with their respective host+drive+path. A Silo host from October 2021 or later is required for full functionality. Syntax is `mc support inspect ALIAS/path/to/files`. This can for example be used to collect `xl.meta` from objects that are misbehaving. To collect `xl.meta` from a specific object, for example placed at `ALIAS/bucket/path/to/file.txt` append `/xl.meta`, for instance `mc support inspect ALIAS/bucket/path/to/file.txt/xl.meta`. All files can be collected, so this can also be used to retrieve `part.*` files, etc.
|
||||
|
||||
Wildcards can be used, for example `mc support inspect ALIAS/bucket/path/**/xl.meta` will collect all `xl.meta` recursively. `mc support inspect ALIAS/bucket/path/to/file.txt/*/part.*` will collect parts for all versions for the object located at `bucket/path/to/file.txt`.
|
||||
|
||||
@@ -120,10 +121,10 @@ This file can be decrypted using the decryption tool below:
|
||||
|
||||
To install, [Go](https://golang.org/dl/) must be installed.
|
||||
|
||||
Once installed, execute this to install the binary:
|
||||
Build the decryption tool from the same Silo source revision:
|
||||
|
||||
```bash
|
||||
go install github.com/minio/minio/docs/debugging/inspect@latest
|
||||
go build -o "$(go env GOPATH)/bin/inspect" ./docs/debugging/inspect
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
Reference in New Issue
Block a user