Skip to content

Commit

Permalink
fix: del doc about installation regarding disk (#92)
Browse files Browse the repository at this point in the history
* fix: add Local Storage Enable Label update in installation_zh.md installation.md
     del unused annotation in installation_zh.md installation.md
      add nil map bug fix

Signed-off-by: jie.li <[email protected]>

* fix: del doc about installation regarding disk

Signed-off-by: jie.li <[email protected]>
  • Loading branch information
angel0507 authored Apr 18, 2022
1 parent 345ae39 commit ba38963
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 103 deletions.
59 changes: 0 additions & 59 deletions deploy/nginx-disk.yaml

This file was deleted.

11 changes: 0 additions & 11 deletions deploy/pvc-disk.yaml

This file was deleted.

14 changes: 0 additions & 14 deletions deploy/storageclass-disk.yaml

This file was deleted.

12 changes: 3 additions & 9 deletions doc/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
local-storage is a cloud native local storage system, which should be deployed in a Kubernetes cluster with the following requirements:

* LocalStorage Version: `4.0+`
* Kubernetes Version: `1.18+`
* Kubernetes Version: `1.22+`
* Node
* Free disks
* LVM (`Optional`)

### Step 1: Select and Configure Nodes

Before deploying local-storage, you must decide which Kubernetes nodes for it. The node must have the free disks and also be able to host the applications using the local volume. In addition, you must decide which kind of volume (`LVM`, `DISK` or `RAM`) should be able to provision on each node. Besides, For the node which is already configured with `LVM` or `DISK`, you can still configure `RAM` volume for it by adding "ramdiskTotalCapacity" into the configuration as below.
Before deploying local-storage, you must decide which Kubernetes nodes for it. The node must have the free disks and also be able to host the applications using the local volume. In addition, you must decide which kind of volume (`LVM`, or `RAM`) should be able to provision on each node. Besides, For the node which is already configured with `LVM`, you can still configure `RAM` volume for it by adding "ramdiskTotalCapacity" into the configuration as below.

``` bash
# 1. List all the kubernetes nodes
Expand Down Expand Up @@ -68,21 +68,15 @@ localstorage-local-storage-scheduler-6585bb5897-9xj85 1/1 Running 0
### Step 3: Create StorageClass

``` bash
# You should create a storageclass for each volume kind, i.e. LVM, DISK, RAM
# You should create a storageclass for each volume kind, i.e. LVM, RAM

# LVM volume storageclass (waitforfistconsumer mode) with expansion capability
$ kubectl apply -f deploy/storageclass-lvm.yaml
# Disk volume storageclass (waitforfistconsumer mode) without expansion capability
$ kubectl apply -f deploy/storageclass-disk.yaml
# RAMdisk volume storageclass (waitforfistconsumer mode) without expansion capability
$ kubectl apply -f deploy/storageclass-ram.yaml

# check for storageclass
$ kubectl get sc
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
local-storage-hdd-disk localstorage.hwameistor.io Delete WaitForFirstConsumer false 21d
local-storage-hdd-lvm localstorage.hwameistor.io Delete WaitForFirstConsumer true 21d
local-storage-hdd-ram localstorage.hwameistor.io Delete WaitForFirstConsumer false 15d
```

### Step 4: Create PVC
Expand Down
14 changes: 4 additions & 10 deletions doc/installation_zh.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
### 前提条件

local-storage需要部署在Kuberntes系统中,需要集群满足下列条件:
local-storage需要部署在Kubernetes系统中,需要集群满足下列条件:

* LocalStorage Version: `4.0+`
* Kubernetes Version: `1.18+`
* Kubernetes Version: `1.22+`
* Node
* 空闲磁盘
* LVM (`可选`)

### 步骤 1: 选择和配置节点

部署local-storage之前,需要选择Kubernetes节点并且进行配置。这些节点会被加入local-storage系统。因此,这些节点要有空闲的磁盘。此外,还需要确定每个节点上的持久化数据卷类型,LVM, DISK 或者 RAM。配置为LVM/DISK的节点,还可以额外的配置RAM。这样,在该节点上,既可以创建LVM/DISK数据卷,也可以创建RAM数据卷。
部署local-storage之前,需要选择Kubernetes节点并且进行配置。这些节点会被加入local-storage系统。因此,这些节点要有空闲的磁盘。此外,还需要确定每个节点上的持久化数据卷类型,LVM 或者 RAM。配置为LVM的节点,还可以额外的配置RAM。这样,在该节点上,既可以创建LVM数据卷,也可以创建RAM数据卷。

``` bash
# 1. List all the kubernetes nodes
Expand Down Expand Up @@ -70,24 +70,18 @@ hwameistor-scheduler-6585bb5897-9xj85 1/1 Running 0 15h 172.2
### 步骤 3: 创建 StorageClass

``` bash
# You should create a storageclass for each volume kind, i.e. LVM, DISK, RAM
# You should create a storageclass for each volume kind, i.e. LVM, RAM

# LVM volume storageclass (waitforfirstconsumer mode) with expansion capability
$ kubectl apply -f deploy/storageclass-lvm.yaml
# LVM volume support HA storageclass (waitforfirstconsumer mode) with expansion capability
$ kubectl apply -f deploy/storageclass-lvm-ha.yaml
# Disk volume storageclass (waitforfirstconsumer mode) without expansion capability
$ kubectl apply -f deploy/storageclass-disk.yaml
# RAMdisk volume storageclass (waitforfirstconsumer mode) without expansion capability
$ kubectl apply -f deploy/storageclass-ram.yaml

# check for storageclass
$ kubectl get sc
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
local-storage-hdd-disk localstorage.hwameistor.io Delete WaitForFirstConsumer false 21d
local-storage-hdd-lvm localstorage.hwameistor.io Delete WaitForFirstConsumer true 21d
local-storage-hdd-lvm-ha localstorage.hwameistor.io Delete WaitForFirstConsumer true 21d
local-storage-hdd-ram localstorage.hwameistor.io Delete WaitForFirstConsumer false 15d
```

### 步骤 4: 创建 non HA PVC
Expand Down

0 comments on commit ba38963

Please sign in to comment.