Skip to content

Commit 02a1ff8

Browse files
committed
Use absolute doc urls
1 parent 375ba91 commit 02a1ff8

20 files changed

Lines changed: 41 additions & 41 deletions

File tree

‎docs/backend/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Obstor Backend
2-
Obstor Backend adds S3 and [other supported protocol](../protocols/README.md) compatibility to third-party cloud storage providers.
2+
Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to third-party cloud storage providers.
33

44
## Supported Backends
55
- [NAS](nas.md)
@@ -10,6 +10,6 @@ Obstor Backend adds S3 and [other supported protocol](../protocols/README.md) co
1010
- [SFTP](sftp.md)
1111

1212
## Explore Further
13-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
13+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
1414
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
1515
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)

‎docs/backend/azure.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Obstor Azure Backend
2-
Obstor Backend adds S3 and [other supported protocol](../protocols/README.md) compatibility to Microsoft Azure Blob Storage.
2+
Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to Microsoft Azure Blob Storage.
33

44
## Run Obstor Backend for Microsoft Azure Blob Storage
55
### Using Docker
@@ -53,7 +53,7 @@ Other limitations:
5353
- Bucket notification APIs are not supported.
5454

5555
## Explore Further
56-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
56+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
5757
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
5858
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
5959
- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)

‎docs/backend/gcs.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Obstor GCS Backend
22

3-
Obstor GCS Backend allows you to access Google Cloud Storage (GCS) with S3-compatible APIs and [other supported protocols](../protocols/README.md)
3+
Obstor GCS Backend allows you to access Google Cloud Storage (GCS) with S3-compatible APIs and [other supported protocols](https://obstor.net/docs/protocols)
44

55
- [Run Obstor Backend for GCS](#run-obstor-backend-for-gcs)
66
- [Test Using Browser Dashboard](#test-using-obstor-browser)
@@ -83,7 +83,7 @@ Other limitations:
8383
* Bucket notification APIs are not supported.
8484

8585
## <a name="explore-further"></a>4. Explore Further
86-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
86+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
8787
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
8888
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
8989
- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)

‎docs/backend/hdfs.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Obstor HDFS Backend
2-
Obstor HDFS backend adds S3 API and [other supported protocol](../protocols/README.md) support to Hadoop HDFS filesystem. Applications can use both the S3 and file APIs concurrently without requiring any data migration. Since the backend is stateless and shared-nothing, you may elastically provision as many Obstor instances as needed to distribute the load.
2+
Obstor HDFS backend adds S3 API and [other supported protocol](https://obstor.net/docs/protocols) support to Hadoop HDFS filesystem. Applications can use both the S3 and file APIs concurrently without requiring any data migration. Since the backend is stateless and shared-nothing, you may elastically provision as many Obstor instances as needed to distribute the load.
33

44
> NOTE: Intention of this backend implementation it to make it easy to migrate your existing data on HDFS clusters to Obstor clusters using standard tools like `mc` or `aws-cli`, if the goal is to use HDFS perpetually we recommend that HDFS should be used directly for all write operations.
55
@@ -101,7 +101,7 @@ Backend inherits the following limitations of HDFS storage layer:
101101
- Concurrent multipart operations are not supported (HDFS lacks safe locking support, or poorly implemented)
102102

103103
## Explore Further
104-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
104+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
105105
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
106106
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
107107
- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)

‎docs/backend/nas.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Obstor NAS Backend
22

3-
Obstor Backend adds S3 and [other supported protocol](../protocols/README.md) compatibility to NAS storage. You may run multiple obstor instances on the same shared NAS volume as a distributed object backend.
3+
Obstor Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to NAS storage. You may run multiple obstor instances on the same shared NAS volume as a distributed object backend.
44

55
## Run Obstor Backend for NAS Storage
66

@@ -93,7 +93,7 @@ NAS backend implementation allows symlinks on regular files,
9393
*Directory symlinks is not and will not be supported as there are no safe ways to handle them.*
9494

9595
## Explore Further
96-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
96+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
9797
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
9898
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
9999
- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)

‎docs/backend/s3.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ With Obstor S3 backend, you can use Obstor browser to explore AWS S3 based objec
128128

129129
## Explore Further
130130

131-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
131+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
132132
- [`mc` command-line interface](https://obstor.net/docs/obstor-client-quickstart-guide)
133133
- [`aws` command-line interface](https://obstor.net/docs/aws-cli-with-obstor)
134134
- [`minio-go` Go SDK](https://obstor.net/docs/golang-client-quickstart-guide)

‎docs/backend/sftp.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Obstor SFTP Backend
22

3-
Obstor SFTP Backend adds S3 and [other supported protocol](../protocols/README.md) compatibility to any existing SFTP server. Use your SFTP server as the storage backend while accessing data through the S3 API and other supported protocols.
3+
Obstor SFTP Backend adds S3 and [other supported protocol](https://obstor.net/docs/protocols) compatibility to any existing SFTP server. Use your SFTP server as the storage backend while accessing data through the S3 API and other supported protocols.
44

5-
> Looking for the built-in SFTP server? See [SFTP Protocol](../protocols/sftp.md).
5+
> Looking for the built-in SFTP server? See [SFTP Protocol](https://obstor.net/docs/protocols/sftp).
66
77
## Run Obstor Backend for SFTP Storage
88

@@ -100,8 +100,8 @@ mc cp myfile.txt mysftp/newbucket/myfile.txt
100100

101101
## Explore Further
102102

103-
- [Supported Protocols](../protocols/README.md) - S3, SFTP, and more
104-
- [Obstor Distributed Mode](../distributed/README.md)
105-
- [TLS Configuration](../tls/README.md)
106-
- [IAM & Policies](../multi-user/README.md)
107-
- [SFTP Protocol](../protocols/sftp.md) - built-in SFTP server for accessing Obstor via SFTP
103+
- [Supported Protocols](https://obstor.net/docs/protocols) - S3, SFTP, and more
104+
- [Obstor Distributed Mode](https://obstor.net/docs/distributed)
105+
- [TLS Configuration](https://obstor.net/docs/tls)
106+
- [IAM & Policies](https://obstor.net/docs/multi-user)
107+
- [SFTP Protocol](https://obstor.net/docs/protocols/sftp) - built-in SFTP server for accessing Obstor via SFTP

‎docs/config/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ obstor server /data
8686
```
8787

8888
### Storage Class
89-
By default, parity for objects with standard storage class is set to `N/2`, and parity for objects with reduced redundancy storage class objects is set to `2`. Read more about storage class support in Obstor server [here](../erasure/storage-class/README.md).
89+
By default, parity for objects with standard storage class is set to `N/2`, and parity for objects with reduced redundancy storage class objects is set to `2`. Read more about storage class support in Obstor server [here](https://obstor.net/docs/erasure/storage-class).
9090

9191
```
9292
KEY:
@@ -172,7 +172,7 @@ OBSTOR_ETCD_COMMENT (sentence) optionally add a comment to this settin
172172
```
173173

174174
### API
175-
By default, there is no limitation on the number of concurrent requests that a server/cluster processes at the same time. However, it is possible to impose such limitation using the API subsystem. Read more about throttling limitation in Obstor server [here](../throttle/README.md).
175+
By default, there is no limitation on the number of concurrent requests that a server/cluster processes at the same time. However, it is possible to impose such limitation using the API subsystem. Read more about throttling limitation in Obstor server [here](https://obstor.net/docs/throttle).
176176

177177
```
178178
KEY:

‎docs/deployment/cluster/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The default replication factor is **3** - every block is stored on 3 independent
1616

1717
This model provides strong consistency (read-after-write, list-after-write) while tolerating individual drive and node failures.
1818

19-
> **NOTE:** Block-level replication differs from erasure coding. Replication stores full copies of each block, trading storage efficiency for simplicity and faster recovery. For erasure-coded deployments, see [Erasure Code Guide](../../erasure/README.md).
19+
> **NOTE:** Block-level replication differs from erasure coding. Replication stores full copies of each block, trading storage efficiency for simplicity and faster recovery. For erasure-coded deployments, see [Erasure Code Guide](https://obstor.net/docs/erasure).
2020
2121
## Node Quotas
2222

‎docs/distributed/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Obstor in distributed mode can help you setup a highly-available storage system
88

99
### Data protection
1010

11-
Distributed Obstor provides protection against multiple node/drive failures and [bit rot](../erasure/README.md#what-is-bit-rot-protection) using [erasure code](https://obstor.net/docs/obstor-erasure-code-quickstart-guide). As the minimum disks required for distributed Obstor is 4 (same as minimum disks required for erasure coding), erasure code automatically kicks in as you launch distributed Obstor.
11+
Distributed Obstor provides protection against multiple node/drive failures and [bit rot](https://obstor.net/docs/erasure#what-is-bit-rot-protection) using [erasure code](https://obstor.net/docs/obstor-erasure-code-quickstart-guide). As the minimum disks required for distributed Obstor is 4 (same as minimum disks required for erasure coding), erasure code automatically kicks in as you launch distributed Obstor.
1212

1313
### High availability
1414

1515
A stand-alone Obstor server would go down if the server hosting the disks goes offline. In contrast, a distributed Obstor setup with _m_ servers and _n_ disks will have your data safe as long as _m/2_ servers or _m*n_/2 or more disks are online.
1616

1717
For example, an 16-server distributed setup with 200 disks per node would continue serving files, up to 4 servers can be offline in default configuration i.e around 800 disks down Obstor would continue to read and write objects.
1818

19-
Refer to sizing guide for more understanding on default values chosen depending on your erasure stripe size [here](SIZING.md). Parity settings can be changed using [storage classes](../erasure/storage-class).
19+
Refer to sizing guide for more understanding on default values chosen depending on your erasure stripe size [here](https://obstor.net/docs/distributed/sizing). Parity settings can be changed using [storage classes](https://obstor.net/docs/erasure/storage-class).
2020

2121
### Consistency Guarantees
2222

0 commit comments

Comments
 (0)