From 2f6b9c030610e57c2e676d476b0096c0a23a6331 Mon Sep 17 00:00:00 2001 From: Vitaliy Filippov Date: Sun, 31 Dec 2023 02:50:28 +0300 Subject: [PATCH] Remove etcd parameter from default command examples --- docs/installation/proxmox.en.md | 2 +- docs/installation/proxmox.ru.md | 2 +- docs/usage/fio.en.md | 7 +++++-- docs/usage/fio.ru.md | 5 ++++- docs/usage/nfs.en.md | 2 +- docs/usage/nfs.ru.md | 2 +- docs/usage/qemu.en.md | 13 ++++++++----- docs/usage/qemu.ru.md | 13 ++++++++----- 8 files changed, 29 insertions(+), 17 deletions(-) diff --git a/docs/installation/proxmox.en.md b/docs/installation/proxmox.en.md index a874c150..c6b3b1b6 100644 --- a/docs/installation/proxmox.en.md +++ b/docs/installation/proxmox.en.md @@ -25,7 +25,7 @@ vitastor: vitastor vitastor_pool testpool # path to the configuration file vitastor_config_path /etc/vitastor/vitastor.conf - # etcd address(es), required only if missing in the configuration file + # etcd address(es), OPTIONAL, required only if missing in the configuration file vitastor_etcd_address 192.168.7.2:2379/v3 # prefix for keys in etcd vitastor_etcd_prefix /vitastor diff --git a/docs/installation/proxmox.ru.md b/docs/installation/proxmox.ru.md index fdb3edb4..07ef91bf 100644 --- a/docs/installation/proxmox.ru.md +++ b/docs/installation/proxmox.ru.md @@ -24,7 +24,7 @@ vitastor: vitastor vitastor_pool testpool # Путь к файлу конфигурации vitastor_config_path /etc/vitastor/vitastor.conf - # Адрес(а) etcd, нужны, только если не указаны в vitastor.conf + # Адрес(а) etcd, ОПЦИОНАЛЬНЫ, нужны, только если не указаны в vitastor.conf vitastor_etcd_address 192.168.7.2:2379/v3 # Префикс ключей метаданных в etcd vitastor_etcd_prefix /vitastor diff --git a/docs/usage/fio.en.md b/docs/usage/fio.en.md index 90ffb147..e850e092 100644 --- a/docs/usage/fio.en.md +++ b/docs/usage/fio.en.md @@ -14,10 +14,13 @@ Vitastor has a fio driver which can be installed from the package vitastor-fio. Use the following command as an example to run tests with fio against a Vitastor cluster: ``` -fio -thread -ioengine=libfio_vitastor.so -name=test -bs=4M -direct=1 -iodepth=16 -rw=write -etcd=10.115.0.10:2379/v3 -image=testimg +fio -thread -ioengine=libfio_vitastor.so -name=test -bs=4M -direct=1 -iodepth=16 -rw=write -image=testimg ``` If you don't want to access your image by name, you can specify pool number, inode number and size (`-pool=1 -inode=1 -size=400G`) instead of the image name (`-image=testimg`). -See exact fio commands to use for benchmarking [here](../performance/understanding.en.md#команды-fio). +You can also specify etcd address(es) explicitly by adding `-etcd=10.115.0.10:2379/v3`, or you +can override configuration file path by adding `-conf=/etc/vitastor/vitastor.conf`. + +See exact fio commands to use for benchmarking [here](../performance/understanding.en.md#fio-commands). diff --git a/docs/usage/fio.ru.md b/docs/usage/fio.ru.md index 27b62425..5163f2d7 100644 --- a/docs/usage/fio.ru.md +++ b/docs/usage/fio.ru.md @@ -14,10 +14,13 @@ Используйте следующую команду как пример для запуска тестов кластера Vitastor через fio: ``` -fio -thread -ioengine=libfio_vitastor.so -name=test -bs=4M -direct=1 -iodepth=16 -rw=write -etcd=10.115.0.10:2379/v3 -image=testimg +fio -thread -ioengine=libfio_vitastor.so -name=test -bs=4M -direct=1 -iodepth=16 -rw=write -image=testimg ``` Вместо обращения к образу по имени (`-image=testimg`) можно указать номер пула, номер инода и размер: `-pool=1 -inode=1 -size=400G`. +Вы также можете задать адрес(а) подключения к etcd явно, добавив `-etcd=10.115.0.10:2379/v3`, +или переопределить путь к файлу конфигурации, добавив `-conf=/etc/vitastor/vitastor.conf`. + Конкретные команды fio для тестирования производительности можно посмотреть [здесь](../performance/understanding.ru.md#команды-fio). diff --git a/docs/usage/nfs.en.md b/docs/usage/nfs.en.md index 95c009cc..92cdf290 100644 --- a/docs/usage/nfs.en.md +++ b/docs/usage/nfs.en.md @@ -34,7 +34,7 @@ vitastor-nfs [STANDARD OPTIONS] [OTHER OPTIONS] --foreground 1 stay in foreground, do not daemonize ``` -Example start and mount commands: +Example start and mount commands (etcd_address is optional): ``` vitastor-nfs --etcd_address 192.168.5.10:2379 --portmap 0 --port 2050 --pool testpool diff --git a/docs/usage/nfs.ru.md b/docs/usage/nfs.ru.md index e0d76e82..73025d2c 100644 --- a/docs/usage/nfs.ru.md +++ b/docs/usage/nfs.ru.md @@ -33,7 +33,7 @@ vitastor-nfs [СТАНДАРТНЫЕ ОПЦИИ] [ДРУГИЕ ОПЦИИ] --foreground 1 не уходить в фон после запуска ``` -Пример монтирования Vitastor через NFS: +Пример монтирования Vitastor через NFS (etcd_address необязателен): ``` vitastor-nfs --etcd_address 192.168.5.10:2379 --portmap 0 --port 2050 --pool testpool diff --git a/docs/usage/qemu.en.md b/docs/usage/qemu.en.md index 6b187cdb..0c7d9646 100644 --- a/docs/usage/qemu.en.md +++ b/docs/usage/qemu.en.md @@ -16,13 +16,16 @@ Old syntax (-drive): ``` qemu-system-x86_64 -enable-kvm -m 1024 \ - -drive 'file=vitastor:etcd_host=192.168.7.2\:2379/v3:image=debian9', + -drive 'file=vitastor:image=debian9', format=raw,if=none,id=drive-virtio-disk0,cache=none \ -device 'virtio-blk-pci,scsi=off,bus=pci.0,addr=0x5,drive=drive-virtio-disk0, id=virtio-disk0,bootindex=1,write-cache=off' \ -vnc 0.0.0.0:0 ``` +Etcd address may be specified explicitly by adding `:etcd_host=192.168.7.2\:2379/v3` to `file=`. +Configuration file path may be overriden by adding `:config_path=/etc/vitastor/vitastor.conf`. + New syntax (-blockdev): ``` @@ -50,12 +53,12 @@ You can also specify inode ID, pool and size manually instead of `:image= ## qemu-img -For qemu-img, you should use `vitastor:etcd_host=:image=` as filename. +For qemu-img, you should use `vitastor:image=[:etcd_host=]` as filename. For example, to upload a VM image into Vitastor, run: ``` -qemu-img convert -f qcow2 debian10.qcow2 -p -O raw 'vitastor:etcd_host=192.168.7.2\:2379/v3:image=debian10' +qemu-img convert -f qcow2 debian10.qcow2 -p -O raw 'vitastor:image=debian10' ``` You can also specify `:pool=:inode=:size=` instead of `:image=` @@ -72,10 +75,10 @@ the snapshot separately using the following commands (key points are using `skip `-B backing_file` option): ``` -qemu-img convert -f raw 'vitastor:etcd_host=192.168.7.2\:2379/v3:image=testimg@0' \ +qemu-img convert -f raw 'vitastor:image=testimg@0' \ -O qcow2 testimg_0.qcow2 -qemu-img convert -f raw 'vitastor:etcd_host=192.168.7.2\:2379/v3:image=testimg:skip-parents=1' \ +qemu-img convert -f raw 'vitastor:image=testimg:skip-parents=1' \ -O qcow2 -o 'cluster_size=4k' -B testimg_0.qcow2 testimg.qcow2 ``` diff --git a/docs/usage/qemu.ru.md b/docs/usage/qemu.ru.md index 1a9e335f..524e3e4d 100644 --- a/docs/usage/qemu.ru.md +++ b/docs/usage/qemu.ru.md @@ -18,13 +18,16 @@ ``` qemu-system-x86_64 -enable-kvm -m 1024 \ - -drive 'file=vitastor:etcd_host=192.168.7.2\:2379/v3:image=debian9', + -drive 'file=vitastor:image=debian9', format=raw,if=none,id=drive-virtio-disk0,cache=none \ -device 'virtio-blk-pci,scsi=off,bus=pci.0,addr=0x5,drive=drive-virtio-disk0, id=virtio-disk0,bootindex=1,write-cache=off' \ -vnc 0.0.0.0:0 ``` +Адрес подключения etcd можно задать явно, если добавить `:etcd_host=192.168.7.2\:2379/v3` к `file=`. +Путь к файлу конфигурации можно переопределить, добавив `:config_path=/etc/vitastor/vitastor.conf`. + Новый синтаксис (-blockdev): ``` @@ -52,12 +55,12 @@ qemu-system-x86_64 -enable-kvm -m 1024 \ ## qemu-img -Для qemu-img используйте строку `vitastor:etcd_host=:image=` в качестве имени файла диска. +Для qemu-img используйте строку `vitastor:image=[:etcd_host=]` в качестве имени файла диска. Например, чтобы загрузить образ диска в Vitastor: ``` -qemu-img convert -f qcow2 debian10.qcow2 -p -O raw 'vitastor:etcd_host=10.115.0.10\:2379/v3:image=testimg' +qemu-img convert -f qcow2 debian10.qcow2 -p -O raw 'vitastor:image=testimg' ``` Если вы не хотите обращаться к образу по имени, вместо `:image=` можно указать номер пула, номер инода и размер: @@ -73,10 +76,10 @@ qemu-img convert -f qcow2 debian10.qcow2 -p -O raw 'vitastor:etcd_host=10.115.0. с помощью следующих команд (ключевые моменты - использование `skip-parents=1` и опции `-B backing_file.qcow2`): ``` -qemu-img convert -f raw 'vitastor:etcd_host=192.168.7.2\:2379/v3:image=testimg@0' \ +qemu-img convert -f raw 'vitastor:image=testimg@0' \ -O qcow2 testimg_0.qcow2 -qemu-img convert -f raw 'vitastor:etcd_host=192.168.7.2\:2379/v3:image=testimg:skip-parents=1' \ +qemu-img convert -f raw 'vitastor:image=testimg:skip-parents=1' \ -O qcow2 -o 'cluster_size=4k' -B testimg_0.qcow2 testimg.qcow2 ```