Skip to content

docs: add a use case for mounting disks via custom block device labels #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add a use case for mounting disks via custom block device labels #154

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs/deploy/setup-iomesh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,9 @@ Device selector is defined by:
All block devices selected by device selector will be mounted to IOMesh with the corresponding mount type.

#### Example of DeviceMap Configuration in Hybrid-Flash Deployment Mode

##### Example 1
Select the block device with the label iomesh.com/bd-driverType equal to SSD and mount it as cacheWithJournal, equal to SSD and mount it as cacheWithJournal
```yaml
spec:
# ...
Expand Down Expand Up @@ -134,6 +137,73 @@ spec:
# ...
```

##### Example 2
Customize labels and mount block devices by selecting them

1. add label `customize/labels: "cacheWithJournal"` for block device `name: blockdevice-first`
```yaml
apiVersion: openebs.io/v1alpha1
kind: BlockDevice
metadata:
annotations:
internal.openebs.io/uuid-scheme: gpt
generation: 1
labels:
customize/labels: "cacheWithJournal"
iomesh.com/bd-devicePath: dev.sda
iomesh.com/bd-deviceType: disk
iomesh.com/bd-driverType: SSD
iomesh.com/bd-serial: 24da000347e1e4a9
iomesh.com/bd-vendor: ATA
kubernetes.io/hostname: kind-control-plane
ndm.io/blockdevice-type: blockdevice
ndm.io/managed: "true"
namespace: iomesh-system
name: blockdevice-first
```

add label `customize/labels: "dataStore"` for block device `name: blockdevice-second`
```yaml
apiVersion: openebs.io/v1alpha1
kind: BlockDevice
metadata:
annotations:
internal.openebs.io/uuid-scheme: gpt
generation: 1
labels:
customize/labels: "dataStore"
iomesh.com/bd-devicePath: dev.sdb
iomesh.com/bd-deviceType: disk
iomesh.com/bd-driverType: HDD
iomesh.com/bd-serial: 24da000347e1e111
iomesh.com/bd-vendor: ATA
kubernetes.io/hostname: kind-control-plane
ndm.io/blockdevice-type: blockdevice
ndm.io/managed: "true"
namespace: iomesh-system
name: blockdevice-second
```


2. Mount on block devices by selecting custom labels
```yaml
spec:
# ...
chunk:
# ...
deviceMap:
cacheWithJournal:
selector:
matchLabels:
customize/labels: "cacheWithJournal"
dataStore:
selector:
matchLabels:
customize/labels: "dataStore"

# ...
```

#### Example of DeviceMap Configuration in All-Flash Deployment Mode
```yaml
spec:
Expand Down