Skip to content

Commit 4ebeb70

Browse files
Merge pull request #63 from latitudesh/fix/readme
fix: keep readme as simple as possible
2 parents 8d120f9 + 7f3799c commit 4ebeb70

2 files changed

Lines changed: 2 additions & 32 deletions

File tree

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
name: Set up Go
2525
uses: actions/setup-go@v4
2626
with:
27-
go-version: '1.21.6'
27+
go-version: '1.22.0'
2828
-
2929
name: Run GoReleaser
3030
uses: goreleaser/goreleaser-action@v5
@@ -47,7 +47,7 @@ jobs:
4747
name: Set up Go
4848
uses: actions/setup-go@v4
4949
with:
50-
go-version: '1.21.6'
50+
go-version: '1.22.0'
5151
-
5252
name: Generate documentation
5353
run: go run internal/generator/documentation/generate.go

README.md

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -110,38 +110,8 @@ Mount block storage to a server (auto-generates/detects NQN and executes mount a
110110

111111
```bash
112112

113-
# Run directly on the server with sudo - NQN will be auto-detected or generated
114-
# and mount will be executed automatically
115-
sudo lsh block mount --id <BLOCK_ID> --subsystem-nqn <CONNECTOR_ID>
116-
117-
# Example with actual values
118-
# Simple! Just provide the block ID
119113
sudo lsh block mount --id blk_abc123
120114

121-
# Or override subsystem NQN if needed
122-
sudo lsh block mount \
123-
--id blk_abc123 \
124-
--subsystem-nqn nqn.2001-07.com.ceph:YOUR-CONNECTOR-ID
125-
126-
# This will automatically:
127-
# 1. Fetch block storage details and connector_id from API
128-
# 2. Install nvme-cli if not present (apt/yum/dnf)
129-
# 3. Auto-detect NQN from /etc/nvme/hostnqn (or generate if missing)
130-
# 4. Send client NQN to API to authorize access to the storage
131-
# 5. Load required NVMe modules (nvme_tcp)
132-
# 6. Connect to the NVMe-oF target using connector_id
133-
# 7. Verify the connection and show available devices
134-
# 8. Provide instructions for formatting and mounting
135-
136-
# Required parameters:
137-
# --id: Block storage ID
138-
139-
# How it works:
140-
# - Block ID: Used to auto-fetch connector_id (subsystem NQN)
141-
# - Client NQN: Auto-detected and sent to API to authorize this client
142-
# - Subsystem NQN: Auto-fetched from block storage's connector_id
143-
# - Gateway: Defaults to 67.213.118.147:4420
144-
145115
```
146116

147117

0 commit comments

Comments
 (0)