Skip to content

Commit

Permalink
delete subheadings when there's only 1
Browse files Browse the repository at this point in the history
  • Loading branch information
ccmao1130 committed Jul 21, 2023
1 parent 9c3d18d commit ac5adee
Show file tree
Hide file tree
Showing 14 changed files with 20 additions and 33 deletions.
2 changes: 0 additions & 2 deletions docs/en/ufs/Azure-Blob-Store.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ called `<AZURE_DIRECTORY>`. For more information about Azure storage account, pl

## Basic Setup

### Root Mount

To use Azure blob store as the UFS of Alluxio root mount point,
you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
Expand Down
6 changes: 0 additions & 6 deletions docs/en/ufs/Azure-Data-Lake-Gen2.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ the directory in that storage account is called `<AZURE_DIRECTORY>`, and the nam

## Setup with Shared Key

### Root Mount

To use Azure Data Lake Storage as the UFS of Alluxio root mount point,
you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
Expand All @@ -45,8 +43,6 @@ fs.azure.account.key.<AZURE_ACCOUNT>.dfs.core.windows.net=<SHARED_KEY>

## Setup with OAuth 2.0 Client Credentials

### Root Mount

To use Azure Data Lake Storage as the UFS of Alluxio root mount point,
you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
Expand All @@ -73,8 +69,6 @@ fs.azure.account.oauth2.client.secret=<CLIENT_SECRET>

## Setup with Azure Managed Identities

### Root Mount

To use Azure Data Lake Storage as the UFS of Alluxio root mount point,
you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
Expand Down
2 changes: 0 additions & 2 deletions docs/en/ufs/Azure-Data-Lake.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ about Azure storage account, please see

## Basic Setup

### Root Mount

To use Azure Data Lake Storage as the UFS of Alluxio root mount point,
you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
Expand Down
6 changes: 3 additions & 3 deletions docs/en/ufs/COS.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ You also need to provide APPID and REGION. In this guide, the APPID is called `C

## Basic Setup

### Root Mount Point

Create `conf/alluxio-site.properties` if it does not exist.
To use Tencent COS as the UFS of Alluxio, you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
template.

```shell
$ cp conf/alluxio-site.properties.template conf/alluxio-site.properties
Expand Down
4 changes: 2 additions & 2 deletions docs/en/ufs/COSN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ This guide describes how to configure Alluxio with [COSN](https://hadoop.apache.
COSN, also known as Hadoop-COS, is a client that makes the upper computing systems based on HDFS be able to use [Tencent Cloud Object Storage (COS)](https://cloud.tencent.com/product/cos) as its underlying storage system.


## Basic Setup
## Prerequisites

In preparation for using COS with Alluxio, create a new bucket or use an existing bucket.
You should also note the directory you want to use in that bucket, either by creating a new directory in the bucket or using an existing one.
For the purposes of this guide, the COS Bucket name is called `COSN_ALLUXIO_BUCKET`, the directory in that bucket is called `COSN_DATA`, and COS Bucket region is called `COSN_REGION` which specifies the region of your bucket.

### Root Mount Point
## Basic Setup

Create `conf/alluxio-site.properties` and `conf/core-site.xml` if they do not exist.

Expand Down
6 changes: 2 additions & 4 deletions docs/en/ufs/CephObjectStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@ Alluxio supports two different clients APIs to connect to Ceph Object Storage us

A Ceph bucket can be mounted to Alluxio either at the root of the namespace, or at a nested directory.

### Root Mount Point

Configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
template.
Expand All @@ -26,7 +24,7 @@ template.
$ cp conf/alluxio-site.properties.template conf/alluxio-site.properties
```

#### Option 1: S3 Interface (preferred)
### Option 1: S3 Interface (preferred)

Modify `conf/alluxio-site.properties` to include:

Expand All @@ -43,7 +41,7 @@ If using a Ceph release such as hammer (or older) specify `alluxio.underfs.s3.si
to use v2 S3 signatures. To use GET Bucket (List Objects) Version 1 specify
`alluxio.underfs.s3.list.objects.v1=true`.

#### Option 2: Swift Interface
### Option 2: Swift Interface
Modify `conf/alluxio-site.properties` to include:

```properties
Expand Down
2 changes: 0 additions & 2 deletions docs/en/ufs/GCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,6 @@ than the default one in metadata and read/write operations.

A GCS bucket can be mounted to the Alluxio either at the root of the namespace, or at a nested directory.

### Root Mount Point

Configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
template.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/ufs/Minio.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ For these parameters, replace `<MINIO_ENDPOINT>` with the hostname and port of y
e.g., `http://localhost:9000/`.
If the port value is left unset, it defaults to port 80 for `http` and 443 for `https`.

## Test the MinIO Configuration
## Running Alluxio Locally with MinIO

Format and start Alluxio with

Expand Down
2 changes: 1 addition & 1 deletion docs/en/ufs/NFS.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You'll need to have a configured and running installation of NFS for the rest of
If you need to get your own NFS installation up and running, we recommend taking a look at the
[NFS-HOW TO](http://nfs.sourceforge.net/nfs-howto/)

## Requirements
## Prerequisites

The prerequisite for this part is that you have a version of
[Java 8](https://adoptopenjdk.net/releases.html?variant=openjdk8&jvmVariant=hotspot)
Expand Down
2 changes: 0 additions & 2 deletions docs/en/ufs/OBS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ the bucket, or using an existing one. For the purposes of this guide, the OBS bu

## Basic Setup

### Root Mount Point

Create `conf/alluxio-site.properties` if it does not exist.

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/en/ufs/OSS.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ which are created and managed in [Aliyun AccessKey management console](https://a
values like `oss-us-west-1.aliyuncs.com` and `oss-cn-shanghai.aliyuncs.com`. Available endpoints are listed in the
[OSS Internet Endpoints documentation](https://intl.aliyun.com/help/doc-detail/31837.htm).

## Example: Running Alluxio Locally with OSS
## Running Alluxio Locally with Aliyun OSS

Start the Alluxio servers:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/ufs/Ozone.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ When mounting the under storage at the Alluxio root with a specific Ozone versio
alluxio.underfs.version=<OZONE_VERSION>
```

## Example: Running Alluxio Locally with Ozone
## Running Alluxio Locally with Ozone

Start the Alluxio servers:

Expand Down
13 changes: 9 additions & 4 deletions docs/en/ufs/Qiniu-KODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This guide describes how to configure Alluxio with [Qiniu Kodo](https://www.qini

Qiniu Object Storage Service (Kodo) is a cloud-based object storage service provided by Qiniu Cloud, a Chinese cloud service provider. Kodo is a massive, secure and highly reliable cloud storge service that is designed to store, manage, and serve large amounts of unstructured data.

## Initial Setup
## Prerequisites

A Qiniu Kodo bucket is necessary before using Kodo with Alluxio. In this guide, the Qiniu Kodo bucket
is called `KODO_BUCKET`, and the directory in the bucket is called `KODO_DIRECTORY`.
Expand All @@ -21,10 +21,15 @@ Alluxio unifies access to different storage systems through the
unified namespace feature.
The root of Alluxio namespace or its subdirectories are all available for the mount point of Kodo.

### Root Mount
If you want to use Qiniu Kodo as its under storage system in Alluxio, you need to configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
template.

If you want to use Qiniu Kodo as its under storage system in Alluxio, `conf/alluxio-site.properties` must be modified.
In the beginning, an existing Kodo bucket and its directory should be specified for storage by the following code:
```shell
$ cp conf/alluxio-site.properties.template conf/alluxio-site.properties
```

In the beginning, an existing Kodo bucket and its directory should be specified for storage:
```properties
alluxio.dora.client.ufs.root=kodo://<KODO_BUCKET>/<KODO_DIRECTORY>/
```
Expand Down
2 changes: 0 additions & 2 deletions docs/en/ufs/Swift.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ Swift is a highly available, distributed, eventually consistent object/blob stor

A Swift bucket can be mounted to the Alluxio either at the root of the namespace, or at a nested directory.

### Root Mount Point

Configure Alluxio to use under storage systems by modifying
`conf/alluxio-site.properties`. If it does not exist, create the configuration file from the
template.
Expand Down

0 comments on commit ac5adee

Please sign in to comment.