Skip to content

Commit d95e3e8

Browse files
committed
docs: polish english markdown copy
1 parent e870f0c commit d95e3e8

20 files changed

Lines changed: 107 additions & 107 deletions

File tree

docs/concepts/glossary.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,12 @@ description: "This article introduces commonly used vocabulary in object storage
9898
| 89 | Multi-Cloud Storage | Storage solutions across different cloud service providers |
9999
| 90 | Storage Federation | Abstraction layer for unified management of multiple storage systems |
100100
| 91 | Object Tag | Adding custom classification tags to objects |
101-
| 92 | Bucket Tag | 存储桶标签 | Adding management/billing related tags to buckets |
102-
| 93 | Storage Quota | 存储配额 | Limiting maximum capacity of buckets |
103-
| 94 | Request Throttling | 请求限速 | Limiting API requests per unit time |
104-
| 95 | SLA | 服务等级协议 | Service Level Agreement commitments for availability/durability (e.g., 99.9% availability) |
105-
| 96 | Disaster Recovery | 灾难恢复 | Ensuring business continuity through cross-region backups |
106-
| 97 | Storage Topology | 存储拓扑 | Distribution structure of data at physical/logical levels |
107-
| 98 | Proximity Access | 就近访问 | Routing user requests to nearest storage nodes |
108-
| 99 | Global Namespace | 全球统一命名空间 | Unified view management of cross-region buckets |
109-
| 100 | Zero-Copy Migration | 零拷贝迁移 | Fast data migration through metadata operations |
101+
| 92 | Bucket Tag | Adding management/billing related tags to buckets |
102+
| 93 | Storage Quota | Limiting maximum capacity of buckets |
103+
| 94 | Request Throttling | Limiting API requests per unit time |
104+
| 95 | SLA | Service Level Agreement commitments for availability/durability (e.g., 99.9% availability) |
105+
| 96 | Disaster Recovery | Ensuring business continuity through cross-region backups |
106+
| 97 | Storage Topology | Distribution structure of data at physical/logical levels |
107+
| 98 | Proximity Access | Routing user requests to nearest storage nodes |
108+
| 99 | Global Namespace | Unified view management of cross-region buckets |
109+
| 100 | Zero-Copy Migration | Fast data migration through metadata operations |

docs/concepts/limit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ description: "RustFS is a simple, efficient, distributed object storage. It is f
4848

4949
Object names in RustFS are primarily limited by the underlying operating system and file system. For example, Windows and some other operating systems restrict the use of certain special characters such as `^`, `*`, `|`, `\`, `/`, `&`, `"`, or `;`.
5050

51-
Please refer to relevant documentation for a complete list of restrictions based on your specific operating system and file system.
51+
Refer to relevant documentation for a complete list of restrictions based on your specific operating system and file system.
5252

5353
RustFS recommends using Linux operating systems based on XFS file systems in production environments for better performance and compatibility.
5454

docs/features/aliyun/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: "RustFS provides high-performance object storage for Alibaba Cloud
88
## Three Reasons Customers Run RustFS on Alibaba Cloud
99

1010
- RustFS serves as a consistent storage layer in hybrid cloud or multi-cloud deployment scenarios
11-
- RustFS is a Kubernetes-native high-performance product that can provide predictable performance in public cloud, private cloud, and edge cloud environments.
11+
- RustFS is a Kubernetes-native high-performance product that delivers predictable performance across public cloud, private cloud, and edge environments.
1212
- Running RustFS on ACK provides control over the software stack with the flexibility needed to avoid cloud lock-in.
1313

1414
Alibaba Cloud ACK is a managed service for running Kubernetes on Alibaba Cloud without needing to install, operate, and maintain your own Kubernetes control plane or nodes.
@@ -37,19 +37,19 @@ A key requirement for deploying RustFS at scale on Alibaba Cloud ACK is capabili
3737

3838
RustFS supports automatic transition of aging objects from fast NVMe tiers to more cost-effective HDD tiers, and even to cost-optimized cold public cloud storage tiers.
3939

40-
When tiering, RustFS provides a unified namespace across tiers. Movement across tiers is transparent to applications and triggered by customer-determined policies.
40+
When tiering, RustFS provides a unified namespace across tiers. Movement across tiers is transparent to applications and triggered by customer-defined policies.
4141

4242
RustFS provides secure storage in Alibaba Cloud ACK hybrid clouds by encrypting objects at the source, ensuring customers always have complete control over data. When Alibaba Cloud ACK is deployed in public clouds, tiering capabilities help Alibaba Cloud ACK effectively manage data across persistent block storage and cheaper object storage tiers.
4343

4444
**Learn More:**
4545

4646
## External Load Balancing
4747

48-
All RustFS communication is based on HTTP, RESTful APIs, and will support any standard Kubernetes-compatible ingress controller. This includes hardware and software-defined solutions. The most popular choice is NGINX. Install using OperatorHub or OpenShift Marketplace, then expose RustFS tenants using annotations.
48+
All RustFS communication is based on HTTP, RESTful APIs, and supports any standard Kubernetes-compatible ingress controller. This includes hardware and software-defined solutions. The most popular choice is NGINX. Install using OperatorHub or OpenShift Marketplace, then expose RustFS tenants using annotations.
4949

5050
## Encryption Key Management
5151

52-
There are no native Alibaba Cloud ACK key management capabilities. Therefore, RustFS recommends using HashiCorp Vault to store keys outside the object storage system. This is a best practice for cloud-native applications.
52+
Alibaba Cloud ACK does not provide native key management capabilities. RustFS recommends using HashiCorp Vault to store keys outside the object storage system. This is a best practice for cloud-native applications.
5353

5454
For all production environments, we recommend enabling encryption on all buckets by default. RustFS uses AES-256-GCM or ChaCha20-Poly1305 encryption to protect data integrity and confidentiality with negligible performance impact.
5555

@@ -59,7 +59,7 @@ RustFS will use this KMS to bootstrap its internal key encryption server (KES se
5959

6060
## Identity Management
6161

62-
When running RustFS on Alibaba Cloud ACK, customers can manage single sign-on (SSO) through third-party OpenID Connect/LDAP compatible identity providers (such as Keycloak, Okta/Auth0, Google, Facebook, ActiveDirectory, and OpenLDAP). RustFS recommends OpenID Connect compatible Keycloak IDP.
62+
When running RustFS on Alibaba Cloud ACK, customers can manage single sign-on (SSO) through third-party OpenID Connect/LDAP compatible identity providers (such as Keycloak, Okta/Auth0, Google, Facebook, ActiveDirectory, and OpenLDAP). RustFS recommends OpenID Connect-compatible Keycloak IDP.
6363

6464
External IDPs allow administrators to centrally manage user/application identities. RustFS builds on top of IDPs to provide AWS IAM-style user, group, role, policy, and token service APIs. The ability to have a unified identity and access management (IAM) layer independent of infrastructure provides significant architectural flexibility.
6565

@@ -71,12 +71,12 @@ RustFS integrates with OpenShift certificate manager, so you can use the RustFS
7171

7272
## Monitoring and Alerting
7373

74-
RustFS recommends using Grafana, platform monitoring components installed in the OpenShift-user-workload-monitoring project, or any other OpenShift container monitoring tools to connect to RustFS. RustFS publishes all imaginable storage-related Prometheus metrics, from bucket capacity to access metrics. These metrics can be collected and visualized in any Prometheus-compatible tool or RustFS console.
74+
RustFS recommends using Grafana, platform monitoring components installed in the OpenShift-user-workload-monitoring project, or any other OpenShift container monitoring tools to connect to RustFS. RustFS publishes a comprehensive set of storage-related Prometheus metrics, from bucket capacity to access metrics. These metrics can be collected and visualized in any Prometheus-compatible tool or RustFS console.
7575

7676
External monitoring solutions periodically scrape RustFS Prometheus endpoints. RustFS recommends using Grafana or platform monitoring components installed in the openshift-user-workload-monitoring project to connect to RustFS. These same tools can also be used to establish baselines and set notification alert thresholds, which can then be routed to notification platforms like PagerDuty, Freshservice, or even SNMP.
7777

7878
## Logging and Auditing
7979

80-
Enabling RustFS auditing generates logs for every operation on the object storage cluster. In addition to audit logs, RustFS also logs console errors for operational troubleshooting.
80+
Enabling RustFS auditing generates logs for every operation on the object storage cluster. In addition to audit logs, RustFS also logs console errors for troubleshooting.
8181

82-
RustFS supports outputting logs to Elastic Stack (or third-party) for analysis and alerting.
82+
RustFS supports sending logs to Elastic Stack (or third-party) for analysis and alerting.

docs/features/aws-elastic/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ description: "RustFS provides high-performance object storage for Amazon EKS wit
88
## Three Reasons Customers Run RustFS on Amazon EKS
99

1010
- RustFS serves as a consistent storage layer in hybrid cloud or multi-cloud deployment scenarios.
11-
- RustFS is a Kubernetes-native high-performance product that can provide predictable performance in public cloud, private cloud, and edge cloud environments.
11+
- RustFS is a Kubernetes-native high-performance product that delivers predictable performance across public cloud, private cloud, and edge environments.
1212
- Running RustFS on EKS provides control over the software stack with the flexibility needed to avoid cloud lock-in.
1313

1414
Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to install, operate, and maintain your own Kubernetes control plane or nodes.
1515

16-
RustFS natively integrates with Amazon EKS, making it easier to operate your own large-scale multi-tenant object storage as a service. RustFS Operator works with the Amazon EKS toolchain to ensure you get maximum return on investment from the AWS ecosystem.
16+
RustFS natively integrates with Amazon EKS, making it easier to operate your own large-scale multi-tenant object storage as a service. RustFS Operator works with the Amazon EKS toolchain to help you maximize the value of the AWS ecosystem.
1717

1818
![RustFS Architecture Diagram](images/sec1-1.png)
1919

20-
RustFS provides consistent, high-performance, and scalable object storage because it is Kubernetes-native by design and S3-compatible from the start. Developers can easily obtain Amazon S3-compatible persistent storage services for all cloud-native applications running on Amazon EKS. Unlike AWS S3, RustFS enables applications to scale across any multi-cloud and hybrid cloud infrastructure while still being manageable within the Amazon EKS ecosystem without public cloud lock-in.
20+
RustFS provides consistent, high-performance, and scalable object storage because it is Kubernetes-native by design and S3-compatible from the start. Developers can easily provision Amazon S3-compatible persistent storage for all cloud-native applications running on Amazon EKS. Unlike AWS S3, RustFS enables applications to scale across any multi-cloud and hybrid cloud infrastructure while still being manageable within the Amazon EKS ecosystem without public cloud lock-in.
2121

2222
## RustFS Operator Natively Integrates with Amazon EKS Features
2323

@@ -37,19 +37,19 @@ A key requirement for deploying RustFS at scale on Amazon EKS is capability tier
3737

3838
RustFS supports automatic transition of aging objects from fast NVMe tiers to more cost-effective HDD tiers, and even to cost-optimized cold public cloud storage tiers (like AWS S3 Glacier).
3939

40-
When tiering, RustFS provides a unified namespace across tiers. Movement across tiers is transparent to applications and triggered by customer-determined policies.
40+
When tiering, RustFS provides a unified namespace across tiers. Movement across tiers is transparent to applications and triggered by customer-defined policies.
4141

4242
RustFS provides secure storage in Amazon EKS hybrid clouds by encrypting objects at the source, ensuring customers always have complete control over data. When Amazon EKS is deployed in public clouds, tiering capabilities help Amazon EKS effectively manage data across persistent block storage (EBS) and cheaper object storage tiers.
4343

4444
**Learn More:**
4545

4646
## External Load Balancing
4747

48-
All RustFS communication is based on HTTP, RESTful APIs, and will support any standard Kubernetes-compatible ingress controller. This includes hardware and software-defined solutions. The most popular choice is NGINX or AWS Load Balancer Controller. Install using Helm charts, then expose RustFS tenants using annotations.
48+
All RustFS communication is based on HTTP, RESTful APIs, and supports any standard Kubernetes-compatible ingress controller. This includes hardware and software-defined solutions. The most popular choice is NGINX or AWS Load Balancer Controller. Install using Helm charts, then expose RustFS tenants using annotations.
4949

5050
## Encryption Key Management
5151

52-
There are no native OpenShift key management capabilities. Therefore, RustFS recommends using HashiCorp Vault to store keys outside the object storage system. This is a best practice for cloud-native applications.
52+
OpenShift does not provide native key management capabilities. RustFS recommends using HashiCorp Vault to store keys outside the object storage system. This is a best practice for cloud-native applications.
5353

5454
For all production environments, we recommend enabling encryption on all buckets by default. RustFS uses AES-256-GCM or ChaCha20-Poly1305 encryption to protect data integrity and confidentiality with negligible performance impact.
5555

@@ -59,7 +59,7 @@ RustFS will use this KMS to bootstrap its internal key encryption server (KES se
5959

6060
## Identity Management
6161

62-
When running RustFS on OpenShift, customers can manage single sign-on (SSO) through third-party OpenID Connect/LDAP compatible identity providers (such as Keycloak, Okta/Auth0, Google, Facebook, ActiveDirectory, and OpenLDAP). RustFS recommends OpenID Connect compatible Keycloak IDP.
62+
When running RustFS on OpenShift, customers can manage single sign-on (SSO) through third-party OpenID Connect/LDAP compatible identity providers (such as Keycloak, Okta/Auth0, Google, Facebook, ActiveDirectory, and OpenLDAP). RustFS recommends OpenID Connect-compatible Keycloak IDP.
6363

6464
External IDPs allow administrators to centrally manage user/application identities. RustFS builds on top of IDPs to provide AWS IAM-style user, group, role, policy, and token service APIs. The ability to have a unified identity and access management (IAM) layer independent of infrastructure provides significant architectural flexibility.
6565

@@ -71,12 +71,12 @@ RustFS integrates with OpenShift certificate manager, so you can use the RustFS
7171

7272
## Monitoring and Alerting
7373

74-
RustFS recommends using Grafana, platform monitoring components installed in the OpenShift-user-workload-monitoring project, or any other OpenShift container monitoring tools to connect to RustFS. RustFS publishes all imaginable storage-related Prometheus metrics, from bucket capacity to access metrics. These metrics can be collected and visualized in any Prometheus-compatible tool or RustFS console.
74+
RustFS recommends using Grafana, platform monitoring components installed in the OpenShift-user-workload-monitoring project, or any other OpenShift container monitoring tools to connect to RustFS. RustFS publishes a comprehensive set of storage-related Prometheus metrics, from bucket capacity to access metrics. These metrics can be collected and visualized in any Prometheus-compatible tool or RustFS console.
7575

7676
External monitoring solutions periodically scrape RustFS Prometheus endpoints. RustFS recommends using Grafana or platform monitoring components installed in the openshift-user-workload-monitoring project to connect to RustFS. These same tools can also be used to establish baselines and set notification alert thresholds, which can then be routed to notification platforms like PagerDuty, Freshservice, or even SNMP.
7777

7878
## Logging and Auditing
7979

80-
Enabling RustFS auditing generates logs for every operation on the object storage cluster. In addition to audit logs, RustFS also logs console errors for operational troubleshooting.
80+
Enabling RustFS auditing generates logs for every operation on the object storage cluster. In addition to audit logs, RustFS also logs console errors for troubleshooting.
8181

82-
RustFS supports outputting logs to Elastic Stack (or third-party) for analysis and alerting.
82+
RustFS supports sending logs to Elastic Stack (or third-party) for analysis and alerting.

docs/features/baremetal/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ The challenge with traditional replication methods is that they don't scale effe
5151

5252
RustFS's continuous replication is designed for large-scale, cross-data center deployments. By leveraging Lambda compute notifications and object metadata, it can efficiently and quickly calculate increments. Lambda notifications ensure immediate propagation of changes rather than traditional batch modes.
5353

54-
Continuous replication means that in case of failure, data loss will be kept to a minimum - even in the face of highly dynamic datasets. Finally, like everything RustFS does, continuous replication is multi-vendor, meaning your backup location can be anywhere from NAS to public cloud.
54+
Continuous replication means that in case of failure, data loss remains minimal - even in the face of highly dynamic datasets. Finally, like other RustFS features, continuous replication is multi-vendor, meaning your backup location can be anywhere from NAS to public cloud.
5555

5656
#### Global Federation
5757

docs/features/cloud-native/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ RustFS's relentless focus on simplicity means large-scale, multi-petabyte data i
5151

5252
### Software-Defined
5353

54-
The only way to succeed in multi-cloud is with software-defined storage. The reason is simple. Hardware appliances don't run on public clouds or Kubernetes. Public cloud storage service offerings aren't designed to run on other public clouds, private clouds, or Kubernetes platforms. Even if they did, bandwidth costs would exceed storage costs because they weren't developed for cross-network replication. Admittedly, software-defined storage can run on public clouds, private clouds, and edge.
54+
The only way to succeed in multi-cloud is with software-defined storage. The reason is straightforward. Hardware appliances don't run on public clouds or Kubernetes. Public cloud storage service offerings aren't designed to run on other public clouds, private clouds, or Kubernetes platforms. Even if they did, bandwidth costs would exceed storage costs because they weren't developed for cross-network replication. Admittedly, software-defined storage can run on public clouds, private clouds, and edge.
5555

5656
RustFS was born in software and is portable across various operating systems and hardware architectures. Evidence can be found in our 2M+ IPs running across AWS, GCP, and Azure.

docs/features/data-lake/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ RustFS protects data using inline erasure coding for each object, which is far m
6060

6161
## Software Defined
6262

63-
The successor to Hadoop HDFS is not a hardware appliance but software running on commodity hardware. This is the essence of RustFS - software. Like Hadoop HDFS, RustFS is designed to take full advantage of commodity servers. Able to leverage NVMe drives and 100 GbE networks, RustFS can shrink data centers, thereby improving operational efficiency and manageability. In fact, companies building alternative data lakes reduce their hardware footprint by 60% or more while improving performance and reducing the FTEs required to manage it.
63+
The successor to Hadoop HDFS is not a hardware appliance but software running on commodity hardware. This is the essence of RustFS - software. Like Hadoop HDFS, RustFS is designed to take full advantage of commodity servers. By leveraging NVMe drives and 100 GbE networks, RustFS can shrink data centers, thereby improving operational efficiency and manageability. In fact, companies building alternative data lakes reduce their hardware footprint by 60% or more while improving performance and reducing the FTEs required to manage it.
6464

6565
## Security
6666

0 commit comments

Comments
 (0)