From ac5adee0c4b12be3f15db90e7b8dacccf95e90df Mon Sep 17 00:00:00 2001 From: ccmao1130 Date: Thu, 20 Jul 2023 18:47:32 -0700 Subject: [PATCH] delete subheadings when there's only 1 --- docs/en/ufs/Azure-Blob-Store.md | 2 -- docs/en/ufs/Azure-Data-Lake-Gen2.md | 6 ------ docs/en/ufs/Azure-Data-Lake.md | 2 -- docs/en/ufs/COS.md | 6 +++--- docs/en/ufs/COSN.md | 4 ++-- docs/en/ufs/CephObjectStorage.md | 6 ++---- docs/en/ufs/GCS.md | 2 -- docs/en/ufs/Minio.md | 2 +- docs/en/ufs/NFS.md | 2 +- docs/en/ufs/OBS.md | 2 -- docs/en/ufs/OSS.md | 2 +- docs/en/ufs/Ozone.md | 2 +- docs/en/ufs/Qiniu-KODO.md | 13 +++++++++---- docs/en/ufs/Swift.md | 2 -- 14 files changed, 20 insertions(+), 33 deletions(-) diff --git a/docs/en/ufs/Azure-Blob-Store.md b/docs/en/ufs/Azure-Blob-Store.md index 335e4dc13580..42e6b7175528 100644 --- a/docs/en/ufs/Azure-Blob-Store.md +++ b/docs/en/ufs/Azure-Blob-Store.md @@ -22,8 +22,6 @@ called ``. 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 diff --git a/docs/en/ufs/Azure-Data-Lake-Gen2.md b/docs/en/ufs/Azure-Data-Lake-Gen2.md index affe651d2c6d..b96899b21ad6 100644 --- a/docs/en/ufs/Azure-Data-Lake-Gen2.md +++ b/docs/en/ufs/Azure-Data-Lake-Gen2.md @@ -20,8 +20,6 @@ the directory in that storage account is called ``, 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 @@ -45,8 +43,6 @@ fs.azure.account.key..dfs.core.windows.net= ## 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 @@ -73,8 +69,6 @@ fs.azure.account.oauth2.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 diff --git a/docs/en/ufs/Azure-Data-Lake.md b/docs/en/ufs/Azure-Data-Lake.md index 06f38ec4caf0..cd0e7660800f 100644 --- a/docs/en/ufs/Azure-Data-Lake.md +++ b/docs/en/ufs/Azure-Data-Lake.md @@ -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 diff --git a/docs/en/ufs/COS.md b/docs/en/ufs/COS.md index 3071ae6d6129..839ef90bcf84 100644 --- a/docs/en/ufs/COS.md +++ b/docs/en/ufs/COS.md @@ -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 diff --git a/docs/en/ufs/COSN.md b/docs/en/ufs/COSN.md index e63b3ea13d89..3c2bd725c2c3 100644 --- a/docs/en/ufs/COSN.md +++ b/docs/en/ufs/COSN.md @@ -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. diff --git a/docs/en/ufs/CephObjectStorage.md b/docs/en/ufs/CephObjectStorage.md index 0adad33774b2..b80b75e82c5c 100644 --- a/docs/en/ufs/CephObjectStorage.md +++ b/docs/en/ufs/CephObjectStorage.md @@ -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. @@ -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: @@ -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 diff --git a/docs/en/ufs/GCS.md b/docs/en/ufs/GCS.md index d636a473a3c4..f24e412f1a67 100644 --- a/docs/en/ufs/GCS.md +++ b/docs/en/ufs/GCS.md @@ -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. diff --git a/docs/en/ufs/Minio.md b/docs/en/ufs/Minio.md index 5bc76a43ff62..450c8c8a5832 100644 --- a/docs/en/ufs/Minio.md +++ b/docs/en/ufs/Minio.md @@ -49,7 +49,7 @@ For these parameters, replace `` 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 diff --git a/docs/en/ufs/NFS.md b/docs/en/ufs/NFS.md index 4c1218578e95..5d420f4517f0 100644 --- a/docs/en/ufs/NFS.md +++ b/docs/en/ufs/NFS.md @@ -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) diff --git a/docs/en/ufs/OBS.md b/docs/en/ufs/OBS.md index 575b0bb62ae7..01f4f58edc32 100644 --- a/docs/en/ufs/OBS.md +++ b/docs/en/ufs/OBS.md @@ -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 diff --git a/docs/en/ufs/OSS.md b/docs/en/ufs/OSS.md index 7293a7cfb90c..77baa60a74a4 100644 --- a/docs/en/ufs/OSS.md +++ b/docs/en/ufs/OSS.md @@ -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: diff --git a/docs/en/ufs/Ozone.md b/docs/en/ufs/Ozone.md index 31253378bf7c..b6c2e962684d 100644 --- a/docs/en/ufs/Ozone.md +++ b/docs/en/ufs/Ozone.md @@ -82,7 +82,7 @@ When mounting the under storage at the Alluxio root with a specific Ozone versio alluxio.underfs.version= ``` -## Example: Running Alluxio Locally with Ozone +## Running Alluxio Locally with Ozone Start the Alluxio servers: diff --git a/docs/en/ufs/Qiniu-KODO.md b/docs/en/ufs/Qiniu-KODO.md index 87768d0d0239..f2e7db255bfc 100644 --- a/docs/en/ufs/Qiniu-KODO.md +++ b/docs/en/ufs/Qiniu-KODO.md @@ -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`. @@ -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://// ``` diff --git a/docs/en/ufs/Swift.md b/docs/en/ufs/Swift.md index bbd22b32aa58..479925e42bdd 100644 --- a/docs/en/ufs/Swift.md +++ b/docs/en/ufs/Swift.md @@ -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.