Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
194f7e0187 |
@@ -1,29 +1,28 @@
|
|||||||
FROM node:16-bookworm
|
FROM node:16-bullseye
|
||||||
|
|
||||||
WORKDIR /root
|
WORKDIR /root
|
||||||
|
|
||||||
ADD ./docker/etc/apt/trusted.gpg.d /etc/apt/trusted.gpg.d
|
ADD ./docker/vitastor.gpg /etc/apt/trusted.gpg.d
|
||||||
|
|
||||||
RUN echo 'deb http://deb.debian.org/debian bookworm-backports main' >> /etc/apt/sources.list; \
|
RUN echo 'deb http://deb.debian.org/debian bullseye-backports main' >> /etc/apt/sources.list; \
|
||||||
echo 'deb http://vitastor.io/debian bookworm main' >> /etc/apt/sources.list; \
|
echo 'deb http://vitastor.io/debian bullseye main' >> /etc/apt/sources.list; \
|
||||||
echo >> /etc/apt/preferences; \
|
echo >> /etc/apt/preferences; \
|
||||||
echo 'Package: *' >> /etc/apt/preferences; \
|
echo 'Package: *' >> /etc/apt/preferences; \
|
||||||
echo 'Pin: release n=bookworm-backports' >> /etc/apt/preferences; \
|
echo 'Pin: release a=bullseye-backports' >> /etc/apt/preferences; \
|
||||||
echo 'Pin-Priority: 500' >> /etc/apt/preferences; \
|
echo 'Pin-Priority: 500' >> /etc/apt/preferences; \
|
||||||
echo >> /etc/apt/preferences; \
|
echo >> /etc/apt/preferences; \
|
||||||
echo 'Package: *' >> /etc/apt/preferences; \
|
echo 'Package: *' >> /etc/apt/preferences; \
|
||||||
echo 'Pin: origin "vitastor.io"' >> /etc/apt/preferences; \
|
echo 'Pin: origin "vitastor.io"' >> /etc/apt/preferences; \
|
||||||
echo 'Pin-Priority: 1000' >> /etc/apt/preferences; \
|
echo 'Pin-Priority: 1000' >> /etc/apt/preferences; \
|
||||||
perl -i -pe 's/Types: deb$/Types: deb deb-src/' /etc/apt/sources.list.d/debian.sources; \
|
|
||||||
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
||||||
echo 'APT::Install-Recommends false;' >> /etc/apt/apt.conf; \
|
echo 'APT::Install-Recommends false;' >> /etc/apt/apt.conf; \
|
||||||
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
||||||
|
|
||||||
RUN apt-get update
|
RUN apt-get update
|
||||||
RUN apt-get -y install etcd qemu-system-x86 qemu-block-extra qemu-utils fio libasan8 \
|
RUN apt-get -y install etcd qemu-system-x86 qemu-block-extra qemu-utils fio libasan5 \
|
||||||
libgoogle-perftools-dev devscripts libjerasure-dev cmake libibverbs-dev libisal-dev
|
liburing1 liburing-dev libgoogle-perftools-dev devscripts libjerasure-dev cmake libibverbs-dev libisal-dev
|
||||||
RUN apt-get -y build-dep fio qemu=`dpkg -s qemu-system-x86|grep ^Version:|awk '{print $2}'`
|
RUN apt-get -y build-dep fio qemu=`dpkg -s qemu-system-x86|grep ^Version:|awk '{print $2}'`
|
||||||
RUN apt-get update && apt-get -y install jq lp-solve sudo nfs-common fdisk parted libc-ares-dev udev
|
RUN apt-get update && apt-get -y install jq lp-solve sudo nfs-common fdisk parted
|
||||||
RUN apt-get --download-only source fio qemu=`dpkg -s qemu-system-x86|grep ^Version:|awk '{print $2}'`
|
RUN apt-get --download-only source fio qemu=`dpkg -s qemu-system-x86|grep ^Version:|awk '{print $2}'`
|
||||||
|
|
||||||
RUN set -ex; \
|
RUN set -ex; \
|
||||||
|
|||||||
+4
-1048
File diff suppressed because it is too large
Load Diff
@@ -38,18 +38,6 @@ for my $line (<>)
|
|||||||
{
|
{
|
||||||
$test_name .= '_antietcd';
|
$test_name .= '_antietcd';
|
||||||
}
|
}
|
||||||
elsif ($1 eq 'ETCD_SCHEME' && $2 eq 'https')
|
|
||||||
{
|
|
||||||
$test_name .= '_https';
|
|
||||||
}
|
|
||||||
elsif ($1 eq 'ENCRYPTED')
|
|
||||||
{
|
|
||||||
$test_name .= '_encrypted';
|
|
||||||
}
|
|
||||||
elsif ($1 eq 'OLD')
|
|
||||||
{
|
|
||||||
$test_name =~ s/^test_/test_old_/s;
|
|
||||||
}
|
|
||||||
else
|
else
|
||||||
{
|
{
|
||||||
$test_name .= '_'.lc($1).'_'.$2;
|
$test_name .= '_'.lc($1).'_'.$2;
|
||||||
|
|||||||
@@ -3,4 +3,3 @@
|
|||||||
package-lock.json
|
package-lock.json
|
||||||
fio
|
fio
|
||||||
qemu
|
qemu
|
||||||
node_modules
|
|
||||||
|
|||||||
+1
-14
@@ -2,19 +2,6 @@ cmake_minimum_required(VERSION 2.8.12)
|
|||||||
|
|
||||||
project(vitastor)
|
project(vitastor)
|
||||||
|
|
||||||
set(VITASTOR_VERSION "3.0.5")
|
set(VITASTOR_VERSION "1.11.0")
|
||||||
|
|
||||||
include(CTest)
|
|
||||||
|
|
||||||
add_custom_target(build_tests)
|
|
||||||
add_custom_target(test
|
|
||||||
COMMAND
|
|
||||||
echo leak:tcmalloc > ${CMAKE_CURRENT_BINARY_DIR}/lsan-suppress.txt &&
|
|
||||||
env LSAN_OPTIONS=suppressions=${CMAKE_CURRENT_BINARY_DIR}/lsan-suppress.txt ${CMAKE_CTEST_COMMAND}
|
|
||||||
)
|
|
||||||
# make -j16 -C ../../build test_heap && ../../build/src/test/test_heap
|
|
||||||
# make -j16 -C ../../build test_heap && rm -f $(find ../../build -name '*.gcda') && ctest -V -T test -T coverage -R heap --test-dir ../../build && (cd ../../build; gcovr -f ../src --html --html-nested -o coverage/index.html; cd ../src/test)
|
|
||||||
# make -j16 -C ../../build test_blockstore && rm -f $(find ../../build -name '*.gcda') && ctest -V -T test -T coverage -R blockstore --test-dir ../../build && (cd ../../build; gcovr -f ../src --html --html-nested -o coverage/index.html; cd ../src/test)
|
|
||||||
# kcov --include-path=../../../src ../../kcov ./test_blockstore
|
|
||||||
add_dependencies(test build_tests)
|
|
||||||
add_subdirectory(src)
|
add_subdirectory(src)
|
||||||
|
|||||||
+6
-13
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
Вернём былую скорость кластерному блочному хранилищу!
|
Вернём былую скорость кластерному блочному хранилищу!
|
||||||
|
|
||||||
Vitastor - распределённая блочная, файловая и объектная SDS (программная СХД), прямой аналог Ceph RBD, CephFS и RGW,
|
Vitastor - распределённая блочная и файловая SDS (программная СХД), прямой аналог Ceph RBD и CephFS,
|
||||||
а также внутренних СХД популярных облачных провайдеров. Однако, в отличие от них, Vitastor
|
а также внутренних СХД популярных облачных провайдеров. Однако, в отличие от них, Vitastor
|
||||||
быстрый и при этом простой. Только пока маленький :-).
|
быстрый и при этом простой. Только пока маленький :-).
|
||||||
|
|
||||||
@@ -19,22 +19,18 @@ Vitastor нацелен в первую очередь на SSD и SSD+HDD кл
|
|||||||
TCP и RDMA и на хорошем железе может достигать задержки 4 КБ чтения и записи на уровне ~0.1 мс,
|
TCP и RDMA и на хорошем железе может достигать задержки 4 КБ чтения и записи на уровне ~0.1 мс,
|
||||||
что примерно в 10 раз быстрее, чем Ceph и другие популярные программные СХД.
|
что примерно в 10 раз быстрее, чем Ceph и другие популярные программные СХД.
|
||||||
|
|
||||||
Vitastor поддерживает QEMU-драйвер, протоколы UBLK, NBD и NFS, драйверы OpenStack, OpenNebula, Proxmox, Kubernetes.
|
Vitastor поддерживает QEMU-драйвер, протоколы NBD и NFS, драйверы OpenStack, OpenNebula, Proxmox, Kubernetes.
|
||||||
Другие драйверы могут также быть легко реализованы.
|
Другие драйверы могут также быть легко реализованы.
|
||||||
|
|
||||||
Подробности смотрите в документации по ссылкам. Можете начать отсюда: [Быстрый старт](docs/intro/quickstart.ru.md).
|
Подробности смотрите в документации по ссылкам. Можете начать отсюда: [Быстрый старт](docs/intro/quickstart.ru.md).
|
||||||
|
|
||||||
## Презентации и записи докладов
|
## Презентации и записи докладов
|
||||||
|
|
||||||
- KuberConf'2025: [видео](https://vitastor.io/presentation/kuberconf.webm)
|
|
||||||
- Highload'2025: [видео](https://vitastor.io/presentation/hl2025/hl2025.webm),
|
|
||||||
[на youtube](https://www.youtube.com/watch?v=0R8MLjFtz7g), презентация
|
|
||||||
([на русском](https://vitastor.io/presentation/hl2025/), [на английском](https://vitastor.io/presentation/hl2025/en.html))
|
|
||||||
- Highload'2022: презентация ([на русском](https://vitastor.io/presentation/highload/highload.html)),
|
|
||||||
[видео](https://vitastor.io/presentation/highload/talk.webm)
|
|
||||||
- DevOpsConf'2021: презентация ([на русском](https://vitastor.io/presentation/devopsconf/devopsconf.html),
|
- DevOpsConf'2021: презентация ([на русском](https://vitastor.io/presentation/devopsconf/devopsconf.html),
|
||||||
[на английском](https://vitastor.io/presentation/devopsconf/devopsconf_en.html)),
|
[на английском](https://vitastor.io/presentation/devopsconf/devopsconf_en.html)),
|
||||||
[видео](https://vitastor.io/presentation/devopsconf/talk.webm)
|
[видео](https://vitastor.io/presentation/devopsconf/talk.webm)
|
||||||
|
- Highload'2022: презентация ([на русском](https://vitastor.io/presentation/highload/highload.html)),
|
||||||
|
[видео](https://vitastor.io/presentation/highload/talk.webm)
|
||||||
|
|
||||||
## Документация
|
## Документация
|
||||||
|
|
||||||
@@ -50,7 +46,6 @@ Vitastor поддерживает QEMU-драйвер, протоколы UBLK,
|
|||||||
- [OpenNebula](docs/installation/opennebula.ru.md)
|
- [OpenNebula](docs/installation/opennebula.ru.md)
|
||||||
- [OpenStack](docs/installation/openstack.ru.md)
|
- [OpenStack](docs/installation/openstack.ru.md)
|
||||||
- [Kubernetes CSI](docs/installation/kubernetes.ru.md)
|
- [Kubernetes CSI](docs/installation/kubernetes.ru.md)
|
||||||
- [S3](docs/installation/s3.ru.md)
|
|
||||||
- [Сборка из исходных кодов](docs/installation/source.ru.md)
|
- [Сборка из исходных кодов](docs/installation/source.ru.md)
|
||||||
- Конфигурация
|
- Конфигурация
|
||||||
- [Обзор](docs/config.ru.md)
|
- [Обзор](docs/config.ru.md)
|
||||||
@@ -62,16 +57,14 @@ Vitastor поддерживает QEMU-драйвер, протоколы UBLK,
|
|||||||
- [Дисковые параметры OSD](docs/config/layout-osd.ru.md)
|
- [Дисковые параметры OSD](docs/config/layout-osd.ru.md)
|
||||||
- [Прочие параметры OSD](docs/config/osd.ru.md)
|
- [Прочие параметры OSD](docs/config/osd.ru.md)
|
||||||
- [Параметры мониторов](docs/config/monitor.ru.md)
|
- [Параметры мониторов](docs/config/monitor.ru.md)
|
||||||
- [Безопасность](docs/config/security.ru.md)
|
|
||||||
- [Настройки пулов](docs/config/pool.ru.md)
|
- [Настройки пулов](docs/config/pool.ru.md)
|
||||||
- [Метаданные образов в etcd](docs/config/inode.ru.md)
|
- [Метаданные образов в etcd](docs/config/inode.ru.md)
|
||||||
- Использование
|
- Использование
|
||||||
- [vitastor-cli](docs/usage/cli.ru.md) (консольный интерфейс)
|
- [vitastor-cli](docs/usage/cli.ru.md) (консольный интерфейс)
|
||||||
- [vitastor-disk](docs/usage/disk.ru.md) (управление дисками)
|
- [vitastor-disk](docs/usage/disk.ru.md) (управление дисками)
|
||||||
- [fio](docs/usage/fio.ru.md) для тестов производительности
|
- [fio](docs/usage/fio.ru.md) для тестов производительности
|
||||||
- [UBLK](docs/usage/ublk.ru.md) для монтирования ядром
|
- [NBD](docs/usage/nbd.ru.md) для монтирования ядром
|
||||||
- [NBD](docs/usage/nbd.ru.md) - старый интерфейс для монтирования ядром
|
- [QEMU и qemu-img](docs/usage/qemu.ru.md)
|
||||||
- [QEMU, qemu-img и VDUSE](docs/usage/qemu.ru.md)
|
|
||||||
- [NFS](docs/usage/nfs.ru.md) кластерная файловая система и псевдо-ФС прокси
|
- [NFS](docs/usage/nfs.ru.md) кластерная файловая система и псевдо-ФС прокси
|
||||||
- [Администрирование](docs/usage/admin.ru.md)
|
- [Администрирование](docs/usage/admin.ru.md)
|
||||||
- Производительность
|
- Производительность
|
||||||
|
|||||||
@@ -6,7 +6,7 @@
|
|||||||
|
|
||||||
Make Clustered Block Storage Fast Again.
|
Make Clustered Block Storage Fast Again.
|
||||||
|
|
||||||
Vitastor is a distributed block, file and object SDS, direct replacement of Ceph RBD, CephFS and RGW,
|
Vitastor is a distributed block and file SDS, direct replacement of Ceph RBD and CephFS,
|
||||||
and also internal SDS's of public clouds. However, in contrast to them, Vitastor is fast
|
and also internal SDS's of public clouds. However, in contrast to them, Vitastor is fast
|
||||||
and simple at the same time. The only thing is it's slightly young :-).
|
and simple at the same time. The only thing is it's slightly young :-).
|
||||||
|
|
||||||
@@ -19,22 +19,18 @@ supports TCP and RDMA and may achieve 4 KB read and write latency as low as ~0.1
|
|||||||
with proper hardware which is ~10 times faster than other popular SDS's like Ceph
|
with proper hardware which is ~10 times faster than other popular SDS's like Ceph
|
||||||
or internal systems of public clouds.
|
or internal systems of public clouds.
|
||||||
|
|
||||||
Vitastor supports QEMU, UBLK, NBD, NFS protocols, OpenStack, OpenNebula, Proxmox, Kubernetes drivers.
|
Vitastor supports QEMU, NBD, NFS protocols, OpenStack, OpenNebula, Proxmox, Kubernetes drivers.
|
||||||
More drivers may be created easily.
|
More drivers may be created easily.
|
||||||
|
|
||||||
Read more details in the documentation. You can start from here: [Quick Start](docs/intro/quickstart.en.md).
|
Read more details in the documentation. You can start from here: [Quick Start](docs/intro/quickstart.en.md).
|
||||||
|
|
||||||
## Talks and presentations
|
## Talks and presentations
|
||||||
|
|
||||||
- KuberConf'2025: [video](https://vitastor.io/presentation/kuberconf.webm)
|
|
||||||
- Highload'2025: [video](https://vitastor.io/presentation/hl2025/hl2025.webm),
|
|
||||||
[youtube](https://www.youtube.com/watch?v=0R8MLjFtz7g), presentation
|
|
||||||
([in Russian](https://vitastor.io/presentation/hl2025/), [in English](https://vitastor.io/presentation/hl2025/en.html))
|
|
||||||
- Highload'2022: presentation ([in Russian](https://vitastor.io/presentation/highload/highload.html)),
|
|
||||||
[video](https://vitastor.io/presentation/highload/talk.webm)
|
|
||||||
- DevOpsConf'2021: presentation ([in Russian](https://vitastor.io/presentation/devopsconf/devopsconf.html),
|
- DevOpsConf'2021: presentation ([in Russian](https://vitastor.io/presentation/devopsconf/devopsconf.html),
|
||||||
[in English](https://vitastor.io/presentation/devopsconf/devopsconf_en.html)),
|
[in English](https://vitastor.io/presentation/devopsconf/devopsconf_en.html)),
|
||||||
[video](https://vitastor.io/presentation/devopsconf/talk.webm)
|
[video](https://vitastor.io/presentation/devopsconf/talk.webm)
|
||||||
|
- Highload'2022: presentation ([in Russian](https://vitastor.io/presentation/highload/highload.html)),
|
||||||
|
[video](https://vitastor.io/presentation/highload/talk.webm)
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
@@ -50,7 +46,6 @@ Read more details in the documentation. You can start from here: [Quick Start](d
|
|||||||
- [OpenNebula](docs/installation/opennebula.en.md)
|
- [OpenNebula](docs/installation/opennebula.en.md)
|
||||||
- [OpenStack](docs/installation/openstack.en.md)
|
- [OpenStack](docs/installation/openstack.en.md)
|
||||||
- [Kubernetes CSI](docs/installation/kubernetes.en.md)
|
- [Kubernetes CSI](docs/installation/kubernetes.en.md)
|
||||||
- [S3](docs/installation/s3.en.md)
|
|
||||||
- [Building from Source](docs/installation/source.en.md)
|
- [Building from Source](docs/installation/source.en.md)
|
||||||
- Configuration
|
- Configuration
|
||||||
- [Overview](docs/config.en.md)
|
- [Overview](docs/config.en.md)
|
||||||
@@ -62,16 +57,14 @@ Read more details in the documentation. You can start from here: [Quick Start](d
|
|||||||
- [OSD Disk Layout](docs/config/layout-osd.en.md)
|
- [OSD Disk Layout](docs/config/layout-osd.en.md)
|
||||||
- [OSD Runtime Parameters](docs/config/osd.en.md)
|
- [OSD Runtime Parameters](docs/config/osd.en.md)
|
||||||
- [Monitor](docs/config/monitor.en.md)
|
- [Monitor](docs/config/monitor.en.md)
|
||||||
- [Security](docs/config/security.en.md)
|
|
||||||
- [Pool configuration](docs/config/pool.en.md)
|
- [Pool configuration](docs/config/pool.en.md)
|
||||||
- [Image metadata in etcd](docs/config/inode.en.md)
|
- [Image metadata in etcd](docs/config/inode.en.md)
|
||||||
- Usage
|
- Usage
|
||||||
- [vitastor-cli](docs/usage/cli.en.md) (command-line interface)
|
- [vitastor-cli](docs/usage/cli.en.md) (command-line interface)
|
||||||
- [vitastor-disk](docs/usage/disk.en.md) (disk management tool)
|
- [vitastor-disk](docs/usage/disk.en.md) (disk management tool)
|
||||||
- [fio](docs/usage/fio.en.md) for benchmarks
|
- [fio](docs/usage/fio.en.md) for benchmarks
|
||||||
- [UBLK](docs/usage/ublk.en.md) for kernel mounts
|
- [NBD](docs/usage/nbd.en.md) for kernel mounts
|
||||||
- [NBD](docs/usage/nbd.en.md) - old interface for kernel mounts
|
- [QEMU and qemu-img](docs/usage/qemu.en.md)
|
||||||
- [QEMU, qemu-img and VDUSE](docs/usage/qemu.en.md)
|
|
||||||
- [NFS](docs/usage/nfs.en.md) clustered file system and pseudo-FS proxy
|
- [NFS](docs/usage/nfs.en.md) clustered file system and pseudo-FS proxy
|
||||||
- [Administration](docs/usage/admin.en.md)
|
- [Administration](docs/usage/admin.en.md)
|
||||||
- Performance
|
- Performance
|
||||||
|
|||||||
+8
-8
@@ -1,5 +1,5 @@
|
|||||||
# Compile stage
|
# Compile stage
|
||||||
FROM golang:trixie AS build
|
FROM golang:bookworm AS build
|
||||||
|
|
||||||
ADD go.sum go.mod /app/
|
ADD go.sum go.mod /app/
|
||||||
RUN cd /app; CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go mod download -x
|
RUN cd /app; CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go mod download -x
|
||||||
@@ -9,7 +9,7 @@ RUN perl -i -e '$/ = undef; while(<>) { s/\n\s*(\{\s*\n)/$1\n/g; s/\}(\s*\n\s*)e
|
|||||||
CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -o vitastor-csi
|
CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -o vitastor-csi
|
||||||
|
|
||||||
# Final stage
|
# Final stage
|
||||||
FROM debian:trixie
|
FROM debian:bookworm
|
||||||
|
|
||||||
LABEL maintainers="Vitaliy Filippov <vitalif@yourcmc.ru>"
|
LABEL maintainers="Vitaliy Filippov <vitalif@yourcmc.ru>"
|
||||||
LABEL description="Vitastor CSI Driver"
|
LABEL description="Vitastor CSI Driver"
|
||||||
@@ -25,20 +25,20 @@ RUN apt-get update && \
|
|||||||
# NFS mount dependencies
|
# NFS mount dependencies
|
||||||
nfs-common netbase \
|
nfs-common netbase \
|
||||||
# dependencies of qemu-storage-daemon
|
# dependencies of qemu-storage-daemon
|
||||||
libaio1t64 libc6 libfuse3-4 libglib2.0-0t64 libgmp10 libgnutls30t64 \
|
libnuma1 liburing2 libglib2.0-0 libfuse3-3 libaio1 libzstd1 libnettle8 \
|
||||||
libhogweed6t64 libnettle8t64 libnuma1 libselinux1 liburing2 libzstd1 zlib1g && \
|
libgmp10 libhogweed6 libp11-kit0 libidn2-0 libunistring2 libtasn1-6 libpcre2-8-0 libffi8 && \
|
||||||
apt-get clean && \
|
apt-get clean && \
|
||||||
(echo options nbd nbds_max=128 > /etc/modprobe.d/nbd.conf)
|
(echo options nbd nbds_max=128 > /etc/modprobe.d/nbd.conf)
|
||||||
|
|
||||||
COPY --from=build /app/vitastor-csi /bin/
|
COPY --from=build /app/vitastor-csi /bin/
|
||||||
|
|
||||||
RUN (echo deb http://vitastor.io/debian trixie main > /etc/apt/sources.list.d/vitastor.list) && \
|
RUN (echo deb http://vitastor.io/debian bookworm main > /etc/apt/sources.list.d/vitastor.list) && \
|
||||||
((echo 'Package: *'; echo 'Pin: origin "vitastor.io"'; echo 'Pin-Priority: 1000') > /etc/apt/preferences.d/vitastor.pref) && \
|
((echo 'Package: *'; echo 'Pin: origin "vitastor.io"'; echo 'Pin-Priority: 1000') > /etc/apt/preferences.d/vitastor.pref) && \
|
||||||
wget -q -O /etc/apt/trusted.gpg.d/vitastor.gpg https://vitastor.io/debian/pubkey.gpg && \
|
wget -q -O /etc/apt/trusted.gpg.d/vitastor.gpg https://vitastor.io/debian/pubkey.gpg && \
|
||||||
apt-get update && \
|
apt-get update && \
|
||||||
apt-get install -y vitastor-client ibverbs-providers && \
|
apt-get install -y vitastor-client && \
|
||||||
wget https://vitastor.io/archive/qemu/qemu-trixie-10.0.2%2Bds-2%2Bvitastor1/qemu-utils_10.0.2%2Bds-2%2Bvitastor1_amd64.deb && \
|
wget https://vitastor.io/archive/qemu/qemu-bookworm-8.1.2%2Bds-1%2Bvitastor1/qemu-utils_8.1.2%2Bds-1%2Bvitastor1_amd64.deb && \
|
||||||
wget https://vitastor.io/archive/qemu/qemu-trixie-10.0.2%2Bds-2%2Bvitastor1/qemu-block-extra_10.0.2%2Bds-2%2Bvitastor1_amd64.deb && \
|
wget https://vitastor.io/archive/qemu/qemu-bookworm-8.1.2%2Bds-1%2Bvitastor1/qemu-block-extra_8.1.2%2Bds-1%2Bvitastor1_amd64.deb && \
|
||||||
dpkg -x qemu-utils*.deb tmp1 && \
|
dpkg -x qemu-utils*.deb tmp1 && \
|
||||||
dpkg -x qemu-block-extra*.deb tmp1 && \
|
dpkg -x qemu-block-extra*.deb tmp1 && \
|
||||||
cp -a tmp1/usr/bin/qemu-storage-daemon /usr/bin/ && \
|
cp -a tmp1/usr/bin/qemu-storage-daemon /usr/bin/ && \
|
||||||
|
|||||||
@@ -1,49 +0,0 @@
|
|||||||
# Compile stage
|
|
||||||
FROM golang:trixie AS build
|
|
||||||
|
|
||||||
ADD go.sum go.mod /app/
|
|
||||||
RUN cd /app; CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go mod download -x
|
|
||||||
ADD . /app
|
|
||||||
RUN perl -i -e '$/ = undef; while(<>) { s/\n\s*(\{\s*\n)/$1\n/g; s/\}(\s*\n\s*)else\b/$1} else/g; print; }' `find /app -name '*.go'` && \
|
|
||||||
cd /app && \
|
|
||||||
CGO_ENABLED=1 GOOS=linux GOARCH=amd64 go build -o vitastor-csi
|
|
||||||
|
|
||||||
# Final stage
|
|
||||||
FROM debian:trixie
|
|
||||||
|
|
||||||
LABEL maintainers="Vitaliy Filippov <vitalif@yourcmc.ru>"
|
|
||||||
LABEL description="Vitastor CSI Driver"
|
|
||||||
|
|
||||||
ENV NODE_ID=""
|
|
||||||
ENV CSI_ENDPOINT=""
|
|
||||||
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get install -y wget && \
|
|
||||||
(echo "APT::Install-Recommends false;" > /etc/apt/apt.conf) && \
|
|
||||||
apt-get update && \
|
|
||||||
apt-get install -y e2fsprogs xfsprogs kmod iproute2 \
|
|
||||||
# NFS mount dependencies
|
|
||||||
nfs-common netbase \
|
|
||||||
# dependencies of qemu-storage-daemon
|
|
||||||
libnuma1 liburing2 libglib2.0-0 libfuse3-3 libaio1 libzstd1 libnettle8 \
|
|
||||||
libgmp10 libhogweed6 libp11-kit0 libidn2-0 libunistring2 libtasn1-6 libpcre2-8-0 libffi8 && \
|
|
||||||
apt-get clean && \
|
|
||||||
(echo options nbd nbds_max=128 > /etc/modprobe.d/nbd.conf)
|
|
||||||
|
|
||||||
COPY --from=build /app/vitastor-csi /bin/
|
|
||||||
|
|
||||||
ADD deb /deb
|
|
||||||
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get -y install /deb/vitastor-client_*.deb && \
|
|
||||||
wget https://vitastor.io/archive/qemu/qemu-trixie-9.2.2%2Bds-1%2Bvitastor4/qemu-utils_9.2.2%2Bds-1%2Bvitastor4_amd64.deb && \
|
|
||||||
wget https://vitastor.io/archive/qemu/qemu-trixie-9.2.2%2Bds-1%2Bvitastor4/qemu-block-extra_9.2.2%2Bds-1%2Bvitastor4_amd64.deb && \
|
|
||||||
dpkg -x qemu-utils*.deb tmp1 && \
|
|
||||||
dpkg -x qemu-block-extra*.deb tmp1 && \
|
|
||||||
cp -a tmp1/usr/bin/qemu-storage-daemon /usr/bin/ && \
|
|
||||||
mkdir -p /usr/lib/x86_64-linux-gnu/qemu && \
|
|
||||||
cp -a tmp1/usr/lib/x86_64-linux-gnu/qemu/block-vitastor.so /usr/lib/x86_64-linux-gnu/qemu/ && \
|
|
||||||
rm -rf tmp1 *.deb && \
|
|
||||||
apt-get clean
|
|
||||||
|
|
||||||
ENTRYPOINT ["/bin/vitastor-csi"]
|
|
||||||
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
VITASTOR_VERSION ?= v3.0.5
|
VITASTOR_VERSION ?= v1.11.0
|
||||||
|
|
||||||
all: build push
|
all: build push
|
||||||
|
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ spec:
|
|||||||
capabilities:
|
capabilities:
|
||||||
add: ["SYS_ADMIN"]
|
add: ["SYS_ADMIN"]
|
||||||
allowPrivilegeEscalation: true
|
allowPrivilegeEscalation: true
|
||||||
image: vitalif/vitastor-csi:v3.0.5
|
image: vitalif/vitastor-csi:v1.11.0
|
||||||
args:
|
args:
|
||||||
- "--node=$(NODE_ID)"
|
- "--node=$(NODE_ID)"
|
||||||
- "--endpoint=$(CSI_ENDPOINT)"
|
- "--endpoint=$(CSI_ENDPOINT)"
|
||||||
|
|||||||
@@ -121,7 +121,7 @@ spec:
|
|||||||
privileged: true
|
privileged: true
|
||||||
capabilities:
|
capabilities:
|
||||||
add: ["SYS_ADMIN"]
|
add: ["SYS_ADMIN"]
|
||||||
image: vitalif/vitastor-csi:v3.0.5
|
image: vitalif/vitastor-csi:v1.11.0
|
||||||
args:
|
args:
|
||||||
- "--node=$(NODE_ID)"
|
- "--node=$(NODE_ID)"
|
||||||
- "--endpoint=$(CSI_ENDPOINT)"
|
- "--endpoint=$(CSI_ENDPOINT)"
|
||||||
|
|||||||
+1
-1
@@ -5,7 +5,7 @@ package vitastor
|
|||||||
|
|
||||||
const (
|
const (
|
||||||
vitastorCSIDriverName = "csi.vitastor.io"
|
vitastorCSIDriverName = "csi.vitastor.io"
|
||||||
vitastorCSIDriverVersion = "3.0.5"
|
vitastorCSIDriverVersion = "1.11.0"
|
||||||
)
|
)
|
||||||
|
|
||||||
// Config struct fills the parameters of request or user input
|
// Config struct fills the parameters of request or user input
|
||||||
|
|||||||
+25
-120
@@ -33,7 +33,7 @@ import (
|
|||||||
type NodeServer struct
|
type NodeServer struct
|
||||||
{
|
{
|
||||||
*Driver
|
*Driver
|
||||||
method MountMethod
|
useVduse bool
|
||||||
stateDir string
|
stateDir string
|
||||||
nfsStageDir string
|
nfsStageDir string
|
||||||
mounter mount.Interface
|
mounter mount.Interface
|
||||||
@@ -81,23 +81,16 @@ func NewNodeServer(driver *Driver) *NodeServer
|
|||||||
}
|
}
|
||||||
ns := &NodeServer{
|
ns := &NodeServer{
|
||||||
Driver: driver,
|
Driver: driver,
|
||||||
method: selectMountMethod(),
|
useVduse: checkVduseSupport(),
|
||||||
stateDir: stateDir,
|
stateDir: stateDir,
|
||||||
nfsStageDir: nfsStageDir,
|
nfsStageDir: nfsStageDir,
|
||||||
mounter: mount.New(""),
|
mounter: mount.New(""),
|
||||||
volumeLocks: make(map[string]bool),
|
volumeLocks: make(map[string]bool),
|
||||||
}
|
}
|
||||||
ns.cond = sync.NewCond(&ns.mu)
|
ns.cond = sync.NewCond(&ns.mu)
|
||||||
if (ns.method == MOUNT_VDUSE)
|
if (ns.useVduse)
|
||||||
{
|
{
|
||||||
ns.restoreVduseDaemons()
|
ns.restoreVduseDaemons()
|
||||||
}
|
|
||||||
else if (ns.method == MOUNT_UBLK)
|
|
||||||
{
|
|
||||||
ns.restoreUblkDaemons()
|
|
||||||
}
|
|
||||||
if (ns.method == MOUNT_VDUSE || ns.method == MOUNT_UBLK)
|
|
||||||
{
|
|
||||||
dur, err := time.ParseDuration(os.Getenv("RESTART_INTERVAL"))
|
dur, err := time.ParseDuration(os.Getenv("RESTART_INTERVAL"))
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
@@ -143,15 +136,8 @@ func (ns *NodeServer) restarter()
|
|||||||
for
|
for
|
||||||
{
|
{
|
||||||
<-ticker.C
|
<-ticker.C
|
||||||
if (ns.method == MOUNT_VDUSE)
|
|
||||||
{
|
|
||||||
ns.restoreVduseDaemons()
|
ns.restoreVduseDaemons()
|
||||||
}
|
}
|
||||||
else if (ns.method == MOUNT_UBLK)
|
|
||||||
{
|
|
||||||
ns.restoreUblkDaemons()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ns *NodeServer) restoreVduseDaemons()
|
func (ns *NodeServer) restoreVduseDaemons()
|
||||||
@@ -245,78 +231,6 @@ func (ns *NodeServer) checkVduseState(stateFile string, devs map[string]interfac
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ns *NodeServer) restoreUblkDaemons()
|
|
||||||
{
|
|
||||||
pattern := ns.stateDir+"vitastor-ublk-*.json"
|
|
||||||
stateFiles, err := filepath.Glob(pattern)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("failed to list %s: %v", pattern, err)
|
|
||||||
}
|
|
||||||
if (len(stateFiles) == 0)
|
|
||||||
{
|
|
||||||
return
|
|
||||||
}
|
|
||||||
for _, stateFile := range stateFiles
|
|
||||||
{
|
|
||||||
deviceNum := stateFile[len(ns.stateDir) + len("vitastor-ublk-") :]
|
|
||||||
deviceNum = deviceNum[0:len(deviceNum)-5]
|
|
||||||
ns.checkUblkState(deviceNum)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (ns *NodeServer) checkUblkState(deviceNum string)
|
|
||||||
{
|
|
||||||
// Check if the ublk daemon is still active
|
|
||||||
|
|
||||||
// Read state file
|
|
||||||
stateFile := ns.stateDir + "vitastor-ublk-" + deviceNum + ".json"
|
|
||||||
stateJSON, err := os.ReadFile(stateFile)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Warningf("error reading state file %v: %v", stateFile, err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var state DeviceState
|
|
||||||
err = json.Unmarshal(stateJSON, &state)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Warningf("state file %v contains invalid JSON (error %v): %v", stateFile, err, string(stateJSON))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Lock volume
|
|
||||||
ns.lockVolume(state.ConfigPath+":block:"+state.Image)
|
|
||||||
defer ns.unlockVolume(state.ConfigPath+":block:"+state.Image)
|
|
||||||
|
|
||||||
// Recheck state file after locking
|
|
||||||
_, err = os.ReadFile(stateFile)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Warningf("state file %v disappeared, skipping volume", stateFile)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if the vitastor-ublk process is still active
|
|
||||||
pidFile := ns.stateDir + "vitastor-ublk-" + deviceNum + ".pid"
|
|
||||||
exists := false
|
|
||||||
proc, err := findByPidFile(pidFile)
|
|
||||||
if (err == nil)
|
|
||||||
{
|
|
||||||
exists = proc.Signal(syscall.Signal(0)) == nil
|
|
||||||
}
|
|
||||||
if (!exists)
|
|
||||||
{
|
|
||||||
// Restart daemon
|
|
||||||
klog.Warningf("recovering UBLK device /dev/ublkb%v for volume %v", deviceNum, state.Image)
|
|
||||||
_, err = mapUblk(ns.stateDir, state.Image, state.ConfigPath, state.Readonly, "/dev/ublkb"+deviceNum)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Warningf("failed to recover ublk device for volume %v: %v", state.Image, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (ns *NodeServer) restoreNfsDaemons()
|
func (ns *NodeServer) restoreNfsDaemons()
|
||||||
{
|
{
|
||||||
pattern := ns.stateDir+"vitastor-nfs-*.json"
|
pattern := ns.stateDir+"vitastor-nfs-*.json"
|
||||||
@@ -503,18 +417,14 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
|
|||||||
}
|
}
|
||||||
|
|
||||||
var devicePath, vdpaId string
|
var devicePath, vdpaId string
|
||||||
if (ns.method == MOUNT_UBLK)
|
if (!ns.useVduse)
|
||||||
{
|
|
||||||
devicePath, err = mapUblk(ns.stateDir, volName, ctxVars["configPath"], false, "")
|
|
||||||
}
|
|
||||||
else if (ns.method == MOUNT_VDUSE)
|
|
||||||
{
|
|
||||||
devicePath, vdpaId, err = mapVduse(ns.stateDir, volName, ctxVars, false)
|
|
||||||
}
|
|
||||||
else /* if (ns.method == MOUNT_NBD) */
|
|
||||||
{
|
{
|
||||||
devicePath, err = mapNbd(volName, ctxVars, false)
|
devicePath, err = mapNbd(volName, ctxVars, false)
|
||||||
}
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
devicePath, vdpaId, err = mapVduse(ns.stateDir, volName, ctxVars, false)
|
||||||
|
}
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -529,8 +439,7 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
|
|||||||
else
|
else
|
||||||
{
|
{
|
||||||
// Check existing format
|
// Check existing format
|
||||||
var existingFormat string
|
existingFormat, err := diskMounter.GetDiskFormat(devicePath)
|
||||||
existingFormat, err = diskMounter.GetDiskFormat(devicePath)
|
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
klog.Errorf("failed to get disk format for path %s, error: %v", err)
|
klog.Errorf("failed to get disk format for path %s, error: %v", err)
|
||||||
@@ -586,6 +495,10 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
|
|||||||
case "xfs":
|
case "xfs":
|
||||||
_, err = systemCombined("xfs_growfs", devicePath)
|
_, err = systemCombined("xfs_growfs", devicePath)
|
||||||
}
|
}
|
||||||
|
if (err != nil)
|
||||||
|
{
|
||||||
|
goto unmap
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
@@ -599,18 +512,14 @@ func (ns *NodeServer) NodeStageVolume(ctx context.Context, req *csi.NodeStageVol
|
|||||||
return &csi.NodeStageVolumeResponse{}, nil
|
return &csi.NodeStageVolumeResponse{}, nil
|
||||||
|
|
||||||
unmap:
|
unmap:
|
||||||
if (ns.method == MOUNT_UBLK)
|
if (!ns.useVduse || len(devicePath) >= 8 && devicePath[0:8] == "/dev/nbd")
|
||||||
{
|
|
||||||
unmapUblk(ns.stateDir, devicePath)
|
|
||||||
}
|
|
||||||
else if (ns.method == MOUNT_VDUSE)
|
|
||||||
{
|
|
||||||
unmapVduseById(ns.stateDir, vdpaId)
|
|
||||||
}
|
|
||||||
else /* if (ns.method == MOUNT_NBD) */
|
|
||||||
{
|
{
|
||||||
unmapNbd(devicePath)
|
unmapNbd(devicePath)
|
||||||
}
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
unmapVduseById(ns.stateDir, vdpaId)
|
||||||
|
}
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -636,7 +545,7 @@ func (ns *NodeServer) NodeUnstageVolume(ctx context.Context, req *csi.NodeUnstag
|
|||||||
defer ns.unlockVolume(ctxVars["configPath"]+":block:"+volName)
|
defer ns.unlockVolume(ctxVars["configPath"]+":block:"+volName)
|
||||||
|
|
||||||
targetPath := req.GetStagingTargetPath()
|
targetPath := req.GetStagingTargetPath()
|
||||||
devicePath, err := GetDeviceNameFromMount(targetPath)
|
devicePath, _, err := mount.GetDeviceNameFromMount(ns.mounter, targetPath)
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
if (os.IsNotExist(err))
|
if (os.IsNotExist(err))
|
||||||
@@ -673,18 +582,14 @@ func (ns *NodeServer) NodeUnstageVolume(ctx context.Context, req *csi.NodeUnstag
|
|||||||
// unmap device
|
// unmap device
|
||||||
if (len(refList) == 0)
|
if (len(refList) == 0)
|
||||||
{
|
{
|
||||||
if (ns.method == MOUNT_UBLK)
|
if (!ns.useVduse)
|
||||||
{
|
|
||||||
unmapUblk(ns.stateDir, devicePath)
|
|
||||||
}
|
|
||||||
else if (ns.method == MOUNT_VDUSE)
|
|
||||||
{
|
|
||||||
unmapVduse(ns.stateDir, devicePath)
|
|
||||||
}
|
|
||||||
else /* if (ns.method == MOUNT_NBD) */
|
|
||||||
{
|
{
|
||||||
unmapNbd(devicePath)
|
unmapNbd(devicePath)
|
||||||
}
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
unmapVduse(ns.stateDir, devicePath)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return &csi.NodeUnstageVolumeResponse{}, nil
|
return &csi.NodeUnstageVolumeResponse{}, nil
|
||||||
@@ -992,7 +897,7 @@ func (ns *NodeServer) NodeUnpublishVolume(ctx context.Context, req *csi.NodeUnpu
|
|||||||
}
|
}
|
||||||
|
|
||||||
targetPath := req.GetTargetPath()
|
targetPath := req.GetTargetPath()
|
||||||
devicePath, err := GetDeviceNameFromMount(targetPath)
|
devicePath, _, err := mount.GetDeviceNameFromMount(ns.mounter, targetPath)
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
if (os.IsNotExist(err))
|
if (os.IsNotExist(err))
|
||||||
|
|||||||
+28
-207
@@ -16,20 +16,10 @@ import (
|
|||||||
"syscall"
|
"syscall"
|
||||||
|
|
||||||
"k8s.io/klog"
|
"k8s.io/klog"
|
||||||
"k8s.io/utils/mount"
|
|
||||||
|
|
||||||
"google.golang.org/grpc/codes"
|
"google.golang.org/grpc/codes"
|
||||||
"google.golang.org/grpc/status"
|
"google.golang.org/grpc/status"
|
||||||
)
|
)
|
||||||
|
|
||||||
type MountMethod int
|
|
||||||
|
|
||||||
const (
|
|
||||||
MOUNT_NBD MountMethod = 0
|
|
||||||
MOUNT_VDUSE MountMethod = 1
|
|
||||||
MOUNT_UBLK MountMethod = 2
|
|
||||||
)
|
|
||||||
|
|
||||||
func Contains(list []string, s string) bool
|
func Contains(list []string, s string) bool
|
||||||
{
|
{
|
||||||
for i := 0; i < len(list); i++
|
for i := 0; i < len(list); i++
|
||||||
@@ -42,53 +32,11 @@ func Contains(list []string, s string) bool
|
|||||||
return false
|
return false
|
||||||
}
|
}
|
||||||
|
|
||||||
func selectMountMethod() MountMethod
|
func checkVduseSupport() bool
|
||||||
{
|
{
|
||||||
// Check UBLK support (ublk_drv kernel module)
|
|
||||||
if (checkModule("ublk_drv"))
|
|
||||||
{
|
|
||||||
klog.Infof("UBLK support enabled successfully")
|
|
||||||
return MOUNT_UBLK
|
|
||||||
}
|
|
||||||
klog.Errorf(
|
|
||||||
"Your host apparently has no UBLK support. UBLK support disabled."+
|
|
||||||
" For UBLK you need at least Linux 6.0 and the ublk_drv kernel module.",
|
|
||||||
)
|
|
||||||
// Check VDUSE support (vdpa, vduse, virtio-vdpa kernel modules)
|
// Check VDUSE support (vdpa, vduse, virtio-vdpa kernel modules)
|
||||||
vduse := true
|
vduse := true
|
||||||
for _, mod := range []string{"vdpa", "vduse", "virtio-vdpa"}
|
for _, mod := range []string{"vdpa", "vduse", "virtio-vdpa"}
|
||||||
{
|
|
||||||
if (!checkModule(mod))
|
|
||||||
{
|
|
||||||
vduse = false
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Check that vdpa tool functions
|
|
||||||
if (vduse)
|
|
||||||
{
|
|
||||||
c := exec.Command("/sbin/vdpa", "-j", "dev")
|
|
||||||
c.Stderr = os.Stderr
|
|
||||||
err := c.Run()
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("/sbin/vdpa -j dev failed: %v", err)
|
|
||||||
vduse = false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (vduse)
|
|
||||||
{
|
|
||||||
klog.Infof("VDUSE support enabled successfully")
|
|
||||||
return MOUNT_VDUSE
|
|
||||||
}
|
|
||||||
klog.Errorf(
|
|
||||||
"Your host apparently has no VDUSE support. VDUSE support disabled, NBD will be used to map devices."+
|
|
||||||
" For VDUSE you need at least Linux 5.15 and the following kernel modules: vdpa, virtio-vdpa, vduse.",
|
|
||||||
)
|
|
||||||
return MOUNT_NBD
|
|
||||||
}
|
|
||||||
|
|
||||||
func checkModule(mod string) bool
|
|
||||||
{
|
{
|
||||||
_, err := os.Stat("/sys/module/"+mod)
|
_, err := os.Stat("/sys/module/"+mod)
|
||||||
if (err != nil)
|
if (err != nil)
|
||||||
@@ -104,10 +52,35 @@ func checkModule(mod string) bool
|
|||||||
if (err != nil)
|
if (err != nil)
|
||||||
{
|
{
|
||||||
klog.Errorf("/sbin/modprobe %s failed: %v", mod, err)
|
klog.Errorf("/sbin/modprobe %s failed: %v", mod, err)
|
||||||
return false
|
vduse = false
|
||||||
|
break
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return true
|
}
|
||||||
|
// Check that vdpa tool functions
|
||||||
|
if (vduse)
|
||||||
|
{
|
||||||
|
c := exec.Command("/sbin/vdpa", "-j", "dev")
|
||||||
|
c.Stderr = os.Stderr
|
||||||
|
err := c.Run()
|
||||||
|
if (err != nil)
|
||||||
|
{
|
||||||
|
klog.Errorf("/sbin/vdpa -j dev failed: %v", err)
|
||||||
|
vduse = false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!vduse)
|
||||||
|
{
|
||||||
|
klog.Errorf(
|
||||||
|
"Your host apparently has no VDUSE support. VDUSE support disabled, NBD will be used to map devices."+
|
||||||
|
" For VDUSE you need at least Linux 5.15 and the following kernel modules: vdpa, virtio-vdpa, vduse.",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
klog.Infof("VDUSE support enabled successfully")
|
||||||
|
}
|
||||||
|
return vduse
|
||||||
}
|
}
|
||||||
|
|
||||||
func mapNbd(volName string, ctxVars map[string]string, readonly bool) (string, error)
|
func mapNbd(volName string, ctxVars map[string]string, readonly bool) (string, error)
|
||||||
@@ -244,7 +217,6 @@ func mapVduse(stateDir string, volName string, ctxVars map[string]string, readon
|
|||||||
stateJSON, _ := json.Marshal(&DeviceState{
|
stateJSON, _ := json.Marshal(&DeviceState{
|
||||||
ConfigPath: ctxVars["configPath"],
|
ConfigPath: ctxVars["configPath"],
|
||||||
VdpaId: vdpaId,
|
VdpaId: vdpaId,
|
||||||
|
|
||||||
Image: volName,
|
Image: volName,
|
||||||
Blockdev: blockdev,
|
Blockdev: blockdev,
|
||||||
Readonly: readonly,
|
Readonly: readonly,
|
||||||
@@ -337,117 +309,6 @@ func unmapVduseById(stateDir, vdpaId string)
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func mapUblk(stateDir string, volName string, configPath string, readonly bool, recoverDev string) (string, error)
|
|
||||||
{
|
|
||||||
pidFile := ""
|
|
||||||
if (recoverDev != "")
|
|
||||||
{
|
|
||||||
if (len(recoverDev) < 10 || recoverDev[0:10] != "/dev/ublkb")
|
|
||||||
{
|
|
||||||
return "", fmt.Errorf("recover: %s does not start with /dev/ublkb", recoverDev)
|
|
||||||
}
|
|
||||||
pidFile = stateDir + "vitastor-ublk-" + recoverDev[10:] + ".pid"
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
pidFd, err := os.CreateTemp(stateDir, "vitastor-tmp-*.pid")
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
pidFile = pidFd.Name()
|
|
||||||
pidFd.Close()
|
|
||||||
}
|
|
||||||
// Map device via vitastor-ublk
|
|
||||||
args := []string{
|
|
||||||
"map", "--image", volName, "--pidfile", pidFile,
|
|
||||||
}
|
|
||||||
if (configPath != "")
|
|
||||||
{
|
|
||||||
args = append(args, "--config_path", configPath)
|
|
||||||
}
|
|
||||||
if (readonly)
|
|
||||||
{
|
|
||||||
args = append(args, "--readonly")
|
|
||||||
}
|
|
||||||
if (recoverDev != "")
|
|
||||||
{
|
|
||||||
args = append(args, "--recover", recoverDev)
|
|
||||||
}
|
|
||||||
stdout, stderr, err := system("/usr/bin/vitastor-ublk", args...)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
devicePath := strings.TrimSpace(string(stdout))
|
|
||||||
if (devicePath == "")
|
|
||||||
{
|
|
||||||
return "", fmt.Errorf("vitastor-ublk did not return the name of the device. output: %s", stderr)
|
|
||||||
}
|
|
||||||
if (len(devicePath) >= 10 && devicePath[0:10] == "/dev/ublkb")
|
|
||||||
{
|
|
||||||
// Generate state file
|
|
||||||
devNum := devicePath[10:]
|
|
||||||
pidNew := stateDir + "vitastor-ublk-" + devNum + ".pid"
|
|
||||||
if (pidFile != pidNew)
|
|
||||||
{
|
|
||||||
err := os.Rename(pidFile, pidNew)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("Failed to rename PID file %s to %s: %v", pidFile, pidNew, err)
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
pidFile = pidNew
|
|
||||||
}
|
|
||||||
}
|
|
||||||
stateFile := stateDir + "vitastor-ublk-" + devNum + ".json"
|
|
||||||
stateJSON, _ := json.Marshal(&DeviceState{
|
|
||||||
ConfigPath: configPath,
|
|
||||||
Image: volName,
|
|
||||||
Readonly: readonly,
|
|
||||||
PidFile: pidFile,
|
|
||||||
})
|
|
||||||
err = os.WriteFile(stateFile, stateJSON, 0600)
|
|
||||||
if (err == nil)
|
|
||||||
{
|
|
||||||
klog.Infof("Attached volume %s via UBLK as %s", volName, devicePath)
|
|
||||||
return devicePath, nil
|
|
||||||
}
|
|
||||||
os.Remove(stateFile)
|
|
||||||
}
|
|
||||||
killErr := killByPidFile(pidFile)
|
|
||||||
if (killErr != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("Failed to kill started vitastor-ublk: %v", killErr)
|
|
||||||
}
|
|
||||||
os.Remove(pidFile)
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
func unmapUblk(stateDir, devicePath string)
|
|
||||||
{
|
|
||||||
if (len(devicePath) < 10 || devicePath[0:10] != "/dev/ublkb")
|
|
||||||
{
|
|
||||||
klog.Errorf("%s does not start with /dev/ublkb", devicePath)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
unmapOut, unmapErr := exec.Command("/usr/bin/vitastor-ublk", "unmap", devicePath).CombinedOutput()
|
|
||||||
if (unmapErr != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("failed to unmap UBLK device %s: %s, error: %v", devicePath, unmapOut, unmapErr)
|
|
||||||
}
|
|
||||||
for _, ext := range []string{"json", "pid"}
|
|
||||||
{
|
|
||||||
fn := stateDir + "vitastor-ublk-" + devicePath[10:] + "." + ext
|
|
||||||
err := os.Remove(fn)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
klog.Errorf("failed to remove %s: %v", fn, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func system(program string, args ...string) ([]byte, []byte, error)
|
func system(program string, args ...string) ([]byte, []byte, error)
|
||||||
{
|
{
|
||||||
klog.Infof("Running "+program+" "+strings.Join(args, " "))
|
klog.Infof("Running "+program+" "+strings.Join(args, " "))
|
||||||
@@ -479,43 +340,3 @@ func systemCombined(program string, args ...string) ([]byte, error)
|
|||||||
}
|
}
|
||||||
return out.Bytes(), nil
|
return out.Bytes(), nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func GetDeviceNameFromMount(mountPath string) (string, error)
|
|
||||||
{
|
|
||||||
// Use /proc/self/mountinfo to correctly parse bind mounts for block device files
|
|
||||||
mps, err := mount.ParseMountInfo("/proc/self/mountinfo")
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
slTarget, err := filepath.EvalSymlinks(mountPath)
|
|
||||||
if (err != nil)
|
|
||||||
{
|
|
||||||
slTarget = mountPath
|
|
||||||
}
|
|
||||||
|
|
||||||
device := ""
|
|
||||||
for _, mp := range mps
|
|
||||||
{
|
|
||||||
if (mp.MountPoint == slTarget)
|
|
||||||
{
|
|
||||||
device = mp.Source
|
|
||||||
if (device[0] != '/' && mp.Root != "/")
|
|
||||||
{
|
|
||||||
// Handle {Source=udev Root=/vdb MountPoint=/var/lib/kubelet/tralaleylo/tralala}
|
|
||||||
for _, other := range mps
|
|
||||||
{
|
|
||||||
if (other.Root == "/" && other.Source == mp.Source)
|
|
||||||
{
|
|
||||||
device = other.MountPoint + mp.Root
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return device, nil
|
|
||||||
}
|
|
||||||
|
|||||||
Vendored
+5
-2
@@ -1,4 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
docker build --build-arg DISTRO=debian --build-arg REL=bookworm -t vitastor-buildenv:bookworm -f vitastor-buildenv.Dockerfile .
|
cat < vitastor.Dockerfile > ../Dockerfile
|
||||||
docker run -it --rm -e REL=bookworm -v `dirname $0`/../:/root/vitastor vitastor-buildenv:bookworm /root/vitastor/debian/vitastor-build.sh
|
cd ..
|
||||||
|
mkdir -p packages
|
||||||
|
sudo podman build --build-arg DISTRO=debian --build-arg REL=bookworm -v `pwd`/packages:/root/packages -f Dockerfile .
|
||||||
|
rm Dockerfile
|
||||||
|
|||||||
Vendored
+5
-2
@@ -1,4 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
docker build --build-arg DISTRO=debian --build-arg REL=bullseye -t vitastor-buildenv:bullseye -f vitastor-buildenv.Dockerfile .
|
cat < vitastor.Dockerfile > ../Dockerfile
|
||||||
docker run -it --rm -e REL=bullseye -v `dirname $0`/../:/root/vitastor vitastor-buildenv:bullseye /root/vitastor/debian/vitastor-build.sh
|
cd ..
|
||||||
|
mkdir -p packages
|
||||||
|
sudo podman build --build-arg DISTRO=debian --build-arg REL=bullseye -v `pwd`/packages:/root/packages -f Dockerfile .
|
||||||
|
rm Dockerfile
|
||||||
|
|||||||
Vendored
+5
-2
@@ -1,4 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
docker build --build-arg DISTRO=debian --build-arg REL=buster -t vitastor-buildenv:buster -f vitastor-buildenv.Dockerfile .
|
cat < vitastor.Dockerfile > ../Dockerfile
|
||||||
docker run -it --rm -e REL=buster -v `dirname $0`/../:/root/vitastor vitastor-buildenv:buster /root/vitastor/debian/vitastor-build.sh
|
cd ..
|
||||||
|
mkdir -p packages
|
||||||
|
sudo podman build --build-arg DISTRO=debian --build-arg REL=buster -v `pwd`/packages:/root/packages -f Dockerfile .
|
||||||
|
rm Dockerfile
|
||||||
|
|||||||
Vendored
-4
@@ -1,4 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
|
|
||||||
docker build --build-arg DISTRO=debian --build-arg REL=trixie -t vitastor-buildenv:trixie -f vitastor-buildenv.Dockerfile .
|
|
||||||
docker run -it --rm -e REL=trixie -v `dirname $0`/../:/root/vitastor vitastor-buildenv:trixie /root/vitastor/debian/vitastor-build.sh
|
|
||||||
+5
-3
@@ -1,5 +1,7 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Ubuntu 22.04 Jammy Jellyfish
|
|
||||||
|
|
||||||
docker build --build-arg DISTRO=ubuntu --build-arg REL=jammy -t vitastor-buildenv:jammy -f vitastor-buildenv.Dockerfile .
|
cat < vitastor.Dockerfile > ../Dockerfile
|
||||||
docker run -it --rm -e REL=jammy -v `dirname $0`/../:/root/vitastor vitastor-buildenv:jammy /root/vitastor/debian/vitastor-build.sh
|
cd ..
|
||||||
|
mkdir -p packages
|
||||||
|
sudo podman build --build-arg DISTRO=ubuntu --build-arg REL=jammy -v `pwd`/packages:/root/packages -f Dockerfile .
|
||||||
|
rm Dockerfile
|
||||||
|
|||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# 24.04 Noble Numbat
|
|
||||||
|
|
||||||
docker build --build-arg DISTRO=ubuntu --build-arg REL=noble -t vitastor-buildenv:noble -f vitastor-buildenv.Dockerfile .
|
|
||||||
docker run -it --rm -e REL=noble -v `dirname $0`/../:/root/vitastor vitastor-buildenv:noble /root/vitastor/debian/vitastor-build.sh
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# 25.10 Questing quokka
|
|
||||||
|
|
||||||
docker build --build-arg DISTRO=ubuntu --build-arg REL=questing -t vitastor-buildenv:questing -f vitastor-buildenv.Dockerfile .
|
|
||||||
docker run -it --rm -e REL=questing -v `dirname $0`/../:/root/vitastor vitastor-buildenv:questing /root/vitastor/debian/vitastor-build.sh
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# 26.04 Resolute Raccoon
|
|
||||||
|
|
||||||
docker build --build-arg DISTRO=ubuntu --build-arg REL=resolute -t vitastor-buildenv:resolute -f vitastor-buildenv.Dockerfile .
|
|
||||||
docker run -it --rm -e REL=resolute -v `dirname $0`/../:/root/vitastor vitastor-buildenv:resolute /root/vitastor/debian/vitastor-build.sh
|
|
||||||
Vendored
+1
-1
@@ -1,4 +1,4 @@
|
|||||||
vitastor (3.0.5-1) unstable; urgency=medium
|
vitastor (1.11.0-1) unstable; urgency=medium
|
||||||
|
|
||||||
* Bugfixes
|
* Bugfixes
|
||||||
|
|
||||||
|
|||||||
Vendored
+3
-3
@@ -2,9 +2,9 @@ Source: vitastor
|
|||||||
Section: admin
|
Section: admin
|
||||||
Priority: optional
|
Priority: optional
|
||||||
Maintainer: Vitaliy Filippov <vitalif@yourcmc.ru>
|
Maintainer: Vitaliy Filippov <vitalif@yourcmc.ru>
|
||||||
Build-Depends: debhelper, g++ (>= 8), libstdc++6 (>= 8),
|
Build-Depends: debhelper, liburing-dev (>= 0.6), g++ (>= 8), libstdc++6 (>= 8),
|
||||||
linux-libc-dev, libgoogle-perftools-dev, libjerasure-dev, libgf-complete-dev, libc-ares-dev,
|
linux-libc-dev, libgoogle-perftools-dev, libjerasure-dev, libgf-complete-dev,
|
||||||
libibverbs-dev, librdmacm-dev, libisal-dev, cmake, pkg-config, libnl-3-dev, libnl-genl-3-dev,
|
libibverbs-dev, libisal-dev, cmake, pkg-config, libnl-3-dev, libnl-genl-3-dev,
|
||||||
node-bindings <!nocheck>, node-gyp, node-nan
|
node-bindings <!nocheck>, node-gyp, node-nan
|
||||||
Standards-Version: 4.5.0
|
Standards-Version: 4.5.0
|
||||||
Homepage: https://vitastor.io/
|
Homepage: https://vitastor.io/
|
||||||
|
|||||||
Vendored
+3
-7
@@ -10,14 +10,10 @@ ARG REL=
|
|||||||
WORKDIR /root
|
WORKDIR /root
|
||||||
|
|
||||||
RUN if [ "$REL" = "buster" -o "$REL" = "bullseye" -o "$REL" = "bookworm" ]; then \
|
RUN if [ "$REL" = "buster" -o "$REL" = "bullseye" -o "$REL" = "bookworm" ]; then \
|
||||||
if [ "$REL" = "buster" ]; then \
|
|
||||||
echo "deb http://archive.debian.org/debian $REL-backports main" >> /etc/apt/sources.list; \
|
|
||||||
else \
|
|
||||||
echo "deb http://deb.debian.org/debian $REL-backports main" >> /etc/apt/sources.list; \
|
echo "deb http://deb.debian.org/debian $REL-backports main" >> /etc/apt/sources.list; \
|
||||||
fi; \
|
|
||||||
echo >> /etc/apt/preferences; \
|
echo >> /etc/apt/preferences; \
|
||||||
echo 'Package: *' >> /etc/apt/preferences; \
|
echo 'Package: *' >> /etc/apt/preferences; \
|
||||||
echo "Pin: release n=$REL-backports" >> /etc/apt/preferences; \
|
echo "Pin: release a=$REL-backports" >> /etc/apt/preferences; \
|
||||||
echo 'Pin-Priority: 500' >> /etc/apt/preferences; \
|
echo 'Pin-Priority: 500' >> /etc/apt/preferences; \
|
||||||
fi; \
|
fi; \
|
||||||
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
||||||
@@ -26,7 +22,7 @@ RUN if [ "$REL" = "buster" -o "$REL" = "bullseye" -o "$REL" = "bookworm" ]; then
|
|||||||
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
||||||
|
|
||||||
RUN apt-get update
|
RUN apt-get update
|
||||||
RUN DEBIAN_FRONTEND=noninteractive TZ=Europe/Moscow apt-get -y install fio libgoogle-perftools-dev devscripts
|
RUN DEBIAN_FRONTEND=noninteractive TZ=Europe/Moscow apt-get -y install fio liburing-dev libgoogle-perftools-dev devscripts
|
||||||
RUN DEBIAN_FRONTEND=noninteractive TZ=Europe/Moscow apt-get -y build-dep qemu
|
RUN DEBIAN_FRONTEND=noninteractive TZ=Europe/Moscow apt-get -y build-dep qemu
|
||||||
# To build a custom version
|
# To build a custom version
|
||||||
#RUN cp /root/packages/qemu-orig/* /root
|
#RUN cp /root/packages/qemu-orig/* /root
|
||||||
@@ -60,7 +56,7 @@ RUN set -e; \
|
|||||||
quilt add block/vitastor.c; \
|
quilt add block/vitastor.c; \
|
||||||
cp /root/qemu_driver.c block/vitastor.c; \
|
cp /root/qemu_driver.c block/vitastor.c; \
|
||||||
quilt refresh; \
|
quilt refresh; \
|
||||||
V=$(head -n1 debian/changelog | perl -pe 's/5\.2\+dfsg-9/5.2+dfsg-11/; s/^.*\((.*?)(\+deb\d+u\d+)?(~bpo[\d\+]*)?\).*$/$1/')+vitastor5; \
|
V=$(head -n1 debian/changelog | perl -pe 's/5\.2\+dfsg-9/5.2+dfsg-11/; s/^.*\((.*?)(~bpo[\d\+]*)?\).*$/$1/')+vitastor4; \
|
||||||
if [ "$REL" = bullseye ]; then V=${V}bullseye; fi; \
|
if [ "$REL" = bullseye ]; then V=${V}bullseye; fi; \
|
||||||
DEBEMAIL="Vitaliy Filippov <vitalif@yourcmc.ru>" dch -D $REL -v $V 'Plug Vitastor block driver'; \
|
DEBEMAIL="Vitaliy Filippov <vitalif@yourcmc.ru>" dch -D $REL -v $V 'Plug Vitastor block driver'; \
|
||||||
DEB_BUILD_OPTIONS=nocheck dpkg-buildpackage --jobs=auto -sa; \
|
DEB_BUILD_OPTIONS=nocheck dpkg-buildpackage --jobs=auto -sa; \
|
||||||
|
|||||||
Vendored
-65
@@ -1,65 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
# To be ran inside buildenv docker
|
|
||||||
|
|
||||||
set -e -x
|
|
||||||
|
|
||||||
[ -e /usr/lib/x86_64-linux-gnu/pkgconfig/libisal.pc ] || cp /root/vitastor/debian/libisal.pc /usr/lib/x86_64-linux-gnu/pkgconfig
|
|
||||||
|
|
||||||
mkdir -p /root/fio-build/
|
|
||||||
cd /root/fio-build/
|
|
||||||
rm -rf /root/fio-build/*
|
|
||||||
dpkg-source -x /root/fio*.dsc
|
|
||||||
|
|
||||||
FULLVER=`head -n1 /root/vitastor/debian/changelog | perl -pe 's/^.*\((.*?)\).*$/$1/'`
|
|
||||||
VER=${FULLVER%%-*}
|
|
||||||
rm -rf /root/vitastor-$VER
|
|
||||||
mkdir /root/vitastor-$VER
|
|
||||||
cd /root/vitastor
|
|
||||||
cp -a $(ls | grep -v packages) /root/vitastor-$VER
|
|
||||||
|
|
||||||
rm -rf /root/vitastor/packages/vitastor-$REL
|
|
||||||
mkdir -p /root/vitastor/packages/vitastor-$REL
|
|
||||||
mv /root/vitastor-$VER /root/vitastor/packages/vitastor-$REL/
|
|
||||||
|
|
||||||
cd /root/vitastor/packages/vitastor-$REL/vitastor-$VER
|
|
||||||
|
|
||||||
rm -rf fio
|
|
||||||
ln -s /root/fio-build/fio-*/ ./fio
|
|
||||||
FIO=`head -n1 fio/debian/changelog | perl -pe 's/^.*\((.*?)\).*$/$1/'`
|
|
||||||
ls /usr/include/linux/raw.h || cp ./debian/raw.h /usr/include/linux/raw.h
|
|
||||||
sh copy-fio-includes.sh
|
|
||||||
rm fio
|
|
||||||
mkdir -p a b debian/patches
|
|
||||||
mv fio-copy b/fio
|
|
||||||
diff -NaurpbB a b > debian/patches/fio-headers.patch || true
|
|
||||||
echo fio-headers.patch >> debian/patches/series
|
|
||||||
rm -rf a b
|
|
||||||
|
|
||||||
echo "dep:fio=$FIO" > debian/fio_version
|
|
||||||
|
|
||||||
cd /root/vitastor/packages/vitastor-$REL/vitastor-$VER
|
|
||||||
mkdir mon/node_modules
|
|
||||||
cd mon/node_modules
|
|
||||||
curl -s https://git.yourcmc.ru/vitalif/antietcd/archive/master.tar.gz | tar -zx
|
|
||||||
curl -s https://git.yourcmc.ru/vitalif/tinyraft/archive/master.tar.gz | tar -zx
|
|
||||||
|
|
||||||
cd /root/vitastor/packages/vitastor-$REL
|
|
||||||
if [[ "$REL" = "trixie" && -e ../vitastor-bookworm/vitastor_$VER.orig.tar.xz ]]; then
|
|
||||||
# Fucking shit, archives differ between bookworm (xz 5.4.1) and trixie (xz 5.8.1)
|
|
||||||
cp ../vitastor-bookworm/vitastor_$VER.orig.tar.xz .
|
|
||||||
else
|
|
||||||
tar --sort=name --mtime='2020-01-01' --owner=0 --group=0 --exclude=debian -cJf vitastor_$VER.orig.tar.xz vitastor-$VER
|
|
||||||
fi
|
|
||||||
cd vitastor-$VER
|
|
||||||
DEBEMAIL="Vitaliy Filippov <vitalif@yourcmc.ru>" dch -D $REL -v "$FULLVER""$REL" "Rebuild for $REL"
|
|
||||||
DEB_BUILD_OPTIONS=nocheck dpkg-buildpackage --jobs=auto -sa
|
|
||||||
rm -rf /root/vitastor/packages/vitastor-$REL/vitastor-*/
|
|
||||||
|
|
||||||
# Why does ubuntu rename debug packages to *.ddeb?
|
|
||||||
cd /root/vitastor/packages/vitastor-$REL
|
|
||||||
if ls *.ddeb >/dev/null; then
|
|
||||||
perl -i -pe 's/\.ddeb/.deb/' *.buildinfo *.changes
|
|
||||||
for i in *.ddeb; do
|
|
||||||
mv $i ${i%%.ddeb}.deb
|
|
||||||
done
|
|
||||||
fi
|
|
||||||
Vendored
-31
@@ -1,31 +0,0 @@
|
|||||||
# Build environment for building Vitastor packages for Debian inside a container
|
|
||||||
# cd ..
|
|
||||||
# docker build --build-arg DISTRO=debian --build-arg REL=bullseye -f debian/vitastor.Dockerfile -t vitastor-buildenv:bullseye .
|
|
||||||
# docker run --rm -e REL=bullseye -v ./:/root/vitastor /root/vitastor/debian/vitastor-build.sh
|
|
||||||
|
|
||||||
ARG DISTRO=debian
|
|
||||||
ARG REL=
|
|
||||||
FROM $DISTRO:$REL
|
|
||||||
ARG DISTRO=debian
|
|
||||||
ARG REL=
|
|
||||||
|
|
||||||
WORKDIR /root
|
|
||||||
|
|
||||||
RUN set -e -x; \
|
|
||||||
if [ "$REL" = "buster" ]; then \
|
|
||||||
perl -i -pe 's/deb.debian.org/archive.debian.org/' /etc/apt/sources.list; \
|
|
||||||
apt-get update; \
|
|
||||||
apt-get -y install wget; \
|
|
||||||
wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg; \
|
|
||||||
echo "deb https://vitastor.io/debian $REL main" >> /etc/apt/sources.list; \
|
|
||||||
fi; \
|
|
||||||
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
|
||||||
perl -i -pe 's/Types: deb$/Types: deb deb-src/' /etc/apt/sources.list.d/*.sources || true; \
|
|
||||||
echo 'APT::Install-Recommends false;' >> /etc/apt/apt.conf; \
|
|
||||||
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
|
||||||
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get -y install fio libgoogle-perftools-dev devscripts libjerasure-dev cmake libc-ares-dev \
|
|
||||||
libibverbs-dev librdmacm-dev libisal-dev libnl-3-dev libnl-genl-3-dev curl nodejs npm node-nan node-bindings && \
|
|
||||||
apt-get -y build-dep fio && \
|
|
||||||
apt-get --download-only source fio
|
|
||||||
Vendored
-1
@@ -2,7 +2,6 @@ usr/bin/vita
|
|||||||
usr/bin/vitastor-cli
|
usr/bin/vitastor-cli
|
||||||
usr/bin/vitastor-rm
|
usr/bin/vitastor-rm
|
||||||
usr/bin/vitastor-nbd
|
usr/bin/vitastor-nbd
|
||||||
usr/bin/vitastor-ublk
|
|
||||||
usr/bin/vitastor-nfs
|
usr/bin/vitastor-nfs
|
||||||
usr/bin/vitastor-kv
|
usr/bin/vitastor-kv
|
||||||
usr/bin/vitastor-kv-stress
|
usr/bin/vitastor-kv-stress
|
||||||
|
|||||||
Vendored
+65
@@ -0,0 +1,65 @@
|
|||||||
|
# Build Vitastor packages for Debian inside a container
|
||||||
|
# cd ..; podman build --build-arg DISTRO=debian --build-arg REL=bullseye -v `pwd`/packages:/root/packages -f debian/vitastor.Dockerfile .
|
||||||
|
|
||||||
|
ARG DISTRO=debian
|
||||||
|
ARG REL=
|
||||||
|
FROM $DISTRO:$REL
|
||||||
|
ARG DISTRO=debian
|
||||||
|
ARG REL=
|
||||||
|
|
||||||
|
WORKDIR /root
|
||||||
|
|
||||||
|
RUN set -e -x; \
|
||||||
|
if [ "$REL" = "buster" ]; then \
|
||||||
|
apt-get update; \
|
||||||
|
apt-get -y install wget; \
|
||||||
|
wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg; \
|
||||||
|
echo "deb https://vitastor.io/debian $REL main" >> /etc/apt/sources.list; \
|
||||||
|
fi; \
|
||||||
|
grep '^deb ' /etc/apt/sources.list | perl -pe 's/^deb/deb-src/' >> /etc/apt/sources.list; \
|
||||||
|
perl -i -pe 's/Types: deb$/Types: deb deb-src/' /etc/apt/sources.list.d/debian.sources || true; \
|
||||||
|
echo 'APT::Install-Recommends false;' >> /etc/apt/apt.conf; \
|
||||||
|
echo 'APT::Install-Suggests false;' >> /etc/apt/apt.conf
|
||||||
|
|
||||||
|
RUN apt-get update && \
|
||||||
|
apt-get -y install fio liburing-dev libgoogle-perftools-dev devscripts libjerasure-dev cmake \
|
||||||
|
libibverbs-dev librdmacm-dev libisal-dev libnl-3-dev libnl-genl-3-dev curl nodejs npm node-nan node-bindings && \
|
||||||
|
apt-get -y build-dep fio && \
|
||||||
|
apt-get --download-only source fio
|
||||||
|
|
||||||
|
ADD . /root/vitastor
|
||||||
|
RUN set -e -x; \
|
||||||
|
[ -e /usr/lib/x86_64-linux-gnu/pkgconfig/libisal.pc ] || cp /root/vitastor/debian/libisal.pc /usr/lib/x86_64-linux-gnu/pkgconfig; \
|
||||||
|
mkdir -p /root/fio-build/; \
|
||||||
|
cd /root/fio-build/; \
|
||||||
|
rm -rf /root/fio-build/*; \
|
||||||
|
dpkg-source -x /root/fio*.dsc; \
|
||||||
|
mkdir -p /root/packages/vitastor-$REL; \
|
||||||
|
rm -rf /root/packages/vitastor-$REL/*; \
|
||||||
|
cd /root/packages/vitastor-$REL; \
|
||||||
|
FULLVER=$(head -n1 /root/vitastor/debian/changelog | perl -pe 's/^.*\((.*?)\).*$/$1/'); \
|
||||||
|
VER=${FULLVER%%-*}; \
|
||||||
|
cp -r /root/vitastor vitastor-$VER; \
|
||||||
|
cd vitastor-$VER; \
|
||||||
|
ln -s /root/fio-build/fio-*/ ./fio; \
|
||||||
|
FIO=$(head -n1 fio/debian/changelog | perl -pe 's/^.*\((.*?)\).*$/$1/'); \
|
||||||
|
ls /usr/include/linux/raw.h || cp ./debian/raw.h /usr/include/linux/raw.h; \
|
||||||
|
sh copy-fio-includes.sh; \
|
||||||
|
rm fio; \
|
||||||
|
mkdir -p a b debian/patches; \
|
||||||
|
mv fio-copy b/fio; \
|
||||||
|
diff -NaurpbB a b > debian/patches/fio-headers.patch || true; \
|
||||||
|
echo fio-headers.patch >> debian/patches/series; \
|
||||||
|
rm -rf a b; \
|
||||||
|
echo "dep:fio=$FIO" > debian/fio_version; \
|
||||||
|
cd /root/packages/vitastor-$REL/vitastor-$VER; \
|
||||||
|
mkdir mon/node_modules; \
|
||||||
|
cd mon/node_modules; \
|
||||||
|
curl -s https://git.yourcmc.ru/vitalif/antietcd/archive/master.tar.gz | tar -zx; \
|
||||||
|
curl -s https://git.yourcmc.ru/vitalif/tinyraft/archive/master.tar.gz | tar -zx; \
|
||||||
|
cd /root/packages/vitastor-$REL; \
|
||||||
|
tar --sort=name --mtime='2020-01-01' --owner=0 --group=0 --exclude=debian -cJf vitastor_$VER.orig.tar.xz vitastor-$VER; \
|
||||||
|
cd vitastor-$VER; \
|
||||||
|
DEBFULLNAME="Vitaliy Filippov <vitalif@yourcmc.ru>" dch -D $REL -v "$FULLVER""$REL" "Rebuild for $REL"; \
|
||||||
|
DEB_BUILD_OPTIONS=nocheck dpkg-buildpackage --jobs=auto -sa; \
|
||||||
|
rm -rf /root/packages/vitastor-$REL/vitastor-*/
|
||||||
+2
-2
@@ -1,9 +1,9 @@
|
|||||||
# Build Docker image with Vitastor packages
|
# Build Docker image with Vitastor packages
|
||||||
|
|
||||||
FROM debian:trixie
|
FROM debian:bookworm
|
||||||
|
|
||||||
ADD etc/apt /etc/apt/
|
ADD etc/apt /etc/apt/
|
||||||
RUN apt-get update && apt-get -y install vitastor ibverbs-providers udev systemd qemu-system-x86 qemu-system-common qemu-block-extra qemu-utils jq nfs-common && apt-get clean
|
RUN apt-get update && apt-get -y install vitastor qemu-system-x86 qemu-system-common qemu-block-extra qemu-utils jq nfs-common && apt-get clean
|
||||||
ADD sleep.sh /usr/bin/
|
ADD sleep.sh /usr/bin/
|
||||||
ADD install.sh /usr/bin/
|
ADD install.sh /usr/bin/
|
||||||
ADD scripts /opt/scripts/
|
ADD scripts /opt/scripts/
|
||||||
|
|||||||
+2
-2
@@ -1,9 +1,9 @@
|
|||||||
VITASTOR_VERSION ?= v3.0.5
|
VITASTOR_VERSION ?= v1.11.0
|
||||||
|
|
||||||
all: build push
|
all: build push
|
||||||
|
|
||||||
build:
|
build:
|
||||||
@docker build --no-cache --rm -t vitalif/vitastor:$(VITASTOR_VERSION) .
|
@docker build --rm -t vitalif/vitastor:$(VITASTOR_VERSION) .
|
||||||
|
|
||||||
push:
|
push:
|
||||||
@docker push vitalif/vitastor:$(VITASTOR_VERSION)
|
@docker push vitalif/vitastor:$(VITASTOR_VERSION)
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
Package: *
|
|
||||||
Pin: release n=trixie-backports
|
|
||||||
Pin-Priority: 500
|
|
||||||
@@ -1,2 +1 @@
|
|||||||
deb http://vitastor.io/debian trixie main
|
deb http://vitastor.io/debian bookworm main
|
||||||
#deb http://http.debian.net/debian/ trixie-backports main
|
|
||||||
|
|||||||
@@ -7,8 +7,8 @@ PartOf=vitastor.target
|
|||||||
[Service]
|
[Service]
|
||||||
Restart=always
|
Restart=always
|
||||||
EnvironmentFile=/etc/vitastor/docker.conf
|
EnvironmentFile=/etc/vitastor/docker.conf
|
||||||
ExecStart=bash -c 'docker run --rm -i -v /etc/vitastor:/etc/vitastor -v /dev:/dev -v /run:/run -e SYSTEMD_IN_CHROOT=0 \
|
ExecStart=bash -c 'docker run --rm -i -v /etc/vitastor:/etc/vitastor -v /dev:/dev \
|
||||||
--security-opt seccomp=unconfined --privileged --pid=host --log-driver none --network host --name vitastor vitastor:$VITASTOR_VERSION \
|
--privileged --log-driver none --network host --name vitastor vitastor:$VITASTOR_VERSION \
|
||||||
sleep.sh'
|
sleep.sh'
|
||||||
ExecStartPost=udevadm trigger
|
ExecStartPost=udevadm trigger
|
||||||
ExecStop=docker stop vitastor
|
ExecStop=docker stop vitastor
|
||||||
|
|||||||
@@ -12,8 +12,7 @@ EnvironmentFile=/etc/vitastor/docker.conf
|
|||||||
SyslogIdentifier=vitastor-osd%i
|
SyslogIdentifier=vitastor-osd%i
|
||||||
ExecStart=bash -c 'docker run --rm -i -v /etc/vitastor:/etc/vitastor -v /dev:/dev \
|
ExecStart=bash -c 'docker run --rm -i -v /etc/vitastor:/etc/vitastor -v /dev:/dev \
|
||||||
$(for i in $(ls /dev/vitastor/osd%i-*); do echo --device $i:$i; done) \
|
$(for i in $(ls /dev/vitastor/osd%i-*); do echo --device $i:$i; done) \
|
||||||
--log-driver none --network host --ulimit nofile=1048576 --ulimit memlock=-1 \
|
--log-driver none --network host --ulimit nofile=1048576 --ulimit memlock=-1 $CONTAINER_OPTIONS --name vitastor-osd%i \
|
||||||
--security-opt seccomp=unconfined $CONTAINER_OPTIONS --name vitastor-osd%i \
|
|
||||||
vitastor:$VITASTOR_VERSION vitastor-disk exec-osd /dev/vitastor/osd%i-data'
|
vitastor:$VITASTOR_VERSION vitastor-disk exec-osd /dev/vitastor/osd%i-data'
|
||||||
ExecStartPre=+docker exec vitastor vitastor-disk pre-exec /dev/vitastor/osd%i-data
|
ExecStartPre=+docker exec vitastor vitastor-disk pre-exec /dev/vitastor/osd%i-data
|
||||||
ExecStop=docker stop vitastor-etcd%i
|
ExecStop=docker stop vitastor-etcd%i
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
#
|
#
|
||||||
|
|
||||||
# Desired Vitastor version
|
# Desired Vitastor version
|
||||||
VITASTOR_VERSION=v3.0.5
|
VITASTOR_VERSION=1.11.0
|
||||||
|
|
||||||
# Additional arguments for all containers
|
# Additional arguments for all containers
|
||||||
# For example, you may want to specify a custom logging driver here
|
# For example, you may want to specify a custom logging driver here
|
||||||
|
|||||||
+3
-2
@@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
cp -urv /etc/systemd/system/vitastor* /host-etc/systemd/system/
|
cp -urv /etc/default /host-etc/
|
||||||
cp -urv /etc/udev/rules.d /host-etc/udev/
|
cp -urv /etc/systemd /host-etc/
|
||||||
|
cp -urv /etc/udev /host-etc/
|
||||||
cp -urnv /etc/vitastor /host-etc/
|
cp -urnv /etc/vitastor /host-etc/
|
||||||
cp -urnv /opt/scripts/* /host-bin/
|
cp -urnv /opt/scripts/* /host-bin/
|
||||||
|
|||||||
@@ -38,4 +38,3 @@ In the future, additional configuration methods may be added:
|
|||||||
- [OSD Disk Layout](config/layout-osd.en.md)
|
- [OSD Disk Layout](config/layout-osd.en.md)
|
||||||
- [OSD Runtime Parameters](config/osd.en.md)
|
- [OSD Runtime Parameters](config/osd.en.md)
|
||||||
- [Monitor](config/monitor.en.md)
|
- [Monitor](config/monitor.en.md)
|
||||||
- [Security Parameters](config/security.en.md)
|
|
||||||
|
|||||||
@@ -41,4 +41,3 @@
|
|||||||
- [Дисковые параметры OSD](config/layout-osd.ru.md)
|
- [Дисковые параметры OSD](config/layout-osd.ru.md)
|
||||||
- [Прочие параметры OSD](config/osd.ru.md)
|
- [Прочие параметры OSD](config/osd.ru.md)
|
||||||
- [Параметры мониторов](config/monitor.ru.md)
|
- [Параметры мониторов](config/monitor.ru.md)
|
||||||
- [Параметры безопасности](config/security.ru.md)
|
|
||||||
|
|||||||
@@ -13,7 +13,6 @@ affect their interaction with the cluster.
|
|||||||
- [client_retry_interval](#client_retry_interval)
|
- [client_retry_interval](#client_retry_interval)
|
||||||
- [client_eio_retry_interval](#client_eio_retry_interval)
|
- [client_eio_retry_interval](#client_eio_retry_interval)
|
||||||
- [client_retry_enospc](#client_retry_enospc)
|
- [client_retry_enospc](#client_retry_enospc)
|
||||||
- [client_wait_up_timeout](#client_wait_up_timeout)
|
|
||||||
- [client_max_dirty_bytes](#client_max_dirty_bytes)
|
- [client_max_dirty_bytes](#client_max_dirty_bytes)
|
||||||
- [client_max_dirty_ops](#client_max_dirty_ops)
|
- [client_max_dirty_ops](#client_max_dirty_ops)
|
||||||
- [client_enable_writeback](#client_enable_writeback)
|
- [client_enable_writeback](#client_enable_writeback)
|
||||||
@@ -24,10 +23,6 @@ affect their interaction with the cluster.
|
|||||||
- [nbd_max_devices](#nbd_max_devices)
|
- [nbd_max_devices](#nbd_max_devices)
|
||||||
- [nbd_max_part](#nbd_max_part)
|
- [nbd_max_part](#nbd_max_part)
|
||||||
- [osd_nearfull_ratio](#osd_nearfull_ratio)
|
- [osd_nearfull_ratio](#osd_nearfull_ratio)
|
||||||
- [hostname](#hostname)
|
|
||||||
- [ublk_queue_depth](#ublk_queue_depth)
|
|
||||||
- [ublk_max_io_size](#ublk_max_io_size)
|
|
||||||
- [qemu_file_mirror_path](#qemu_file_mirror_path)
|
|
||||||
|
|
||||||
## client_iothread_count
|
## client_iothread_count
|
||||||
|
|
||||||
@@ -75,19 +70,6 @@ and clients are not blocked and just get EIO error code instead.
|
|||||||
Retry writes on out of space errors to wait until some space is freed on
|
Retry writes on out of space errors to wait until some space is freed on
|
||||||
OSDs.
|
OSDs.
|
||||||
|
|
||||||
## client_wait_up_timeout
|
|
||||||
|
|
||||||
- Type: seconds
|
|
||||||
- Default: 16
|
|
||||||
- Can be changed online: yes
|
|
||||||
|
|
||||||
Wait for this number of seconds until PGs are up when doing operations
|
|
||||||
which require all PGs to be up. Currently only used by object listings
|
|
||||||
in delete and merge-based commands ([vitastor-cli rm](../usage/cli.en.md#rm), merge and so on).
|
|
||||||
|
|
||||||
The default value is calculated as `1 + OSD lease timeout`, which is
|
|
||||||
`1 + etcd_report_interval + max_etcd_attempts*2*etcd_quick_timeout`.
|
|
||||||
|
|
||||||
## client_max_dirty_bytes
|
## client_max_dirty_bytes
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
@@ -219,37 +201,3 @@ just one OSD becomes 100 % full!
|
|||||||
However, unlike in Ceph, 100 % full Vitastor OSDs don't crash (in Ceph they're
|
However, unlike in Ceph, 100 % full Vitastor OSDs don't crash (in Ceph they're
|
||||||
unable to start at all), so you'll be able to recover from "out of space" errors
|
unable to start at all), so you'll be able to recover from "out of space" errors
|
||||||
without destroying and recreating OSDs.
|
without destroying and recreating OSDs.
|
||||||
|
|
||||||
## hostname
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
- Can be changed online: yes
|
|
||||||
|
|
||||||
Clients use host name to find their distance to OSDs when [localized reads](pool.en.md#local_reads)
|
|
||||||
are enabled. By default, standard [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html)
|
|
||||||
function is used to determine host name, but you can also override it with this parameter.
|
|
||||||
|
|
||||||
## ublk_queue_depth
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 256
|
|
||||||
|
|
||||||
Default queue depth for [Vitastor ublk servers](../usage/ublk.en.md).
|
|
||||||
|
|
||||||
## ublk_max_io_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
|
|
||||||
Default maximum I/O size for Vitastor [ublk servers](../usage/ublk.en.md).
|
|
||||||
The largest of 1 MB and pool block size multiplied by EC data chunk count is used if not specified.
|
|
||||||
|
|
||||||
## qemu_file_mirror_path
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
When set to an FS directory path (for example, `/mnt/vitastor/`), `qemu-img info` and similar
|
|
||||||
QAPI commands return the name of the image inside this directory instead of normal
|
|
||||||
`vitastor://?image=abc` URI as `filename`.
|
|
||||||
|
|
||||||
This allows to then mount this path using [vitastor-nfs](../usage/nfs.en.md) and trick
|
|
||||||
third-party systems like Veeam which rely on `filename` in the image info but don't support Vitastor.
|
|
||||||
|
|||||||
@@ -13,7 +13,6 @@
|
|||||||
- [client_retry_interval](#client_retry_interval)
|
- [client_retry_interval](#client_retry_interval)
|
||||||
- [client_eio_retry_interval](#client_eio_retry_interval)
|
- [client_eio_retry_interval](#client_eio_retry_interval)
|
||||||
- [client_retry_enospc](#client_retry_enospc)
|
- [client_retry_enospc](#client_retry_enospc)
|
||||||
- [client_wait_up_timeout](#client_wait_up_timeout)
|
|
||||||
- [client_max_dirty_bytes](#client_max_dirty_bytes)
|
- [client_max_dirty_bytes](#client_max_dirty_bytes)
|
||||||
- [client_max_dirty_ops](#client_max_dirty_ops)
|
- [client_max_dirty_ops](#client_max_dirty_ops)
|
||||||
- [client_enable_writeback](#client_enable_writeback)
|
- [client_enable_writeback](#client_enable_writeback)
|
||||||
@@ -24,10 +23,6 @@
|
|||||||
- [nbd_max_devices](#nbd_max_devices)
|
- [nbd_max_devices](#nbd_max_devices)
|
||||||
- [nbd_max_part](#nbd_max_part)
|
- [nbd_max_part](#nbd_max_part)
|
||||||
- [osd_nearfull_ratio](#osd_nearfull_ratio)
|
- [osd_nearfull_ratio](#osd_nearfull_ratio)
|
||||||
- [hostname](#hostname)
|
|
||||||
- [ublk_queue_depth](#ublk_queue_depth)
|
|
||||||
- [ublk_max_io_size](#ublk_max_io_size)
|
|
||||||
- [qemu_file_mirror_path](#qemu_file_mirror_path)
|
|
||||||
|
|
||||||
## client_iothread_count
|
## client_iothread_count
|
||||||
|
|
||||||
@@ -77,19 +72,6 @@ RDMA и хотите повысить пиковую производитель
|
|||||||
Повторять запросы записи, завершившиеся с ошибками нехватки места, т.е.
|
Повторять запросы записи, завершившиеся с ошибками нехватки места, т.е.
|
||||||
ожидать, пока на OSD не освободится место.
|
ожидать, пока на OSD не освободится место.
|
||||||
|
|
||||||
## client_wait_up_timeout
|
|
||||||
|
|
||||||
- Тип: секунды
|
|
||||||
- Значение по умолчанию: 16
|
|
||||||
- Можно менять на лету: да
|
|
||||||
|
|
||||||
Время ожидания поднятия PG при операциях, требующих активности всех PG.
|
|
||||||
В данный момент используется листингами объектов в командах, использующих
|
|
||||||
удаление и слияние ([vitastor-cli rm](../usage/cli.ru.md#rm), merge и подобные).
|
|
||||||
|
|
||||||
Значение по умолчанию вычисляется как `1 + время lease OSD`, равное
|
|
||||||
`1 + etcd_report_interval + max_etcd_attempts*2*etcd_quick_timeout`.
|
|
||||||
|
|
||||||
## client_max_dirty_bytes
|
## client_max_dirty_bytes
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
@@ -223,40 +205,3 @@ RDMA и хотите повысить пиковую производитель
|
|||||||
заполненные на 100% OSD вообще не могут стартовать), так что вы сможете
|
заполненные на 100% OSD вообще не могут стартовать), так что вы сможете
|
||||||
восстановить работу кластера после ошибок отсутствия свободного места
|
восстановить работу кластера после ошибок отсутствия свободного места
|
||||||
без уничтожения и пересоздания OSD.
|
без уничтожения и пересоздания OSD.
|
||||||
|
|
||||||
## hostname
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
- Можно менять на лету: да
|
|
||||||
|
|
||||||
Клиенты используют имя хоста для определения расстояния до OSD, когда включены
|
|
||||||
[локальные чтения](pool.ru.md#local_reads). По умолчанию для определения имени
|
|
||||||
хоста используется стандартная функция [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html),
|
|
||||||
но вы также можете задать имя хоста вручную данным параметром.
|
|
||||||
|
|
||||||
## ublk_queue_depth
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 256
|
|
||||||
|
|
||||||
Глубина очереди по умолчанию для [ublk-серверов Vitastor](../usage/ublk.ru.md).
|
|
||||||
|
|
||||||
## ublk_max_io_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
|
|
||||||
Максимальный размер запроса ввода-вывода для [ublk-серверов Vitastor](../usage/ublk.ru.md).
|
|
||||||
Если не задан, используется максимум из 1 МБ и размера блока пула, умноженного на число частей
|
|
||||||
данных EC-пула.
|
|
||||||
|
|
||||||
## qemu_file_mirror_path
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Если установить эту опцию равной пути к каталогу в ФС, команда `qemu-img info` и подобные
|
|
||||||
команды QAPI будут возвращать в поле `filename` имя образа внутри заданного каталога вместо
|
|
||||||
обычного адреса типа `vitastor://?image=abc`.
|
|
||||||
|
|
||||||
Это позволяет смонтировать этот путь с помощью [vitastor-nfs](../usage/nfs.ru.md) и обмануть
|
|
||||||
сторонние системы типа Veeam, которые полагаются на поле `filename` в информации об образе QEMU,
|
|
||||||
но не поддерживают Vitastor.
|
|
||||||
|
|||||||
@@ -9,7 +9,6 @@
|
|||||||
These parameters apply to OSDs, are fixed at the moment of OSD drive
|
These parameters apply to OSDs, are fixed at the moment of OSD drive
|
||||||
initialization and can't be changed after it without losing data.
|
initialization and can't be changed after it without losing data.
|
||||||
|
|
||||||
- [meta_format](#meta_format)
|
|
||||||
- [data_device](#data_device)
|
- [data_device](#data_device)
|
||||||
- [meta_device](#meta_device)
|
- [meta_device](#meta_device)
|
||||||
- [journal_device](#journal_device)
|
- [journal_device](#journal_device)
|
||||||
@@ -28,21 +27,6 @@ initialization and can't be changed after it without losing data.
|
|||||||
- [data_csum_type](#data_csum_type)
|
- [data_csum_type](#data_csum_type)
|
||||||
- [csum_block_size](#csum_block_size)
|
- [csum_block_size](#csum_block_size)
|
||||||
|
|
||||||
## meta_format
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 3
|
|
||||||
|
|
||||||
OSD store implementation version and on-disk metadata format.
|
|
||||||
|
|
||||||
Three versions are currently supported: 3, 2 and 1.
|
|
||||||
- 3 the new log-structured store, it's overall faster, has lower Write
|
|
||||||
Amplification, which may be even close to 1 (i.e. almost no extra writes)
|
|
||||||
if your SSDs support atomic writes (see [atomic_write_size](osd.en.md#atomic_write_size)).
|
|
||||||
- 2 is the old stable store from Vitastor 0.9-2.x.
|
|
||||||
- 1 is the same old store but with a legacy metadata format from Vitastor
|
|
||||||
versions to up 0.8.x, without any support for checksums.
|
|
||||||
|
|
||||||
## data_device
|
## data_device
|
||||||
|
|
||||||
- Type: string
|
- Type: string
|
||||||
@@ -198,14 +182,8 @@ put a modified value into etcd key /vitastor/config/global.
|
|||||||
- Type: string
|
- Type: string
|
||||||
- Default: none
|
- Default: none
|
||||||
|
|
||||||
Data and metadata checksum type to use. May be "crc32c", "xxh3_32" or "none".
|
Data checksum type to use. May be "crc32c" or "none". Set to "crc32c" to
|
||||||
Select crc32c or xxh3_32 and set csum_block_size to enable data checksums.
|
enable data checksums.
|
||||||
|
|
||||||
Both crc32c and xxh3_32 are almost equally fast, xxh3_32 is safer. xxh3_32 is
|
|
||||||
the xxhash3 algorithm truncated from 64 to 32 bits (which is still a good hash).
|
|
||||||
|
|
||||||
Note that enabled data checksums either increase memory usage or reduce
|
|
||||||
performance. Check details in [csum_block_size](#csum_block_size) description.
|
|
||||||
|
|
||||||
## csum_block_size
|
## csum_block_size
|
||||||
|
|
||||||
|
|||||||
@@ -10,7 +10,6 @@
|
|||||||
дисковые параметры, задаются в момент инициализации дисков OSD и не могут быть
|
дисковые параметры, задаются в момент инициализации дисков OSD и не могут быть
|
||||||
изменены после этого без потери данных.
|
изменены после этого без потери данных.
|
||||||
|
|
||||||
- [meta_format](#meta_format)
|
|
||||||
- [data_device](#data_device)
|
- [data_device](#data_device)
|
||||||
- [meta_device](#meta_device)
|
- [meta_device](#meta_device)
|
||||||
- [journal_device](#journal_device)
|
- [journal_device](#journal_device)
|
||||||
@@ -29,23 +28,6 @@
|
|||||||
- [data_csum_type](#data_csum_type)
|
- [data_csum_type](#data_csum_type)
|
||||||
- [csum_block_size](#csum_block_size)
|
- [csum_block_size](#csum_block_size)
|
||||||
|
|
||||||
## meta_format
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 3
|
|
||||||
|
|
||||||
Версия реализации дискового хранилища OSD и дискового формата метаданных.
|
|
||||||
|
|
||||||
Поддерживаются три версии: 3, 2 и 1.
|
|
||||||
- 3 - новое лог-структурированное хранилище, в целом более быстрое, со
|
|
||||||
сниженным фактором амплификации записи, который может составлять около 1
|
|
||||||
(то есть, практически без лишней служебной записи), если ваши SSD
|
|
||||||
поддерживают атомарную запись (см. [atomic_write_size](osd.ru.md#atomic_write_size)).
|
|
||||||
- 2 - старое стабильное хранилище из версий Vitastor 0.9-2.x.
|
|
||||||
- 1 - то же самое стабильное хранилище, но с ещё более старым форматом
|
|
||||||
метаданных из версий Vitastor до 0.8.x, без какой-либо поддержки
|
|
||||||
контрольных сумм.
|
|
||||||
|
|
||||||
## data_device
|
## data_device
|
||||||
|
|
||||||
- Тип: строка
|
- Тип: строка
|
||||||
@@ -209,12 +191,8 @@ journal_block_size и meta_block_size. Однако на данный момен
|
|||||||
- Тип: строка
|
- Тип: строка
|
||||||
- Значение по умолчанию: none
|
- Значение по умолчанию: none
|
||||||
|
|
||||||
Тип используемых OSD контрольных сумм данных и метаданных. Может быть "crc32c",
|
Тип используемых OSD контрольных сумм данных. Может быть "crc32c" или "none".
|
||||||
"xxh3_32" или "none". Выберите crc32c или xxh3_32 и установите csum_block_size,
|
Установите в "crc32c", чтобы включить расчёт и проверку контрольных сумм данных.
|
||||||
чтобы включить контрольные суммы данных.
|
|
||||||
|
|
||||||
И crc32c, и xxh3_32 примерно одинаково быстры, xxh3_32 надёжней. xxh3_32 - это
|
|
||||||
алгоритм xxhash3, обрезанный с 64 до 32 бит (это всё равно хороший хеш).
|
|
||||||
|
|
||||||
Следует понимать, что контрольные суммы в зависимости от размера блока их
|
Следует понимать, что контрольные суммы в зависимости от размера блока их
|
||||||
расчёта либо увеличивают потребление памяти, либо снижают производительность.
|
расчёта либо увеличивают потребление памяти, либо снижают производительность.
|
||||||
|
|||||||
@@ -74,13 +74,13 @@ Grafana dashboard suitable for this exporter is here: [Vitastor-Grafana-6+.json]
|
|||||||
- Type: integer
|
- Type: integer
|
||||||
- Default: 8060
|
- Default: 8060
|
||||||
|
|
||||||
HTTP port for monitors to listen to (including metrics exporter)
|
HTTP port for monitors to listen on (including metrics exporter)
|
||||||
|
|
||||||
## mon_http_ip
|
## mon_http_ip
|
||||||
|
|
||||||
- Type: string
|
- Type: string
|
||||||
|
|
||||||
IP address for monitors to listen to (all addresses by default)
|
IP address for monitors to listen on (all addresses by default)
|
||||||
|
|
||||||
## mon_https_cert
|
## mon_https_cert
|
||||||
|
|
||||||
|
|||||||
+54
-132
@@ -9,11 +9,9 @@
|
|||||||
These parameters apply to clients and OSDs and affect network connection logic
|
These parameters apply to clients and OSDs and affect network connection logic
|
||||||
between clients, OSDs and etcd.
|
between clients, OSDs and etcd.
|
||||||
|
|
||||||
- [osd_network](#osd_network)
|
- [tcp_header_buffer_size](#tcp_header_buffer_size)
|
||||||
- [osd_cluster_network](#osd_cluster_network)
|
- [use_sync_send_recv](#use_sync_send_recv)
|
||||||
- [use_rdma](#use_rdma)
|
- [use_rdma](#use_rdma)
|
||||||
- [use_rdmacm](#use_rdmacm)
|
|
||||||
- [disable_tcp](#disable_tcp)
|
|
||||||
- [rdma_device](#rdma_device)
|
- [rdma_device](#rdma_device)
|
||||||
- [rdma_port_num](#rdma_port_num)
|
- [rdma_port_num](#rdma_port_num)
|
||||||
- [rdma_gid_index](#rdma_gid_index)
|
- [rdma_gid_index](#rdma_gid_index)
|
||||||
@@ -22,6 +20,7 @@ between clients, OSDs and etcd.
|
|||||||
- [rdma_max_msg](#rdma_max_msg)
|
- [rdma_max_msg](#rdma_max_msg)
|
||||||
- [rdma_max_recv](#rdma_max_recv)
|
- [rdma_max_recv](#rdma_max_recv)
|
||||||
- [rdma_max_send](#rdma_max_send)
|
- [rdma_max_send](#rdma_max_send)
|
||||||
|
- [rdma_odp](#rdma_odp)
|
||||||
- [peer_connect_interval](#peer_connect_interval)
|
- [peer_connect_interval](#peer_connect_interval)
|
||||||
- [peer_connect_timeout](#peer_connect_timeout)
|
- [peer_connect_timeout](#peer_connect_timeout)
|
||||||
- [osd_idle_timeout](#osd_idle_timeout)
|
- [osd_idle_timeout](#osd_idle_timeout)
|
||||||
@@ -31,63 +30,38 @@ between clients, OSDs and etcd.
|
|||||||
- [etcd_slow_timeout](#etcd_slow_timeout)
|
- [etcd_slow_timeout](#etcd_slow_timeout)
|
||||||
- [etcd_keepalive_timeout](#etcd_keepalive_timeout)
|
- [etcd_keepalive_timeout](#etcd_keepalive_timeout)
|
||||||
- [etcd_ws_keepalive_interval](#etcd_ws_keepalive_interval)
|
- [etcd_ws_keepalive_interval](#etcd_ws_keepalive_interval)
|
||||||
- [etcd_min_reload_interval](#etcd_min_reload_interval)
|
|
||||||
- [tcp_header_buffer_size](#tcp_header_buffer_size)
|
|
||||||
- [min_zerocopy_send_size](#min_zerocopy_send_size)
|
|
||||||
- [use_sync_send_recv](#use_sync_send_recv)
|
|
||||||
|
|
||||||
## osd_network
|
## tcp_header_buffer_size
|
||||||
|
|
||||||
- Type: string or array of strings
|
- Type: integer
|
||||||
|
- Default: 65536
|
||||||
|
|
||||||
Network mask of public OSD network(s) (IPv4 or IPv6). Each OSD listens to all
|
Size of the buffer used to read data using an additional copy. Vitastor
|
||||||
addresses of UP + RUNNING interfaces matching one of these networks, on the
|
packet headers are 128 bytes, payload is always at least 4 KB, so it is
|
||||||
same port. Port is auto-selected except if [bind_port](osd.en.md#bind_port) is
|
usually beneficial to try to read multiple packets at once even though
|
||||||
explicitly specified. Bind address(es) may also be overridden manually by
|
it requires to copy the data an additional time. The rest of each packet
|
||||||
specifying [bind_address](osd.en.md#bind_address). If OSD networks are not specified
|
is received without an additional copy. You can try to play with this
|
||||||
at all, OSD just listens to a wildcard address (0.0.0.0).
|
parameter and see how it affects random iops and linear bandwidth if you
|
||||||
|
want.
|
||||||
|
|
||||||
## osd_cluster_network
|
## use_sync_send_recv
|
||||||
|
|
||||||
- Type: string or array of strings
|
- Type: boolean
|
||||||
|
- Default: false
|
||||||
|
|
||||||
Network mask of separate network(s) (IPv4 or IPv6) to use for OSD
|
If true, synchronous send/recv syscalls are used instead of io_uring for
|
||||||
cluster connections. I.e. OSDs will always attempt to use these networks
|
socket communication. Useless for OSDs because they require io_uring anyway,
|
||||||
to connect to other OSDs, while clients will attempt to use networks from
|
but may be required for clients with old kernel versions.
|
||||||
[osd_network](#osd_network).
|
|
||||||
|
|
||||||
## use_rdma
|
## use_rdma
|
||||||
|
|
||||||
- Type: boolean
|
- Type: boolean
|
||||||
- Default: true
|
- Default: true
|
||||||
|
|
||||||
Try to use RDMA through libibverbs for communication if it's available.
|
Try to use RDMA for communication if it's available. Disable if you don't
|
||||||
Disable if you don't want Vitastor to use RDMA. TCP-only clients can also
|
want Vitastor to use RDMA. TCP-only clients can also talk to an RDMA-enabled
|
||||||
talk to an RDMA-enabled cluster, so disabling RDMA may be needed if clients
|
cluster, so disabling RDMA may be needed if clients have RDMA devices,
|
||||||
have RDMA devices, but they are not connected to the cluster.
|
but they are not connected to the cluster.
|
||||||
|
|
||||||
`use_rdma` works with RoCEv1/RoCEv2 networks, but not with iWARP and,
|
|
||||||
maybe, with some Infiniband configurations which require RDMA-CM.
|
|
||||||
Consider `use_rdmacm` for such networks.
|
|
||||||
|
|
||||||
## use_rdmacm
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
- Default: false
|
|
||||||
|
|
||||||
Use an alternative implementation of RDMA through RDMA-CM (Connection
|
|
||||||
Manager). Works with all RDMA networks: Infiniband, iWARP and
|
|
||||||
RoCEv1/RoCEv2, and even allows to disable TCP and run only with RDMA.
|
|
||||||
OSDs always use random port numbers for RDMA-CM listeners, different
|
|
||||||
from their TCP ports. `use_rdma` is automatically disabled when
|
|
||||||
`use_rdmacm` is enabled.
|
|
||||||
|
|
||||||
## disable_tcp
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
- Default: true
|
|
||||||
|
|
||||||
Fully disable TCP and only use RDMA-CM for OSD communication.
|
|
||||||
|
|
||||||
## rdma_device
|
## rdma_device
|
||||||
|
|
||||||
@@ -101,6 +75,11 @@ found or if `osd_network` is not specified. Auto-selection is also
|
|||||||
unsupported with old libibverbs < v32, like in Debian 10 Buster or
|
unsupported with old libibverbs < v32, like in Debian 10 Buster or
|
||||||
CentOS 7.
|
CentOS 7.
|
||||||
|
|
||||||
|
Vitastor supports all adapters, even ones without ODP support, like
|
||||||
|
Mellanox ConnectX-3 and non-Mellanox cards. Versions up to Vitastor
|
||||||
|
1.2.0 required ODP which is only present in Mellanox ConnectX >= 4.
|
||||||
|
See also [rdma_odp](#rdma_odp).
|
||||||
|
|
||||||
Run `ibv_devinfo -v` as root to list available RDMA devices and their
|
Run `ibv_devinfo -v` as root to list available RDMA devices and their
|
||||||
features.
|
features.
|
||||||
|
|
||||||
@@ -110,33 +89,15 @@ the manual of your network vendor for details about setting up the switch
|
|||||||
for RoCEv2 correctly. Usually it means setting up Lossless Ethernet with
|
for RoCEv2 correctly. Usually it means setting up Lossless Ethernet with
|
||||||
PFC (Priority Flow Control) and ECN (Explicit Congestion Notification).
|
PFC (Priority Flow Control) and ECN (Explicit Congestion Notification).
|
||||||
|
|
||||||
Vitastor supports all adapters, even ones without ODP (On-Demand Paging)
|
|
||||||
support, like Mellanox ConnectX-3 and non-Mellanox cards. ODP is only present
|
|
||||||
in Mellanox ConnectX >= 4 adapters and allows to skip memory registration
|
|
||||||
for RDMA and thus, in theory, avoid memory copying.
|
|
||||||
|
|
||||||
Versions up to Vitastor 1.2.0 required ODP, then it was disabled by default,
|
|
||||||
but it was still supported up to 3.0.3. Now ODP support is removed because it
|
|
||||||
actually only hurts performance: an example 3-node cluster with 8 NVMe in each
|
|
||||||
node and 2*25 GBit/s ConnectX-6 RDMA network pushed 3950000 read iops without
|
|
||||||
ODP, but only 239000 iops with ODP.
|
|
||||||
|
|
||||||
This happens because Mellanox ODP implementation seems to be based on
|
|
||||||
message retransmissions when the adapter doesn't know about the buffer yet -
|
|
||||||
it likely uses standard "RNR retransmissions" (RNR = receiver not ready)
|
|
||||||
which is generally slow in RDMA/RoCE networks. Here's a presentation about
|
|
||||||
it from ISPASS-2021 conference: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
|
||||||
|
|
||||||
## rdma_port_num
|
## rdma_port_num
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
|
- Default: 1
|
||||||
|
|
||||||
RDMA device port number to use. Only for devices that have more than 1 port.
|
RDMA device port number to use. Only for devices that have more than 1 port.
|
||||||
See `phys_port_cnt` in `ibv_devinfo -v` output to determine how many ports
|
See `phys_port_cnt` in `ibv_devinfo -v` output to determine how many ports
|
||||||
your device has.
|
your device has.
|
||||||
|
|
||||||
Not relevant for RDMA-CM (use_rdmacm).
|
|
||||||
|
|
||||||
## rdma_gid_index
|
## rdma_gid_index
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
@@ -152,14 +113,13 @@ GID auto-selection is unsupported with libibverbs < v32.
|
|||||||
|
|
||||||
A correct rdma_gid_index for RoCEv2 is usually 1 (IPv6) or 3 (IPv4).
|
A correct rdma_gid_index for RoCEv2 is usually 1 (IPv6) or 3 (IPv4).
|
||||||
|
|
||||||
Not relevant for RDMA-CM (use_rdmacm).
|
|
||||||
|
|
||||||
## rdma_mtu
|
## rdma_mtu
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
|
- Default: 4096
|
||||||
|
|
||||||
RDMA Path MTU to use. Must be 1024, 2048 or 4096. Default is to use the
|
RDMA Path MTU to use. Must be 1024, 2048 or 4096. There is usually no
|
||||||
RDMA device's MTU.
|
sense to change it from the default 4096.
|
||||||
|
|
||||||
## rdma_max_sge
|
## rdma_max_sge
|
||||||
|
|
||||||
@@ -198,6 +158,28 @@ less than `rdma_max_recv` so the receiving side doesn't run out of buffers.
|
|||||||
Doesn't affect memory usage - additional memory isn't allocated for send
|
Doesn't affect memory usage - additional memory isn't allocated for send
|
||||||
operations.
|
operations.
|
||||||
|
|
||||||
|
## rdma_odp
|
||||||
|
|
||||||
|
- Type: boolean
|
||||||
|
- Default: false
|
||||||
|
|
||||||
|
Use RDMA with On-Demand Paging. ODP is currently only available on Mellanox
|
||||||
|
ConnectX-4 and newer adapters. ODP allows to not register memory explicitly
|
||||||
|
for RDMA adapter to be able to use it. This, in turn, allows to skip memory
|
||||||
|
copying during sending. One would think this should improve performance, but
|
||||||
|
**in reality** RDMA performance with ODP is **drastically** worse. Example
|
||||||
|
3-node cluster with 8 NVMe in each node and 2*25 GBit/s ConnectX-6 RDMA network
|
||||||
|
without ODP pushes 3950000 read iops, but only 239000 iops with ODP...
|
||||||
|
|
||||||
|
This happens because Mellanox ODP implementation seems to be based on
|
||||||
|
message retransmissions when the adapter doesn't know about the buffer yet -
|
||||||
|
it likely uses standard "RNR retransmissions" (RNR = receiver not ready)
|
||||||
|
which is generally slow in RDMA/RoCE networks. Here's a presentation about
|
||||||
|
it from ISPASS-2021 conference: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
||||||
|
|
||||||
|
ODP support is retained in the code just in case a good ODP implementation
|
||||||
|
appears one day.
|
||||||
|
|
||||||
## peer_connect_interval
|
## peer_connect_interval
|
||||||
|
|
||||||
- Type: seconds
|
- Type: seconds
|
||||||
@@ -279,63 +261,3 @@ etcd_report_interval to guarantee that keepalive actually works.
|
|||||||
|
|
||||||
etcd websocket ping interval required to keep the connection alive and
|
etcd websocket ping interval required to keep the connection alive and
|
||||||
detect disconnections quickly.
|
detect disconnections quickly.
|
||||||
|
|
||||||
## etcd_min_reload_interval
|
|
||||||
|
|
||||||
- Type: milliseconds
|
|
||||||
- Default: 1000
|
|
||||||
- Can be changed online: yes
|
|
||||||
|
|
||||||
Minimum interval for full etcd state reload. Introduced to prevent
|
|
||||||
excessive load on etcd during outages when etcd can't keep up with event
|
|
||||||
streams and cancels them.
|
|
||||||
|
|
||||||
## tcp_header_buffer_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 65536
|
|
||||||
|
|
||||||
Size of the buffer used to read data using an additional copy. Vitastor
|
|
||||||
packet headers are 128 bytes, payload is always at least 4 KB, so it is
|
|
||||||
usually beneficial to try to read multiple packets at once even though
|
|
||||||
it requires to copy the data an additional time. The rest of each packet
|
|
||||||
is received without an additional copy. You can try to play with this
|
|
||||||
parameter and see how it affects random iops and linear bandwidth if you
|
|
||||||
want.
|
|
||||||
|
|
||||||
## min_zerocopy_send_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 32768
|
|
||||||
|
|
||||||
OSDs and clients will attempt to use io_uring-based zero-copy TCP send
|
|
||||||
for buffers larger than this number of bytes. Zero-copy send with io_uring is
|
|
||||||
supported since Linux kernel version 6.1. Support is auto-detected and disabled
|
|
||||||
automatically when not available. It can also be disabled explicitly by setting
|
|
||||||
this parameter to a negative value.
|
|
||||||
|
|
||||||
⚠️ Warning! Zero-copy send performance may vary greatly from CPU to CPU and from
|
|
||||||
one kernel version to another. Generally, it tends to only make benefit with larger
|
|
||||||
messages. With smaller messages (say, 4 KB), it may actually be slower. 32 KB is
|
|
||||||
enough for almost all CPUs, but even smaller values are optimal for some of them.
|
|
||||||
For example, 4 KB is OK for EPYC Milan/Genoa and 12 KB is OK for Xeon Ice Lake
|
|
||||||
(but verify it yourself please).
|
|
||||||
|
|
||||||
Verification instructions:
|
|
||||||
1. Add `iommu=pt` into your Linux kernel command line and reboot.
|
|
||||||
2. Upgrade your kernel. For example, it's very important to use 6.11+ with recent AMD EPYCs.
|
|
||||||
3. Run some tests with the [send-zerocopy liburing example](https://github.com/axboe/liburing/blob/master/examples/send-zerocopy.c)
|
|
||||||
to find the minimal message size for which zero-copy is optimal.
|
|
||||||
Use `./send-zerocopy tcp -4 -R` at the server side and
|
|
||||||
`time ./send-zerocopy tcp -4 -b 0 -s BUFFER_SIZE -D SERVER_IP` at the client side with
|
|
||||||
`-z 0` (no zero-copy) and `-z 1` (zero-copy), and compare MB/s and used CPU time
|
|
||||||
(user+system).
|
|
||||||
|
|
||||||
## use_sync_send_recv
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
- Default: false
|
|
||||||
|
|
||||||
If true, synchronous send/recv syscalls are used instead of io_uring for
|
|
||||||
socket communication. Useless for OSDs because they require io_uring anyway,
|
|
||||||
but may be required for clients with old kernel versions.
|
|
||||||
|
|||||||
+58
-134
@@ -9,11 +9,9 @@
|
|||||||
Данные параметры используются клиентами и OSD и влияют на логику сетевого
|
Данные параметры используются клиентами и OSD и влияют на логику сетевого
|
||||||
взаимодействия между клиентами, OSD, а также etcd.
|
взаимодействия между клиентами, OSD, а также etcd.
|
||||||
|
|
||||||
- [osd_network](#osd_network)
|
- [tcp_header_buffer_size](#tcp_header_buffer_size)
|
||||||
- [osd_cluster_network](#osd_cluster_network)
|
- [use_sync_send_recv](#use_sync_send_recv)
|
||||||
- [use_rdma](#use_rdma)
|
- [use_rdma](#use_rdma)
|
||||||
- [use_rdmacm](#use_rdmacm)
|
|
||||||
- [disable_tcp](#disable_tcp)
|
|
||||||
- [rdma_device](#rdma_device)
|
- [rdma_device](#rdma_device)
|
||||||
- [rdma_port_num](#rdma_port_num)
|
- [rdma_port_num](#rdma_port_num)
|
||||||
- [rdma_gid_index](#rdma_gid_index)
|
- [rdma_gid_index](#rdma_gid_index)
|
||||||
@@ -22,6 +20,7 @@
|
|||||||
- [rdma_max_msg](#rdma_max_msg)
|
- [rdma_max_msg](#rdma_max_msg)
|
||||||
- [rdma_max_recv](#rdma_max_recv)
|
- [rdma_max_recv](#rdma_max_recv)
|
||||||
- [rdma_max_send](#rdma_max_send)
|
- [rdma_max_send](#rdma_max_send)
|
||||||
|
- [rdma_odp](#rdma_odp)
|
||||||
- [peer_connect_interval](#peer_connect_interval)
|
- [peer_connect_interval](#peer_connect_interval)
|
||||||
- [peer_connect_timeout](#peer_connect_timeout)
|
- [peer_connect_timeout](#peer_connect_timeout)
|
||||||
- [osd_idle_timeout](#osd_idle_timeout)
|
- [osd_idle_timeout](#osd_idle_timeout)
|
||||||
@@ -31,63 +30,41 @@
|
|||||||
- [etcd_slow_timeout](#etcd_slow_timeout)
|
- [etcd_slow_timeout](#etcd_slow_timeout)
|
||||||
- [etcd_keepalive_timeout](#etcd_keepalive_timeout)
|
- [etcd_keepalive_timeout](#etcd_keepalive_timeout)
|
||||||
- [etcd_ws_keepalive_interval](#etcd_ws_keepalive_interval)
|
- [etcd_ws_keepalive_interval](#etcd_ws_keepalive_interval)
|
||||||
- [etcd_min_reload_interval](#etcd_min_reload_interval)
|
|
||||||
- [tcp_header_buffer_size](#tcp_header_buffer_size)
|
|
||||||
- [min_zerocopy_send_size](#min_zerocopy_send_size)
|
|
||||||
- [use_sync_send_recv](#use_sync_send_recv)
|
|
||||||
|
|
||||||
## osd_network
|
## tcp_header_buffer_size
|
||||||
|
|
||||||
- Тип: строка или массив строк
|
- Тип: целое число
|
||||||
|
- Значение по умолчанию: 65536
|
||||||
|
|
||||||
Маски подсетей (IPv4 или IPv6) публичной сети или сетей OSD. Каждый OSD слушает
|
Размер буфера для чтения данных с дополнительным копированием. Пакеты
|
||||||
один и тот же порт на всех адресах поднятых (UP + RUNNING) сетевых интерфейсов,
|
Vitastor содержат 128-байтные заголовки, за которыми следуют данные размером
|
||||||
соответствующих одной из указанных сетей. Порт выбирается автоматически, если
|
от 4 КБ и для мелких операций ввода-вывода обычно выгодно за 1 вызов читать
|
||||||
только [bind_port](osd.ru.md#bind_port) не задан явно. Адреса для подключений можно
|
сразу несколько пакетов, даже не смотря на то, что это требует лишний раз
|
||||||
также переопределить явно, задав [bind_address](osd.ru.md#bind_address). Если сети OSD
|
скопировать данные. Часть каждого пакета за пределами значения данного
|
||||||
не заданы вообще, OSD слушает все адреса (0.0.0.0).
|
параметра читается без дополнительного копирования. Вы можете попробовать
|
||||||
|
поменять этот параметр и посмотреть, как он влияет на производительность
|
||||||
|
случайного и линейного доступа.
|
||||||
|
|
||||||
## osd_cluster_network
|
## use_sync_send_recv
|
||||||
|
|
||||||
- Тип: строка или массив строк
|
- Тип: булево (да/нет)
|
||||||
|
- Значение по умолчанию: false
|
||||||
|
|
||||||
Маски подсетей (IPv4 или IPv6) отдельной кластерной сети или сетей OSD.
|
Если установлено в истину, то вместо io_uring для передачи данных по сети
|
||||||
То есть, OSD будут всегда стараться использовать эти сети для соединений
|
будут использоваться обычные синхронные системные вызовы send/recv. Для OSD
|
||||||
с другими OSD, а клиенты будут стараться использовать сети из [osd_network](#osd_network).
|
это бессмысленно, так как OSD в любом случае нуждается в io_uring, но, в
|
||||||
|
принципе, это может применяться для клиентов со старыми версиями ядра.
|
||||||
|
|
||||||
## use_rdma
|
## use_rdma
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
- Тип: булево (да/нет)
|
||||||
- Значение по умолчанию: true
|
- Значение по умолчанию: true
|
||||||
|
|
||||||
Попробовать использовать RDMA через libibverbs для связи при наличии
|
Пытаться использовать RDMA для связи при наличии доступных устройств.
|
||||||
доступных устройств. Отключите, если вы не хотите, чтобы Vitastor
|
Отключите, если вы не хотите, чтобы Vitastor использовал RDMA.
|
||||||
использовал RDMA. TCP-клиенты также могут работать с RDMA-кластером,
|
TCP-клиенты также могут работать с RDMA-кластером, так что отключать
|
||||||
так что отключать RDMA может быть нужно, только если у клиентов есть
|
RDMA может быть нужно только если у клиентов есть RDMA-устройства,
|
||||||
RDMA-устройства, но они не имеют соединения с кластером Vitastor.
|
но они не имеют соединения с кластером Vitastor.
|
||||||
|
|
||||||
`use_rdma` работает с RoCEv1/RoCEv2 сетями, но не работает с iWARP и
|
|
||||||
может не работать с частью конфигураций Infiniband, требующих RDMA-CM.
|
|
||||||
Рассмотрите включение `use_rdmacm` для таких сетей.
|
|
||||||
|
|
||||||
## use_rdmacm
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
- Значение по умолчанию: false
|
|
||||||
|
|
||||||
Использовать альтернативную реализацию RDMA на основе RDMA-CM (Connection
|
|
||||||
Manager). Работает со всеми типами RDMA-сетей: Infiniband, iWARP и
|
|
||||||
RoCEv1/RoCEv2, и даже позволяет полностью отключить TCP и работать
|
|
||||||
только на RDMA. OSD используют случайные номера портов для ожидания
|
|
||||||
соединений через RDMA-CM, отличающиеся от их TCP-портов. Также при
|
|
||||||
включении `use_rdmacm` автоматически отключается опция `use_rdma`.
|
|
||||||
|
|
||||||
## disable_tcp
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
- Значение по умолчанию: true
|
|
||||||
|
|
||||||
Полностью отключить TCP и использовать только RDMA-CM для соединений с OSD.
|
|
||||||
|
|
||||||
## rdma_device
|
## rdma_device
|
||||||
|
|
||||||
@@ -100,6 +77,12 @@ RoCEv1/RoCEv2, и даже позволяет полностью отключи
|
|||||||
не задана. Также автовыбор не поддерживается со старыми версиями библиотеки
|
не задана. Также автовыбор не поддерживается со старыми версиями библиотеки
|
||||||
libibverbs < v32, например в Debian 10 Buster или CentOS 7.
|
libibverbs < v32, например в Debian 10 Buster или CentOS 7.
|
||||||
|
|
||||||
|
Vitastor поддерживает все модели адаптеров, включая те, у которых
|
||||||
|
нет поддержки ODP, то есть вы можете использовать RDMA с ConnectX-3 и
|
||||||
|
картами производства не Mellanox. Версии Vitastor до 1.2.0 включительно
|
||||||
|
требовали ODP, который есть только на Mellanox ConnectX 4 и более новых.
|
||||||
|
См. также [rdma_odp](#rdma_odp).
|
||||||
|
|
||||||
Запустите `ibv_devinfo -v` от имени суперпользователя, чтобы посмотреть
|
Запустите `ibv_devinfo -v` от имени суперпользователя, чтобы посмотреть
|
||||||
список доступных RDMA-устройств, их параметры и возможности.
|
список доступных RDMA-устройств, их параметры и возможности.
|
||||||
|
|
||||||
@@ -110,35 +93,16 @@ libibverbs < v32, например в Debian 10 Buster или CentOS 7.
|
|||||||
подразумевает настройку сети без потерь на основе PFC (Priority Flow
|
подразумевает настройку сети без потерь на основе PFC (Priority Flow
|
||||||
Control) и ECN (Explicit Congestion Notification).
|
Control) и ECN (Explicit Congestion Notification).
|
||||||
|
|
||||||
Vitastor поддерживает все модели адаптеров, включая те, у которых нет
|
|
||||||
поддержки ODP (On-Demand Paging), например, ConnectX-3 и карты производства
|
|
||||||
не Mellanox. Функция ODP доступна только на адаптерах Mellanox ConnectX-4 и
|
|
||||||
более новых и позволяет не регистрировать память для её использования RDMA-картой,
|
|
||||||
благодаря чему в теории можно избежать лишних копирований памяти.
|
|
||||||
|
|
||||||
Версии Vitastor до 1.2.0 включительно требовали ODP, потом функция был отключена
|
|
||||||
по умолчанию, но поддерживалась вплоть до версии 3.0.3. Сейчас поддержка ODP
|
|
||||||
полностью удалена, так как на самом деле она только портит производительность:
|
|
||||||
например, на 3-узловом кластере с 8 NVMe в каждом узле и сетью 2*25 Гбит/с на
|
|
||||||
чтение с RDMA без ODP удаётся снять 3950000 iops, а с ODP - всего 239000 iops.
|
|
||||||
|
|
||||||
Это происходит из-за того, что реализация ODP у Mellanox неоптимальная и
|
|
||||||
основана на повторной передаче сообщений, когда карте не известен буфер -
|
|
||||||
вероятно, на стандартных "RNR retransmission" (RNR = receiver not ready).
|
|
||||||
А данные повторные передачи в RDMA/RoCE - всегда очень медленная штука.
|
|
||||||
Презентация на эту тему с конференции ISPASS-2021: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
|
||||||
|
|
||||||
## rdma_port_num
|
## rdma_port_num
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
|
- Значение по умолчанию: 1
|
||||||
|
|
||||||
Номер порта RDMA-устройства, который следует использовать. Имеет смысл
|
Номер порта RDMA-устройства, который следует использовать. Имеет смысл
|
||||||
только для устройств, у которых более 1 порта. Чтобы узнать, сколько портов
|
только для устройств, у которых более 1 порта. Чтобы узнать, сколько портов
|
||||||
у вашего адаптера, посмотрите `phys_port_cnt` в выводе команды
|
у вашего адаптера, посмотрите `phys_port_cnt` в выводе команды
|
||||||
`ibv_devinfo -v`.
|
`ibv_devinfo -v`.
|
||||||
|
|
||||||
Опция неприменима к RDMA-CM (use_rdmacm).
|
|
||||||
|
|
||||||
## rdma_gid_index
|
## rdma_gid_index
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
@@ -155,14 +119,13 @@ libibverbs < v32.
|
|||||||
|
|
||||||
Правильный rdma_gid_index для RoCEv2, как правило, 1 (IPv6) или 3 (IPv4).
|
Правильный rdma_gid_index для RoCEv2, как правило, 1 (IPv6) или 3 (IPv4).
|
||||||
|
|
||||||
Опция неприменима к RDMA-CM (use_rdmacm).
|
|
||||||
|
|
||||||
## rdma_mtu
|
## rdma_mtu
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
|
- Значение по умолчанию: 4096
|
||||||
|
|
||||||
Максимальная единица передачи (Path MTU) для RDMA. Должно быть равно 1024,
|
Максимальная единица передачи (Path MTU) для RDMA. Должно быть равно 1024,
|
||||||
2048 или 4096. По умолчанию используется значение MTU RDMA-устройства.
|
2048 или 4096. Обычно нет смысла менять значение по умолчанию, равное 4096.
|
||||||
|
|
||||||
## rdma_max_sge
|
## rdma_max_sge
|
||||||
|
|
||||||
@@ -203,6 +166,29 @@ OSD в любом случае согласовывают реальное зн
|
|||||||
Не влияет на потребление памяти - дополнительная память на операции отправки
|
Не влияет на потребление памяти - дополнительная память на операции отправки
|
||||||
не выделяется.
|
не выделяется.
|
||||||
|
|
||||||
|
## rdma_odp
|
||||||
|
|
||||||
|
- Тип: булево (да/нет)
|
||||||
|
- Значение по умолчанию: false
|
||||||
|
|
||||||
|
Использовать RDMA с On-Demand Paging. ODP - функция, доступная пока что
|
||||||
|
исключительно на адаптерах Mellanox ConnectX-4 и более новых. ODP позволяет
|
||||||
|
не регистрировать память для её использования RDMA-картой. Благодаря этому
|
||||||
|
можно не копировать данные при отправке их в сеть и, казалось бы, это должно
|
||||||
|
улучшать производительность - но **по факту** получается так, что
|
||||||
|
производительность только ухудшается, причём сильно. Пример - на 3-узловом
|
||||||
|
кластере с 8 NVMe в каждом узле и сетью 2*25 Гбит/с на чтение с RDMA без ODP
|
||||||
|
удаётся снять 3950000 iops, а с ODP - всего 239000 iops...
|
||||||
|
|
||||||
|
Это происходит из-за того, что реализация ODP у Mellanox неоптимальная и
|
||||||
|
основана на повторной передаче сообщений, когда карте не известен буфер -
|
||||||
|
вероятно, на стандартных "RNR retransmission" (RNR = receiver not ready).
|
||||||
|
А данные повторные передачи в RDMA/RoCE - всегда очень медленная штука.
|
||||||
|
Презентация на эту тему с конференции ISPASS-2021: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
||||||
|
|
||||||
|
Возможность использования ODP сохранена в коде на случай, если вдруг в один
|
||||||
|
прекрасный день появится хорошая реализация ODP.
|
||||||
|
|
||||||
## peer_connect_interval
|
## peer_connect_interval
|
||||||
|
|
||||||
- Тип: секунды
|
- Тип: секунды
|
||||||
@@ -285,65 +271,3 @@ etcd_report_interval, чтобы keepalive гарантированно рабо
|
|||||||
- Можно менять на лету: да
|
- Можно менять на лету: да
|
||||||
|
|
||||||
Интервал проверки живости вебсокет-подключений к etcd.
|
Интервал проверки живости вебсокет-подключений к etcd.
|
||||||
|
|
||||||
## etcd_min_reload_interval
|
|
||||||
|
|
||||||
- Тип: миллисекунды
|
|
||||||
- Значение по умолчанию: 1000
|
|
||||||
- Можно менять на лету: да
|
|
||||||
|
|
||||||
Минимальный интервал полной перезагрузки состояния из etcd. Добавлено для
|
|
||||||
предотвращения избыточной нагрузки на etcd во время отказов, когда etcd не
|
|
||||||
успевает рассылать потоки событий и отменяет их.
|
|
||||||
|
|
||||||
## tcp_header_buffer_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 65536
|
|
||||||
|
|
||||||
Размер буфера для чтения данных с дополнительным копированием. Пакеты
|
|
||||||
Vitastor содержат 128-байтные заголовки, за которыми следуют данные размером
|
|
||||||
от 4 КБ и для мелких операций ввода-вывода обычно выгодно за 1 вызов читать
|
|
||||||
сразу несколько пакетов, даже не смотря на то, что это требует лишний раз
|
|
||||||
скопировать данные. Часть каждого пакета за пределами значения данного
|
|
||||||
параметра читается без дополнительного копирования. Вы можете попробовать
|
|
||||||
поменять этот параметр и посмотреть, как он влияет на производительность
|
|
||||||
случайного и линейного доступа.
|
|
||||||
|
|
||||||
## min_zerocopy_send_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 32768
|
|
||||||
|
|
||||||
OSD и клиенты будут пробовать использовать TCP-отправку без копирования (zero-copy) на
|
|
||||||
основе io_uring для буферов, больших, чем это число байт. Отправка без копирования
|
|
||||||
поддерживается в io_uring, начиная с версии ядра Linux 6.1. Наличие поддержки
|
|
||||||
проверяется автоматически и zero-copy отключается, когда поддержки нет. Также
|
|
||||||
её можно отключить явно, установив данный параметр в отрицательное значение.
|
|
||||||
|
|
||||||
⚠️ Внимание! Производительность данной функции может сильно отличаться на разных
|
|
||||||
процессорах и на разных версиях ядра Linux. В целом, zero-copy обычно быстрее с
|
|
||||||
большими сообщениями, а с мелкими (например, 4 КБ) zero-copy может быть даже
|
|
||||||
медленнее. 32 КБ достаточно почти для всех процессоров, но для каких-то можно
|
|
||||||
использовать даже меньшие значения. Например, для EPYC Milan/Genoa подходит 4 КБ,
|
|
||||||
а для Xeon Ice Lake - 12 КБ (но, пожалуйста, перепроверьте это сами).
|
|
||||||
|
|
||||||
Инструкция по проверке:
|
|
||||||
1. Добавьте `iommu=pt` в командную строку загрузки вашего ядра Linux и перезагрузитесь.
|
|
||||||
2. Обновите ядро. Например, для AMD EPYC очень важно использовать версию 6.11+.
|
|
||||||
3. Позапускайте тесты с помощью [send-zerocopy из примеров liburing](https://github.com/axboe/liburing/blob/master/examples/send-zerocopy.c),
|
|
||||||
чтобы найти минимальный размер сообщения, для которого zero-copy отправка оптимальна.
|
|
||||||
Запускайте `./send-zerocopy tcp -4 -R` на стороне сервера и
|
|
||||||
`time ./send-zerocopy tcp -4 -b 0 -s РАЗМЕР_БУФЕРА -D АДРЕС_СЕРВЕРА` на стороне клиента
|
|
||||||
с опцией `-z 0` (обычная отправка) и `-z 1` (отправка без копирования), и сравнивайте
|
|
||||||
скорость в МБ/с и занятое процессорное время (user+system).
|
|
||||||
|
|
||||||
## use_sync_send_recv
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
- Значение по умолчанию: false
|
|
||||||
|
|
||||||
Если установлено в истину, то вместо io_uring для передачи данных по сети
|
|
||||||
будут использоваться обычные синхронные системные вызовы send/recv. Для OSD
|
|
||||||
это бессмысленно, так как OSD в любом случае нуждается в io_uring, но, в
|
|
||||||
принципе, это может применяться для клиентов со старыми версиями ядра.
|
|
||||||
|
|||||||
+42
-166
@@ -7,15 +7,16 @@
|
|||||||
# Runtime OSD Parameters
|
# Runtime OSD Parameters
|
||||||
|
|
||||||
These parameters only apply to OSDs, are not fixed at the moment of OSD drive
|
These parameters only apply to OSDs, are not fixed at the moment of OSD drive
|
||||||
initialization and can be changed - in /etc/vitastor/vitastor.conf or [vitastor-disk update-sb](../usage/disk.en.md#update-sb)
|
initialization and can be changed - either with an OSD restart or, for some of
|
||||||
with an OSD restart or, for some of them, even without restarting by updating configuration in etcd.
|
them, even without restarting by updating configuration in etcd.
|
||||||
|
|
||||||
- [bind_address](#bind_address)
|
|
||||||
- [bind_port](#bind_port)
|
|
||||||
- [osd_iothread_count](#osd_iothread_count)
|
- [osd_iothread_count](#osd_iothread_count)
|
||||||
- [etcd_report_interval](#etcd_report_interval)
|
- [etcd_report_interval](#etcd_report_interval)
|
||||||
- [etcd_stats_interval](#etcd_stats_interval)
|
- [etcd_stats_interval](#etcd_stats_interval)
|
||||||
- [run_primary](#run_primary)
|
- [run_primary](#run_primary)
|
||||||
|
- [osd_network](#osd_network)
|
||||||
|
- [bind_address](#bind_address)
|
||||||
|
- [bind_port](#bind_port)
|
||||||
- [autosync_interval](#autosync_interval)
|
- [autosync_interval](#autosync_interval)
|
||||||
- [autosync_writes](#autosync_writes)
|
- [autosync_writes](#autosync_writes)
|
||||||
- [recovery_queue_depth](#recovery_queue_depth)
|
- [recovery_queue_depth](#recovery_queue_depth)
|
||||||
@@ -38,7 +39,6 @@ with an OSD restart or, for some of them, even without restarting by updating co
|
|||||||
- [journal_io](#journal_io)
|
- [journal_io](#journal_io)
|
||||||
- [journal_sector_buffer_count](#journal_sector_buffer_count)
|
- [journal_sector_buffer_count](#journal_sector_buffer_count)
|
||||||
- [journal_no_same_sector_overwrites](#journal_no_same_sector_overwrites)
|
- [journal_no_same_sector_overwrites](#journal_no_same_sector_overwrites)
|
||||||
- [skip_corrupted_meta_entries](#skip_corrupted_meta_entries)
|
|
||||||
- [throttle_small_writes](#throttle_small_writes)
|
- [throttle_small_writes](#throttle_small_writes)
|
||||||
- [throttle_target_iops](#throttle_target_iops)
|
- [throttle_target_iops](#throttle_target_iops)
|
||||||
- [throttle_target_mbs](#throttle_target_mbs)
|
- [throttle_target_mbs](#throttle_target_mbs)
|
||||||
@@ -61,32 +61,6 @@ with an OSD restart or, for some of them, even without restarting by updating co
|
|||||||
- [recovery_tune_agg_interval](#recovery_tune_agg_interval)
|
- [recovery_tune_agg_interval](#recovery_tune_agg_interval)
|
||||||
- [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us)
|
- [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us)
|
||||||
- [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us)
|
- [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us)
|
||||||
- [discard_on_start](#discard_on_start)
|
|
||||||
- [min_discard_size](#min_discard_size)
|
|
||||||
- [allow_net_split](#allow_net_split)
|
|
||||||
- [enable_pg_locks](#enable_pg_locks)
|
|
||||||
- [pg_lock_retry_interval_ms](#pg_lock_retry_interval_ms)
|
|
||||||
- [atomic_write_size](#atomic_write_size)
|
|
||||||
- [use_atomic_flag](#use_atomic_flag)
|
|
||||||
- [pg_reshard_chunk_size](#pg_reshard_chunk_size)
|
|
||||||
- [pg_reshard_chunk_pause_ms](#pg_reshard_chunk_pause_ms)
|
|
||||||
|
|
||||||
## bind_address
|
|
||||||
|
|
||||||
- Type: string or array of strings
|
|
||||||
|
|
||||||
Instead of the network masks ([osd_network](network.en.md#osd_network) and
|
|
||||||
[osd_cluster_network](network.en.md#osd_cluster_network)), you can also set
|
|
||||||
OSD listen addresses explicitly using this parameter. May be useful if you
|
|
||||||
want to start OSDs on interfaces that are not UP + RUNNING.
|
|
||||||
|
|
||||||
## bind_port
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
|
|
||||||
By default, OSDs pick random ports to use for incoming connections
|
|
||||||
automatically. With this option you can set a specific port for a specific
|
|
||||||
OSD by hand.
|
|
||||||
|
|
||||||
## osd_iothread_count
|
## osd_iothread_count
|
||||||
|
|
||||||
@@ -130,6 +104,34 @@ debugging purposes. It's possible to implement additional feature for the
|
|||||||
monitor which may allow to separate primary and secondary OSDs, but it's
|
monitor which may allow to separate primary and secondary OSDs, but it's
|
||||||
unclear why anyone could need it, so it's not implemented.
|
unclear why anyone could need it, so it's not implemented.
|
||||||
|
|
||||||
|
## osd_network
|
||||||
|
|
||||||
|
- Type: string or array of strings
|
||||||
|
|
||||||
|
Network mask of the network (IPv4 or IPv6) to use for OSDs. Note that
|
||||||
|
although it's possible to specify multiple networks here, this does not
|
||||||
|
mean that OSDs will create multiple listening sockets - they'll only
|
||||||
|
pick the first matching address of an UP + RUNNING interface. Separate
|
||||||
|
networks for cluster and client connections are also not implemented, but
|
||||||
|
they are mostly useless anyway, so it's not a big deal.
|
||||||
|
|
||||||
|
## bind_address
|
||||||
|
|
||||||
|
- Type: string
|
||||||
|
- Default: 0.0.0.0
|
||||||
|
|
||||||
|
Instead of the network mask, you can also set OSD listen address explicitly
|
||||||
|
using this parameter. May be useful if you want to start OSDs on interfaces
|
||||||
|
that are not UP + RUNNING.
|
||||||
|
|
||||||
|
## bind_port
|
||||||
|
|
||||||
|
- Type: integer
|
||||||
|
|
||||||
|
By default, OSDs pick random ports to use for incoming connections
|
||||||
|
automatically. With this option you can set a specific port for a specific
|
||||||
|
OSD by hand.
|
||||||
|
|
||||||
## autosync_interval
|
## autosync_interval
|
||||||
|
|
||||||
- Type: seconds
|
- Type: seconds
|
||||||
@@ -280,19 +282,13 @@ Maximum number of journal flushers (see above min_flusher_count).
|
|||||||
- Type: boolean
|
- Type: boolean
|
||||||
- Default: true
|
- Default: true
|
||||||
|
|
||||||
Only for the old store ([meta_format](layout-osd.en.md#meta_format) 2).
|
This parameter makes Vitastor always keep metadata area of the block device
|
||||||
|
in memory. It's required for good performance because it allows to avoid
|
||||||
This parameter makes Vitastor keep a copy of metadata area in memory as it is
|
additional read-modify-write cycles during metadata modifications. Metadata
|
||||||
on disk, in addition to the metadata database. When the option is enabled, every
|
area size is currently roughly 224 MB per 1 TB of data. You can turn it off
|
||||||
metadata entry is effectively stored in RAM twice. It's required for good performance
|
to reduce memory usage by this value, but it will hurt performance. This
|
||||||
because it allows to avoid additional read-modify-write cycles during metadata
|
restriction is likely to be removed in the future along with the upgrade
|
||||||
modifications. Metadata area size with the old store is roughly 224 MB per 1 TB
|
of the metadata storage scheme.
|
||||||
of data. You can turn the option off to reduce memory usage by this value, but
|
|
||||||
it will reduce performance.
|
|
||||||
|
|
||||||
For the new store ([meta_format](layout-osd.en.md#meta_format) 3), the option
|
|
||||||
may be changed in the future to support operation without loading full metadata
|
|
||||||
database in memory.
|
|
||||||
|
|
||||||
## inmemory_journal
|
## inmemory_journal
|
||||||
|
|
||||||
@@ -320,7 +316,7 @@ for hot data and slower disks - HDDs and maybe SATA SSDs - but will slightly
|
|||||||
decrease write performance for fast disks because page cache is an overhead
|
decrease write performance for fast disks because page cache is an overhead
|
||||||
itself.
|
itself.
|
||||||
|
|
||||||
Choose "directsync" to use [immediate_commit](layout-cluster.en.md#immediate_commit)
|
Choose "directsync" to use [immediate_commit](layout-cluster.ru.md#immediate_commit)
|
||||||
(which requires disable_data_fsync) with drives having write-back cache
|
(which requires disable_data_fsync) with drives having write-back cache
|
||||||
which can't be turned off, for example, Intel Optane. Also note that *some*
|
which can't be turned off, for example, Intel Optane. Also note that *some*
|
||||||
desktop SSDs (for example, HP EX950) may ignore O_SYNC thus making
|
desktop SSDs (for example, HP EX950) may ignore O_SYNC thus making
|
||||||
@@ -371,8 +367,6 @@ blocks. The only situation when you should increase it to a larger value
|
|||||||
is when you enable journal_no_same_sector_overwrites. In this case set
|
is when you enable journal_no_same_sector_overwrites. In this case set
|
||||||
it to, for example, 1024.
|
it to, for example, 1024.
|
||||||
|
|
||||||
Not applicable to the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
|
|
||||||
## journal_no_same_sector_overwrites
|
## journal_no_same_sector_overwrites
|
||||||
|
|
||||||
- Type: boolean
|
- Type: boolean
|
||||||
@@ -386,17 +380,6 @@ journal after writing it instead of possibly overwriting it the second time.
|
|||||||
|
|
||||||
Most (99%) other SSDs don't need this option.
|
Most (99%) other SSDs don't need this option.
|
||||||
|
|
||||||
Not applicable to the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
|
|
||||||
## skip_corrupted_meta_entries
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
- Default: false
|
|
||||||
|
|
||||||
Only for the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
Allow OSD to start when some metadata entries or blocks are corrupted by
|
|
||||||
skipping them. Should be only used as an emergency measure.
|
|
||||||
|
|
||||||
## throttle_small_writes
|
## throttle_small_writes
|
||||||
|
|
||||||
- Type: boolean
|
- Type: boolean
|
||||||
@@ -515,7 +498,7 @@ Can be used to slow down scrubbing if it affects user load too much.
|
|||||||
## scrub_list_limit
|
## scrub_list_limit
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
- Default: 262144
|
- Default: 1000
|
||||||
- Can be changed online: yes
|
- Can be changed online: yes
|
||||||
|
|
||||||
Number of objects to list in one listing operation during scrub.
|
Number of objects to list in one listing operation during scrub.
|
||||||
@@ -646,110 +629,3 @@ are changed to 0.
|
|||||||
|
|
||||||
Maximum possible value for auto-tuned recovery_sleep_us. Higher values
|
Maximum possible value for auto-tuned recovery_sleep_us. Higher values
|
||||||
are treated as outliers and ignored in aggregation.
|
are treated as outliers and ignored in aggregation.
|
||||||
|
|
||||||
## discard_on_start
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
|
|
||||||
Discard (SSD TRIM) unused data device blocks on every OSD startup.
|
|
||||||
|
|
||||||
## min_discard_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 1048576
|
|
||||||
|
|
||||||
Minimum consecutive block size to TRIM it.
|
|
||||||
|
|
||||||
## allow_net_split
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
- Default: false
|
|
||||||
|
|
||||||
Allow "safe" cases of network splits/partitions - allow to start PGs without
|
|
||||||
connections to some OSDs currently registered as alive in etcd, if the number
|
|
||||||
of actually connected PG OSDs is at least pg_minsize. That is, allow some OSDs to lose
|
|
||||||
connectivity with some other OSDs as long as it doesn't break pg_minsize guarantees.
|
|
||||||
The downside is that it increases the probability of writing data into just pg_minsize
|
|
||||||
OSDs during failover which can lead to PGs becoming incomplete after additional outages.
|
|
||||||
|
|
||||||
The old behaviour in versions up to 2.0.0 was equal to enabled allow_net_split.
|
|
||||||
|
|
||||||
## enable_pg_locks
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
|
|
||||||
Vitastor 2.2.0 introduces a new layer of split-brain prevention mechanism in
|
|
||||||
addition to etcd: PG locks. They prevent split-brain even in abnormal theoretical cases
|
|
||||||
when etcd is extremely laggy. As a new feature, by default, PG locks are only enabled
|
|
||||||
for pools where they're required - pools with [localized reads](pool.en.md#local_reads).
|
|
||||||
Use this parameter to enable or disable this function for all pools.
|
|
||||||
|
|
||||||
## pg_lock_retry_interval_ms
|
|
||||||
|
|
||||||
- Type: milliseconds
|
|
||||||
- Default: 100
|
|
||||||
|
|
||||||
Retry interval for failed PG lock attempts.
|
|
||||||
|
|
||||||
## atomic_write_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 4096
|
|
||||||
|
|
||||||
Maximum data device atomic write size allowed for OSD to use.
|
|
||||||
|
|
||||||
Atomic writes allow to reduce the Write Amplification factor with the new store
|
|
||||||
([meta_format](layout-osd.en.md#meta_format)=3) to almost 1 (i.e. almost no extra writes)
|
|
||||||
with replicated pools and reach the best possible write performance.
|
|
||||||
|
|
||||||
Default value is auto-detected during OSD initialization from
|
|
||||||
`/sys/block/xx/queue/atomic_write_max_bytes` or assumed to be 4096 bytes
|
|
||||||
because all known disks support 4 KB atomic writes. Auto-detection is only used for
|
|
||||||
NVMe disks because SAS disks require the explicit WRITE ATOMIC command which requires
|
|
||||||
RWF_ATOMIC (see below [#use_atomic_flag]) but that flag works incorrectly in current
|
|
||||||
Linux versions.
|
|
||||||
|
|
||||||
You can also check if your NVMe drives support atomic writes by running
|
|
||||||
the command `nvme id-ctrl /dev/nvme0n1 | grep awupf`. If the reported value,
|
|
||||||
plus 1, multiplied by the currently selected block size of the NVMe,
|
|
||||||
is more than 4 KB, then the new store can utilize it for better performance.
|
|
||||||
The only drives known to support it currently are [Micron and Kioxia](../intro/quickstart.en.md).
|
|
||||||
|
|
||||||
Atomic writes allow to skip double data writes in replicated pools, thus
|
|
||||||
reducing Write Amplification and improving write performance up to 2 times.
|
|
||||||
|
|
||||||
## use_atomic_flag
|
|
||||||
|
|
||||||
- Type: boolean
|
|
||||||
|
|
||||||
This option controls whether Vitastor OSDs use RWF_ATOMIC write flag with atomic writes.
|
|
||||||
This flag is supported since Linux 6.11 and adds some safety to atomic writes - the kernel
|
|
||||||
guarantees to not fragment write requests with it and also to check them against the actual
|
|
||||||
device atomic write capabilities.
|
|
||||||
|
|
||||||
However, the option is disabled by default because the flag is currently UNUSABLE - Linux
|
|
||||||
incorrectly requires writes with that flag to be of power-of-2 length and length-aligned.
|
|
||||||
I.e., for example, 12 KB writes and not-8-KB aligned 8 KB writes are forbidden by the kernel,
|
|
||||||
even though the NVMe specification allows them.
|
|
||||||
|
|
||||||
For NVMe disks with `scheduler=none` writes aren't fragmented anyway so it's not a big deal.
|
|
||||||
However, you can rebuild your kernel with [this patch](../../patches/linux-fix-atomic-write-checks.diff)
|
|
||||||
and turn this option on. It will make your atomic writes a bit safer.
|
|
||||||
|
|
||||||
## pg_reshard_chunk_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 100000
|
|
||||||
|
|
||||||
Pool PG count change is a CPU-intensive operation because OSDs store the full object database
|
|
||||||
in memory and have to move all entries between old and new PGs. Thus it's performed in chunks,
|
|
||||||
with pauses between chunks to prevent blocking OSD's event loop and other clients' operations.
|
|
||||||
This option sets the maximum number of object is a chunk. Moving 100k objects usually takes
|
|
||||||
50-100ms. Chunk size equal to 0 means unlimited.
|
|
||||||
|
|
||||||
## pg_reshard_chunk_pause_ms
|
|
||||||
|
|
||||||
- Type: milliseconds
|
|
||||||
- Default: 100
|
|
||||||
|
|
||||||
This option sets the interval between handling two PG count change chunks.
|
|
||||||
|
|||||||
+41
-174
@@ -8,15 +8,16 @@
|
|||||||
|
|
||||||
Данные параметры используются только OSD, но, в отличие от дисковых параметров,
|
Данные параметры используются только OSD, но, в отличие от дисковых параметров,
|
||||||
не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой
|
не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой
|
||||||
момент с перезапуском OSD в /etc/vitastor/vitastor.conf или [vitastor-disk update-sb](../usage/disk.ru.md#update-sb),
|
момент с помощью перезапуска OSD, а некоторые и без перезапуска, с помощью
|
||||||
а некоторые и без перезапуска, с помощью изменения конфигурации в etcd.
|
изменения конфигурации в etcd.
|
||||||
|
|
||||||
- [bind_address](#bind_address)
|
|
||||||
- [bind_port](#bind_port)
|
|
||||||
- [osd_iothread_count](#osd_iothread_count)
|
- [osd_iothread_count](#osd_iothread_count)
|
||||||
- [etcd_report_interval](#etcd_report_interval)
|
- [etcd_report_interval](#etcd_report_interval)
|
||||||
- [etcd_stats_interval](#etcd_stats_interval)
|
- [etcd_stats_interval](#etcd_stats_interval)
|
||||||
- [run_primary](#run_primary)
|
- [run_primary](#run_primary)
|
||||||
|
- [osd_network](#osd_network)
|
||||||
|
- [bind_address](#bind_address)
|
||||||
|
- [bind_port](#bind_port)
|
||||||
- [autosync_interval](#autosync_interval)
|
- [autosync_interval](#autosync_interval)
|
||||||
- [autosync_writes](#autosync_writes)
|
- [autosync_writes](#autosync_writes)
|
||||||
- [recovery_queue_depth](#recovery_queue_depth)
|
- [recovery_queue_depth](#recovery_queue_depth)
|
||||||
@@ -39,7 +40,6 @@
|
|||||||
- [journal_io](#journal_io)
|
- [journal_io](#journal_io)
|
||||||
- [journal_sector_buffer_count](#journal_sector_buffer_count)
|
- [journal_sector_buffer_count](#journal_sector_buffer_count)
|
||||||
- [journal_no_same_sector_overwrites](#journal_no_same_sector_overwrites)
|
- [journal_no_same_sector_overwrites](#journal_no_same_sector_overwrites)
|
||||||
- [skip_corrupted_meta_entries](#skip_corrupted_meta_entries)
|
|
||||||
- [throttle_small_writes](#throttle_small_writes)
|
- [throttle_small_writes](#throttle_small_writes)
|
||||||
- [throttle_target_iops](#throttle_target_iops)
|
- [throttle_target_iops](#throttle_target_iops)
|
||||||
- [throttle_target_mbs](#throttle_target_mbs)
|
- [throttle_target_mbs](#throttle_target_mbs)
|
||||||
@@ -62,32 +62,6 @@
|
|||||||
- [recovery_tune_agg_interval](#recovery_tune_agg_interval)
|
- [recovery_tune_agg_interval](#recovery_tune_agg_interval)
|
||||||
- [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us)
|
- [recovery_tune_sleep_min_us](#recovery_tune_sleep_min_us)
|
||||||
- [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us)
|
- [recovery_tune_sleep_cutoff_us](#recovery_tune_sleep_cutoff_us)
|
||||||
- [discard_on_start](#discard_on_start)
|
|
||||||
- [min_discard_size](#min_discard_size)
|
|
||||||
- [allow_net_split](#allow_net_split)
|
|
||||||
- [enable_pg_locks](#enable_pg_locks)
|
|
||||||
- [pg_lock_retry_interval_ms](#pg_lock_retry_interval_ms)
|
|
||||||
- [atomic_write_size](#atomic_write_size)
|
|
||||||
- [use_atomic_flag](#use_atomic_flag)
|
|
||||||
- [pg_reshard_chunk_size](#pg_reshard_chunk_size)
|
|
||||||
- [pg_reshard_chunk_pause_ms](#pg_reshard_chunk_pause_ms)
|
|
||||||
|
|
||||||
## bind_address
|
|
||||||
|
|
||||||
- Тип: строка или массив строк
|
|
||||||
|
|
||||||
Вместо использования масок подсети ([osd_network](network.ru.md#osd_network) и
|
|
||||||
[osd_cluster_network](network.ru.md#osd_cluster_network)), вы также можете явно
|
|
||||||
задать адрес(а), на которых будут ожидать соединений OSD, с помощью данного
|
|
||||||
параметра. Это может быть полезно, например, чтобы запускать OSD на неподнятых
|
|
||||||
интерфейсах (не UP + RUNNING).
|
|
||||||
|
|
||||||
## bind_port
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
|
|
||||||
По умолчанию OSD сами выбирают случайные порты для входящих подключений.
|
|
||||||
С помощью данной опции вы можете задать порт для отдельного OSD вручную.
|
|
||||||
|
|
||||||
## osd_iothread_count
|
## osd_iothread_count
|
||||||
|
|
||||||
@@ -133,6 +107,34 @@ max_etcd_attempts * etcd_quick_timeout.
|
|||||||
первичные OSD от вторичных, но пока не понятно, зачем это может кому-то
|
первичные OSD от вторичных, но пока не понятно, зачем это может кому-то
|
||||||
понадобиться, поэтому это не реализовано.
|
понадобиться, поэтому это не реализовано.
|
||||||
|
|
||||||
|
## osd_network
|
||||||
|
|
||||||
|
- Тип: строка или массив строк
|
||||||
|
|
||||||
|
Маска подсети (IPv4 или IPv6) для использования для соединений с OSD.
|
||||||
|
Имейте в виду, что хотя сейчас и можно передать в этот параметр несколько
|
||||||
|
подсетей, это не означает, что OSD будут создавать несколько слушающих
|
||||||
|
сокетов - они лишь будут выбирать адрес первого поднятого (состояние UP +
|
||||||
|
RUNNING), подходящий под заданную маску. Также не реализовано разделение
|
||||||
|
кластерной и публичной сетей OSD. Правда, от него обычно всё равно довольно
|
||||||
|
мало толку, так что особенной проблемы в этом нет.
|
||||||
|
|
||||||
|
## bind_address
|
||||||
|
|
||||||
|
- Тип: строка
|
||||||
|
- Значение по умолчанию: 0.0.0.0
|
||||||
|
|
||||||
|
Этим параметром можно явным образом задать адрес, на котором будет ожидать
|
||||||
|
соединений OSD (вместо использования маски подсети). Может быть полезно,
|
||||||
|
например, чтобы запускать OSD на неподнятых интерфейсах (не UP + RUNNING).
|
||||||
|
|
||||||
|
## bind_port
|
||||||
|
|
||||||
|
- Тип: целое число
|
||||||
|
|
||||||
|
По умолчанию OSD сами выбирают случайные порты для входящих подключений.
|
||||||
|
С помощью данной опции вы можете задать порт для отдельного OSD вручную.
|
||||||
|
|
||||||
## autosync_interval
|
## autosync_interval
|
||||||
|
|
||||||
- Тип: секунды
|
- Тип: секунды
|
||||||
@@ -288,19 +290,13 @@ Flusher - это микро-поток (корутина), которая коп
|
|||||||
- Тип: булево (да/нет)
|
- Тип: булево (да/нет)
|
||||||
- Значение по умолчанию: true
|
- Значение по умолчанию: true
|
||||||
|
|
||||||
Только для старого хранилища ([meta_format](layout-osd.en.md#meta_format) 2).
|
Данный параметр заставляет Vitastor всегда держать область метаданных диска
|
||||||
|
в памяти. Это нужно, чтобы избегать дополнительных операций чтения с диска
|
||||||
Данный параметр заставляет Vitastor всегда держать копию области метаданных
|
при записи. Размер области метаданных на данный момент составляет примерно
|
||||||
в памяти в том же виде, как она лежит на диске, в дополнение к БД метаданных.
|
224 МБ на 1 ТБ данных. При включении потребление памяти снизится примерно
|
||||||
То есть, с включённой опцией каждая запись метаданных хранится в памяти дважды.
|
на эту величину, но при этом также снизится и производительность. В будущем,
|
||||||
Это нужно, чтобы избегать дополнительных операций чтения с диска при записи.
|
после обновления схемы хранения метаданных, это ограничение, скорее всего,
|
||||||
Размер области метаданных в старом хранилище составляет примерно 224 МБ на
|
будет ликвидировано.
|
||||||
1 ТБ данных. Вы можете отключить опцию, чтобы снизить потребление памяти
|
|
||||||
примерно на эту величину, но при этом также снизится и производительность.
|
|
||||||
|
|
||||||
Для нового хранилища ([meta_format](layout-osd.en.md#meta_format) 3) опция,
|
|
||||||
возможно, будет переработана в будущем для поддержки работы без полной
|
|
||||||
загрузки метаданных в памяти.
|
|
||||||
|
|
||||||
## inmemory_journal
|
## inmemory_journal
|
||||||
|
|
||||||
@@ -383,8 +379,6 @@ fsync небезопасным даже с режимом "directsync".
|
|||||||
нужно менять - это если вы включаете journal_no_same_sector_overwrites. В
|
нужно менять - это если вы включаете journal_no_same_sector_overwrites. В
|
||||||
этом случае установите данный параметр, например, в 1024.
|
этом случае установите данный параметр, например, в 1024.
|
||||||
|
|
||||||
Неприменимо к новому хранилищу ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
|
|
||||||
## journal_no_same_sector_overwrites
|
## journal_no_same_sector_overwrites
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
- Тип: булево (да/нет)
|
||||||
@@ -400,18 +394,6 @@ fsync небезопасным даже с режимом "directsync".
|
|||||||
|
|
||||||
Почти все другие SSD (99% моделей) не требуют данной опции.
|
Почти все другие SSD (99% моделей) не требуют данной опции.
|
||||||
|
|
||||||
Неприменимо к новому хранилищу ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
|
|
||||||
## skip_corrupted_meta_entries
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
- Значение по умолчанию: false
|
|
||||||
|
|
||||||
Только для нового хранилища ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
Разрешить OSD запускаться, даже если часть блоков или записей метаданных
|
|
||||||
повреждена, пропуская их. Опция предназначена для использования только в
|
|
||||||
целях аварийного восстановления.
|
|
||||||
|
|
||||||
## throttle_small_writes
|
## throttle_small_writes
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
- Тип: булево (да/нет)
|
||||||
@@ -539,7 +521,7 @@ fsync небезопасным даже с режимом "directsync".
|
|||||||
## scrub_list_limit
|
## scrub_list_limit
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
- Значение по умолчанию: 262144
|
- Значение по умолчанию: 1000
|
||||||
- Можно менять на лету: да
|
- Можно менять на лету: да
|
||||||
|
|
||||||
Размер загружаемых за одну операцию списков объектов в процессе фоновой
|
Размер загружаемых за одну операцию списков объектов в процессе фоновой
|
||||||
@@ -678,118 +660,3 @@ EC (кодов коррекции ошибок) с более, чем 1 диск
|
|||||||
Максимальное возможное значение авто-подстроенного recovery_sleep_us.
|
Максимальное возможное значение авто-подстроенного recovery_sleep_us.
|
||||||
Большие значения считаются случайными выбросами и игнорируются в
|
Большие значения считаются случайными выбросами и игнорируются в
|
||||||
усреднении.
|
усреднении.
|
||||||
|
|
||||||
## discard_on_start
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
|
|
||||||
Освобождать (SSD TRIM) неиспользуемые блоки диска данных при каждом запуске OSD.
|
|
||||||
|
|
||||||
## min_discard_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 1048576
|
|
||||||
|
|
||||||
Минимальный размер последовательного блока данных, чтобы освобождать его через TRIM.
|
|
||||||
|
|
||||||
## allow_net_split
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
- Значение по умолчанию: false
|
|
||||||
|
|
||||||
Разрешить "безопасные" случаи разделений сети - разрешить активировать PG без
|
|
||||||
соединений к некоторым OSD, помеченным активными в etcd, если общее число активных
|
|
||||||
OSD в PG составляет как минимум pg_minsize. То есть, разрешать некоторым OSD терять
|
|
||||||
соединения с некоторыми другими OSD, если это не нарушает гарантий pg_minsize.
|
|
||||||
Минус такого разрешения в том, что оно повышает вероятность записи данных ровно в
|
|
||||||
pg_minsize OSD во время переключений, что может потом привести к тому, что PG станут
|
|
||||||
неполными (incomplete), если упадут ещё какие-то OSD.
|
|
||||||
|
|
||||||
Старое поведение в версиях до 2.0.0 было идентично включённому allow_net_split.
|
|
||||||
|
|
||||||
## enable_pg_locks
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
|
|
||||||
В Vitastor 2.2.0 появился новый слой защиты от сплитбрейна в дополнение к etcd -
|
|
||||||
блокировки PG. Они гарантируют порядок даже в теоретических ненормальных случаях,
|
|
||||||
когда etcd очень сильно тормозит. Так как функция новая, по умолчанию она включается
|
|
||||||
только для пулов, в которых она необходима - а именно, в пулах с включёнными
|
|
||||||
[локальными чтениями](pool.ru.md#local_reads). Ну а с помощью данного параметра
|
|
||||||
можно включить блокировки PG для всех пулов.
|
|
||||||
|
|
||||||
## pg_lock_retry_interval_ms
|
|
||||||
|
|
||||||
- Тип: миллисекунды
|
|
||||||
- Значение по умолчанию: 100
|
|
||||||
|
|
||||||
Интервал повтора неудачных попыток блокировки PG.
|
|
||||||
|
|
||||||
## atomic_write_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 4096
|
|
||||||
|
|
||||||
Максимальный размер атомарной записи на диск данных, который OSD разрешено использовать.
|
|
||||||
|
|
||||||
Поддержка атомарной записи позволяет снизить мультипликатор записи (Write Amplification)
|
|
||||||
на диск с новым хранилищем ([meta_format](layout-osd.ru.md#meta_format)=3)
|
|
||||||
практически до 1 (то есть, почти до нулевого объёма лишней записи) в реплицированных
|
|
||||||
пулах и достигнуть наилучшей возможной производительности записи.
|
|
||||||
|
|
||||||
Значение по умолчанию авто-определяется во время инициализации OSD из
|
|
||||||
`/sys/block/xx/queue/atomic_write_max_bytes` либо принимается равным 4096,
|
|
||||||
так как все известные диски поддерживают атомарную запись 4 КБ блоков.
|
|
||||||
Автоопределение применяется только для NVMe-дисков, так как SAS диски требуют
|
|
||||||
использования отдельной команды WRITE ATOMIC, а для неё нужен флаг RWF_ATOMIC
|
|
||||||
(см. ниже [#use_atomic_flag]), а он в текущих версиях Linux работает некорректно.
|
|
||||||
|
|
||||||
Вы также можете проверить, поддерживают ли ваши NVMe-диски атомарную запись,
|
|
||||||
с помощью команды `nvme id-ctrl /dev/nvme0n1 | grep awupf`. Если значение awupf
|
|
||||||
плюс 1, умноженное на текущий выбранный размер блока NVMe-диска, больше 4 КБ,
|
|
||||||
то новое хранилище может использовать атомарные записи для достижения лучшей
|
|
||||||
производительности. Единственные известные диски, которые поддерживают это сейчас -
|
|
||||||
[Micron и Kioxia](../intro/quickstart.ru.md).
|
|
||||||
|
|
||||||
Атомарная запись позволяет не использовать двойную запись данных (в журнал и на
|
|
||||||
устройство данных) в реплицированных пулах и таким образом снижает амплификацию
|
|
||||||
записи (объём служебной записи на диск) и улучшает производительность записи
|
|
||||||
вплоть до 2-х кратного прироста.
|
|
||||||
|
|
||||||
## use_atomic_flag
|
|
||||||
|
|
||||||
- Тип: булево (да/нет)
|
|
||||||
|
|
||||||
Данная опция контролирует использование Vitastor OSD флага RWF_ATOMIC при атомарной записи
|
|
||||||
блоков. Этот флаг поддерживается, начиная с версии ядра Linux 6.11 и добавляет немного корректности
|
|
||||||
атомарным записям - ядро гарантирует отсутствие фрагментации запросов записи с этим флагом и
|
|
||||||
проверяет их на соответствие реальным возможностям устройства.
|
|
||||||
|
|
||||||
Однако, данная опция по умолчанию отключена, так как флаг в текущих версиях Linux работает
|
|
||||||
абсолютно НЕКОРРЕКТНО - при нём Linux требует, чтобы запросы записи имели длину, равную
|
|
||||||
степени двойки и были выровнены на эту длину. То есть, например, 12 КБ запросы записи, а также
|
|
||||||
8 КБ запросы записи по не-кратному 8 КБ смещению запрещаются ядром, хотя спецификация NVMe их
|
|
||||||
разрешает.
|
|
||||||
|
|
||||||
Для NVMe-дисков с `scheduler=none` запросы записи и так не фрагментируются, так что это не так
|
|
||||||
уж и важно, однако вы можете пересобрать своё ядро с [этим патчем](../../patches/linux-fix-atomic-write-checks.diff)
|
|
||||||
и включить данную опцию. Это сделает вашу атомарную запись капельку безопаснее.
|
|
||||||
|
|
||||||
## pg_reshard_chunk_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 100000
|
|
||||||
|
|
||||||
Изменение числа PG в пуле заметно загружает процессор, так как OSD хранят полную базу данных
|
|
||||||
объектов в памяти и им приходится перемещать все записи объектов между старыми и новыми PG.
|
|
||||||
Поэтому изменение применяется порциями, с паузами между порциями, чтобы не блокировать обработку
|
|
||||||
событий OSD и операции остальных клиентов. Данная опция задаёт максимальное число объектов
|
|
||||||
в порции. Перемещение 100 тысяч объектов (значение по умолчанию) обычно занимает порядка
|
|
||||||
50-100 миллисекунд. Значение опции 0 отключает лимит размера порции.
|
|
||||||
|
|
||||||
## pg_reshard_chunk_pause_ms
|
|
||||||
|
|
||||||
- Тип: миллисекунды
|
|
||||||
- Значение по умолчанию: 100
|
|
||||||
|
|
||||||
Данная опция задаёт интервал между обработкой двух порций изменения числа PG пулов.
|
|
||||||
|
|||||||
+12
-54
@@ -34,7 +34,6 @@ Parameters:
|
|||||||
- [failure_domain](#failure_domain)
|
- [failure_domain](#failure_domain)
|
||||||
- [level_placement](#level_placement)
|
- [level_placement](#level_placement)
|
||||||
- [raw_placement](#raw_placement)
|
- [raw_placement](#raw_placement)
|
||||||
- [local_reads](#local_reads)
|
|
||||||
- [max_osd_combinations](#max_osd_combinations)
|
- [max_osd_combinations](#max_osd_combinations)
|
||||||
- [block_size](#block_size)
|
- [block_size](#block_size)
|
||||||
- [bitmap_granularity](#bitmap_granularity)
|
- [bitmap_granularity](#bitmap_granularity)
|
||||||
@@ -44,7 +43,7 @@ Parameters:
|
|||||||
- [osd_tags](#osd_tags)
|
- [osd_tags](#osd_tags)
|
||||||
- [primary_affinity_tags](#primary_affinity_tags)
|
- [primary_affinity_tags](#primary_affinity_tags)
|
||||||
- [scrub_interval](#scrub_interval)
|
- [scrub_interval](#scrub_interval)
|
||||||
- [used_for_app](#used_for_app)
|
- [used_for_fs](#used_for_fs)
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
|
|
||||||
@@ -134,8 +133,8 @@ Pool name.
|
|||||||
## scheme
|
## scheme
|
||||||
|
|
||||||
- Type: string
|
- Type: string
|
||||||
- One of: "replicated", "xor", "ec" or "jerasure"
|
|
||||||
- Required
|
- Required
|
||||||
|
- One of: "replicated", "xor", "ec" or "jerasure"
|
||||||
|
|
||||||
Redundancy scheme used for data in this pool. "jerasure" is an alias for "ec",
|
Redundancy scheme used for data in this pool. "jerasure" is an alias for "ec",
|
||||||
both use Reed-Solomon-Vandermonde codes based on ISA-L or jerasure libraries.
|
both use Reed-Solomon-Vandermonde codes based on ISA-L or jerasure libraries.
|
||||||
@@ -190,9 +189,6 @@ So, pg_minsize regulates the number of failures that a pool can tolerate
|
|||||||
without temporary downtime for [osd_out_time](monitor.en.md#osd_out_time),
|
without temporary downtime for [osd_out_time](monitor.en.md#osd_out_time),
|
||||||
but at a cost of slightly reduced storage reliability.
|
but at a cost of slightly reduced storage reliability.
|
||||||
|
|
||||||
See also [allow_net_split](osd.en.md#allow_net_split) and
|
|
||||||
[PG state descriptions](../usage/admin.en.md#pg-states).
|
|
||||||
|
|
||||||
FIXME: pg_minsize behaviour may be changed in the future to only make PGs
|
FIXME: pg_minsize behaviour may be changed in the future to only make PGs
|
||||||
read-only instead of deactivating them.
|
read-only instead of deactivating them.
|
||||||
|
|
||||||
@@ -290,30 +286,6 @@ Examples:
|
|||||||
- EC 4+2 in 3 DC: `any, dc=1 host!=1, dc!=1, dc=3 host!=3, dc!=(1,3), dc=5 host!=5`
|
- EC 4+2 in 3 DC: `any, dc=1 host!=1, dc!=1, dc=3 host!=3, dc!=(1,3), dc=5 host!=5`
|
||||||
- 1 replica in fixed DC + 2 in random DCs: `dc?=meow, dc!=1, dc!=(1,2)`
|
- 1 replica in fixed DC + 2 in random DCs: `dc?=meow, dc!=1, dc!=(1,2)`
|
||||||
|
|
||||||
## local_reads
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
- One of: "primary", "nearest" or "random"
|
|
||||||
- Default: primary
|
|
||||||
|
|
||||||
By default, Vitastor serves all read and write requests from the primary OSD of each PG.
|
|
||||||
But it can also serve read requests for replicated pools from secondary OSDs in clean PGs
|
|
||||||
(active or active+left_on_dead) which may be useful if you have OSDs with different network
|
|
||||||
latency to the client - for example, if you have a cross-datacenter setup.
|
|
||||||
|
|
||||||
If you set this parameter to "nearest", clients will try to read from the nearest OSD
|
|
||||||
in the [Placement Tree](#placement-tree), i.e. from an OSD from the same host or datacenter.
|
|
||||||
Distance to different OSDs will be calculated based on client hostname, determined
|
|
||||||
automatically or set manually in the [hostname](client.en.md#hostname) parameter.
|
|
||||||
|
|
||||||
If you set this parameter to "random", clients will try to distribute read requests over
|
|
||||||
all available secondary OSDs. This mode is mainly useful for tests, but, probably, not
|
|
||||||
really required in production setups.
|
|
||||||
|
|
||||||
[PG locks](osd.en.md#enable_pg_locks) are required for local reads to function. However,
|
|
||||||
PG locks are enabled automatically by default for pools with enabled local reads, so you
|
|
||||||
don't have to enable them explicitly.
|
|
||||||
|
|
||||||
## max_osd_combinations
|
## max_osd_combinations
|
||||||
|
|
||||||
- Type: integer
|
- Type: integer
|
||||||
@@ -349,8 +321,7 @@ Read more about this parameter in [Cluster-Wide Disk Layout Parameters](layout-c
|
|||||||
|
|
||||||
## immediate_commit
|
## immediate_commit
|
||||||
|
|
||||||
- Type: string
|
- Type: string, one of "all", "small" and "none"
|
||||||
- One of: "all", "small" or "none"
|
|
||||||
- Default: none
|
- Default: none
|
||||||
|
|
||||||
Immediate commit setting for this pool. The value from /vitastor/config/global
|
Immediate commit setting for this pool. The value from /vitastor/config/global
|
||||||
@@ -406,37 +377,24 @@ of the OSDs containing a data chunk for a PG.
|
|||||||
Automatic scrubbing interval for this pool. Overrides
|
Automatic scrubbing interval for this pool. Overrides
|
||||||
[global scrub_interval setting](osd.en.md#scrub_interval).
|
[global scrub_interval setting](osd.en.md#scrub_interval).
|
||||||
|
|
||||||
## used_for_app
|
## used_for_fs
|
||||||
|
|
||||||
- Type: string
|
- Type: string
|
||||||
|
|
||||||
If non-empty, the pool is marked as used for a separate application, for example,
|
If non-empty, the pool is marked as used for VitastorFS with metadata stored
|
||||||
VitastorFS or S3, which allocates Vitastor volume IDs by itself and does not use
|
in block image (regular Vitastor volume) named as the value of this pool parameter.
|
||||||
image/inode metadata in etcd.
|
|
||||||
|
|
||||||
When a pool is marked as used for such app, regular block volume creation in it
|
When a pool is marked as used for VitastorFS, regular block volume creation in it
|
||||||
is disabled (vitastor-cli refuses to create images without --force) to protect
|
is disabled (vitastor-cli refuses to create images without --force) to protect
|
||||||
the user from block volume and FS/S3 volume ID collisions and data loss.
|
the user from block volume and FS file ID collisions and data loss.
|
||||||
|
|
||||||
Also such pools do not calculate per-inode space usage statistics in etcd because
|
[vitastor-nfs](../usage/nfs.ru.md), in its turn, refuses to use pools not marked
|
||||||
using it for an external application implies that it may contain a very large
|
|
||||||
number of volumes and their statistics may take too much space in etcd.
|
|
||||||
|
|
||||||
Setting used_for_app to `fs:<name>` tells Vitastor that the pool is used for VitastorFS
|
|
||||||
with VitastorKV metadata base stored in a block image (regular Vitastor volume) named
|
|
||||||
`<name>`.
|
|
||||||
|
|
||||||
[vitastor-nfs](../usage/nfs.en.md), in its turn, refuses to use pools not marked
|
|
||||||
for the corresponding FS when starting. This also implies that you can use one
|
for the corresponding FS when starting. This also implies that you can use one
|
||||||
pool only for one VitastorFS.
|
pool only for one VitastorFS.
|
||||||
|
|
||||||
If you plan to use the pool for S3, set its used_for_app to `s3:<name>`. `<name>` may
|
The second thing that is disabled for VitastorFS pools is reporting per-inode space
|
||||||
be basically anything you want (for example, `s3:standard`) - it's not validated
|
usage statistics in etcd because a FS pool may store a very large number of files
|
||||||
by Vitastor S3 components in any way.
|
and statistics for them all would take a lot of space in etcd.
|
||||||
|
|
||||||
All other values except prefixed with `fs:` or `s3:` may be used freely and don't
|
|
||||||
mean anything special for Vitastor core components. For now, you can use them as
|
|
||||||
you wish.
|
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
|
|||||||
+18
-60
@@ -33,7 +33,6 @@
|
|||||||
- [failure_domain](#failure_domain)
|
- [failure_domain](#failure_domain)
|
||||||
- [level_placement](#level_placement)
|
- [level_placement](#level_placement)
|
||||||
- [raw_placement](#raw_placement)
|
- [raw_placement](#raw_placement)
|
||||||
- [local_reads](#local_reads)
|
|
||||||
- [max_osd_combinations](#max_osd_combinations)
|
- [max_osd_combinations](#max_osd_combinations)
|
||||||
- [block_size](#block_size)
|
- [block_size](#block_size)
|
||||||
- [bitmap_granularity](#bitmap_granularity)
|
- [bitmap_granularity](#bitmap_granularity)
|
||||||
@@ -43,7 +42,7 @@
|
|||||||
- [osd_tags](#osd_tags)
|
- [osd_tags](#osd_tags)
|
||||||
- [primary_affinity_tags](#primary_affinity_tags)
|
- [primary_affinity_tags](#primary_affinity_tags)
|
||||||
- [scrub_interval](#scrub_interval)
|
- [scrub_interval](#scrub_interval)
|
||||||
- [used_for_app](#used_for_app)
|
- [used_for_fs](#used_for_fs)
|
||||||
|
|
||||||
Примеры:
|
Примеры:
|
||||||
|
|
||||||
@@ -134,8 +133,8 @@ OSD игнорируется и OSD не удаляется из распред
|
|||||||
## scheme
|
## scheme
|
||||||
|
|
||||||
- Тип: строка
|
- Тип: строка
|
||||||
- Возможные значения: "replicated", "xor", "ec" или "jerasure"
|
|
||||||
- Обязательный
|
- Обязательный
|
||||||
|
- Возможные значения: "replicated", "xor", "ec" или "jerasure"
|
||||||
|
|
||||||
Схема избыточности, используемая в данном пуле. "jerasure" - синоним для "ec",
|
Схема избыточности, используемая в данном пуле. "jerasure" - синоним для "ec",
|
||||||
в обеих схемах используются коды Рида-Соломона-Вандермонда, реализованные на
|
в обеих схемах используются коды Рида-Соломона-Вандермонда, реализованные на
|
||||||
@@ -257,7 +256,7 @@ PG в Vitastor эферемерны, то есть вы можете менят
|
|||||||
|
|
||||||
## raw_placement
|
## raw_placement
|
||||||
|
|
||||||
- Тип: строка
|
- Type: string
|
||||||
|
|
||||||
Низкоуровневые правила генерации PG в форме DSL (доменно-специфичного языка).
|
Низкоуровневые правила генерации PG в форме DSL (доменно-специфичного языка).
|
||||||
Используйте, только если действительно знаете, зачем вам это надо :)
|
Используйте, только если действительно знаете, зачем вам это надо :)
|
||||||
@@ -288,30 +287,6 @@ meow недоступен".
|
|||||||
- EC 4+2 в 3 датацентрах: `any, dc=1 host!=1, dc!=1, dc=3 host!=3, dc!=(1,3), dc=5 host!=5`
|
- EC 4+2 в 3 датацентрах: `any, dc=1 host!=1, dc!=1, dc=3 host!=3, dc!=(1,3), dc=5 host!=5`
|
||||||
- 1 копия в фиксированном ДЦ + 2 в других ДЦ: `dc?=meow, dc!=1, dc!=(1,2)`
|
- 1 копия в фиксированном ДЦ + 2 в других ДЦ: `dc?=meow, dc!=1, dc!=(1,2)`
|
||||||
|
|
||||||
## local_reads
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
- Возможные значения: "primary", "nearest" или "random"
|
|
||||||
- По умолчанию: primary
|
|
||||||
|
|
||||||
По умолчанию Vitastor обслуживает все запросы чтения и записи с первичного OSD каждой PG.
|
|
||||||
Однако, в чистых PG (active или active+left_on_dead) реплицированных пулов также есть
|
|
||||||
возможность обслуживать запросы чтения с вторичных OSD, что может быть полезно, если
|
|
||||||
у вас сильно отличается время сетевого обращения от клиента к разным OSD - например,
|
|
||||||
если у вас несколько дата-центров.
|
|
||||||
|
|
||||||
Если данный параметр установлен в значение "nearest", клиенты будут стараться читать с
|
|
||||||
ближайших по [Дереву размещения](#дерево-размещения) OSD, то есть, с OSD с того же хоста
|
|
||||||
или датацентра. Расстояние до разных OSD будет рассчитываться с помощью имени хоста клиента,
|
|
||||||
определяемого автоматически или заданного вручную параметром [hostname](client.ru.md#hostname).
|
|
||||||
|
|
||||||
Если данный параметр установлен в значение "random", клиенты будут стараться распределять
|
|
||||||
запросы чтения по всем доступным вторичным OSD. Этот режим в основном полезен для тестов,
|
|
||||||
но, скорее всего, редко нужен в реальных инсталляциях.
|
|
||||||
|
|
||||||
Для работы локальных чтений требуются [блокировки PG](osd.ru.md#enable_pg_locks). Включать
|
|
||||||
их явно не нужно - они включаются автоматически для пулов с включёнными локальными чтениями.
|
|
||||||
|
|
||||||
## max_osd_combinations
|
## max_osd_combinations
|
||||||
|
|
||||||
- Тип: целое число
|
- Тип: целое число
|
||||||
@@ -349,8 +324,7 @@ meow недоступен".
|
|||||||
|
|
||||||
## immediate_commit
|
## immediate_commit
|
||||||
|
|
||||||
- Тип: строка
|
- Тип: строка "all", "small" или "none"
|
||||||
- Возможные значения: "all", "small" или "none"
|
|
||||||
- По умолчанию: none
|
- По умолчанию: none
|
||||||
|
|
||||||
Настройка мгновенного коммита для данного пула. Если не задана, используется
|
Настройка мгновенного коммита для данного пула. Если не задана, используется
|
||||||
@@ -409,42 +383,26 @@ OSD с "all".
|
|||||||
Интервал скраба, то есть, автоматической фоновой проверки данных для данного пула.
|
Интервал скраба, то есть, автоматической фоновой проверки данных для данного пула.
|
||||||
Переопределяет [глобальную настройку scrub_interval](osd.ru.md#scrub_interval).
|
Переопределяет [глобальную настройку scrub_interval](osd.ru.md#scrub_interval).
|
||||||
|
|
||||||
## used_for_app
|
## used_for_fs
|
||||||
|
|
||||||
- Тип: строка
|
- Type: string
|
||||||
|
|
||||||
Если непусто, пул помечается как используемый для отдельного приложения, например,
|
Если непусто, пул помечается как используемый для файловой системы VitastorFS с
|
||||||
для VitastorFS или S3, которое распределяет ID образов в пуле само и не использует
|
метаданными, хранимыми в блочном образе Vitastor с именем, равным значению
|
||||||
метаданные образов/инодов в etcd.
|
этого параметра.
|
||||||
|
|
||||||
Когда пул помечается используемым для такого приложения, создание обычных блочных
|
Когда пул помечается как используемый для VitastorFS, создание обычных блочных
|
||||||
образов в нём запрещается (vitastor-cli отказывается создавать образы без --force),
|
образов в нём отключается (vitastor-cli отказывается создавать образы без --force),
|
||||||
чтобы защитить пользователя от коллизий ID блочных образов и томов ФС/S3, и,
|
чтобы защитить пользователя от коллизий ID файлов и блочных образов и, таким
|
||||||
таким образом, от потери данных.
|
образом, от потери данных.
|
||||||
|
|
||||||
Также для таких пулов отключается передача статистики в etcd по отдельным инодам,
|
|
||||||
так как использование для внешнего приложения подразумевает, что пул может содержать
|
|
||||||
очень много томов и их статистика может занять слишком много места в etcd.
|
|
||||||
|
|
||||||
Установка used_for_app в значение `fs:<name>` сообщает о том, что пул используется
|
|
||||||
для VitastorFS с базой метаданных VitastorKV, хранимой в блочном образе с именем
|
|
||||||
`<name>`.
|
|
||||||
|
|
||||||
[vitastor-nfs](../usage/nfs.ru.md), в свою очередь, при запуске отказывается
|
[vitastor-nfs](../usage/nfs.ru.md), в свою очередь, при запуске отказывается
|
||||||
использовать для ФС пулы, не помеченные, как используемые для неё. Это также
|
использовать для ФС пулы, не выделенные для неё. Это также означает, что один
|
||||||
означает, что один пул может использоваться только для одной VitastorFS.
|
пул может использоваться только для одной VitastorFS.
|
||||||
|
|
||||||
Если же вы планируете использовать пул для данных S3, установите его used_for_app
|
Также для ФС-пулов отключается передача статистики в etcd по отдельным инодам,
|
||||||
в значение `s3:<name>`, где `<name>` - любое название по вашему усмотрению
|
так как ФС-пул может содержать очень много файлов и статистика по ним всем
|
||||||
(например, `s3:standard`) - конкретное содержимое `<name>` пока никак не проверяется
|
заняла бы очень много места в etcd.
|
||||||
компонентами Vitastor S3.
|
|
||||||
|
|
||||||
Смотрите также [allow_net_split](osd.ru.md#allow_net_split) и
|
|
||||||
[документацию по состояниям PG](../usage/admin.ru.md#состояния-pg).
|
|
||||||
|
|
||||||
Все остальные значения used_for_app, кроме начинающихся на `fs:` или `s3:`, не
|
|
||||||
означают ничего особенного для основных компонентов Vitastor. Поэтому сейчас вы
|
|
||||||
можете использовать их свободно любым желаемым способом.
|
|
||||||
|
|
||||||
# Примеры
|
# Примеры
|
||||||
|
|
||||||
|
|||||||
@@ -1,150 +0,0 @@
|
|||||||
[Documentation](../../README.md#documentation) → [Configuration](../config.en.md) → Security Parameters
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Читать на русском](security.ru.md)
|
|
||||||
|
|
||||||
# Security Parameters
|
|
||||||
|
|
||||||
These parameters affect your Vitastor installation security and apply to OSDs, monitors and clients.
|
|
||||||
|
|
||||||
Most of them can be set in /etc/vitastor/vitastor.conf and in etcd, but don't support online modification.
|
|
||||||
|
|
||||||
- [etcd_client_cert](#etcd_client_cert)
|
|
||||||
- [etcd_client_key](#etcd_client_key)
|
|
||||||
- [etcd_ca](#etcd_ca)
|
|
||||||
- [osd_etcd_client_cert](#osd_etcd_client_cert)
|
|
||||||
- [osd_etcd_client_key](#osd_etcd_client_key)
|
|
||||||
- [mon_etcd_client_cert](#mon_etcd_client_cert)
|
|
||||||
- [mon_etcd_client_key](#mon_etcd_client_key)
|
|
||||||
- [vault_url](#vault_url)
|
|
||||||
- [vault_secret_api_path](#vault_secret_api_path)
|
|
||||||
- [vault_client_cert](#vault_client_cert)
|
|
||||||
- [vault_client_key](#vault_client_key)
|
|
||||||
- [vault_ca](#vault_ca)
|
|
||||||
- [vault_timeout_ms](#vault_timeout_ms)
|
|
||||||
- [vault_error_timeout_sec](#vault_error_timeout_sec)
|
|
||||||
- [vault_refresh_leeway_sec](#vault_refresh_leeway_sec)
|
|
||||||
- [max_aes_xts_pool_size](#max_aes_xts_pool_size)
|
|
||||||
|
|
||||||
## etcd_client_cert
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Client TLS certificate to use for Vitastor client (not OSD and not monitor)
|
|
||||||
etcd https connections. May be path to a file or just a PEM string with certificate.
|
|
||||||
In the latter case, string must begin with "-----BEGIN CERTIFICATE-----".
|
|
||||||
|
|
||||||
## etcd_client_key
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Private key for etcd_client_cert (also a file or a PEM string).
|
|
||||||
|
|
||||||
## etcd_ca
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Trusted TLS CA to verify etcd server certificate. May be path to a file,
|
|
||||||
directory or just a PEM string with certificate.
|
|
||||||
|
|
||||||
## osd_etcd_client_cert
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Same as [etcd_client_cert](#etcd_client_cert), but only for OSDs.
|
|
||||||
OSDs, clients and monitors should have different permissions, so they should
|
|
||||||
use different certificates.
|
|
||||||
|
|
||||||
## osd_etcd_client_key
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Same as [etcd_client_key](#etcd_client_key), but only for OSDs.
|
|
||||||
|
|
||||||
## mon_etcd_client_cert
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Same as [etcd_client_cert](#etcd_client_cert), but only for Vitastor monitors.
|
|
||||||
|
|
||||||
## mon_etcd_client_key
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Same as [etcd_client_key](#etcd_client_key), but only for Vitastor monitors.
|
|
||||||
|
|
||||||
## vault_url
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Vault base URL.
|
|
||||||
|
|
||||||
Vitastor clients support AES-256-XTS image data encryption with different per-image keys.
|
|
||||||
Encryption is performed by the client, OSDs don't have access to decrypted data.
|
|
||||||
|
|
||||||
Encryption keys may be stored in etcd or, for the increased security level, in an external
|
|
||||||
[HashiCorp Vault](https://developer.hashicorp.com/vault/) or [OpenBao](https://openbao.org/)
|
|
||||||
instance.
|
|
||||||
|
|
||||||
Vitastor clients use [v1 k/v secrets engine](https://openbao.org/api-docs/secret/kv/kv-v1/)
|
|
||||||
and [TLS authentication engine](https://openbao.org/api-docs/auth/cert/) in Vault.
|
|
||||||
|
|
||||||
In that case, only key IDs are stored in etcd.
|
|
||||||
|
|
||||||
## vault_secret_api_path
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
- Default: /v1/secret/
|
|
||||||
|
|
||||||
Vault v1 secret API mount path to use.
|
|
||||||
|
|
||||||
## vault_client_cert
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Client TLS certificate to use for Vault connections. Just like [etcd_client_cert](#etcd_client_cert),
|
|
||||||
may be path to a file or just a certificate in PEM string.
|
|
||||||
|
|
||||||
## vault_client_key
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Private key for vault_client_cert (also a file or a PEM string).
|
|
||||||
|
|
||||||
## vault_ca
|
|
||||||
|
|
||||||
- Type: string
|
|
||||||
|
|
||||||
Trusted TLS CA to verify Vault server certificate. May be path to a file,
|
|
||||||
directory or just a PEM string with certificate.
|
|
||||||
|
|
||||||
## vault_timeout_ms
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 5000
|
|
||||||
|
|
||||||
Timeout for Vault requests in milliseconds.
|
|
||||||
|
|
||||||
## vault_error_timeout_sec
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 60
|
|
||||||
|
|
||||||
Time (in seconds) to wait before retrying after receiving an error from Vault.
|
|
||||||
|
|
||||||
## vault_refresh_leeway_sec
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 60
|
|
||||||
|
|
||||||
Extra time (in seconds) before real Vault token lease_timeout to refresh it, just
|
|
||||||
in case of system clock drift.
|
|
||||||
|
|
||||||
## max_aes_xts_pool_size
|
|
||||||
|
|
||||||
- Type: integer
|
|
||||||
- Default: 256
|
|
||||||
|
|
||||||
Maximum number of OpenSSL encryption contexts cached in OSD memory. Probably
|
|
||||||
doesn't require modification.
|
|
||||||
@@ -1,154 +0,0 @@
|
|||||||
[Документация](../../README-ru.md#документация) → [Конфигурация](../config.ru.md) → Параметры безопасности
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Read in English](security.en.md)
|
|
||||||
|
|
||||||
# Параметры безопасности
|
|
||||||
|
|
||||||
Данные параметры затрагивают безопасность инсталляций Vitastor и используются
|
|
||||||
OSD, мониторами и клиентами.
|
|
||||||
|
|
||||||
Большая их часть может задаваться в /etc/vitastor/vitastor.conf и в etcd, но не
|
|
||||||
поддерживает онлайн-изменение.
|
|
||||||
|
|
||||||
- [etcd_client_cert](#etcd_client_cert)
|
|
||||||
- [etcd_client_key](#etcd_client_key)
|
|
||||||
- [etcd_ca](#etcd_ca)
|
|
||||||
- [osd_etcd_client_cert](#osd_etcd_client_cert)
|
|
||||||
- [osd_etcd_client_key](#osd_etcd_client_key)
|
|
||||||
- [mon_etcd_client_cert](#mon_etcd_client_cert)
|
|
||||||
- [mon_etcd_client_key](#mon_etcd_client_key)
|
|
||||||
- [vault_url](#vault_url)
|
|
||||||
- [vault_secret_api_path](#vault_secret_api_path)
|
|
||||||
- [vault_client_cert](#vault_client_cert)
|
|
||||||
- [vault_client_key](#vault_client_key)
|
|
||||||
- [vault_ca](#vault_ca)
|
|
||||||
- [vault_timeout_ms](#vault_timeout_ms)
|
|
||||||
- [vault_error_timeout_sec](#vault_error_timeout_sec)
|
|
||||||
- [vault_refresh_leeway_sec](#vault_refresh_leeway_sec)
|
|
||||||
- [max_aes_xts_pool_size](#max_aes_xts_pool_size)
|
|
||||||
|
|
||||||
## etcd_client_cert
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Клиентский TLS сертификат для https-подключений к etcd для клиентов Vitastor
|
|
||||||
(не OSD и не мониторов). Может быть путём к файлу или просто строкой с
|
|
||||||
сертификатом в формате PEM. В последнем случае строка должна начинаться с
|
|
||||||
"-----BEGIN CERTIFICATE-----".
|
|
||||||
|
|
||||||
## etcd_client_key
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Закрытый ключ для сертификата etcd_client_cert (также путь к файлу или PEM строка).
|
|
||||||
|
|
||||||
## etcd_ca
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Доверенный корневой TLS-сертификат для проверки сертификата сервера etcd.
|
|
||||||
Может быть путём к файлу, директории или просто строкой с сертификатом в
|
|
||||||
формате PEM.
|
|
||||||
|
|
||||||
## osd_etcd_client_cert
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Аналогично [etcd_client_cert](#etcd_client_cert), но только для OSD.
|
|
||||||
OSD, клиенты и мониторы должны иметь разные привилегии, поэтому они должны
|
|
||||||
использовать разные сертификаты.
|
|
||||||
|
|
||||||
## osd_etcd_client_key
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Аналогично [etcd_client_key](#etcd_client_key), но только для OSD.
|
|
||||||
|
|
||||||
## mon_etcd_client_cert
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Аналогично [etcd_client_cert](#etcd_client_cert), но только для мониторов Vitastor.
|
|
||||||
|
|
||||||
## mon_etcd_client_key
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Аналогично [etcd_client_key](#etcd_client_key), но только для мониторов Vitastor.
|
|
||||||
|
|
||||||
## vault_url
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Базовый адрес Vault.
|
|
||||||
|
|
||||||
Клиенты Vitastor поддерживают AES-256-XTS шифрование данных образов с отдельными ключами на
|
|
||||||
каждый образ. Данные шифруются клиентами, OSD не имеют доступа к незашифрованным данным.
|
|
||||||
|
|
||||||
Ключи шифрования могут храниться в etcd или, для повышенного уровня безопасности, во внешнем
|
|
||||||
[HashiCorp Vault](https://developer.hashicorp.com/vault/) или [OpenBao](https://openbao.org/).
|
|
||||||
|
|
||||||
Клиенты Vitastor используют [движок секретов v1](https://openbao.org/api-docs/secret/kv/kv-v1/)
|
|
||||||
и [TLS-аутентификацию](https://openbao.org/api-docs/auth/cert/) в Vault.
|
|
||||||
|
|
||||||
В этом случае, только ID ключей хранятся в etcd.
|
|
||||||
|
|
||||||
## vault_secret_api_path
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
- Значение по умолчанию: /v1/secret/
|
|
||||||
|
|
||||||
Путь к API секретов v1 для использования клиентами.
|
|
||||||
|
|
||||||
## vault_client_cert
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Клиентский TLS сертификат для подключений к Vault. Как и [etcd_client_cert](#etcd_client_cert),
|
|
||||||
может быть путём к файлу или просто PEM-строкой с сертификатом.
|
|
||||||
|
|
||||||
## vault_client_key
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Закрытый ключ для сертификата vault_client_cert (также путь к файлу или PEM строка).
|
|
||||||
|
|
||||||
## vault_ca
|
|
||||||
|
|
||||||
- Тип: строка
|
|
||||||
|
|
||||||
Доверенный корневой TLS-сертификат для проверки сертификата сервера Vault.
|
|
||||||
Может быть путём к файлу, директории или просто строкой с сертификатом в
|
|
||||||
формате PEM.
|
|
||||||
|
|
||||||
## vault_timeout_ms
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 5000
|
|
||||||
|
|
||||||
Максимально время выполнения Vault-запросов в миллисекундах.
|
|
||||||
|
|
||||||
## vault_error_timeout_sec
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 60
|
|
||||||
|
|
||||||
Время (в секундах) для ожидания перед повторной попыткой при получении ошибки от Vault.
|
|
||||||
|
|
||||||
## vault_refresh_leeway_sec
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 60
|
|
||||||
|
|
||||||
Зазор времени (в секундах), чтобы обновлять токены Vault чуть раньше их реального
|
|
||||||
lease_timeout, на случай "ухода" системных часов.
|
|
||||||
|
|
||||||
## max_aes_xts_pool_size
|
|
||||||
|
|
||||||
- Тип: целое число
|
|
||||||
- Значение по умолчанию: 256
|
|
||||||
|
|
||||||
Максимальное количество кэшируемых в памяти OSD контекстов шифрования OpenSSL.
|
|
||||||
Вряд ли требует изменения.
|
|
||||||
@@ -271,48 +271,3 @@
|
|||||||
заполненные на 100% OSD вообще не могут стартовать), так что вы сможете
|
заполненные на 100% OSD вообще не могут стартовать), так что вы сможете
|
||||||
восстановить работу кластера после ошибок отсутствия свободного места
|
восстановить работу кластера после ошибок отсутствия свободного места
|
||||||
без уничтожения и пересоздания OSD.
|
без уничтожения и пересоздания OSD.
|
||||||
- name: hostname
|
|
||||||
type: string
|
|
||||||
online: true
|
|
||||||
info: |
|
|
||||||
Clients use host name to find their distance to OSDs when [localized reads](pool.en.md#local_reads)
|
|
||||||
are enabled. By default, standard [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html)
|
|
||||||
function is used to determine host name, but you can also override it with this parameter.
|
|
||||||
info_ru: |
|
|
||||||
Клиенты используют имя хоста для определения расстояния до OSD, когда включены
|
|
||||||
[локальные чтения](pool.ru.md#local_reads). По умолчанию для определения имени
|
|
||||||
хоста используется стандартная функция [gethostname](https://man7.org/linux/man-pages/man2/gethostname.2.html),
|
|
||||||
но вы также можете задать имя хоста вручную данным параметром.
|
|
||||||
- name: ublk_queue_depth
|
|
||||||
type: int
|
|
||||||
default: 256
|
|
||||||
online: false
|
|
||||||
info: Default queue depth for [Vitastor ublk servers](../usage/ublk.en.md).
|
|
||||||
info_ru: Глубина очереди по умолчанию для [ublk-серверов Vitastor](../usage/ublk.ru.md).
|
|
||||||
- name: ublk_max_io_size
|
|
||||||
type: int
|
|
||||||
online: false
|
|
||||||
info: |
|
|
||||||
Default maximum I/O size for Vitastor [ublk servers](../usage/ublk.en.md).
|
|
||||||
The largest of 1 MB and pool block size multiplied by EC data chunk count is used if not specified.
|
|
||||||
info_ru: |
|
|
||||||
Максимальный размер запроса ввода-вывода для [ublk-серверов Vitastor](../usage/ublk.ru.md).
|
|
||||||
Если не задан, используется максимум из 1 МБ и размера блока пула, умноженного на число частей
|
|
||||||
данных EC-пула.
|
|
||||||
- name: qemu_file_mirror_path
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
When set to an FS directory path (for example, `/mnt/vitastor/`), `qemu-img info` and similar
|
|
||||||
QAPI commands return the name of the image inside this directory instead of normal
|
|
||||||
`vitastor://?image=abc` URI as `filename`.
|
|
||||||
|
|
||||||
This allows to then mount this path using [vitastor-nfs](../usage/nfs.en.md) and trick
|
|
||||||
third-party systems like Veeam which rely on `filename` in the image info but don't support Vitastor.
|
|
||||||
info_ru: |
|
|
||||||
Если установить эту опцию равной пути к каталогу в ФС, команда `qemu-img info` и подобные
|
|
||||||
команды QAPI будут возвращать в поле `filename` имя образа внутри заданного каталога вместо
|
|
||||||
обычного адреса типа `vitastor://?image=abc`.
|
|
||||||
|
|
||||||
Это позволяет смонтировать этот путь с помощью [vitastor-nfs](../usage/nfs.ru.md) и обмануть
|
|
||||||
сторонние системы типа Veeam, которые полагаются на поле `filename` в информации об образе QEMU,
|
|
||||||
но не поддерживают Vitastor.
|
|
||||||
|
|||||||
@@ -24,8 +24,6 @@
|
|||||||
|
|
||||||
{{../../installation/kubernetes.en.md}}
|
{{../../installation/kubernetes.en.md}}
|
||||||
|
|
||||||
{{../../installation/s3.en.md}}
|
|
||||||
|
|
||||||
{{../../installation/source.en.md}}
|
{{../../installation/source.en.md}}
|
||||||
|
|
||||||
{{../../config.en.md|indent=1}}
|
{{../../config.en.md|indent=1}}
|
||||||
@@ -44,8 +42,6 @@
|
|||||||
|
|
||||||
{{../../config/monitor.en.md|indent=2}}
|
{{../../config/monitor.en.md|indent=2}}
|
||||||
|
|
||||||
{{../../config/security.en.md|indent=2}}
|
|
||||||
|
|
||||||
{{../../config/pool.en.md|indent=2}}
|
{{../../config/pool.en.md|indent=2}}
|
||||||
|
|
||||||
{{../../config/inode.en.md|indent=2}}
|
{{../../config/inode.en.md|indent=2}}
|
||||||
@@ -58,8 +54,6 @@
|
|||||||
|
|
||||||
{{../../usage/fio.en.md}}
|
{{../../usage/fio.en.md}}
|
||||||
|
|
||||||
{{../../usage/ublk.en.md}}
|
|
||||||
|
|
||||||
{{../../usage/nbd.en.md}}
|
{{../../usage/nbd.en.md}}
|
||||||
|
|
||||||
{{../../usage/qemu.en.md}}
|
{{../../usage/qemu.en.md}}
|
||||||
|
|||||||
@@ -26,8 +26,6 @@
|
|||||||
|
|
||||||
{{../../installation/source.ru.md}}
|
{{../../installation/source.ru.md}}
|
||||||
|
|
||||||
{{../../installation/s3.ru.md}}
|
|
||||||
|
|
||||||
{{../../config.ru.md|indent=1}}
|
{{../../config.ru.md|indent=1}}
|
||||||
|
|
||||||
{{../../config/common.ru.md|indent=2}}
|
{{../../config/common.ru.md|indent=2}}
|
||||||
@@ -44,8 +42,6 @@
|
|||||||
|
|
||||||
{{../../config/monitor.ru.md|indent=2}}
|
{{../../config/monitor.ru.md|indent=2}}
|
||||||
|
|
||||||
{{../../config/security.ru.md|indent=2}}
|
|
||||||
|
|
||||||
{{../../config/pool.ru.md|indent=2}}
|
{{../../config/pool.ru.md|indent=2}}
|
||||||
|
|
||||||
{{../../config/inode.ru.md|indent=2}}
|
{{../../config/inode.ru.md|indent=2}}
|
||||||
@@ -58,8 +54,6 @@
|
|||||||
|
|
||||||
{{../../usage/fio.ru.md}}
|
{{../../usage/fio.ru.md}}
|
||||||
|
|
||||||
{{../../usage/ublk.ru.md}}
|
|
||||||
|
|
||||||
{{../../usage/nbd.ru.md}}
|
{{../../usage/nbd.ru.md}}
|
||||||
|
|
||||||
{{../../usage/qemu.ru.md}}
|
{{../../usage/qemu.ru.md}}
|
||||||
|
|||||||
@@ -1,28 +1,3 @@
|
|||||||
- name: meta_format
|
|
||||||
type: int
|
|
||||||
default: 3
|
|
||||||
info: |
|
|
||||||
OSD store implementation version and on-disk metadata format.
|
|
||||||
|
|
||||||
Three versions are currently supported: 3, 2 and 1.
|
|
||||||
- 3 the new log-structured store, it's overall faster, has lower Write
|
|
||||||
Amplification, which may be even close to 1 (i.e. almost no extra writes)
|
|
||||||
if your SSDs support atomic writes (see [atomic_write_size](osd.en.md#atomic_write_size)).
|
|
||||||
- 2 is the old stable store from Vitastor 0.9-2.x.
|
|
||||||
- 1 is the same old store but with a legacy metadata format from Vitastor
|
|
||||||
versions to up 0.8.x, without any support for checksums.
|
|
||||||
info_ru: |
|
|
||||||
Версия реализации дискового хранилища OSD и дискового формата метаданных.
|
|
||||||
|
|
||||||
Поддерживаются три версии: 3, 2 и 1.
|
|
||||||
- 3 - новое лог-структурированное хранилище, в целом более быстрое, со
|
|
||||||
сниженным фактором амплификации записи, который может составлять около 1
|
|
||||||
(то есть, практически без лишней служебной записи), если ваши SSD
|
|
||||||
поддерживают атомарную запись (см. [atomic_write_size](osd.ru.md#atomic_write_size)).
|
|
||||||
- 2 - старое стабильное хранилище из версий Vitastor 0.9-2.x.
|
|
||||||
- 1 - то же самое стабильное хранилище, но с ещё более старым форматом
|
|
||||||
метаданных из версий Vitastor до 0.8.x, без какой-либо поддержки
|
|
||||||
контрольных сумм.
|
|
||||||
- name: data_device
|
- name: data_device
|
||||||
type: string
|
type: string
|
||||||
info: |
|
info: |
|
||||||
@@ -233,21 +208,11 @@
|
|||||||
type: string
|
type: string
|
||||||
default: none
|
default: none
|
||||||
info: |
|
info: |
|
||||||
Data and metadata checksum type to use. May be "crc32c", "xxh3_32" or "none".
|
Data checksum type to use. May be "crc32c" or "none". Set to "crc32c" to
|
||||||
Select crc32c or xxh3_32 and set csum_block_size to enable data checksums.
|
enable data checksums.
|
||||||
|
|
||||||
Both crc32c and xxh3_32 are almost equally fast, xxh3_32 is safer. xxh3_32 is
|
|
||||||
the xxhash3 algorithm truncated from 64 to 32 bits (which is still a good hash).
|
|
||||||
|
|
||||||
Note that enabled data checksums either increase memory usage or reduce
|
|
||||||
performance. Check details in [csum_block_size](#csum_block_size) description.
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Тип используемых OSD контрольных сумм данных и метаданных. Может быть "crc32c",
|
Тип используемых OSD контрольных сумм данных. Может быть "crc32c" или "none".
|
||||||
"xxh3_32" или "none". Выберите crc32c или xxh3_32 и установите csum_block_size,
|
Установите в "crc32c", чтобы включить расчёт и проверку контрольных сумм данных.
|
||||||
чтобы включить контрольные суммы данных.
|
|
||||||
|
|
||||||
И crc32c, и xxh3_32 примерно одинаково быстры, xxh3_32 надёжней. xxh3_32 - это
|
|
||||||
алгоритм xxhash3, обрезанный с 64 до 32 бит (это всё равно хороший хеш).
|
|
||||||
|
|
||||||
Следует понимать, что контрольные суммы в зависимости от размера блока их
|
Следует понимать, что контрольные суммы в зависимости от размера блока их
|
||||||
расчёта либо увеличивают потребление памяти, либо снижают производительность.
|
расчёта либо увеличивают потребление памяти, либо снижают производительность.
|
||||||
|
|||||||
@@ -75,11 +75,11 @@
|
|||||||
- name: mon_http_port
|
- name: mon_http_port
|
||||||
type: int
|
type: int
|
||||||
default: 8060
|
default: 8060
|
||||||
info: HTTP port for monitors to listen to (including metrics exporter)
|
info: HTTP port for monitors to listen on (including metrics exporter)
|
||||||
info_ru: Порт, на котором мониторы принимают HTTP-соединения (в том числе для отдачи метрик)
|
info_ru: Порт, на котором мониторы принимают HTTP-соединения (в том числе для отдачи метрик)
|
||||||
- name: mon_http_ip
|
- name: mon_http_ip
|
||||||
type: string
|
type: string
|
||||||
info: IP address for monitors to listen to (all addresses by default)
|
info: IP address for monitors to listen on (all addresses by default)
|
||||||
info_ru: IP-адрес, на котором мониторы принимают HTTP-соединения (по умолчанию все адреса)
|
info_ru: IP-адрес, на котором мониторы принимают HTTP-соединения (по умолчанию все адреса)
|
||||||
- name: mon_https_cert
|
- name: mon_https_cert
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
+92
-205
@@ -1,78 +1,49 @@
|
|||||||
- name: osd_network
|
- name: tcp_header_buffer_size
|
||||||
type: string or array of strings
|
type: int
|
||||||
type_ru: строка или массив строк
|
default: 65536
|
||||||
info: |
|
info: |
|
||||||
Network mask of public OSD network(s) (IPv4 or IPv6). Each OSD listens to all
|
Size of the buffer used to read data using an additional copy. Vitastor
|
||||||
addresses of UP + RUNNING interfaces matching one of these networks, on the
|
packet headers are 128 bytes, payload is always at least 4 KB, so it is
|
||||||
same port. Port is auto-selected except if [bind_port](osd.en.md#bind_port) is
|
usually beneficial to try to read multiple packets at once even though
|
||||||
explicitly specified. Bind address(es) may also be overridden manually by
|
it requires to copy the data an additional time. The rest of each packet
|
||||||
specifying [bind_address](osd.en.md#bind_address). If OSD networks are not specified
|
is received without an additional copy. You can try to play with this
|
||||||
at all, OSD just listens to a wildcard address (0.0.0.0).
|
parameter and see how it affects random iops and linear bandwidth if you
|
||||||
|
want.
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Маски подсетей (IPv4 или IPv6) публичной сети или сетей OSD. Каждый OSD слушает
|
Размер буфера для чтения данных с дополнительным копированием. Пакеты
|
||||||
один и тот же порт на всех адресах поднятых (UP + RUNNING) сетевых интерфейсов,
|
Vitastor содержат 128-байтные заголовки, за которыми следуют данные размером
|
||||||
соответствующих одной из указанных сетей. Порт выбирается автоматически, если
|
от 4 КБ и для мелких операций ввода-вывода обычно выгодно за 1 вызов читать
|
||||||
только [bind_port](osd.ru.md#bind_port) не задан явно. Адреса для подключений можно
|
сразу несколько пакетов, даже не смотря на то, что это требует лишний раз
|
||||||
также переопределить явно, задав [bind_address](osd.ru.md#bind_address). Если сети OSD
|
скопировать данные. Часть каждого пакета за пределами значения данного
|
||||||
не заданы вообще, OSD слушает все адреса (0.0.0.0).
|
параметра читается без дополнительного копирования. Вы можете попробовать
|
||||||
- name: osd_cluster_network
|
поменять этот параметр и посмотреть, как он влияет на производительность
|
||||||
type: string or array of strings
|
случайного и линейного доступа.
|
||||||
type_ru: строка или массив строк
|
- name: use_sync_send_recv
|
||||||
|
type: bool
|
||||||
|
default: false
|
||||||
info: |
|
info: |
|
||||||
Network mask of separate network(s) (IPv4 or IPv6) to use for OSD
|
If true, synchronous send/recv syscalls are used instead of io_uring for
|
||||||
cluster connections. I.e. OSDs will always attempt to use these networks
|
socket communication. Useless for OSDs because they require io_uring anyway,
|
||||||
to connect to other OSDs, while clients will attempt to use networks from
|
but may be required for clients with old kernel versions.
|
||||||
[osd_network](#osd_network).
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Маски подсетей (IPv4 или IPv6) отдельной кластерной сети или сетей OSD.
|
Если установлено в истину, то вместо io_uring для передачи данных по сети
|
||||||
То есть, OSD будут всегда стараться использовать эти сети для соединений
|
будут использоваться обычные синхронные системные вызовы send/recv. Для OSD
|
||||||
с другими OSD, а клиенты будут стараться использовать сети из [osd_network](#osd_network).
|
это бессмысленно, так как OSD в любом случае нуждается в io_uring, но, в
|
||||||
|
принципе, это может применяться для клиентов со старыми версиями ядра.
|
||||||
- name: use_rdma
|
- name: use_rdma
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
info: |
|
info: |
|
||||||
Try to use RDMA through libibverbs for communication if it's available.
|
Try to use RDMA for communication if it's available. Disable if you don't
|
||||||
Disable if you don't want Vitastor to use RDMA. TCP-only clients can also
|
want Vitastor to use RDMA. TCP-only clients can also talk to an RDMA-enabled
|
||||||
talk to an RDMA-enabled cluster, so disabling RDMA may be needed if clients
|
cluster, so disabling RDMA may be needed if clients have RDMA devices,
|
||||||
have RDMA devices, but they are not connected to the cluster.
|
but they are not connected to the cluster.
|
||||||
|
|
||||||
`use_rdma` works with RoCEv1/RoCEv2 networks, but not with iWARP and,
|
|
||||||
maybe, with some Infiniband configurations which require RDMA-CM.
|
|
||||||
Consider `use_rdmacm` for such networks.
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Попробовать использовать RDMA через libibverbs для связи при наличии
|
Пытаться использовать RDMA для связи при наличии доступных устройств.
|
||||||
доступных устройств. Отключите, если вы не хотите, чтобы Vitastor
|
Отключите, если вы не хотите, чтобы Vitastor использовал RDMA.
|
||||||
использовал RDMA. TCP-клиенты также могут работать с RDMA-кластером,
|
TCP-клиенты также могут работать с RDMA-кластером, так что отключать
|
||||||
так что отключать RDMA может быть нужно, только если у клиентов есть
|
RDMA может быть нужно только если у клиентов есть RDMA-устройства,
|
||||||
RDMA-устройства, но они не имеют соединения с кластером Vitastor.
|
но они не имеют соединения с кластером Vitastor.
|
||||||
|
|
||||||
`use_rdma` работает с RoCEv1/RoCEv2 сетями, но не работает с iWARP и
|
|
||||||
может не работать с частью конфигураций Infiniband, требующих RDMA-CM.
|
|
||||||
Рассмотрите включение `use_rdmacm` для таких сетей.
|
|
||||||
- name: use_rdmacm
|
|
||||||
type: bool
|
|
||||||
default: false
|
|
||||||
info: |
|
|
||||||
Use an alternative implementation of RDMA through RDMA-CM (Connection
|
|
||||||
Manager). Works with all RDMA networks: Infiniband, iWARP and
|
|
||||||
RoCEv1/RoCEv2, and even allows to disable TCP and run only with RDMA.
|
|
||||||
OSDs always use random port numbers for RDMA-CM listeners, different
|
|
||||||
from their TCP ports. `use_rdma` is automatically disabled when
|
|
||||||
`use_rdmacm` is enabled.
|
|
||||||
info_ru: |
|
|
||||||
Использовать альтернативную реализацию RDMA на основе RDMA-CM (Connection
|
|
||||||
Manager). Работает со всеми типами RDMA-сетей: Infiniband, iWARP и
|
|
||||||
RoCEv1/RoCEv2, и даже позволяет полностью отключить TCP и работать
|
|
||||||
только на RDMA. OSD используют случайные номера портов для ожидания
|
|
||||||
соединений через RDMA-CM, отличающиеся от их TCP-портов. Также при
|
|
||||||
включении `use_rdmacm` автоматически отключается опция `use_rdma`.
|
|
||||||
- name: disable_tcp
|
|
||||||
type: bool
|
|
||||||
default: true
|
|
||||||
info: |
|
|
||||||
Fully disable TCP and only use RDMA-CM for OSD communication.
|
|
||||||
info_ru: |
|
|
||||||
Полностью отключить TCP и использовать только RDMA-CM для соединений с OSD.
|
|
||||||
- name: rdma_device
|
- name: rdma_device
|
||||||
type: string
|
type: string
|
||||||
info: |
|
info: |
|
||||||
@@ -84,6 +55,11 @@
|
|||||||
unsupported with old libibverbs < v32, like in Debian 10 Buster or
|
unsupported with old libibverbs < v32, like in Debian 10 Buster or
|
||||||
CentOS 7.
|
CentOS 7.
|
||||||
|
|
||||||
|
Vitastor supports all adapters, even ones without ODP support, like
|
||||||
|
Mellanox ConnectX-3 and non-Mellanox cards. Versions up to Vitastor
|
||||||
|
1.2.0 required ODP which is only present in Mellanox ConnectX >= 4.
|
||||||
|
See also [rdma_odp](#rdma_odp).
|
||||||
|
|
||||||
Run `ibv_devinfo -v` as root to list available RDMA devices and their
|
Run `ibv_devinfo -v` as root to list available RDMA devices and their
|
||||||
features.
|
features.
|
||||||
|
|
||||||
@@ -92,23 +68,6 @@
|
|||||||
the manual of your network vendor for details about setting up the switch
|
the manual of your network vendor for details about setting up the switch
|
||||||
for RoCEv2 correctly. Usually it means setting up Lossless Ethernet with
|
for RoCEv2 correctly. Usually it means setting up Lossless Ethernet with
|
||||||
PFC (Priority Flow Control) and ECN (Explicit Congestion Notification).
|
PFC (Priority Flow Control) and ECN (Explicit Congestion Notification).
|
||||||
|
|
||||||
Vitastor supports all adapters, even ones without ODP (On-Demand Paging)
|
|
||||||
support, like Mellanox ConnectX-3 and non-Mellanox cards. ODP is only present
|
|
||||||
in Mellanox ConnectX >= 4 adapters and allows to skip memory registration
|
|
||||||
for RDMA and thus, in theory, avoid memory copying.
|
|
||||||
|
|
||||||
Versions up to Vitastor 1.2.0 required ODP, then it was disabled by default,
|
|
||||||
but it was still supported up to 3.0.3. Now ODP support is removed because it
|
|
||||||
actually only hurts performance: an example 3-node cluster with 8 NVMe in each
|
|
||||||
node and 2*25 GBit/s ConnectX-6 RDMA network pushed 3950000 read iops without
|
|
||||||
ODP, but only 239000 iops with ODP.
|
|
||||||
|
|
||||||
This happens because Mellanox ODP implementation seems to be based on
|
|
||||||
message retransmissions when the adapter doesn't know about the buffer yet -
|
|
||||||
it likely uses standard "RNR retransmissions" (RNR = receiver not ready)
|
|
||||||
which is generally slow in RDMA/RoCE networks. Here's a presentation about
|
|
||||||
it from ISPASS-2021 conference: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Название RDMA-устройства для связи с Vitastor OSD (например, "rocep5s0f0").
|
Название RDMA-устройства для связи с Vitastor OSD (например, "rocep5s0f0").
|
||||||
Если не указано, Vitastor попробует найти RoCE-устройство, соответствующее
|
Если не указано, Vitastor попробует найти RoCE-устройство, соответствующее
|
||||||
@@ -117,6 +76,12 @@
|
|||||||
не задана. Также автовыбор не поддерживается со старыми версиями библиотеки
|
не задана. Также автовыбор не поддерживается со старыми версиями библиотеки
|
||||||
libibverbs < v32, например в Debian 10 Buster или CentOS 7.
|
libibverbs < v32, например в Debian 10 Buster или CentOS 7.
|
||||||
|
|
||||||
|
Vitastor поддерживает все модели адаптеров, включая те, у которых
|
||||||
|
нет поддержки ODP, то есть вы можете использовать RDMA с ConnectX-3 и
|
||||||
|
картами производства не Mellanox. Версии Vitastor до 1.2.0 включительно
|
||||||
|
требовали ODP, который есть только на Mellanox ConnectX 4 и более новых.
|
||||||
|
См. также [rdma_odp](#rdma_odp).
|
||||||
|
|
||||||
Запустите `ibv_devinfo -v` от имени суперпользователя, чтобы посмотреть
|
Запустите `ibv_devinfo -v` от имени суперпользователя, чтобы посмотреть
|
||||||
список доступных RDMA-устройств, их параметры и возможности.
|
список доступных RDMA-устройств, их параметры и возможности.
|
||||||
|
|
||||||
@@ -126,39 +91,18 @@
|
|||||||
коммутатора для RoCEv2 ищите в документации производителя. Обычно это
|
коммутатора для RoCEv2 ищите в документации производителя. Обычно это
|
||||||
подразумевает настройку сети без потерь на основе PFC (Priority Flow
|
подразумевает настройку сети без потерь на основе PFC (Priority Flow
|
||||||
Control) и ECN (Explicit Congestion Notification).
|
Control) и ECN (Explicit Congestion Notification).
|
||||||
|
|
||||||
Vitastor поддерживает все модели адаптеров, включая те, у которых нет
|
|
||||||
поддержки ODP (On-Demand Paging), например, ConnectX-3 и карты производства
|
|
||||||
не Mellanox. Функция ODP доступна только на адаптерах Mellanox ConnectX-4 и
|
|
||||||
более новых и позволяет не регистрировать память для её использования RDMA-картой,
|
|
||||||
благодаря чему в теории можно избежать лишних копирований памяти.
|
|
||||||
|
|
||||||
Версии Vitastor до 1.2.0 включительно требовали ODP, потом функция был отключена
|
|
||||||
по умолчанию, но поддерживалась вплоть до версии 3.0.3. Сейчас поддержка ODP
|
|
||||||
полностью удалена, так как на самом деле она только портит производительность:
|
|
||||||
например, на 3-узловом кластере с 8 NVMe в каждом узле и сетью 2*25 Гбит/с на
|
|
||||||
чтение с RDMA без ODP удаётся снять 3950000 iops, а с ODP - всего 239000 iops.
|
|
||||||
|
|
||||||
Это происходит из-за того, что реализация ODP у Mellanox неоптимальная и
|
|
||||||
основана на повторной передаче сообщений, когда карте не известен буфер -
|
|
||||||
вероятно, на стандартных "RNR retransmission" (RNR = receiver not ready).
|
|
||||||
А данные повторные передачи в RDMA/RoCE - всегда очень медленная штука.
|
|
||||||
Презентация на эту тему с конференции ISPASS-2021: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
|
||||||
- name: rdma_port_num
|
- name: rdma_port_num
|
||||||
type: int
|
type: int
|
||||||
|
default: 1
|
||||||
info: |
|
info: |
|
||||||
RDMA device port number to use. Only for devices that have more than 1 port.
|
RDMA device port number to use. Only for devices that have more than 1 port.
|
||||||
See `phys_port_cnt` in `ibv_devinfo -v` output to determine how many ports
|
See `phys_port_cnt` in `ibv_devinfo -v` output to determine how many ports
|
||||||
your device has.
|
your device has.
|
||||||
|
|
||||||
Not relevant for RDMA-CM (use_rdmacm).
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Номер порта RDMA-устройства, который следует использовать. Имеет смысл
|
Номер порта RDMA-устройства, который следует использовать. Имеет смысл
|
||||||
только для устройств, у которых более 1 порта. Чтобы узнать, сколько портов
|
только для устройств, у которых более 1 порта. Чтобы узнать, сколько портов
|
||||||
у вашего адаптера, посмотрите `phys_port_cnt` в выводе команды
|
у вашего адаптера, посмотрите `phys_port_cnt` в выводе команды
|
||||||
`ibv_devinfo -v`.
|
`ibv_devinfo -v`.
|
||||||
|
|
||||||
Опция неприменима к RDMA-CM (use_rdmacm).
|
|
||||||
- name: rdma_gid_index
|
- name: rdma_gid_index
|
||||||
type: int
|
type: int
|
||||||
info: |
|
info: |
|
||||||
@@ -172,8 +116,6 @@
|
|||||||
GID auto-selection is unsupported with libibverbs < v32.
|
GID auto-selection is unsupported with libibverbs < v32.
|
||||||
|
|
||||||
A correct rdma_gid_index for RoCEv2 is usually 1 (IPv6) or 3 (IPv4).
|
A correct rdma_gid_index for RoCEv2 is usually 1 (IPv6) or 3 (IPv4).
|
||||||
|
|
||||||
Not relevant for RDMA-CM (use_rdmacm).
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Номер глобального идентификатора адреса RDMA-устройства, который следует
|
Номер глобального идентификатора адреса RDMA-устройства, который следует
|
||||||
использовать. Разным gid_index могут соответствовать разные протоколы связи:
|
использовать. Разным gid_index могут соответствовать разные протоколы связи:
|
||||||
@@ -186,16 +128,15 @@
|
|||||||
libibverbs < v32.
|
libibverbs < v32.
|
||||||
|
|
||||||
Правильный rdma_gid_index для RoCEv2, как правило, 1 (IPv6) или 3 (IPv4).
|
Правильный rdma_gid_index для RoCEv2, как правило, 1 (IPv6) или 3 (IPv4).
|
||||||
|
|
||||||
Опция неприменима к RDMA-CM (use_rdmacm).
|
|
||||||
- name: rdma_mtu
|
- name: rdma_mtu
|
||||||
type: int
|
type: int
|
||||||
|
default: 4096
|
||||||
info: |
|
info: |
|
||||||
RDMA Path MTU to use. Must be 1024, 2048 or 4096. Default is to use the
|
RDMA Path MTU to use. Must be 1024, 2048 or 4096. There is usually no
|
||||||
RDMA device's MTU.
|
sense to change it from the default 4096.
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Максимальная единица передачи (Path MTU) для RDMA. Должно быть равно 1024,
|
Максимальная единица передачи (Path MTU) для RDMA. Должно быть равно 1024,
|
||||||
2048 или 4096. По умолчанию используется значение MTU RDMA-устройства.
|
2048 или 4096. Обычно нет смысла менять значение по умолчанию, равное 4096.
|
||||||
- name: rdma_max_sge
|
- name: rdma_max_sge
|
||||||
type: int
|
type: int
|
||||||
default: 128
|
default: 128
|
||||||
@@ -242,6 +183,45 @@
|
|||||||
у принимающей стороны в процессе работы не заканчивались буферы на приём.
|
у принимающей стороны в процессе работы не заканчивались буферы на приём.
|
||||||
Не влияет на потребление памяти - дополнительная память на операции отправки
|
Не влияет на потребление памяти - дополнительная память на операции отправки
|
||||||
не выделяется.
|
не выделяется.
|
||||||
|
- name: rdma_odp
|
||||||
|
type: bool
|
||||||
|
default: false
|
||||||
|
online: false
|
||||||
|
info: |
|
||||||
|
Use RDMA with On-Demand Paging. ODP is currently only available on Mellanox
|
||||||
|
ConnectX-4 and newer adapters. ODP allows to not register memory explicitly
|
||||||
|
for RDMA adapter to be able to use it. This, in turn, allows to skip memory
|
||||||
|
copying during sending. One would think this should improve performance, but
|
||||||
|
**in reality** RDMA performance with ODP is **drastically** worse. Example
|
||||||
|
3-node cluster with 8 NVMe in each node and 2*25 GBit/s ConnectX-6 RDMA network
|
||||||
|
without ODP pushes 3950000 read iops, but only 239000 iops with ODP...
|
||||||
|
|
||||||
|
This happens because Mellanox ODP implementation seems to be based on
|
||||||
|
message retransmissions when the adapter doesn't know about the buffer yet -
|
||||||
|
it likely uses standard "RNR retransmissions" (RNR = receiver not ready)
|
||||||
|
which is generally slow in RDMA/RoCE networks. Here's a presentation about
|
||||||
|
it from ISPASS-2021 conference: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
||||||
|
|
||||||
|
ODP support is retained in the code just in case a good ODP implementation
|
||||||
|
appears one day.
|
||||||
|
info_ru: |
|
||||||
|
Использовать RDMA с On-Demand Paging. ODP - функция, доступная пока что
|
||||||
|
исключительно на адаптерах Mellanox ConnectX-4 и более новых. ODP позволяет
|
||||||
|
не регистрировать память для её использования RDMA-картой. Благодаря этому
|
||||||
|
можно не копировать данные при отправке их в сеть и, казалось бы, это должно
|
||||||
|
улучшать производительность - но **по факту** получается так, что
|
||||||
|
производительность только ухудшается, причём сильно. Пример - на 3-узловом
|
||||||
|
кластере с 8 NVMe в каждом узле и сетью 2*25 Гбит/с на чтение с RDMA без ODP
|
||||||
|
удаётся снять 3950000 iops, а с ODP - всего 239000 iops...
|
||||||
|
|
||||||
|
Это происходит из-за того, что реализация ODP у Mellanox неоптимальная и
|
||||||
|
основана на повторной передаче сообщений, когда карте не известен буфер -
|
||||||
|
вероятно, на стандартных "RNR retransmission" (RNR = receiver not ready).
|
||||||
|
А данные повторные передачи в RDMA/RoCE - всегда очень медленная штука.
|
||||||
|
Презентация на эту тему с конференции ISPASS-2021: https://tkygtr6.github.io/pub/ISPASS21_slides.pdf
|
||||||
|
|
||||||
|
Возможность использования ODP сохранена в коде на случай, если вдруг в один
|
||||||
|
прекрасный день появится хорошая реализация ODP.
|
||||||
- name: peer_connect_interval
|
- name: peer_connect_interval
|
||||||
type: sec
|
type: sec
|
||||||
min: 1
|
min: 1
|
||||||
@@ -326,96 +306,3 @@
|
|||||||
detect disconnections quickly.
|
detect disconnections quickly.
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Интервал проверки живости вебсокет-подключений к etcd.
|
Интервал проверки живости вебсокет-подключений к etcd.
|
||||||
- name: etcd_min_reload_interval
|
|
||||||
type: ms
|
|
||||||
default: 1000
|
|
||||||
online: true
|
|
||||||
info: |
|
|
||||||
Minimum interval for full etcd state reload. Introduced to prevent
|
|
||||||
excessive load on etcd during outages when etcd can't keep up with event
|
|
||||||
streams and cancels them.
|
|
||||||
info_ru: |
|
|
||||||
Минимальный интервал полной перезагрузки состояния из etcd. Добавлено для
|
|
||||||
предотвращения избыточной нагрузки на etcd во время отказов, когда etcd не
|
|
||||||
успевает рассылать потоки событий и отменяет их.
|
|
||||||
- name: tcp_header_buffer_size
|
|
||||||
type: int
|
|
||||||
default: 65536
|
|
||||||
info: |
|
|
||||||
Size of the buffer used to read data using an additional copy. Vitastor
|
|
||||||
packet headers are 128 bytes, payload is always at least 4 KB, so it is
|
|
||||||
usually beneficial to try to read multiple packets at once even though
|
|
||||||
it requires to copy the data an additional time. The rest of each packet
|
|
||||||
is received without an additional copy. You can try to play with this
|
|
||||||
parameter and see how it affects random iops and linear bandwidth if you
|
|
||||||
want.
|
|
||||||
info_ru: |
|
|
||||||
Размер буфера для чтения данных с дополнительным копированием. Пакеты
|
|
||||||
Vitastor содержат 128-байтные заголовки, за которыми следуют данные размером
|
|
||||||
от 4 КБ и для мелких операций ввода-вывода обычно выгодно за 1 вызов читать
|
|
||||||
сразу несколько пакетов, даже не смотря на то, что это требует лишний раз
|
|
||||||
скопировать данные. Часть каждого пакета за пределами значения данного
|
|
||||||
параметра читается без дополнительного копирования. Вы можете попробовать
|
|
||||||
поменять этот параметр и посмотреть, как он влияет на производительность
|
|
||||||
случайного и линейного доступа.
|
|
||||||
- name: min_zerocopy_send_size
|
|
||||||
type: int
|
|
||||||
default: 32768
|
|
||||||
info: |
|
|
||||||
OSDs and clients will attempt to use io_uring-based zero-copy TCP send
|
|
||||||
for buffers larger than this number of bytes. Zero-copy send with io_uring is
|
|
||||||
supported since Linux kernel version 6.1. Support is auto-detected and disabled
|
|
||||||
automatically when not available. It can also be disabled explicitly by setting
|
|
||||||
this parameter to a negative value.
|
|
||||||
|
|
||||||
⚠️ Warning! Zero-copy send performance may vary greatly from CPU to CPU and from
|
|
||||||
one kernel version to another. Generally, it tends to only make benefit with larger
|
|
||||||
messages. With smaller messages (say, 4 KB), it may actually be slower. 32 KB is
|
|
||||||
enough for almost all CPUs, but even smaller values are optimal for some of them.
|
|
||||||
For example, 4 KB is OK for EPYC Milan/Genoa and 12 KB is OK for Xeon Ice Lake
|
|
||||||
(but verify it yourself please).
|
|
||||||
|
|
||||||
Verification instructions:
|
|
||||||
1. Add `iommu=pt` into your Linux kernel command line and reboot.
|
|
||||||
2. Upgrade your kernel. For example, it's very important to use 6.11+ with recent AMD EPYCs.
|
|
||||||
3. Run some tests with the [send-zerocopy liburing example](https://github.com/axboe/liburing/blob/master/examples/send-zerocopy.c)
|
|
||||||
to find the minimal message size for which zero-copy is optimal.
|
|
||||||
Use `./send-zerocopy tcp -4 -R` at the server side and
|
|
||||||
`time ./send-zerocopy tcp -4 -b 0 -s BUFFER_SIZE -D SERVER_IP` at the client side with
|
|
||||||
`-z 0` (no zero-copy) and `-z 1` (zero-copy), and compare MB/s and used CPU time
|
|
||||||
(user+system).
|
|
||||||
info_ru: |
|
|
||||||
OSD и клиенты будут пробовать использовать TCP-отправку без копирования (zero-copy) на
|
|
||||||
основе io_uring для буферов, больших, чем это число байт. Отправка без копирования
|
|
||||||
поддерживается в io_uring, начиная с версии ядра Linux 6.1. Наличие поддержки
|
|
||||||
проверяется автоматически и zero-copy отключается, когда поддержки нет. Также
|
|
||||||
её можно отключить явно, установив данный параметр в отрицательное значение.
|
|
||||||
|
|
||||||
⚠️ Внимание! Производительность данной функции может сильно отличаться на разных
|
|
||||||
процессорах и на разных версиях ядра Linux. В целом, zero-copy обычно быстрее с
|
|
||||||
большими сообщениями, а с мелкими (например, 4 КБ) zero-copy может быть даже
|
|
||||||
медленнее. 32 КБ достаточно почти для всех процессоров, но для каких-то можно
|
|
||||||
использовать даже меньшие значения. Например, для EPYC Milan/Genoa подходит 4 КБ,
|
|
||||||
а для Xeon Ice Lake - 12 КБ (но, пожалуйста, перепроверьте это сами).
|
|
||||||
|
|
||||||
Инструкция по проверке:
|
|
||||||
1. Добавьте `iommu=pt` в командную строку загрузки вашего ядра Linux и перезагрузитесь.
|
|
||||||
2. Обновите ядро. Например, для AMD EPYC очень важно использовать версию 6.11+.
|
|
||||||
3. Позапускайте тесты с помощью [send-zerocopy из примеров liburing](https://github.com/axboe/liburing/blob/master/examples/send-zerocopy.c),
|
|
||||||
чтобы найти минимальный размер сообщения, для которого zero-copy отправка оптимальна.
|
|
||||||
Запускайте `./send-zerocopy tcp -4 -R` на стороне сервера и
|
|
||||||
`time ./send-zerocopy tcp -4 -b 0 -s РАЗМЕР_БУФЕРА -D АДРЕС_СЕРВЕРА` на стороне клиента
|
|
||||||
с опцией `-z 0` (обычная отправка) и `-z 1` (отправка без копирования), и сравнивайте
|
|
||||||
скорость в МБ/с и занятое процессорное время (user+system).
|
|
||||||
- name: use_sync_send_recv
|
|
||||||
type: bool
|
|
||||||
default: false
|
|
||||||
info: |
|
|
||||||
If true, synchronous send/recv syscalls are used instead of io_uring for
|
|
||||||
socket communication. Useless for OSDs because they require io_uring anyway,
|
|
||||||
but may be required for clients with old kernel versions.
|
|
||||||
info_ru: |
|
|
||||||
Если установлено в истину, то вместо io_uring для передачи данных по сети
|
|
||||||
будут использоваться обычные синхронные системные вызовы send/recv. Для OSD
|
|
||||||
это бессмысленно, так как OSD в любом случае нуждается в io_uring, но, в
|
|
||||||
принципе, это может применяться для клиентов со старыми версиями ядра.
|
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
# Runtime OSD Parameters
|
# Runtime OSD Parameters
|
||||||
|
|
||||||
These parameters only apply to OSDs, are not fixed at the moment of OSD drive
|
These parameters only apply to OSDs, are not fixed at the moment of OSD drive
|
||||||
initialization and can be changed - in /etc/vitastor/vitastor.conf or [vitastor-disk update-sb](../usage/disk.en.md#update-sb)
|
initialization and can be changed - either with an OSD restart or, for some of
|
||||||
with an OSD restart or, for some of them, even without restarting by updating configuration in etcd.
|
them, even without restarting by updating configuration in etcd.
|
||||||
|
|||||||
@@ -2,5 +2,5 @@
|
|||||||
|
|
||||||
Данные параметры используются только OSD, но, в отличие от дисковых параметров,
|
Данные параметры используются только OSD, но, в отличие от дисковых параметров,
|
||||||
не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой
|
не фиксируются в момент инициализации дисков OSD и могут быть изменены в любой
|
||||||
момент с перезапуском OSD в /etc/vitastor/vitastor.conf или [vitastor-disk update-sb](../usage/disk.ru.md#update-sb),
|
момент с помощью перезапуска OSD, а некоторые и без перезапуска, с помощью
|
||||||
а некоторые и без перезапуска, с помощью изменения конфигурации в etcd.
|
изменения конфигурации в etcd.
|
||||||
|
|||||||
+54
-227
@@ -1,26 +1,3 @@
|
|||||||
- name: bind_address
|
|
||||||
type: string or array of strings
|
|
||||||
type_ru: строка или массив строк
|
|
||||||
info: |
|
|
||||||
Instead of the network masks ([osd_network](network.en.md#osd_network) and
|
|
||||||
[osd_cluster_network](network.en.md#osd_cluster_network)), you can also set
|
|
||||||
OSD listen addresses explicitly using this parameter. May be useful if you
|
|
||||||
want to start OSDs on interfaces that are not UP + RUNNING.
|
|
||||||
info_ru: |
|
|
||||||
Вместо использования масок подсети ([osd_network](network.ru.md#osd_network) и
|
|
||||||
[osd_cluster_network](network.ru.md#osd_cluster_network)), вы также можете явно
|
|
||||||
задать адрес(а), на которых будут ожидать соединений OSD, с помощью данного
|
|
||||||
параметра. Это может быть полезно, например, чтобы запускать OSD на неподнятых
|
|
||||||
интерфейсах (не UP + RUNNING).
|
|
||||||
- name: bind_port
|
|
||||||
type: int
|
|
||||||
info: |
|
|
||||||
By default, OSDs pick random ports to use for incoming connections
|
|
||||||
automatically. With this option you can set a specific port for a specific
|
|
||||||
OSD by hand.
|
|
||||||
info_ru: |
|
|
||||||
По умолчанию OSD сами выбирают случайные порты для входящих подключений.
|
|
||||||
С помощью данной опции вы можете задать порт для отдельного OSD вручную.
|
|
||||||
- name: osd_iothread_count
|
- name: osd_iothread_count
|
||||||
type: int
|
type: int
|
||||||
default: 0
|
default: 0
|
||||||
@@ -79,6 +56,44 @@
|
|||||||
реализовать дополнительный режим для монитора, который позволит отделять
|
реализовать дополнительный режим для монитора, который позволит отделять
|
||||||
первичные OSD от вторичных, но пока не понятно, зачем это может кому-то
|
первичные OSD от вторичных, но пока не понятно, зачем это может кому-то
|
||||||
понадобиться, поэтому это не реализовано.
|
понадобиться, поэтому это не реализовано.
|
||||||
|
- name: osd_network
|
||||||
|
type: string or array of strings
|
||||||
|
type_ru: строка или массив строк
|
||||||
|
info: |
|
||||||
|
Network mask of the network (IPv4 or IPv6) to use for OSDs. Note that
|
||||||
|
although it's possible to specify multiple networks here, this does not
|
||||||
|
mean that OSDs will create multiple listening sockets - they'll only
|
||||||
|
pick the first matching address of an UP + RUNNING interface. Separate
|
||||||
|
networks for cluster and client connections are also not implemented, but
|
||||||
|
they are mostly useless anyway, so it's not a big deal.
|
||||||
|
info_ru: |
|
||||||
|
Маска подсети (IPv4 или IPv6) для использования для соединений с OSD.
|
||||||
|
Имейте в виду, что хотя сейчас и можно передать в этот параметр несколько
|
||||||
|
подсетей, это не означает, что OSD будут создавать несколько слушающих
|
||||||
|
сокетов - они лишь будут выбирать адрес первого поднятого (состояние UP +
|
||||||
|
RUNNING), подходящий под заданную маску. Также не реализовано разделение
|
||||||
|
кластерной и публичной сетей OSD. Правда, от него обычно всё равно довольно
|
||||||
|
мало толку, так что особенной проблемы в этом нет.
|
||||||
|
- name: bind_address
|
||||||
|
type: string
|
||||||
|
default: "0.0.0.0"
|
||||||
|
info: |
|
||||||
|
Instead of the network mask, you can also set OSD listen address explicitly
|
||||||
|
using this parameter. May be useful if you want to start OSDs on interfaces
|
||||||
|
that are not UP + RUNNING.
|
||||||
|
info_ru: |
|
||||||
|
Этим параметром можно явным образом задать адрес, на котором будет ожидать
|
||||||
|
соединений OSD (вместо использования маски подсети). Может быть полезно,
|
||||||
|
например, чтобы запускать OSD на неподнятых интерфейсах (не UP + RUNNING).
|
||||||
|
- name: bind_port
|
||||||
|
type: int
|
||||||
|
info: |
|
||||||
|
By default, OSDs pick random ports to use for incoming connections
|
||||||
|
automatically. With this option you can set a specific port for a specific
|
||||||
|
OSD by hand.
|
||||||
|
info_ru: |
|
||||||
|
По умолчанию OSD сами выбирают случайные порты для входящих подключений.
|
||||||
|
С помощью данной опции вы можете задать порт для отдельного OSD вручную.
|
||||||
- name: autosync_interval
|
- name: autosync_interval
|
||||||
type: sec
|
type: sec
|
||||||
default: 5
|
default: 5
|
||||||
@@ -253,33 +268,21 @@
|
|||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
info: |
|
info: |
|
||||||
Only for the old store ([meta_format](layout-osd.en.md#meta_format) 2).
|
This parameter makes Vitastor always keep metadata area of the block device
|
||||||
|
in memory. It's required for good performance because it allows to avoid
|
||||||
This parameter makes Vitastor keep a copy of metadata area in memory as it is
|
additional read-modify-write cycles during metadata modifications. Metadata
|
||||||
on disk, in addition to the metadata database. When the option is enabled, every
|
area size is currently roughly 224 MB per 1 TB of data. You can turn it off
|
||||||
metadata entry is effectively stored in RAM twice. It's required for good performance
|
to reduce memory usage by this value, but it will hurt performance. This
|
||||||
because it allows to avoid additional read-modify-write cycles during metadata
|
restriction is likely to be removed in the future along with the upgrade
|
||||||
modifications. Metadata area size with the old store is roughly 224 MB per 1 TB
|
of the metadata storage scheme.
|
||||||
of data. You can turn the option off to reduce memory usage by this value, but
|
|
||||||
it will reduce performance.
|
|
||||||
|
|
||||||
For the new store ([meta_format](layout-osd.en.md#meta_format) 3), the option
|
|
||||||
may be changed in the future to support operation without loading full metadata
|
|
||||||
database in memory.
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Только для старого хранилища ([meta_format](layout-osd.en.md#meta_format) 2).
|
Данный параметр заставляет Vitastor всегда держать область метаданных диска
|
||||||
|
в памяти. Это нужно, чтобы избегать дополнительных операций чтения с диска
|
||||||
Данный параметр заставляет Vitastor всегда держать копию области метаданных
|
при записи. Размер области метаданных на данный момент составляет примерно
|
||||||
в памяти в том же виде, как она лежит на диске, в дополнение к БД метаданных.
|
224 МБ на 1 ТБ данных. При включении потребление памяти снизится примерно
|
||||||
То есть, с включённой опцией каждая запись метаданных хранится в памяти дважды.
|
на эту величину, но при этом также снизится и производительность. В будущем,
|
||||||
Это нужно, чтобы избегать дополнительных операций чтения с диска при записи.
|
после обновления схемы хранения метаданных, это ограничение, скорее всего,
|
||||||
Размер области метаданных в старом хранилище составляет примерно 224 МБ на
|
будет ликвидировано.
|
||||||
1 ТБ данных. Вы можете отключить опцию, чтобы снизить потребление памяти
|
|
||||||
примерно на эту величину, но при этом также снизится и производительность.
|
|
||||||
|
|
||||||
Для нового хранилища ([meta_format](layout-osd.en.md#meta_format) 3) опция,
|
|
||||||
возможно, будет переработана в будущем для поддержки работы без полной
|
|
||||||
загрузки метаданных в памяти.
|
|
||||||
- name: inmemory_journal
|
- name: inmemory_journal
|
||||||
type: bool
|
type: bool
|
||||||
default: true
|
default: true
|
||||||
@@ -312,7 +315,7 @@
|
|||||||
decrease write performance for fast disks because page cache is an overhead
|
decrease write performance for fast disks because page cache is an overhead
|
||||||
itself.
|
itself.
|
||||||
|
|
||||||
Choose "directsync" to use [immediate_commit](layout-cluster.en.md#immediate_commit)
|
Choose "directsync" to use [immediate_commit](layout-cluster.ru.md#immediate_commit)
|
||||||
(which requires disable_data_fsync) with drives having write-back cache
|
(which requires disable_data_fsync) with drives having write-back cache
|
||||||
which can't be turned off, for example, Intel Optane. Also note that *some*
|
which can't be turned off, for example, Intel Optane. Also note that *some*
|
||||||
desktop SSDs (for example, HP EX950) may ignore O_SYNC thus making
|
desktop SSDs (for example, HP EX950) may ignore O_SYNC thus making
|
||||||
@@ -398,15 +401,11 @@
|
|||||||
blocks. The only situation when you should increase it to a larger value
|
blocks. The only situation when you should increase it to a larger value
|
||||||
is when you enable journal_no_same_sector_overwrites. In this case set
|
is when you enable journal_no_same_sector_overwrites. In this case set
|
||||||
it to, for example, 1024.
|
it to, for example, 1024.
|
||||||
|
|
||||||
Not applicable to the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Максимальное число буферов, разрешённых для использования под записываемые
|
Максимальное число буферов, разрешённых для использования под записываемые
|
||||||
в журнал блоки метаданных. Единственная ситуация, в которой этот параметр
|
в журнал блоки метаданных. Единственная ситуация, в которой этот параметр
|
||||||
нужно менять - это если вы включаете journal_no_same_sector_overwrites. В
|
нужно менять - это если вы включаете journal_no_same_sector_overwrites. В
|
||||||
этом случае установите данный параметр, например, в 1024.
|
этом случае установите данный параметр, например, в 1024.
|
||||||
|
|
||||||
Неприменимо к новому хранилищу ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
- name: journal_no_same_sector_overwrites
|
- name: journal_no_same_sector_overwrites
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
@@ -418,8 +417,6 @@
|
|||||||
journal after writing it instead of possibly overwriting it the second time.
|
journal after writing it instead of possibly overwriting it the second time.
|
||||||
|
|
||||||
Most (99%) other SSDs don't need this option.
|
Most (99%) other SSDs don't need this option.
|
||||||
|
|
||||||
Not applicable to the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
info_ru: |
|
info_ru: |
|
||||||
Включайте данную опцию для SSD вроде Intel D3-S4510 и D3-S4610, которые
|
Включайте данную опцию для SSD вроде Intel D3-S4510 и D3-S4610, которые
|
||||||
ОЧЕНЬ не любят, когда ПО перезаписывает один и тот же сектор несколько раз
|
ОЧЕНЬ не любят, когда ПО перезаписывает один и тот же сектор несколько раз
|
||||||
@@ -430,20 +427,6 @@
|
|||||||
самого сектора.
|
самого сектора.
|
||||||
|
|
||||||
Почти все другие SSD (99% моделей) не требуют данной опции.
|
Почти все другие SSD (99% моделей) не требуют данной опции.
|
||||||
|
|
||||||
Неприменимо к новому хранилищу ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
- name: skip_corrupted_meta_entries
|
|
||||||
type: bool
|
|
||||||
default: false
|
|
||||||
info: |
|
|
||||||
Only for the new store ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
Allow OSD to start when some metadata entries or blocks are corrupted by
|
|
||||||
skipping them. Should be only used as an emergency measure.
|
|
||||||
info_ru: |
|
|
||||||
Только для нового хранилища ([meta_format](layout-osd.en.md#meta_format) 3).
|
|
||||||
Разрешить OSD запускаться, даже если часть блоков или записей метаданных
|
|
||||||
повреждена, пропуская их. Опция предназначена для использования только в
|
|
||||||
целях аварийного восстановления.
|
|
||||||
- name: throttle_small_writes
|
- name: throttle_small_writes
|
||||||
type: bool
|
type: bool
|
||||||
default: false
|
default: false
|
||||||
@@ -598,7 +581,7 @@
|
|||||||
сильно влияет на пользовательскую нагрузку.
|
сильно влияет на пользовательскую нагрузку.
|
||||||
- name: scrub_list_limit
|
- name: scrub_list_limit
|
||||||
type: int
|
type: int
|
||||||
default: 262144
|
default: 1000
|
||||||
online: true
|
online: true
|
||||||
info: |
|
info: |
|
||||||
Number of objects to list in one listing operation during scrub.
|
Number of objects to list in one listing operation during scrub.
|
||||||
@@ -782,159 +765,3 @@
|
|||||||
Максимальное возможное значение авто-подстроенного recovery_sleep_us.
|
Максимальное возможное значение авто-подстроенного recovery_sleep_us.
|
||||||
Большие значения считаются случайными выбросами и игнорируются в
|
Большие значения считаются случайными выбросами и игнорируются в
|
||||||
усреднении.
|
усреднении.
|
||||||
- name: discard_on_start
|
|
||||||
type: bool
|
|
||||||
info: Discard (SSD TRIM) unused data device blocks on every OSD startup.
|
|
||||||
info_ru: Освобождать (SSD TRIM) неиспользуемые блоки диска данных при каждом запуске OSD.
|
|
||||||
- name: min_discard_size
|
|
||||||
type: int
|
|
||||||
default: 1048576
|
|
||||||
info: Minimum consecutive block size to TRIM it.
|
|
||||||
info_ru: Минимальный размер последовательного блока данных, чтобы освобождать его через TRIM.
|
|
||||||
- name: allow_net_split
|
|
||||||
type: bool
|
|
||||||
default: false
|
|
||||||
info: |
|
|
||||||
Allow "safe" cases of network splits/partitions - allow to start PGs without
|
|
||||||
connections to some OSDs currently registered as alive in etcd, if the number
|
|
||||||
of actually connected PG OSDs is at least pg_minsize. That is, allow some OSDs to lose
|
|
||||||
connectivity with some other OSDs as long as it doesn't break pg_minsize guarantees.
|
|
||||||
The downside is that it increases the probability of writing data into just pg_minsize
|
|
||||||
OSDs during failover which can lead to PGs becoming incomplete after additional outages.
|
|
||||||
|
|
||||||
The old behaviour in versions up to 2.0.0 was equal to enabled allow_net_split.
|
|
||||||
info_ru: |
|
|
||||||
Разрешить "безопасные" случаи разделений сети - разрешить активировать PG без
|
|
||||||
соединений к некоторым OSD, помеченным активными в etcd, если общее число активных
|
|
||||||
OSD в PG составляет как минимум pg_minsize. То есть, разрешать некоторым OSD терять
|
|
||||||
соединения с некоторыми другими OSD, если это не нарушает гарантий pg_minsize.
|
|
||||||
Минус такого разрешения в том, что оно повышает вероятность записи данных ровно в
|
|
||||||
pg_minsize OSD во время переключений, что может потом привести к тому, что PG станут
|
|
||||||
неполными (incomplete), если упадут ещё какие-то OSD.
|
|
||||||
|
|
||||||
Старое поведение в версиях до 2.0.0 было идентично включённому allow_net_split.
|
|
||||||
- name: enable_pg_locks
|
|
||||||
type: bool
|
|
||||||
info: |
|
|
||||||
Vitastor 2.2.0 introduces a new layer of split-brain prevention mechanism in
|
|
||||||
addition to etcd: PG locks. They prevent split-brain even in abnormal theoretical cases
|
|
||||||
when etcd is extremely laggy. As a new feature, by default, PG locks are only enabled
|
|
||||||
for pools where they're required - pools with [localized reads](pool.en.md#local_reads).
|
|
||||||
Use this parameter to enable or disable this function for all pools.
|
|
||||||
info_ru: |
|
|
||||||
В Vitastor 2.2.0 появился новый слой защиты от сплитбрейна в дополнение к etcd -
|
|
||||||
блокировки PG. Они гарантируют порядок даже в теоретических ненормальных случаях,
|
|
||||||
когда etcd очень сильно тормозит. Так как функция новая, по умолчанию она включается
|
|
||||||
только для пулов, в которых она необходима - а именно, в пулах с включёнными
|
|
||||||
[локальными чтениями](pool.ru.md#local_reads). Ну а с помощью данного параметра
|
|
||||||
можно включить блокировки PG для всех пулов.
|
|
||||||
- name: pg_lock_retry_interval_ms
|
|
||||||
type: ms
|
|
||||||
default: 100
|
|
||||||
info: Retry interval for failed PG lock attempts.
|
|
||||||
info_ru: Интервал повтора неудачных попыток блокировки PG.
|
|
||||||
- name: atomic_write_size
|
|
||||||
type: int
|
|
||||||
default: 4096
|
|
||||||
info: |
|
|
||||||
Maximum data device atomic write size allowed for OSD to use.
|
|
||||||
|
|
||||||
Atomic writes allow to reduce the Write Amplification factor with the new store
|
|
||||||
([meta_format](layout-osd.en.md#meta_format)=3) to almost 1 (i.e. almost no extra writes)
|
|
||||||
with replicated pools and reach the best possible write performance.
|
|
||||||
|
|
||||||
Default value is auto-detected during OSD initialization from
|
|
||||||
`/sys/block/xx/queue/atomic_write_max_bytes` or assumed to be 4096 bytes
|
|
||||||
because all known disks support 4 KB atomic writes. Auto-detection is only used for
|
|
||||||
NVMe disks because SAS disks require the explicit WRITE ATOMIC command which requires
|
|
||||||
RWF_ATOMIC (see below [#use_atomic_flag]) but that flag works incorrectly in current
|
|
||||||
Linux versions.
|
|
||||||
|
|
||||||
You can also check if your NVMe drives support atomic writes by running
|
|
||||||
the command `nvme id-ctrl /dev/nvme0n1 | grep awupf`. If the reported value,
|
|
||||||
plus 1, multiplied by the currently selected block size of the NVMe,
|
|
||||||
is more than 4 KB, then the new store can utilize it for better performance.
|
|
||||||
The only drives known to support it currently are [Micron and Kioxia](../intro/quickstart.en.md).
|
|
||||||
|
|
||||||
Atomic writes allow to skip double data writes in replicated pools, thus
|
|
||||||
reducing Write Amplification and improving write performance up to 2 times.
|
|
||||||
info_ru: |
|
|
||||||
Максимальный размер атомарной записи на диск данных, который OSD разрешено использовать.
|
|
||||||
|
|
||||||
Поддержка атомарной записи позволяет снизить мультипликатор записи (Write Amplification)
|
|
||||||
на диск с новым хранилищем ([meta_format](layout-osd.ru.md#meta_format)=3)
|
|
||||||
практически до 1 (то есть, почти до нулевого объёма лишней записи) в реплицированных
|
|
||||||
пулах и достигнуть наилучшей возможной производительности записи.
|
|
||||||
|
|
||||||
Значение по умолчанию авто-определяется во время инициализации OSD из
|
|
||||||
`/sys/block/xx/queue/atomic_write_max_bytes` либо принимается равным 4096,
|
|
||||||
так как все известные диски поддерживают атомарную запись 4 КБ блоков.
|
|
||||||
Автоопределение применяется только для NVMe-дисков, так как SAS диски требуют
|
|
||||||
использования отдельной команды WRITE ATOMIC, а для неё нужен флаг RWF_ATOMIC
|
|
||||||
(см. ниже [#use_atomic_flag]), а он в текущих версиях Linux работает некорректно.
|
|
||||||
|
|
||||||
Вы также можете проверить, поддерживают ли ваши NVMe-диски атомарную запись,
|
|
||||||
с помощью команды `nvme id-ctrl /dev/nvme0n1 | grep awupf`. Если значение awupf
|
|
||||||
плюс 1, умноженное на текущий выбранный размер блока NVMe-диска, больше 4 КБ,
|
|
||||||
то новое хранилище может использовать атомарные записи для достижения лучшей
|
|
||||||
производительности. Единственные известные диски, которые поддерживают это сейчас -
|
|
||||||
[Micron и Kioxia](../intro/quickstart.ru.md).
|
|
||||||
|
|
||||||
Атомарная запись позволяет не использовать двойную запись данных (в журнал и на
|
|
||||||
устройство данных) в реплицированных пулах и таким образом снижает амплификацию
|
|
||||||
записи (объём служебной записи на диск) и улучшает производительность записи
|
|
||||||
вплоть до 2-х кратного прироста.
|
|
||||||
- name: use_atomic_flag
|
|
||||||
type: bool
|
|
||||||
info: |
|
|
||||||
This option controls whether Vitastor OSDs use RWF_ATOMIC write flag with atomic writes.
|
|
||||||
This flag is supported since Linux 6.11 and adds some safety to atomic writes - the kernel
|
|
||||||
guarantees to not fragment write requests with it and also to check them against the actual
|
|
||||||
device atomic write capabilities.
|
|
||||||
|
|
||||||
However, the option is disabled by default because the flag is currently UNUSABLE - Linux
|
|
||||||
incorrectly requires writes with that flag to be of power-of-2 length and length-aligned.
|
|
||||||
I.e., for example, 12 KB writes and not-8-KB aligned 8 KB writes are forbidden by the kernel,
|
|
||||||
even though the NVMe specification allows them.
|
|
||||||
|
|
||||||
For NVMe disks with `scheduler=none` writes aren't fragmented anyway so it's not a big deal.
|
|
||||||
However, you can rebuild your kernel with [this patch](../../patches/linux-fix-atomic-write-checks.diff)
|
|
||||||
and turn this option on. It will make your atomic writes a bit safer.
|
|
||||||
info_ru: |
|
|
||||||
Данная опция контролирует использование Vitastor OSD флага RWF_ATOMIC при атомарной записи
|
|
||||||
блоков. Этот флаг поддерживается, начиная с версии ядра Linux 6.11 и добавляет немного корректности
|
|
||||||
атомарным записям - ядро гарантирует отсутствие фрагментации запросов записи с этим флагом и
|
|
||||||
проверяет их на соответствие реальным возможностям устройства.
|
|
||||||
|
|
||||||
Однако, данная опция по умолчанию отключена, так как флаг в текущих версиях Linux работает
|
|
||||||
абсолютно НЕКОРРЕКТНО - при нём Linux требует, чтобы запросы записи имели длину, равную
|
|
||||||
степени двойки и были выровнены на эту длину. То есть, например, 12 КБ запросы записи, а также
|
|
||||||
8 КБ запросы записи по не-кратному 8 КБ смещению запрещаются ядром, хотя спецификация NVMe их
|
|
||||||
разрешает.
|
|
||||||
|
|
||||||
Для NVMe-дисков с `scheduler=none` запросы записи и так не фрагментируются, так что это не так
|
|
||||||
уж и важно, однако вы можете пересобрать своё ядро с [этим патчем](../../patches/linux-fix-atomic-write-checks.diff)
|
|
||||||
и включить данную опцию. Это сделает вашу атомарную запись капельку безопаснее.
|
|
||||||
- name: pg_reshard_chunk_size
|
|
||||||
type: int
|
|
||||||
default: 100000
|
|
||||||
info: |
|
|
||||||
Pool PG count change is a CPU-intensive operation because OSDs store the full object database
|
|
||||||
in memory and have to move all entries between old and new PGs. Thus it's performed in chunks,
|
|
||||||
with pauses between chunks to prevent blocking OSD's event loop and other clients' operations.
|
|
||||||
This option sets the maximum number of object is a chunk. Moving 100k objects usually takes
|
|
||||||
50-100ms. Chunk size equal to 0 means unlimited.
|
|
||||||
info_ru: |
|
|
||||||
Изменение числа PG в пуле заметно загружает процессор, так как OSD хранят полную базу данных
|
|
||||||
объектов в памяти и им приходится перемещать все записи объектов между старыми и новыми PG.
|
|
||||||
Поэтому изменение применяется порциями, с паузами между порциями, чтобы не блокировать обработку
|
|
||||||
событий OSD и операции остальных клиентов. Данная опция задаёт максимальное число объектов
|
|
||||||
в порции. Перемещение 100 тысяч объектов (значение по умолчанию) обычно занимает порядка
|
|
||||||
50-100 миллисекунд. Значение опции 0 отключает лимит размера порции.
|
|
||||||
- name: pg_reshard_chunk_pause_ms
|
|
||||||
type: ms
|
|
||||||
default: 100
|
|
||||||
info: |
|
|
||||||
This option sets the interval between handling two PG count change chunks.
|
|
||||||
info_ru: |
|
|
||||||
Данная опция задаёт интервал между обработкой двух порций изменения числа PG пулов.
|
|
||||||
|
|||||||
@@ -1,5 +0,0 @@
|
|||||||
{
|
|
||||||
"dependencies": {
|
|
||||||
"yaml": "^2.8.2"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
# Security Parameters
|
|
||||||
|
|
||||||
These parameters affect your Vitastor installation security and apply to OSDs, monitors and clients.
|
|
||||||
|
|
||||||
Most of them can be set in /etc/vitastor/vitastor.conf and in etcd, but don't support online modification.
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
# Параметры безопасности
|
|
||||||
|
|
||||||
Данные параметры затрагивают безопасность инсталляций Vitastor и используются
|
|
||||||
OSD, мониторами и клиентами.
|
|
||||||
|
|
||||||
Большая их часть может задаваться в /etc/vitastor/vitastor.conf и в etcd, но не
|
|
||||||
поддерживает онлайн-изменение.
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
- name: etcd_client_cert
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Client TLS certificate to use for Vitastor client (not OSD and not monitor)
|
|
||||||
etcd https connections. May be path to a file or just a PEM string with certificate.
|
|
||||||
In the latter case, string must begin with "-----BEGIN CERTIFICATE-----".
|
|
||||||
info_ru: |
|
|
||||||
Клиентский TLS сертификат для https-подключений к etcd для клиентов Vitastor
|
|
||||||
(не OSD и не мониторов). Может быть путём к файлу или просто строкой с
|
|
||||||
сертификатом в формате PEM. В последнем случае строка должна начинаться с
|
|
||||||
"-----BEGIN CERTIFICATE-----".
|
|
||||||
- name: etcd_client_key
|
|
||||||
type: string
|
|
||||||
info: Private key for etcd_client_cert (also a file or a PEM string).
|
|
||||||
info_ru: Закрытый ключ для сертификата etcd_client_cert (также путь к файлу или PEM строка).
|
|
||||||
- name: etcd_ca
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Trusted TLS CA to verify etcd server certificate. May be path to a file,
|
|
||||||
directory or just a PEM string with certificate.
|
|
||||||
info_ru: |
|
|
||||||
Доверенный корневой TLS-сертификат для проверки сертификата сервера etcd.
|
|
||||||
Может быть путём к файлу, директории или просто строкой с сертификатом в
|
|
||||||
формате PEM.
|
|
||||||
- name: osd_etcd_client_cert
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Same as [etcd_client_cert](#etcd_client_cert), but only for OSDs.
|
|
||||||
OSDs, clients and monitors should have different permissions, so they should
|
|
||||||
use different certificates.
|
|
||||||
info_ru: |
|
|
||||||
Аналогично [etcd_client_cert](#etcd_client_cert), но только для OSD.
|
|
||||||
OSD, клиенты и мониторы должны иметь разные привилегии, поэтому они должны
|
|
||||||
использовать разные сертификаты.
|
|
||||||
- name: osd_etcd_client_key
|
|
||||||
type: string
|
|
||||||
info: Same as [etcd_client_key](#etcd_client_key), but only for OSDs.
|
|
||||||
info_ru: Аналогично [etcd_client_key](#etcd_client_key), но только для OSD.
|
|
||||||
- name: mon_etcd_client_cert
|
|
||||||
type: string
|
|
||||||
info: Same as [etcd_client_cert](#etcd_client_cert), but only for Vitastor monitors.
|
|
||||||
info_ru: Аналогично [etcd_client_cert](#etcd_client_cert), но только для мониторов Vitastor.
|
|
||||||
- name: mon_etcd_client_key
|
|
||||||
type: string
|
|
||||||
info: Same as [etcd_client_key](#etcd_client_key), but only for Vitastor monitors.
|
|
||||||
info_ru: Аналогично [etcd_client_key](#etcd_client_key), но только для мониторов Vitastor.
|
|
||||||
- name: vault_url
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Vault base URL.
|
|
||||||
|
|
||||||
Vitastor clients support AES-256-XTS image data encryption with different per-image keys.
|
|
||||||
Encryption is performed by the client, OSDs don't have access to decrypted data.
|
|
||||||
|
|
||||||
Encryption keys may be stored in etcd or, for the increased security level, in an external
|
|
||||||
[HashiCorp Vault](https://developer.hashicorp.com/vault/) or [OpenBao](https://openbao.org/)
|
|
||||||
instance.
|
|
||||||
|
|
||||||
Vitastor clients use [v1 k/v secrets engine](https://openbao.org/api-docs/secret/kv/kv-v1/)
|
|
||||||
and [TLS authentication engine](https://openbao.org/api-docs/auth/cert/) in Vault.
|
|
||||||
|
|
||||||
In that case, only key IDs are stored in etcd.
|
|
||||||
info_ru: |
|
|
||||||
Базовый адрес Vault.
|
|
||||||
|
|
||||||
Клиенты Vitastor поддерживают AES-256-XTS шифрование данных образов с отдельными ключами на
|
|
||||||
каждый образ. Данные шифруются клиентами, OSD не имеют доступа к незашифрованным данным.
|
|
||||||
|
|
||||||
Ключи шифрования могут храниться в etcd или, для повышенного уровня безопасности, во внешнем
|
|
||||||
[HashiCorp Vault](https://developer.hashicorp.com/vault/) или [OpenBao](https://openbao.org/).
|
|
||||||
|
|
||||||
Клиенты Vitastor используют [движок секретов v1](https://openbao.org/api-docs/secret/kv/kv-v1/)
|
|
||||||
и [TLS-аутентификацию](https://openbao.org/api-docs/auth/cert/) в Vault.
|
|
||||||
|
|
||||||
В этом случае, только ID ключей хранятся в etcd.
|
|
||||||
- name: vault_secret_api_path
|
|
||||||
type: string
|
|
||||||
default: /v1/secret/
|
|
||||||
info: Vault v1 secret API mount path to use.
|
|
||||||
info_ru: Путь к API секретов v1 для использования клиентами.
|
|
||||||
- name: vault_client_cert
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Client TLS certificate to use for Vault connections. Just like [etcd_client_cert](#etcd_client_cert),
|
|
||||||
may be path to a file or just a certificate in PEM string.
|
|
||||||
info_ru: |
|
|
||||||
Клиентский TLS сертификат для подключений к Vault. Как и [etcd_client_cert](#etcd_client_cert),
|
|
||||||
может быть путём к файлу или просто PEM-строкой с сертификатом.
|
|
||||||
- name: vault_client_key
|
|
||||||
type: string
|
|
||||||
info: Private key for vault_client_cert (also a file or a PEM string).
|
|
||||||
info_ru: Закрытый ключ для сертификата vault_client_cert (также путь к файлу или PEM строка).
|
|
||||||
- name: vault_ca
|
|
||||||
type: string
|
|
||||||
info: |
|
|
||||||
Trusted TLS CA to verify Vault server certificate. May be path to a file,
|
|
||||||
directory or just a PEM string with certificate.
|
|
||||||
info_ru: |
|
|
||||||
Доверенный корневой TLS-сертификат для проверки сертификата сервера Vault.
|
|
||||||
Может быть путём к файлу, директории или просто строкой с сертификатом в
|
|
||||||
формате PEM.
|
|
||||||
- name: vault_timeout_ms
|
|
||||||
type: int
|
|
||||||
default: 5000
|
|
||||||
info: Timeout for Vault requests in milliseconds.
|
|
||||||
info_ru: Максимально время выполнения Vault-запросов в миллисекундах.
|
|
||||||
- name: vault_error_timeout_sec
|
|
||||||
type: int
|
|
||||||
default: 60
|
|
||||||
info: |
|
|
||||||
Time (in seconds) to wait before retrying after receiving an error from Vault.
|
|
||||||
info_ru: |
|
|
||||||
Время (в секундах) для ожидания перед повторной попыткой при получении ошибки от Vault.
|
|
||||||
- name: vault_refresh_leeway_sec
|
|
||||||
type: int
|
|
||||||
default: 60
|
|
||||||
info: |
|
|
||||||
Extra time (in seconds) before real Vault token lease_timeout to refresh it, just
|
|
||||||
in case of system clock drift.
|
|
||||||
info_ru: |
|
|
||||||
Зазор времени (в секундах), чтобы обновлять токены Vault чуть раньше их реального
|
|
||||||
lease_timeout, на случай "ухода" системных часов.
|
|
||||||
- name: max_aes_xts_pool_size
|
|
||||||
type: int
|
|
||||||
default: 256
|
|
||||||
info: |
|
|
||||||
Maximum number of OpenSSL encryption contexts cached in OSD memory. Probably
|
|
||||||
doesn't require modification.
|
|
||||||
info_ru: |
|
|
||||||
Максимальное количество кэшируемых в памяти OSD контекстов шифрования OpenSSL.
|
|
||||||
Вряд ли требует изменения.
|
|
||||||
@@ -26,37 +26,13 @@ at Vitastor Kubernetes operator: https://github.com/Antilles7227/vitastor-operat
|
|||||||
The instruction is very simple.
|
The instruction is very simple.
|
||||||
|
|
||||||
1. Download a Docker image of the desired version: \
|
1. Download a Docker image of the desired version: \
|
||||||
`docker pull vitalif/vitastor:v3.0.5`
|
`docker pull vitastor:1.10.2`
|
||||||
2. Install scripts to the host system: \
|
2. Install scripts to the host system: \
|
||||||
`docker run --rm -it -v /etc:/host-etc -v /usr/bin:/host-bin vitalif/vitastor:v3.0.5 install.sh`
|
`docker run --rm -it -v /etc:/host-etc -v /usr/bin:/host-bin vitastor:1.10.2 install.sh`
|
||||||
3. Reload udev rules: \
|
3. Reload udev rules: \
|
||||||
`udevadm control --reload-rules`
|
`udevadm control --reload-rules`
|
||||||
4. Enable the vitastor-host service: \
|
|
||||||
`systemctl enable --now vitastor-host`
|
|
||||||
|
|
||||||
After these steps, you can return to [Quick Start](../intro/quickstart.en.md).
|
And you can return to [Quick Start](../intro/quickstart.en.md).
|
||||||
|
|
||||||
## Podman
|
|
||||||
|
|
||||||
If you use Podman, run the following commands as root before installing Vitastor containers:
|
|
||||||
|
|
||||||
```
|
|
||||||
ln -s podman /usr/bin/docker
|
|
||||||
|
|
||||||
mkdir -p /etc/systemd/system/systemd-udevd.service.d
|
|
||||||
|
|
||||||
cat >/etc/systemd/system/systemd-udevd.service.d/override.conf <<EOF
|
|
||||||
[Service]
|
|
||||||
CapabilityBoundingSet=~
|
|
||||||
SystemCallFilter=@mount capset
|
|
||||||
EOF
|
|
||||||
|
|
||||||
systemctl daemon-reload
|
|
||||||
|
|
||||||
systemctl restart systemd-udevd
|
|
||||||
```
|
|
||||||
|
|
||||||
Without it, udev fails to do calls into a Podman container and Vitastor disk detection doesn't work.
|
|
||||||
|
|
||||||
## Upgrading Containers
|
## Upgrading Containers
|
||||||
|
|
||||||
|
|||||||
@@ -25,39 +25,14 @@ Vitastor можно установить в Docker/Podman. При этом etcd,
|
|||||||
Инструкция по установке максимально простая.
|
Инструкция по установке максимально простая.
|
||||||
|
|
||||||
1. Скачайте Docker-образ желаемой версии: \
|
1. Скачайте Docker-образ желаемой версии: \
|
||||||
`docker pull vitalif/vitastor:v3.0.5`
|
`docker pull vitastor:1.10.2`
|
||||||
2. Установите скрипты в хост-систему командой: \
|
2. Установите скрипты в хост-систему командой: \
|
||||||
`docker run --rm -it -v /etc:/host-etc -v /usr/bin:/host-bin vitalif/vitastor:v3.0.5 install.sh`
|
`docker run --rm -it -v /etc:/host-etc -v /usr/bin:/host-bin vitastor:1.10.2 install.sh`
|
||||||
3. Перезагрузите правила udev: \
|
3. Перезагрузите правила udev: \
|
||||||
`udevadm control --reload-rules`
|
`udevadm control --reload-rules`
|
||||||
4. Включите сервис vitastor-host: \
|
|
||||||
`systemctl enable --now vitastor-host`
|
|
||||||
|
|
||||||
После этого вы можете возвращаться к разделу [Быстрый старт](../intro/quickstart.ru.md).
|
После этого вы можете возвращаться к разделу [Быстрый старт](../intro/quickstart.ru.md).
|
||||||
|
|
||||||
## Podman
|
|
||||||
|
|
||||||
Если вы используете Podman, перед установкой контейнеров Vitastor выполните следующие
|
|
||||||
команды от имени суперпользователя:
|
|
||||||
|
|
||||||
```
|
|
||||||
ln -s podman /usr/bin/docker
|
|
||||||
|
|
||||||
mkdir -p /etc/systemd/system/systemd-udevd.service.d
|
|
||||||
|
|
||||||
cat >/etc/systemd/system/systemd-udevd.service.d/override.conf <<EOF
|
|
||||||
[Service]
|
|
||||||
CapabilityBoundingSet=~
|
|
||||||
SystemCallFilter=@mount capset
|
|
||||||
EOF
|
|
||||||
|
|
||||||
systemctl daemon-reload
|
|
||||||
|
|
||||||
systemctl restart systemd-udevd
|
|
||||||
```
|
|
||||||
|
|
||||||
Без этих настроек udev не может делать вызовы внутрь Podman-контейнеров и определение дисков Vitastor не работает.
|
|
||||||
|
|
||||||
## Обновление контейнеров
|
## Обновление контейнеров
|
||||||
|
|
||||||
Сначала обязательно проверьте раздел [Обновление Vitastor](../usage/admin.ru.md#обновление-vitastor),
|
Сначала обязательно проверьте раздел [Обновление Vitastor](../usage/admin.ru.md#обновление-vitastor),
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ volume_backend_name = vitastor-testcluster
|
|||||||
image_volume_cache_enabled = True
|
image_volume_cache_enabled = True
|
||||||
volume_clear = none
|
volume_clear = none
|
||||||
vitastor_etcd_address = 192.168.7.2:2379
|
vitastor_etcd_address = 192.168.7.2:2379
|
||||||
vitastor_etcd_prefix = /vitastor
|
vitastor_etcd_prefix =
|
||||||
vitastor_config_path = /etc/vitastor/vitastor.conf
|
vitastor_config_path = /etc/vitastor/vitastor.conf
|
||||||
vitastor_pool_id = 1
|
vitastor_pool_id = 1
|
||||||
image_upload_use_cinder_backend = True
|
image_upload_use_cinder_backend = True
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ volume_backend_name = vitastor-testcluster
|
|||||||
image_volume_cache_enabled = True
|
image_volume_cache_enabled = True
|
||||||
volume_clear = none
|
volume_clear = none
|
||||||
vitastor_etcd_address = 192.168.7.2:2379
|
vitastor_etcd_address = 192.168.7.2:2379
|
||||||
vitastor_etcd_prefix = /vitastor
|
vitastor_etcd_prefix =
|
||||||
vitastor_config_path = /etc/vitastor/vitastor.conf
|
vitastor_config_path = /etc/vitastor/vitastor.conf
|
||||||
vitastor_pool_id = 1
|
vitastor_pool_id = 1
|
||||||
image_upload_use_cinder_backend = True
|
image_upload_use_cinder_backend = True
|
||||||
|
|||||||
@@ -11,20 +11,12 @@
|
|||||||
- Trust Vitastor package signing key:
|
- Trust Vitastor package signing key:
|
||||||
`wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg`
|
`wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg`
|
||||||
- Add Vitastor package repository to your /etc/apt/sources.list:
|
- Add Vitastor package repository to your /etc/apt/sources.list:
|
||||||
- Debian 13 (Trixie/Sid): `deb https://vitastor.io/debian trixie main`
|
- Debian 12 (Bookworm/Sid): `deb https://vitastor.io/debian bookworm main`
|
||||||
- Debian 12 (Bookworm): `deb https://vitastor.io/debian bookworm main`
|
|
||||||
- Debian 11 (Bullseye): `deb https://vitastor.io/debian bullseye main`
|
- Debian 11 (Bullseye): `deb https://vitastor.io/debian bullseye main`
|
||||||
- Debian 10 (Buster): `deb https://vitastor.io/debian buster main`
|
- Debian 10 (Buster): `deb https://vitastor.io/debian buster main`
|
||||||
- Ubuntu 22.04 (Jammy): `deb https://vitastor.io/debian jammy main`
|
- Ubuntu 22.04 (Jammy): `deb https://vitastor.io/debian jammy main`
|
||||||
- Ubuntu 24.04 (Noble): `deb https://vitastor.io/debian noble main`
|
|
||||||
- Add `-oldstable` to bookworm/bullseye/buster in this line to install the last
|
- Add `-oldstable` to bookworm/bullseye/buster in this line to install the last
|
||||||
stable version from 0.9.x branch instead of 1.x
|
stable version from 0.9.x branch instead of 1.x
|
||||||
- To always prefer vitastor-patched QEMU and Libvirt versions, add the following to `/etc/apt/preferences`:
|
|
||||||
```
|
|
||||||
Package: *
|
|
||||||
Pin: origin "vitastor.io"
|
|
||||||
Pin-Priority: 501
|
|
||||||
```
|
|
||||||
- Install packages: `apt update; apt install vitastor lp-solve etcd linux-image-amd64 qemu-system-x86`
|
- Install packages: `apt update; apt install vitastor lp-solve etcd linux-image-amd64 qemu-system-x86`
|
||||||
|
|
||||||
## CentOS
|
## CentOS
|
||||||
@@ -33,17 +25,15 @@
|
|||||||
- CentOS 7: `yum install https://vitastor.io/rpms/centos/7/vitastor-release.rpm`
|
- CentOS 7: `yum install https://vitastor.io/rpms/centos/7/vitastor-release.rpm`
|
||||||
- CentOS 8: `dnf install https://vitastor.io/rpms/centos/8/vitastor-release.rpm`
|
- CentOS 8: `dnf install https://vitastor.io/rpms/centos/8/vitastor-release.rpm`
|
||||||
- AlmaLinux 9 and other RHEL 9 clones (Rocky, Oracle...): `dnf install https://vitastor.io/rpms/centos/9/vitastor-release.rpm`
|
- AlmaLinux 9 and other RHEL 9 clones (Rocky, Oracle...): `dnf install https://vitastor.io/rpms/centos/9/vitastor-release.rpm`
|
||||||
- AlmaLinux 10 and other RHEL 10 clones: `dnf install https://vitastor.io/rpms/centos/10/vitastor-release.rpm`
|
|
||||||
- Enable EPEL: `yum/dnf install epel-release`
|
- Enable EPEL: `yum/dnf install epel-release`
|
||||||
- Enable additional CentOS repositories:
|
- Enable additional CentOS repositories:
|
||||||
- CentOS 7: `yum install centos-release-scl`
|
- CentOS 7: `yum install centos-release-scl`
|
||||||
- CentOS 8: `dnf install centos-release-advanced-virtualization`
|
- CentOS 8: `dnf install centos-release-advanced-virtualization`
|
||||||
- RHEL 9/10 clones: not required
|
- RHEL 9 clones: not required
|
||||||
- Enable elrepo-kernel:
|
- Enable elrepo-kernel:
|
||||||
- CentOS 7: `yum install https://www.elrepo.org/elrepo-release-7.el7.elrepo.noarch.rpm`
|
- CentOS 7: `yum install https://www.elrepo.org/elrepo-release-7.el7.elrepo.noarch.rpm`
|
||||||
- CentOS 8: `dnf install https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm`
|
- CentOS 8: `dnf install https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm`
|
||||||
- RHEL 9 clones: `dnf install https://www.elrepo.org/elrepo-release-9.el9.elrepo.noarch.rpm`
|
- RHEL 9 clones: `dnf install https://www.elrepo.org/elrepo-release-9.el9.elrepo.noarch.rpm`
|
||||||
- RHEL 10 clones: not required
|
|
||||||
- Install packages: `yum/dnf install vitastor lpsolve etcd kernel-ml qemu-kvm`
|
- Install packages: `yum/dnf install vitastor lpsolve etcd kernel-ml qemu-kvm`
|
||||||
|
|
||||||
## Installation requirements
|
## Installation requirements
|
||||||
@@ -52,6 +42,7 @@
|
|||||||
recommended because io_uring is a relatively new technology and there is
|
recommended because io_uring is a relatively new technology and there is
|
||||||
at least one bug which reproduces with io_uring and HP SmartArray
|
at least one bug which reproduces with io_uring and HP SmartArray
|
||||||
controllers in 5.4
|
controllers in 5.4
|
||||||
|
- liburing 0.4 or newer
|
||||||
- lp_solve
|
- lp_solve
|
||||||
- etcd 3.4.15 or newer. Earlier versions won't work because of various bugs,
|
- etcd 3.4.15 or newer. Earlier versions won't work because of various bugs,
|
||||||
for example [#12402](https://github.com/etcd-io/etcd/pull/12402).
|
for example [#12402](https://github.com/etcd-io/etcd/pull/12402).
|
||||||
|
|||||||
@@ -11,20 +11,12 @@
|
|||||||
- Добавьте ключ репозитория Vitastor:
|
- Добавьте ключ репозитория Vitastor:
|
||||||
`wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg`
|
`wget https://vitastor.io/debian/pubkey.gpg -O /etc/apt/trusted.gpg.d/vitastor.gpg`
|
||||||
- Добавьте репозиторий Vitastor в /etc/apt/sources.list:
|
- Добавьте репозиторий Vitastor в /etc/apt/sources.list:
|
||||||
- Debian 13 (Trixie/Sid): `deb https://vitastor.io/debian trixie main`
|
- Debian 12 (Bookworm/Sid): `deb https://vitastor.io/debian bookworm main`
|
||||||
- Debian 12 (Bookworm): `deb https://vitastor.io/debian bookworm main`
|
|
||||||
- Debian 11 (Bullseye): `deb https://vitastor.io/debian bullseye main`
|
- Debian 11 (Bullseye): `deb https://vitastor.io/debian bullseye main`
|
||||||
- Debian 10 (Buster): `deb https://vitastor.io/debian buster main`
|
- Debian 10 (Buster): `deb https://vitastor.io/debian buster main`
|
||||||
- Ubuntu 22.04 (Jammy): `deb https://vitastor.io/debian jammy main`
|
- Ubuntu 22.04 (Jammy): `deb https://vitastor.io/debian jammy main`
|
||||||
- Ubuntu 24.04 (Noble): `deb https://vitastor.io/debian noble main`
|
|
||||||
- Добавьте `-oldstable` к слову bookworm/bullseye/buster в этой строке, чтобы
|
- Добавьте `-oldstable` к слову bookworm/bullseye/buster в этой строке, чтобы
|
||||||
установить последнюю стабильную версию из ветки 0.9.x вместо 1.x
|
установить последнюю стабильную версию из ветки 0.9.x вместо 1.x
|
||||||
- Чтобы всегда предпочитались версии пакетов QEMU и Libvirt с патчами Vitastor, добавьте в `/etc/apt/preferences`:
|
|
||||||
```
|
|
||||||
Package: *
|
|
||||||
Pin: origin "vitastor.io"
|
|
||||||
Pin-Priority: 501
|
|
||||||
```
|
|
||||||
- Установите пакеты: `apt update; apt install vitastor lp-solve etcd linux-image-amd64 qemu-system-x86`
|
- Установите пакеты: `apt update; apt install vitastor lp-solve etcd linux-image-amd64 qemu-system-x86`
|
||||||
|
|
||||||
## CentOS
|
## CentOS
|
||||||
@@ -33,17 +25,15 @@
|
|||||||
- CentOS 7: `yum install https://vitastor.io/rpms/centos/7/vitastor-release.rpm`
|
- CentOS 7: `yum install https://vitastor.io/rpms/centos/7/vitastor-release.rpm`
|
||||||
- CentOS 8: `dnf install https://vitastor.io/rpms/centos/8/vitastor-release.rpm`
|
- CentOS 8: `dnf install https://vitastor.io/rpms/centos/8/vitastor-release.rpm`
|
||||||
- AlmaLinux 9 и другие клоны RHEL 9 (Rocky, Oracle...): `dnf install https://vitastor.io/rpms/centos/9/vitastor-release.rpm`
|
- AlmaLinux 9 и другие клоны RHEL 9 (Rocky, Oracle...): `dnf install https://vitastor.io/rpms/centos/9/vitastor-release.rpm`
|
||||||
- AlmaLinux 10 и другие клоны RHEL 10: `dnf install https://vitastor.io/rpms/centos/10/vitastor-release.rpm`
|
|
||||||
- Включите EPEL: `yum/dnf install epel-release`
|
- Включите EPEL: `yum/dnf install epel-release`
|
||||||
- Включите дополнительные репозитории CentOS:
|
- Включите дополнительные репозитории CentOS:
|
||||||
- CentOS 7: `yum install centos-release-scl`
|
- CentOS 7: `yum install centos-release-scl`
|
||||||
- CentOS 8: `dnf install centos-release-advanced-virtualization`
|
- CentOS 8: `dnf install centos-release-advanced-virtualization`
|
||||||
- Клоны RHEL 9/10: не нужно
|
- Клоны RHEL 9: не нужно
|
||||||
- Включите elrepo-kernel:
|
- Включите elrepo-kernel:
|
||||||
- CentOS 7: `yum install https://www.elrepo.org/elrepo-release-7.el7.elrepo.noarch.rpm`
|
- CentOS 7: `yum install https://www.elrepo.org/elrepo-release-7.el7.elrepo.noarch.rpm`
|
||||||
- CentOS 8: `dnf install https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm`
|
- CentOS 8: `dnf install https://www.elrepo.org/elrepo-release-8.el8.elrepo.noarch.rpm`
|
||||||
- Клоны RHEL 9: `dnf install https://www.elrepo.org/elrepo-release-9.el9.elrepo.noarch.rpm`
|
- Клоны RHEL 9: `dnf install https://www.elrepo.org/elrepo-release-9.el9.elrepo.noarch.rpm`
|
||||||
- Клоны RHEL 10: не нужно
|
|
||||||
- Установите пакеты: `yum/dnf install vitastor lpsolve etcd kernel-ml qemu-kvm`
|
- Установите пакеты: `yum/dnf install vitastor lpsolve etcd kernel-ml qemu-kvm`
|
||||||
|
|
||||||
## Установочные требования
|
## Установочные требования
|
||||||
@@ -51,6 +41,7 @@
|
|||||||
- Ядро Linux 5.4 или новее, для поддержки io_uring. Рекомендуется даже 5.8,
|
- Ядро Linux 5.4 или новее, для поддержки io_uring. Рекомендуется даже 5.8,
|
||||||
так как io_uring - относительно новый интерфейс и в версиях до 5.8 встречались
|
так как io_uring - относительно новый интерфейс и в версиях до 5.8 встречались
|
||||||
некоторые баги, например, зависание с io_uring и контроллером HP SmartArray
|
некоторые баги, например, зависание с io_uring и контроллером HP SmartArray
|
||||||
|
- liburing 0.4 или новее
|
||||||
- lp_solve
|
- lp_solve
|
||||||
- etcd 3.4.15 или новее. Более старые версии не будут работать из-за разных багов,
|
- etcd 3.4.15 или новее. Более старые версии не будут работать из-за разных багов,
|
||||||
например, [#12402](https://github.com/etcd-io/etcd/pull/12402).
|
например, [#12402](https://github.com/etcd-io/etcd/pull/12402).
|
||||||
|
|||||||
@@ -6,10 +6,10 @@
|
|||||||
|
|
||||||
# Proxmox VE
|
# Proxmox VE
|
||||||
|
|
||||||
To enable Vitastor support in Proxmox Virtual Environment (6.4-9.x are supported):
|
To enable Vitastor support in Proxmox Virtual Environment (6.4-8.1 are supported):
|
||||||
|
|
||||||
- Add the corresponding Vitastor Debian repository into sources.list on Proxmox hosts:
|
- Add the corresponding Vitastor Debian repository into sources.list on Proxmox hosts:
|
||||||
trixie for 9.0+, bookworm for 8.1+, pve8.0 for 8.0, bullseye for 7.4, pve7.3 for 7.3, pve7.2 for 7.2, pve7.1 for 7.1, buster for 6.4
|
bookworm for 8.1, pve8.0 for 8.0, bullseye for 7.4, pve7.3 for 7.3, pve7.2 for 7.2, pve7.1 for 7.1, buster for 6.4
|
||||||
- Install vitastor-client, pve-qemu-kvm, pve-storage-vitastor (* or see note) packages from Vitastor repository
|
- Install vitastor-client, pve-qemu-kvm, pve-storage-vitastor (* or see note) packages from Vitastor repository
|
||||||
- Define storage in `/etc/pve/storage.cfg` (see below)
|
- Define storage in `/etc/pve/storage.cfg` (see below)
|
||||||
- Block network access from VMs to Vitastor network (to OSDs and etcd),
|
- Block network access from VMs to Vitastor network (to OSDs and etcd),
|
||||||
|
|||||||
@@ -6,10 +6,10 @@
|
|||||||
|
|
||||||
# Proxmox VE
|
# Proxmox VE
|
||||||
|
|
||||||
Чтобы подключить Vitastor к Proxmox Virtual Environment (поддерживаются версии 6.4-9.x):
|
Чтобы подключить Vitastor к Proxmox Virtual Environment (поддерживаются версии 6.4-8.1):
|
||||||
|
|
||||||
- Добавьте соответствующий Debian-репозиторий Vitastor в sources.list на хостах Proxmox:
|
- Добавьте соответствующий Debian-репозиторий Vitastor в sources.list на хостах Proxmox:
|
||||||
trixie для 9.0+, bookworm для 8.1+, pve8.0 для 8.0, bullseye для 7.4, pve7.3 для 7.3, pve7.2 для 7.2, pve7.1 для 7.1, buster для 6.4
|
bookworm для 8.1, pve8.0 для 8.0, bullseye для 7.4, pve7.3 для 7.3, pve7.2 для 7.2, pve7.1 для 7.1, buster для 6.4
|
||||||
- Установите пакеты vitastor-client, pve-qemu-kvm, pve-storage-vitastor (* или см. сноску) из репозитория Vitastor
|
- Установите пакеты vitastor-client, pve-qemu-kvm, pve-storage-vitastor (* или см. сноску) из репозитория Vitastor
|
||||||
- Определите тип хранилища в `/etc/pve/storage.cfg` (см. ниже)
|
- Определите тип хранилища в `/etc/pve/storage.cfg` (см. ниже)
|
||||||
- Обязательно заблокируйте доступ от виртуальных машин к сети Vitastor (OSD и etcd), т.к. Vitastor (пока) не поддерживает аутентификацию
|
- Обязательно заблокируйте доступ от виртуальных машин к сети Vitastor (OSD и etcd), т.к. Vitastor (пока) не поддерживает аутентификацию
|
||||||
|
|||||||
@@ -1,191 +0,0 @@
|
|||||||
[Documentation](../../README.md#documentation) → Installation → S3 for Vitastor
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Читать на русском](s3.ru.md)
|
|
||||||
|
|
||||||
# S3 for Vitastor
|
|
||||||
|
|
||||||
The moment has come - Vitastor S3 implementation based on Zenko CloudServer is released.
|
|
||||||
|
|
||||||
## Highlights
|
|
||||||
|
|
||||||
- Zenko CloudServer is implemented in node.js.
|
|
||||||
- Object metadata is stored in MongoDB.
|
|
||||||
- Modified Zenko CloudServer version is used for Vitastor. It is slightly different from
|
|
||||||
the original, has an optimised build and unneeded dependencies are stripped off.
|
|
||||||
- Object data is stored in Vitastor block volumes, but the volume metadata is stored in
|
|
||||||
the same MongoDB, not in Vitastor etcd.
|
|
||||||
- Objects are written to volumes sequentially one after another. The space is allocated
|
|
||||||
with rounding to the sector size (4 KB), so each object takes at least 4 KB.
|
|
||||||
- An important property of such storage scheme is that small objects aren't chunked into
|
|
||||||
parts in Vitastor EC N+K pools and thus don't require reads from all N disks when
|
|
||||||
downloading.
|
|
||||||
- Deleted objects are marked as deleted, but the space is only actually freed during
|
|
||||||
asynchronously executed "defragmentation" process. Defragmentation runs automatically
|
|
||||||
in the background when a volume reaches configured amount of "garbage" (20% by default).
|
|
||||||
Defragmentation copies actual objects to new volume(s) and then removes the old volume.
|
|
||||||
Defragmentation can be configured in locationConfig.json.
|
|
||||||
|
|
||||||
## Plans for future development
|
|
||||||
|
|
||||||
- User account storage in the DB instead of a static file. Original Zenko uses
|
|
||||||
a separate closed-source "Scality Vault" service for it, that's why we use
|
|
||||||
a static file for now.
|
|
||||||
- More detailed documentation.
|
|
||||||
- Support for other (and faster) key-value DBMS for object metadata storage.
|
|
||||||
- Other performance optimisations, for example, related to the used hash function -
|
|
||||||
MD5 used for Amazon compatibility purposes is relatively slow.
|
|
||||||
- Object Lifecycle support. There is a Lifecycle implementation for Zenko called
|
|
||||||
[Backbeat](https://github.com/scality/backbeat) but it's not adapted for Vitastor yet.
|
|
||||||
- Quota support. Original Zenko uses a separate "SCUBA" service for quotas, but
|
|
||||||
it's also proprietary and not available publicly.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
In a few words:
|
|
||||||
|
|
||||||
- Install MongoDB, create a user for S3 metadata DB.
|
|
||||||
- Create a Vitastor pool for S3 data.
|
|
||||||
- Download and setup the Docker container `vitalif/vitastor-zenko`.
|
|
||||||
|
|
||||||
### Setup MongoDB
|
|
||||||
|
|
||||||
You can setup MongoDB yourself, following the [MongoDB manual](https://www.mongodb.com/docs/manual/installation/).
|
|
||||||
|
|
||||||
Or you can follow the instructions below - it describes a simple example of MongoDB setup
|
|
||||||
in Docker (through docker-compose) with 3 replicas.
|
|
||||||
|
|
||||||
1. On each host, create a file `docker-compose.yml` with the content listed below.
|
|
||||||
Replace `<YOUR_PASSWORD>` with your future mongodb administrator password, and optionally
|
|
||||||
replace `0.0.0.0` with `localhost,<server_IP>`. It's recommended to either use a private IP
|
|
||||||
or [setup TLS](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/) afterwards.
|
|
||||||
|
|
||||||
```
|
|
||||||
version: '3.1'
|
|
||||||
|
|
||||||
services:
|
|
||||||
|
|
||||||
mongo:
|
|
||||||
container_name: mongo
|
|
||||||
image: mongo:7-jammy
|
|
||||||
restart: always
|
|
||||||
environment:
|
|
||||||
MONGO_INITDB_ROOT_USERNAME: root
|
|
||||||
MONGO_INITDB_ROOT_PASSWORD: <YOUR_PASSWORD>
|
|
||||||
network_mode: host
|
|
||||||
volumes:
|
|
||||||
- ./keyfile:/opt/keyfile
|
|
||||||
- ./mongo-data/db:/data/db
|
|
||||||
- ./mongo-data/configdb:/data/configdb
|
|
||||||
entrypoint: /bin/bash -c
|
|
||||||
command: [ "chown mongodb /opt/keyfile && chmod 600 /opt/keyfile && . /usr/local/bin/docker-entrypoint.sh mongod --replSet rs0 --keyFile /opt/keyfile --bind_ip 0.0.0.0" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Generate a shared cluster key using `openssl rand -base64 756 > ./keyfile` and copy
|
|
||||||
that `keyfile` to all hosts.
|
|
||||||
|
|
||||||
3. Start MongoDB on all hosts with `docker compose up -d mongo`.
|
|
||||||
|
|
||||||
4. Enter Mongo Shell with `docker exec -it mongo mongosh -u root -p <YOUR_PASSWORD> localhost/admin`
|
|
||||||
and execute the following command (replace IP addresses `10.10.10.{1,2,3}` with your host IPs):
|
|
||||||
|
|
||||||
`rs.initiate({ _id: 'rs0', members: [
|
|
||||||
{ _id: 1, host: '10.10.10.1:27017' },
|
|
||||||
{ _id: 2, host: '10.10.10.2:27017' },
|
|
||||||
{ _id: 3, host: '10.10.10.3:27017' }
|
|
||||||
] })`
|
|
||||||
|
|
||||||
5. Stay in Mongo Shell and create a user for the future S3 database:
|
|
||||||
|
|
||||||
`db.createUser({ user: 's3', pwd: '<YOUR_S3_PASSWORD>', roles: [
|
|
||||||
{ role: 'readWrite', db: 's3' },
|
|
||||||
{ role: 'dbAdmin', db: 's3' },
|
|
||||||
{ role: 'readWrite', db: 'vitastor' },
|
|
||||||
{ role: 'dbAdmin', db: 'vitastor' }
|
|
||||||
] })`
|
|
||||||
|
|
||||||
### Setup Vitastor
|
|
||||||
|
|
||||||
Create a pool in Vitastor for S3 object data, for example:
|
|
||||||
|
|
||||||
`vitastor-cli create-pool --ec 2+1 -n 512 s3-data --used_for_app s3:standard`
|
|
||||||
|
|
||||||
The `--used_for_app` options works as fool-proofing and prevents you from
|
|
||||||
accidentally creating a regular block volume in the S3 pool and overwriting some S3 data.
|
|
||||||
Also it hides inode space statistics from Vitastor etcd.
|
|
||||||
|
|
||||||
Retrieve the ID of your pool with `vitastor-cli ls-pools s3-data --detail`.
|
|
||||||
|
|
||||||
### Setup Vitastor S3
|
|
||||||
|
|
||||||
1. Add the following lines to `docker-compose.yml` (instead of `network_mode: host`,
|
|
||||||
you can use `ports: [ "8000:8000", "8002:8002" ]`):
|
|
||||||
|
|
||||||
```
|
|
||||||
zenko:
|
|
||||||
container_name: zenko
|
|
||||||
image: vitalif/vitastor-zenko
|
|
||||||
restart: always
|
|
||||||
security_opt:
|
|
||||||
- seccomp:unconfined
|
|
||||||
ulimits:
|
|
||||||
memlock: -1
|
|
||||||
network_mode: host
|
|
||||||
volumes:
|
|
||||||
- /etc/vitastor:/etc/vitastor
|
|
||||||
- /etc/vitastor/s3:/conf
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Download Docker image: `docker pull vitalif/vitastor-zenko`
|
|
||||||
|
|
||||||
3. Extract configuration file examples from the Docker image:
|
|
||||||
```
|
|
||||||
docker run --rm -it -v /etc/vitastor:/etc/vitastor -v /etc/vitastor/s3:/conf vitalif/vitastor-zenko configure.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Edit configuration files in `/etc/vitastor/s3/`:
|
|
||||||
- `config.json` - common settings.
|
|
||||||
- `authdata.json` - user accounts and access keys.
|
|
||||||
- `locationConfig.json` - S3 storage class list with placement settings.
|
|
||||||
Note: it actually contains storage classes (like STANDARD, COLD, etc)
|
|
||||||
instead of "locations" (zones like us-east-1) as in the original Zenko CloudServer.
|
|
||||||
- Put your MongoDB connection data into `config.json` and `locationConfig.json`.
|
|
||||||
- Put your Vitastor pool ID into `locationConfig.json`.
|
|
||||||
- For now, the complete list of Vitastor backend settings is only available [in the code](https://git.yourcmc.ru/vitalif/zenko-arsenal/src/branch/master/lib/storage/data/vitastor/VitastorBackend.ts#L94).
|
|
||||||
|
|
||||||
### Start Zenko
|
|
||||||
|
|
||||||
Start the S3 server with:
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run --restart always --security-opt seccomp:unconfined --ulimit memlock=-1 --network=host \
|
|
||||||
-v /etc/vitastor:/etc/vitastor -v /etc/vitastor/s3:/conf --name zenko vitalif/vitastor-zenko
|
|
||||||
```
|
|
||||||
|
|
||||||
If you use default settings, Zenko CloudServer starts on port 8000.
|
|
||||||
The default access key is `accessKey1` with a secret key of `verySecretKey1`.
|
|
||||||
|
|
||||||
Now you can access your S3 with, for example, [s3cmd](https://s3tools.org/s3cmd):
|
|
||||||
|
|
||||||
```
|
|
||||||
s3cmd --access_key=accessKey1 --secret_key=verySecretKey1 --host=http://localhost:8000 mb s3://testbucket
|
|
||||||
```
|
|
||||||
|
|
||||||
Or even mount it with [GeeseFS](https://github.com/yandex-cloud/geesefs):
|
|
||||||
|
|
||||||
```
|
|
||||||
AWS_ACCESS_KEY_ID=accessKey1 \
|
|
||||||
AWS_SECRET_ACCESS_KEY=verySecretKey1 \
|
|
||||||
geesefs --endpoint http://localhost:8000 testbucket mountdir
|
|
||||||
```
|
|
||||||
|
|
||||||
## Author & License
|
|
||||||
|
|
||||||
- [Zenko CloudServer](https://s3-server.readthedocs.io/en/latest/) author is Scality,
|
|
||||||
licensed under [Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
|
||||||
- [Vitastor](https://git.yourcmc.ru/vitalif/vitastor/) and Zenko Vitastor backend author is
|
|
||||||
Vitaliy Filippov, licensed under [VNPL-1.1](https://git.yourcmc.ru/vitalif/vitastor/src/branch/master/VNPL-1.1.txt)
|
|
||||||
(a "network copyleft" license based on AGPL/SSPL, but worded in a better way)
|
|
||||||
- Vitastor S3 repository: https://git.yourcmc.ru/vitalif/zenko-cloudserver-vitastor
|
|
||||||
- Vitastor S3 backend code: https://git.yourcmc.ru/vitalif/zenko-arsenal/src/branch/master/lib/storage/data/vitastor/VitastorBackend.ts
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
[Документация](../../README-ru.md#документация) → Установка → S3 на базе Vitastor
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Read in English](s3.en.md)
|
|
||||||
|
|
||||||
# S3 на базе Vitastor
|
|
||||||
|
|
||||||
Итак, свершилось - реализация Vitastor S3 на базе Zenko CloudServer достигла
|
|
||||||
состояния готовности к публикации и использованию.
|
|
||||||
|
|
||||||
## Ключевые особенности
|
|
||||||
|
|
||||||
- Zenko CloudServer реализован на node.js.
|
|
||||||
- Метаданные объектов хранятся в MongoDB.
|
|
||||||
- Поставляется модифицированная версия Zenko CloudServer, отвязанная от лишних зависимостей,
|
|
||||||
с оптимизированной сборкой и немного отличающаяся от оригинала.
|
|
||||||
- Данные объектов хранятся в блочных томах Vitastor, однако информация о самих томах
|
|
||||||
сохраняется не в etcd Vitastor, а тоже в БД на основе MongoDB.
|
|
||||||
- Объекты записываются в тома последовательно друг за другом. Место выделяется с округлением
|
|
||||||
до размера сектора (до 4 килобайт), поэтому каждый объект занимает как минимум 4 КБ.
|
|
||||||
- Благодаря такой схеме записи объектов мелкие объекты не нарезаются на части и поэтому не
|
|
||||||
требуют чтения с N дисков данных в EC N+K пулах Vitastor.
|
|
||||||
- При удалении объекты помечаются удалёнными, но место освобождается не сразу, а при
|
|
||||||
запускаемой асинхронно "дефрагментации". Дефрагментация запускается автоматически в фоне
|
|
||||||
при достижении заданного объёма "мусора" в томе (по умолчанию 20%), копирует актуальные
|
|
||||||
объекты в новые тома, после чего очищает старый том полностью. Дефрагментацию можно
|
|
||||||
настраивать в locationConfig.json.
|
|
||||||
|
|
||||||
## Планы развития
|
|
||||||
|
|
||||||
- Хранение учётных записей в БД, а не в статическом файле (в оригинальном Zenko для
|
|
||||||
этого используется отдельный закрытый сервис "Scality Vault").
|
|
||||||
- Более подробная документация.
|
|
||||||
- Поддержка других (и более производительных) key-value СУБД для хранения метаданных.
|
|
||||||
- Другие оптимизации производительности, например, в области используемой хеш-функции
|
|
||||||
(хеш MD5, используемый в целях совместимости, относительно медленный).
|
|
||||||
- Поддержка Object Lifecycle. Реализация Lifecycle для Zenko существует и называется
|
|
||||||
[Backbeat](https://github.com/scality/backbeat), но она ещё не адаптирована для Vitastor.
|
|
||||||
- Квоты. В оригинальном Zenko для этого используется отдельный сервис "SCUBA", однако
|
|
||||||
он тоже является закрытым и недоступен для публичного использования.
|
|
||||||
|
|
||||||
## Установка
|
|
||||||
|
|
||||||
Кратко:
|
|
||||||
|
|
||||||
- Установите MongoDB, создайте пользователя для БД метаданных S3.
|
|
||||||
- Создайте в Vitastor пул для хранения данных объектов.
|
|
||||||
- Скачайте и настройте Docker-контейнер `vitalif/vitastor-zenko`.
|
|
||||||
|
|
||||||
### Установка MongoDB
|
|
||||||
|
|
||||||
Вы можете установить MongoDB сами, следуя [официальному руководству MongoDB](https://www.mongodb.com/docs/manual/installation/).
|
|
||||||
|
|
||||||
Либо вы можете последовать инструкции, приведённой ниже - здесь описан простейший пример
|
|
||||||
установки MongoDB в Docker (docker-compose) в конфигурации с 3 репликами.
|
|
||||||
|
|
||||||
1. На всех 3 серверах создайте файл `docker-compose.yml`, заменив `<ВАШ_ПАРОЛЬ>`
|
|
||||||
на собственный будущий пароль администратора mongodb, а `0.0.0.0` по желанию
|
|
||||||
заменив на на `localhost,<IP_сервера>` - желательно либо использовать публично не доступный IP,
|
|
||||||
либо потом [настроить TLS](https://www.mongodb.com/docs/manual/tutorial/configure-ssl/).
|
|
||||||
|
|
||||||
```
|
|
||||||
version: '3.1'
|
|
||||||
|
|
||||||
services:
|
|
||||||
|
|
||||||
mongo:
|
|
||||||
container_name: mongo
|
|
||||||
image: mongo:7-jammy
|
|
||||||
restart: always
|
|
||||||
environment:
|
|
||||||
MONGO_INITDB_ROOT_USERNAME: root
|
|
||||||
MONGO_INITDB_ROOT_PASSWORD: <ВАШ_ПАРОЛЬ>
|
|
||||||
network_mode: host
|
|
||||||
volumes:
|
|
||||||
- ./keyfile:/opt/keyfile
|
|
||||||
- ./mongo-data/db:/data/db
|
|
||||||
- ./mongo-data/configdb:/data/configdb
|
|
||||||
entrypoint: /bin/bash -c
|
|
||||||
command: [ "chown mongodb /opt/keyfile && chmod 600 /opt/keyfile && . /usr/local/bin/docker-entrypoint.sh mongod --replSet rs0 --keyFile /opt/keyfile --bind_ip 0.0.0.0" ]
|
|
||||||
```
|
|
||||||
|
|
||||||
2. В той же директории сгенерируйте общий ключ кластера командой `openssl rand -base64 756 > ./keyfile`
|
|
||||||
и скопируйте этот файл на все 3 сервера.
|
|
||||||
|
|
||||||
3. На всех 3 серверах запустите MongoDB командой `docker compose up -d mongo`.
|
|
||||||
|
|
||||||
4. Зайдите в Mongo Shell с помощью команды `docker exec -it mongo mongosh -u root -p <ВАШ_ПАРОЛЬ> localhost/admin`
|
|
||||||
и там выполните команду (заменив IP-адреса `10.10.10.{1,2,3}` на адреса своих серверов):
|
|
||||||
|
|
||||||
`rs.initiate({ _id: 'rs0', members: [
|
|
||||||
{ _id: 1, host: '10.10.10.1:27017' },
|
|
||||||
{ _id: 2, host: '10.10.10.2:27017' },
|
|
||||||
{ _id: 3, host: '10.10.10.3:27017' }
|
|
||||||
] })`
|
|
||||||
|
|
||||||
5. Находясь там же, в Mongo Shell, создайте пользователя с доступом к будущей базе данных S3:
|
|
||||||
|
|
||||||
`db.createUser({ user: 's3', pwd: '<ВАШ_ПАРОЛЬ_S3>', roles: [
|
|
||||||
{ role: 'readWrite', db: 's3' },
|
|
||||||
{ role: 'dbAdmin', db: 's3' },
|
|
||||||
{ role: 'readWrite', db: 'vitastor' },
|
|
||||||
{ role: 'dbAdmin', db: 'vitastor' }
|
|
||||||
] })`
|
|
||||||
|
|
||||||
### Настройка Vitastor
|
|
||||||
|
|
||||||
Создайте в Vitastor отдельный пул для данных объектов S3, например:
|
|
||||||
|
|
||||||
`vitastor-cli create-pool --ec 2+1 -n 512 s3-data --used_for_app s3:standard`
|
|
||||||
|
|
||||||
Опция `--used_for_app` работает как "защита от дурака" и не даёт вам случайно создать
|
|
||||||
в этом пуле обычный блочный том и перезаписать им какие-то данные S3, а также скрывает
|
|
||||||
статистику занятого места по томам S3 из etcd.
|
|
||||||
|
|
||||||
Получите ID своего пула с помощью команды `vitastor-cli ls-pools --detail`.
|
|
||||||
|
|
||||||
### Установка Vitastor S3
|
|
||||||
|
|
||||||
1. Добавьте в `docker-compose.yml` строки (альтернативно вместо `network_mode: host`
|
|
||||||
можно использовать `ports: [ "8000:8000", "8002:8002" ]`):
|
|
||||||
|
|
||||||
```
|
|
||||||
zenko:
|
|
||||||
container_name: zenko
|
|
||||||
image: vitalif/vitastor-zenko
|
|
||||||
restart: always
|
|
||||||
security_opt:
|
|
||||||
- seccomp:unconfined
|
|
||||||
ulimits:
|
|
||||||
memlock: -1
|
|
||||||
network_mode: host
|
|
||||||
volumes:
|
|
||||||
- /etc/vitastor:/etc/vitastor
|
|
||||||
- /etc/vitastor/s3:/conf
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Извлеките из Docker-образа Vitastor примеры файлов конфигурации:
|
|
||||||
`docker run --rm -it -v /etc/vitastor:/etc/vitastor -v /etc/vitastor/s3:/conf vitalif/vitastor-zenko configure.sh`
|
|
||||||
|
|
||||||
3. Отредактируйте файлы конфигурации в `/etc/vitastor/s3/`:
|
|
||||||
- `config.json` - общие настройки.
|
|
||||||
- `authdata.json` - учётные записи и ключи доступа.
|
|
||||||
- `locationConfig.json` - список классов хранения S3 с настройками расположения.
|
|
||||||
Внимание: в данной версии это именно список S3 storage class-ов (STANDARD, COLD и т.п.),
|
|
||||||
а не зон (подобных us-east-1), как в оригинальном Zenko CloudServer.
|
|
||||||
- В `config.json` и в `locationConfig.json` пропишите свои данные подключения к MongoDB.
|
|
||||||
- В `locationConfig.json` укажите ID пула Vitastor для хранения данных.
|
|
||||||
- Полный перечень настроек Vitastor-бэкенда пока можно посмотреть [в коде](https://git.yourcmc.ru/vitalif/zenko-arsenal/src/branch/master/lib/storage/data/vitastor/VitastorBackend.ts#L94).
|
|
||||||
|
|
||||||
### Запуск
|
|
||||||
|
|
||||||
Запустите S3-сервер: `docker-compose up -d zenko`
|
|
||||||
|
|
||||||
Готово! Вы получили S3-сервер, работающий на порту 8000.
|
|
||||||
|
|
||||||
Можете попробовать обратиться к нему с помощью, например, [s3cmd](https://s3tools.org/s3cmd):
|
|
||||||
|
|
||||||
`s3cmd --host-bucket= --no-ssl --access_key=accessKey1 --secret_key=verySecretKey1 --host=http://localhost:8000 mb s3://testbucket`
|
|
||||||
|
|
||||||
Или смонтировать его с помощью [GeeseFS](https://github.com/yandex-cloud/geesefs):
|
|
||||||
|
|
||||||
`AWS_ACCESS_KEY_ID=accessKey1 AWS_SECRET_ACCESS_KEY=verySecretKey1 geesefs --endpoint http://localhost:8000 testbucket /mnt/geesefs`
|
|
||||||
|
|
||||||
## Лицензия
|
|
||||||
|
|
||||||
- Автор [Zenko CloudServer](https://s3-server.readthedocs.io/en/latest/) - Scality, лицензия [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0)
|
|
||||||
- Vitastor-бэкенд для S3, как и сам Vitastor, лицензируется на условиях [VNPL 1.1](https://git.yourcmc.ru/vitalif/vitastor/src/branch/master/VNPL-1.1.txt)
|
|
||||||
- Репозиторий сборки: https://git.yourcmc.ru/vitalif/zenko-cloudserver-vitastor
|
|
||||||
- Бэкенд хранения данных: https://git.yourcmc.ru/vitalif/zenko-arsenal/src/branch/master/lib/storage/data/vitastor/VitastorBackend.ts
|
|
||||||
@@ -15,8 +15,8 @@
|
|||||||
- gcc and g++ 8 or newer, clang 10 or newer, or other compiler with C++11 plus
|
- gcc and g++ 8 or newer, clang 10 or newer, or other compiler with C++11 plus
|
||||||
designated initializers support from C++20
|
designated initializers support from C++20
|
||||||
- CMake
|
- CMake
|
||||||
- jerasure, c-ares headers and libraries
|
- liburing, jerasure headers and libraries
|
||||||
- ISA-L, libibverbs, librdmacm, libnl3 headers and libraries (optional)
|
- ISA-L, libibverbs headers and libraries (optional)
|
||||||
- tcmalloc (google-perftools-dev)
|
- tcmalloc (google-perftools-dev)
|
||||||
|
|
||||||
## Basic instructions
|
## Basic instructions
|
||||||
|
|||||||
@@ -15,8 +15,8 @@
|
|||||||
- gcc и g++ >= 8, либо clang >= 10, либо другой компилятор с поддержкой C++11 плюс
|
- gcc и g++ >= 8, либо clang >= 10, либо другой компилятор с поддержкой C++11 плюс
|
||||||
назначенных инициализаторов (designated initializers) из C++20
|
назначенных инициализаторов (designated initializers) из C++20
|
||||||
- CMake
|
- CMake
|
||||||
- Заголовки и библиотеки jerasure, c-ares
|
- Заголовки и библиотеки liburing, jerasure
|
||||||
- Опционально - заголовки и библиотеки ISA-L, libibverbs, librdmacm, libnl3
|
- Опционально - заголовки и библиотеки ISA-L, libibverbs
|
||||||
- tcmalloc (google-perftools-dev)
|
- tcmalloc (google-perftools-dev)
|
||||||
|
|
||||||
## Базовая инструкция
|
## Базовая инструкция
|
||||||
|
|||||||
@@ -125,13 +125,6 @@ All other client-side components are based on the client library:
|
|||||||
all current read/write operations to it fail with EPIPE error and are retried by clients.
|
all current read/write operations to it fail with EPIPE error and are retried by clients.
|
||||||
- After completing all secondary read/write requests, primary OSD sends the response to
|
- After completing all secondary read/write requests, primary OSD sends the response to
|
||||||
the client.
|
the client.
|
||||||
- When [localized reads](../config/pool.en.md#local_reads) are enabled for a PG in a
|
|
||||||
replicated pool, and the PG is in an active and clean state (active or
|
|
||||||
active+left_on_dead), the client can send the request to one of secondary OSDs instead
|
|
||||||
of the primary. Secondary OSD checks the [PG lock](../config/osd.en.md#enable_pg_locks)
|
|
||||||
and handles the request locally without communicating to the primary. PG lock is required
|
|
||||||
for the secondary OSD to know for sure that the PG is in clean state and not switching
|
|
||||||
primary at the moment.
|
|
||||||
|
|
||||||
### Nuances of request handling
|
### Nuances of request handling
|
||||||
|
|
||||||
|
|||||||
@@ -125,12 +125,6 @@
|
|||||||
и если любое из этих соединений отключается, PG перезапускается, а все текущие запросы чтения
|
и если любое из этих соединений отключается, PG перезапускается, а все текущие запросы чтения
|
||||||
и записи в неё завершаются с ошибкой EPIPE, после чего повторяются клиентами.
|
и записи в неё завершаются с ошибкой EPIPE, после чего повторяются клиентами.
|
||||||
- После завершения всех вторичных операций чтения/записи первичный OSD отправляет ответ клиенту.
|
- После завершения всех вторичных операций чтения/записи первичный OSD отправляет ответ клиенту.
|
||||||
- Если в реплицированном пуле включены [локализованные чтения](../config/pool.ru.md#local_reads),
|
|
||||||
а PG находится в чистом активном состоянии (active или active+left_on_dead), клиент может
|
|
||||||
послать запрос к одному из вторичных OSD вместо первичного. Вторичный OSD проверяет
|
|
||||||
[блокировку PG](../config/osd.ru.md#enable_pg_locks) и обрабатывает запрос локально, не
|
|
||||||
обращаясь к первичному. Блокировка PG здесь нужна, чтобы вторичный OSD мог точно знать,
|
|
||||||
что PG находится в чистом состоянии и не переключается на другой первичный OSD.
|
|
||||||
|
|
||||||
### Особенности обработки запросов
|
### Особенности обработки запросов
|
||||||
|
|
||||||
|
|||||||
+10
-84
@@ -10,17 +10,8 @@ Copyright (c) Vitaliy Filippov (vitalif [at] yourcmc.ru), 2019+
|
|||||||
|
|
||||||
Join Vitastor Telegram Chat: https://t.me/vitastor
|
Join Vitastor Telegram Chat: https://t.me/vitastor
|
||||||
|
|
||||||
License: VNPL 1.1 for server-side code and dual VNPL 1.1 + GPL 2.0+ for client tools.
|
All server-side code (OSD, Monitor and so on) is licensed under the terms of
|
||||||
|
Vitastor Network Public License 1.1 (VNPL 1.1), a copyleft license based on
|
||||||
Server-side code is licensed only under the terms of VNPL.
|
|
||||||
|
|
||||||
Client libraries (cluster_client and so on) are dual-licensed under the same
|
|
||||||
VNPL 1.1 and also GNU GPL 2.0 or later to allow for compatibility with GPLed
|
|
||||||
software like QEMU and fio.
|
|
||||||
|
|
||||||
## VNPL
|
|
||||||
|
|
||||||
Vitastor Network Public License 1.1 (VNPL 1.1) is a copyleft license based on
|
|
||||||
GNU GPLv3.0 with the additional "Network Interaction" clause which requires
|
GNU GPLv3.0 with the additional "Network Interaction" clause which requires
|
||||||
opensourcing all programs directly or indirectly interacting with Vitastor
|
opensourcing all programs directly or indirectly interacting with Vitastor
|
||||||
through a computer network and expressly designed to be used in conjunction
|
through a computer network and expressly designed to be used in conjunction
|
||||||
@@ -29,83 +20,18 @@ the terms of the same license, but also under the terms of any GPL-Compatible
|
|||||||
Free Software License, as listed by the Free Software Foundation.
|
Free Software License, as listed by the Free Software Foundation.
|
||||||
This is a stricter copyleft license than the Affero GPL.
|
This is a stricter copyleft license than the Affero GPL.
|
||||||
|
|
||||||
The idea of VNPL is, in addition to modules linked to Vitastor code in a single
|
Please note that VNPL doesn't require you to open the code of proprietary
|
||||||
binary file, to extend copyleft action to micro-service modules only interacting
|
software running inside a VM if it's not specially designed to be used with
|
||||||
with it over the network.
|
Vitastor.
|
||||||
|
|
||||||
Basically, you can't use the software in a proprietary environment to provide
|
Basically, you can't use the software in a proprietary environment to provide
|
||||||
its functionality to users without opensourcing all intermediary components
|
its functionality to users without opensourcing all intermediary components
|
||||||
standing between the user and Vitastor or purchasing a commercial license
|
standing between the user and Vitastor or purchasing a commercial license
|
||||||
from the author 😀.
|
from the author 😀.
|
||||||
|
|
||||||
At the same time, VNPL doesn't impose any restrictions on software *not specially designed*
|
Client libraries (cluster_client and so on) are dual-licensed under the same
|
||||||
to be used with Vitastor, for example, on Windows running inside a VM with a Vitastor disk.
|
VNPL 1.1 and also GNU GPL 2.0 or later to allow for compatibility with GPLed
|
||||||
|
software like QEMU and fio.
|
||||||
|
|
||||||
## Explanation
|
You can find the full text of VNPL-1.1 in the file [VNPL-1.1.txt](../../VNPL-1.1.txt).
|
||||||
|
GPL 2.0 is also included in this repository as [GPL-2.0.txt](../../GPL-2.0.txt).
|
||||||
Network copyleft is governed by the clause **13. Remote Network Interaction** of VNPL.
|
|
||||||
|
|
||||||
A program is considered to be a "Proxy Program" if it meets both conditions:
|
|
||||||
- It is specially designed to be used with Vitastor. Basically, it means that the program
|
|
||||||
has any functionality specific to Vitastor and thus "knows" that it works with Vitastor,
|
|
||||||
not with something random.
|
|
||||||
- It interacts with Vitastor directly or indirectly through any programming interface,
|
|
||||||
including API, CLI, network or any wrapper (also considered a Proxy Program itself).
|
|
||||||
|
|
||||||
If, in addition to that:
|
|
||||||
- You give any user an apportunity to interact with Vitastor directly or indirectly through
|
|
||||||
any computer interface including the network or any number of wrappers (Proxy Programs).
|
|
||||||
|
|
||||||
Then VNPL requires you to publish the code of all above Proxy Programs to all above users
|
|
||||||
under the terms of any GPL-compatible license - that is, GPL, LGPL, MIT/BSD or Apache 2,
|
|
||||||
because "GPL compatibility" is treated as an ability to legally include licensed code in
|
|
||||||
a GPL application.
|
|
||||||
|
|
||||||
So, if you have a "Proxy Program", but it's not open to the user who directly or indirectly
|
|
||||||
interacts with Vitastor - you are forbidden to use Vitastor under the terms of VNPL and you
|
|
||||||
need a commercial license which doesn't contain open-source requirements.
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
- Vitastor Kubernetes CSI driver which creates PersistentVolumes by calling `vitastor-cli create`.
|
|
||||||
- Yes, it interacts with Vitastor through vitastor-cli.
|
|
||||||
- Yes, it is designed specially for use with Vitastor (it has no sense otherwise).
|
|
||||||
- So, CSI driver **definitely IS** a Proxy Program and must be published under the terms of
|
|
||||||
a free software license.
|
|
||||||
- Windows, installed in a VM with the system disk on Vitastor storage.
|
|
||||||
- Yes, it interacts with Vitastor indirectly - it reads and writes data through the block
|
|
||||||
device interface, emulated by QEMU.
|
|
||||||
- No, it definitely isn't designed specially for use with Vitastor - Windows was created long
|
|
||||||
ago before Vitastor and doesn't know anything about it.
|
|
||||||
- So, Windows **definitely IS NOT** a Proxy Program and VNPL doesn't require to open it.
|
|
||||||
- Cloud control panel which makes requests to Vitastor Kubernetes CSI driver.
|
|
||||||
- Yes, it interacts with Vitastor indirectly through the CSI driver, which is a Proxy Program.
|
|
||||||
- May or may not be designed specially for use with Vitastor. How to determine exactly?
|
|
||||||
Imagine that Vitastor is replaced with any other storage (for example, with a proprietary).
|
|
||||||
Do control panel functions change in any way? If they do (for example, if snapshots stop working),
|
|
||||||
then the panel contains specific functionality and thus is designed specially for use with Vitastor.
|
|
||||||
Otherwise, the panel is universal and isn't designed specially for Vitastor.
|
|
||||||
- So, whether you are required to open-source the panel also **depends** on whether it
|
|
||||||
contains specific functionality or not.
|
|
||||||
|
|
||||||
## Why?
|
|
||||||
|
|
||||||
Because I believe into the spirit of copyleft (Linux wouldn't become so popular without GPL!)
|
|
||||||
and, at the same time, I want to have a way to monetize the product.
|
|
||||||
|
|
||||||
Existing licenses including AGPL are useless for it with an SDS - SDS is a very deeply
|
|
||||||
internal software which is almost definitely invisible to the user and thus AGPL doesn't
|
|
||||||
require anyone to open the code even if they make a proprietary fork.
|
|
||||||
|
|
||||||
And, in fact, the current situation in the world where GPL is though to only restrict direct
|
|
||||||
linking of programs into a single executable file, isn't much correct. Nowadays, programs
|
|
||||||
are more often linked with network API calls, not with /usr/bin/ld, and a software product
|
|
||||||
may consist of dozens of microservices interacting with each other over the network.
|
|
||||||
|
|
||||||
That's why we need VNPL to keep the license sufficiently copyleft.
|
|
||||||
|
|
||||||
## License Texts
|
|
||||||
|
|
||||||
- VNPL 1.1 in English: [VNPL-1.1.txt](../../VNPL-1.1.txt)
|
|
||||||
- VNPL 1.1 in Russian: [VNPL-1.1-RU.txt](../../VNPL-1.1-RU.txt)
|
|
||||||
- GPL 2.0: [GPL-2.0.txt](../../GPL-2.0.txt)
|
|
||||||
|
|||||||
+5
-74
@@ -12,14 +12,6 @@
|
|||||||
|
|
||||||
Лицензия: VNPL 1.1 на серверный код и двойная VNPL 1.1 + GPL 2.0+ на клиентский.
|
Лицензия: VNPL 1.1 на серверный код и двойная VNPL 1.1 + GPL 2.0+ на клиентский.
|
||||||
|
|
||||||
Серверные компоненты распространяются только на условиях VNPL.
|
|
||||||
|
|
||||||
Клиентские библиотеки распространяются на условиях двойной лицензии VNPL 1.0
|
|
||||||
и также на условиях GNU GPL 2.0 или более поздней версии. Так сделано в целях
|
|
||||||
совместимости с таким ПО, как QEMU и fio.
|
|
||||||
|
|
||||||
## VNPL
|
|
||||||
|
|
||||||
VNPL - "сетевой копилефт", собственная свободная копилефт-лицензия
|
VNPL - "сетевой копилефт", собственная свободная копилефт-лицензия
|
||||||
Vitastor Network Public License 1.1, основанная на GNU GPL 3.0 с дополнительным
|
Vitastor Network Public License 1.1, основанная на GNU GPL 3.0 с дополнительным
|
||||||
условием "Сетевого взаимодействия", требующим распространять все программы,
|
условием "Сетевого взаимодействия", требующим распространять все программы,
|
||||||
@@ -37,70 +29,9 @@ Vitastor Network Public License 1.1, основанная на GNU GPL 3.0 с д
|
|||||||
На Windows и любое другое ПО, не разработанное *специально* для использования
|
На Windows и любое другое ПО, не разработанное *специально* для использования
|
||||||
вместе с Vitastor, никакие ограничения не накладываются.
|
вместе с Vitastor, никакие ограничения не накладываются.
|
||||||
|
|
||||||
## Пояснение
|
Клиентские библиотеки распространяются на условиях двойной лицензии VNPL 1.0
|
||||||
|
и также на условиях GNU GPL 2.0 или более поздней версии. Так сделано в целях
|
||||||
|
совместимости с таким ПО, как QEMU и fio.
|
||||||
|
|
||||||
Сетевой копилефт регулируется пунктом лицензии **13. Удалённое сетевое взаимодействие**.
|
Вы можете найти полный текст VNPL 1.1 на английском языке в файле [VNPL-1.1.txt](../../VNPL-1.1.txt),
|
||||||
|
VNPL 1.1 на русском языке в файле [VNPL-1.1-RU.txt](../../VNPL-1.1-RU.txt), а GPL 2.0 в файле [GPL-2.0.txt](../../GPL-2.0.txt).
|
||||||
Программа считается "прокси-программой", если верны оба условия:
|
|
||||||
- Она создана специально для работы вместе с Vitastor. По сути это означает, что программа
|
|
||||||
должна иметь специфичный для Vitastor функционал, то есть, "знать", что она взаимодействует
|
|
||||||
именно с Vitastor.
|
|
||||||
- Она прямо или косвенно взаимодействует с Vitastor через абсолютно любой программный
|
|
||||||
интерфейс, включая любые способы вызова: API, CLI, сеть или через какую-то обёртку (в
|
|
||||||
свою очередь тоже являющуюся прокси-программой).
|
|
||||||
|
|
||||||
Если в дополнение к этому также:
|
|
||||||
- Вы предоставляете любому пользователю возможность взаимодействовать с Vitastor по сети,
|
|
||||||
опять-таки, через любой интерфейс или любую серию "обёрток" (прокси-программ)
|
|
||||||
|
|
||||||
То, согласно VNPL, вы должны открыть код "прокси-программ" **таким пользователям** на условиях
|
|
||||||
любой GPL-совместимой лицензии - то есть, GPL, LGPL, MIT/BSD или Apache 2 - "совместимость с GPL"
|
|
||||||
понимается как возможность включать лицензируемый код в GPL-приложение.
|
|
||||||
|
|
||||||
Соответственно, если у вас есть "прокси-программа", но её код не открыт пользователю,
|
|
||||||
который прямо или косвенно взаимодействует с Vitastor - вам запрещено использовать Vitastor
|
|
||||||
на условиях VNPL и вам нужна коммерческая лицензия, не содержащая требований об открытии кода.
|
|
||||||
|
|
||||||
## Примеры
|
|
||||||
|
|
||||||
- Kubernetes CSI-драйвер Vitastor, создающий PersistentVolume с помощью вызова `vitastor-cli create`.
|
|
||||||
- Да, взаимодействует с Vitastor через vitastor-cli.
|
|
||||||
- Да, создавался специально для работы с Vitastor (иначе в чём же ещё его смысл).
|
|
||||||
- Значит, CSI-драйвер **точно считается** "прокси-программой" и должен быть открыт под свободной
|
|
||||||
лицензией.
|
|
||||||
- Windows, установленный в виртуальную машину на диске Vitastor.
|
|
||||||
- Да, взаимодействует с Vitastor "прямо или косвенно" - пишет и читает данные через интерфейс
|
|
||||||
блочного устройства, эмулируемый QEMU.
|
|
||||||
- Нет, точно не создан *специально для работы с Vitastor* - когда его создавали, никакого
|
|
||||||
Vitastor ещё и в помине не было.
|
|
||||||
- Значит, Windows **точно не считается** "прокси-программой" и на него требования VNPL не распространяются.
|
|
||||||
- Панель управления облака, делающая запросы к Kubernetes CSI-драйверу Vitastor.
|
|
||||||
- Да, взаимодействует с Vitastor косвенно через CSI-драйвер, являющийся "прокси-программой".
|
|
||||||
- Сходу не известно, создавалась ли конкретно для работы с Vitastor. Как понять, да или нет?
|
|
||||||
Представьте, что Vitastor заменён на любую другую систему хранения (например, на проприетарную).
|
|
||||||
Работа панели управления изменится? Если да (например, перестанут работать снапшоты) - значит,
|
|
||||||
панель содержит специфичный функционал и "создана специально для работы с Vitastor".
|
|
||||||
Если нет - значит, специфичного функционала панель не содержит и в принципе она универсальна.
|
|
||||||
- Нужно ли открывать панель - **зависит** от того, содержит она специфичный функционал или нет.
|
|
||||||
|
|
||||||
## Почему так?
|
|
||||||
|
|
||||||
Потому что я одновременно верю в дух копилефт-лицензий (Linux не стал бы так популярен,
|
|
||||||
если бы не GPL!) и хочу иметь возможность монетизации продукта.
|
|
||||||
|
|
||||||
При этом использовать даже AGPL для программной СХД бессмысленно - это глубоко внутреннее
|
|
||||||
ПО, которое пользователь почти наверняка не увидит вообще, поэтому и открывать код никому
|
|
||||||
никогда не придётся, даже при создании производного продукта.
|
|
||||||
|
|
||||||
Да и в целом сложившаяся в мире ситуация, при которой действие GPL ограничивается только
|
|
||||||
прямым связыванием в один исполняемый файл, не очень корректна. В настоящее время программы
|
|
||||||
гораздо чаще интегрируют сетевыми вызовами, а не с помощью /usr/bin/ld, и общий программный
|
|
||||||
продукт может состоять из нескольких десятков микросервисов, взаимодействующих по сети.
|
|
||||||
|
|
||||||
Поэтому для сохранения достаточной "копилефтности" и придумана VNPL.
|
|
||||||
|
|
||||||
## Тексты лицензий
|
|
||||||
|
|
||||||
- VNPL 1.1 на английском языке: [VNPL-1.1.txt](../../VNPL-1.1.txt)
|
|
||||||
- VNPL 1.1 на русском языке: [VNPL-1.1-RU.txt](../../VNPL-1.1-RU.txt)
|
|
||||||
- GPL 2.0: [GPL-2.0.txt](../../GPL-2.0.txt)
|
|
||||||
|
|||||||
@@ -14,8 +14,6 @@
|
|||||||
|
|
||||||
- Basic part: highly-available block storage with symmetric clustering and no SPOF
|
- Basic part: highly-available block storage with symmetric clustering and no SPOF
|
||||||
- [Performance](../performance/bench2.en.md) ;-D
|
- [Performance](../performance/bench2.en.md) ;-D
|
||||||
- [NVMe atomic write support](../config/osd.en.md#atomic_write_size) for reducing the amount
|
|
||||||
of "extra" disk writes to almost zero (Write Amplification = 1)
|
|
||||||
- [Multiple redundancy schemes](../config/pool.en.md#scheme): Replication, XOR n+1, Reed-Solomon erasure codes
|
- [Multiple redundancy schemes](../config/pool.en.md#scheme): Replication, XOR n+1, Reed-Solomon erasure codes
|
||||||
based on jerasure and ISA-L libraries with any number of data and parity drives in a group
|
based on jerasure and ISA-L libraries with any number of data and parity drives in a group
|
||||||
- Configuration via simple JSON data structures in etcd (parameters, pools and images)
|
- Configuration via simple JSON data structures in etcd (parameters, pools and images)
|
||||||
@@ -27,11 +25,10 @@
|
|||||||
- Recovery of degraded blocks
|
- Recovery of degraded blocks
|
||||||
- Rebalancing (data movement between OSDs)
|
- Rebalancing (data movement between OSDs)
|
||||||
- [Lazy fsync support](../config/layout-cluster.en.md#immediate_commit)
|
- [Lazy fsync support](../config/layout-cluster.en.md#immediate_commit)
|
||||||
- [Localized read support](../config/pool.en.md#local_reads) for cross-datacenter setup optimization
|
|
||||||
- Per-OSD and per-image I/O and space usage statistics in etcd
|
- Per-OSD and per-image I/O and space usage statistics in etcd
|
||||||
- Snapshots and copy-on-write image clones
|
- Snapshots and copy-on-write image clones
|
||||||
- [Write throttling to smooth random write workloads in SSD+HDD configurations](../config/osd.en.md#throttle_small_writes)
|
- [Write throttling to smooth random write workloads in SSD+HDD configurations](../config/osd.en.md#throttle_small_writes)
|
||||||
- RDMA/RoCEv2 support [via libibverbs](../config/network.en.md#use_rdma) or [RDMA-CM](../config/network.en.md#use_rdmacm)
|
- [RDMA/RoCEv2 support via libibverbs](../config/network.en.md#rdma_device)
|
||||||
- [Scrubbing](../config/osd.en.md#auto_scrub) (verification of copies)
|
- [Scrubbing](../config/osd.en.md#auto_scrub) (verification of copies)
|
||||||
- [Checksums](../config/layout-osd.en.md#data_csum_type)
|
- [Checksums](../config/layout-osd.en.md#data_csum_type)
|
||||||
- [Client write-back cache](../config/client.en.md#client_enable_writeback)
|
- [Client write-back cache](../config/client.en.md#client_enable_writeback)
|
||||||
@@ -40,9 +37,6 @@
|
|||||||
- [Experimental internal etcd replacement - antietcd](../config/monitor.en.md#use_antietcd)
|
- [Experimental internal etcd replacement - antietcd](../config/monitor.en.md#use_antietcd)
|
||||||
- [Built-in Prometheus metric exporter](../config/monitor.en.md#enable_prometheus)
|
- [Built-in Prometheus metric exporter](../config/monitor.en.md#enable_prometheus)
|
||||||
- [NFS RDMA support](../usage/nfs.en.md#rdma) (probably also usable for GPUDirect)
|
- [NFS RDMA support](../usage/nfs.en.md#rdma) (probably also usable for GPUDirect)
|
||||||
- [S3](../installation/s3.en.md)
|
|
||||||
- [TLS support for etcd connections](../config/security.en.md)
|
|
||||||
- [AES-256-XTS image encryption](../usage/cli.en.md#create) and [Vault support](../config/security.en.md#vault_url) for key storage
|
|
||||||
|
|
||||||
## Plugins and tools
|
## Plugins and tools
|
||||||
|
|
||||||
@@ -56,7 +50,7 @@
|
|||||||
- Generic user-space client library
|
- Generic user-space client library
|
||||||
- [Native QEMU driver](../usage/qemu.en.md)
|
- [Native QEMU driver](../usage/qemu.en.md)
|
||||||
- [Loadable fio engine for benchmarks](../usage/fio.en.md)
|
- [Loadable fio engine for benchmarks](../usage/fio.en.md)
|
||||||
- [UBLK](../usage/ublk.en.md) and [NBD](../usage/nbd.en.md) servers for kernel mounts
|
- [NBD proxy for kernel mounts](../usage/nbd.en.md)
|
||||||
- [Simplified NFS proxy for file-based image access emulation (suitable for VMWare)](../usage/nfs.en.md#pseudo-fs)
|
- [Simplified NFS proxy for file-based image access emulation (suitable for VMWare)](../usage/nfs.en.md#pseudo-fs)
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
@@ -69,6 +63,7 @@ The following features are planned for the future:
|
|||||||
- iSCSI and NVMeoF gateways
|
- iSCSI and NVMeoF gateways
|
||||||
- Multi-threaded client
|
- Multi-threaded client
|
||||||
- Faster failover
|
- Faster failover
|
||||||
|
- S3
|
||||||
- Tiered storage (SSD caching)
|
- Tiered storage (SSD caching)
|
||||||
- NVDIMM support
|
- NVDIMM support
|
||||||
- Compression (possibly)
|
- Compression (possibly)
|
||||||
|
|||||||
@@ -14,8 +14,6 @@
|
|||||||
|
|
||||||
- Базовая часть - надёжное кластерное блочное хранилище без единой точки отказа
|
- Базовая часть - надёжное кластерное блочное хранилище без единой точки отказа
|
||||||
- [Производительность](../performance/bench2.ru.md) ;-D
|
- [Производительность](../performance/bench2.ru.md) ;-D
|
||||||
- [Поддержка атомарной записи NVMe](../config/osd.ru.md#atomic_write_size) для снижения объёма
|
|
||||||
служебной записи практически до нуля (Write Amplification = 1)
|
|
||||||
- [Несколько схем отказоустойчивости](../config/pool.ru.md#scheme): репликация, XOR n+1 (1 диск чётности), коды коррекции ошибок
|
- [Несколько схем отказоустойчивости](../config/pool.ru.md#scheme): репликация, XOR n+1 (1 диск чётности), коды коррекции ошибок
|
||||||
Рида-Соломона на основе библиотек jerasure и ISA-L с любым числом дисков данных и чётности в группе
|
Рида-Соломона на основе библиотек jerasure и ISA-L с любым числом дисков данных и чётности в группе
|
||||||
- Конфигурация через простые человекочитаемые JSON-структуры в etcd
|
- Конфигурация через простые человекочитаемые JSON-структуры в etcd
|
||||||
@@ -27,13 +25,12 @@
|
|||||||
- Восстановление деградированных блоков
|
- Восстановление деградированных блоков
|
||||||
- Ребаланс, то есть перемещение данных между OSD (дисками)
|
- Ребаланс, то есть перемещение данных между OSD (дисками)
|
||||||
- [Поддержка "ленивого" fsync (fsync не на каждую операцию)](../config/layout-cluster.ru.md#immediate_commit)
|
- [Поддержка "ленивого" fsync (fsync не на каждую операцию)](../config/layout-cluster.ru.md#immediate_commit)
|
||||||
- [Локальные чтения](../config/pool.ru.md#local_reads) для оптимизации при нескольких датацентрах
|
|
||||||
- Сбор статистики ввода/вывода в etcd
|
- Сбор статистики ввода/вывода в etcd
|
||||||
- Статистика операций ввода/вывода и занятого места в разрезе инодов
|
- Статистика операций ввода/вывода и занятого места в разрезе инодов
|
||||||
- Именование инодов через хранение их метаданных в etcd
|
- Именование инодов через хранение их метаданных в etcd
|
||||||
- Снапшоты и copy-on-write клоны
|
- Снапшоты и copy-on-write клоны
|
||||||
- [Сглаживание производительности случайной записи в SSD+HDD конфигурациях](../config/osd.ru.md#throttle_small_writes)
|
- [Сглаживание производительности случайной записи в SSD+HDD конфигурациях](../config/osd.ru.md#throttle_small_writes)
|
||||||
- Поддержка RDMA/RoCEv2 [через libibverbs](../config/network.ru.md#use_rdma) или [RDMA-CM](../config/network.ru.md#use_rdmacm)
|
- [Поддержка RDMA/RoCEv2 через libibverbs](../config/network.ru.md#rdma_device)
|
||||||
- [Фоновая проверка целостности](../config/osd.ru.md#auto_scrub) (сверка копий)
|
- [Фоновая проверка целостности](../config/osd.ru.md#auto_scrub) (сверка копий)
|
||||||
- [Контрольные суммы](../config/layout-osd.ru.md#data_csum_type)
|
- [Контрольные суммы](../config/layout-osd.ru.md#data_csum_type)
|
||||||
- [Буферизация записи на стороне клиента](../config/client.ru.md#client_enable_writeback)
|
- [Буферизация записи на стороне клиента](../config/client.ru.md#client_enable_writeback)
|
||||||
@@ -42,9 +39,6 @@
|
|||||||
- [Экспериментальная встроенная замена etcd - antietcd](../config/monitor.ru.md#use_antietcd)
|
- [Экспериментальная встроенная замена etcd - antietcd](../config/monitor.ru.md#use_antietcd)
|
||||||
- [Встроенный Prometheus-экспортер метрик](../config/monitor.ru.md#enable_prometheus)
|
- [Встроенный Prometheus-экспортер метрик](../config/monitor.ru.md#enable_prometheus)
|
||||||
- [Поддержка NFS RDMA](../usage/nfs.ru.md#rdma) (вероятно, также подходящая для GPUDirect)
|
- [Поддержка NFS RDMA](../usage/nfs.ru.md#rdma) (вероятно, также подходящая для GPUDirect)
|
||||||
- [S3](../installation/s3.ru.md)
|
|
||||||
- [Поддержка TLS-соединений с etcd](../config/security.ru.md)
|
|
||||||
- [AES-256-XTS шифрование данных](../usage/cli.ru.md#create) и [поддержка Vault](../config/security.ru.md#vault_url) для хранения ключей
|
|
||||||
|
|
||||||
## Драйверы и инструменты
|
## Драйверы и инструменты
|
||||||
|
|
||||||
@@ -58,7 +52,7 @@
|
|||||||
- Общая пользовательская клиентская библиотека для работы с кластером
|
- Общая пользовательская клиентская библиотека для работы с кластером
|
||||||
- [Драйвер диска для QEMU](../usage/qemu.ru.md)
|
- [Драйвер диска для QEMU](../usage/qemu.ru.md)
|
||||||
- [Драйвер диска для утилиты тестирования производительности fio](../usage/fio.ru.md)
|
- [Драйвер диска для утилиты тестирования производительности fio](../usage/fio.ru.md)
|
||||||
- [UBLK](../usage/ublk.ru.md) и [NBD](../usage/nbd.ru.md) серверы для монтирования образов ядром ("блочное устройство в режиме пользователя")
|
- [NBD-прокси для монтирования образов ядром](../usage/nbd.ru.md) ("блочное устройство в режиме пользователя")
|
||||||
- [Упрощённая NFS-прокси для эмуляции файлового доступа к образам (подходит для VMWare)](../usage/nfs.ru.md#псевдо-фс)
|
- [Упрощённая NFS-прокси для эмуляции файлового доступа к образам (подходит для VMWare)](../usage/nfs.ru.md#псевдо-фс)
|
||||||
|
|
||||||
## Планы развития
|
## Планы развития
|
||||||
@@ -69,6 +63,7 @@
|
|||||||
- iSCSI и NVMeoF прокси
|
- iSCSI и NVMeoF прокси
|
||||||
- Многопоточный клиент
|
- Многопоточный клиент
|
||||||
- Более быстрое переключение при отказах
|
- Более быстрое переключение при отказах
|
||||||
|
- S3
|
||||||
- Поддержка SSD-кэширования (tiered storage)
|
- Поддержка SSD-кэширования (tiered storage)
|
||||||
- Поддержка NVDIMM
|
- Поддержка NVDIMM
|
||||||
- Возможно, сжатие
|
- Возможно, сжатие
|
||||||
|
|||||||
@@ -18,10 +18,9 @@
|
|||||||
|
|
||||||
## Preparation
|
## Preparation
|
||||||
|
|
||||||
- Get some SATA or NVMe SSDs with capacitors (server-grade drives). The best performance
|
- Get some SATA or NVMe SSDs with capacitors (server-grade drives). You can use desktop SSDs
|
||||||
is achieved with Micron or Kioxia NVMes with atomic write support (see below). You can use desktop
|
with lazy fsync, but prepare for inferior single-thread latency. Read more about capacitors
|
||||||
SSDs with lazy fsync, but prepare for inferior single-thread latency. Read more about
|
[here](../config/layout-cluster.en.md#immediate_commit).
|
||||||
capacitors [here](../config/layout-cluster.en.md#immediate_commit).
|
|
||||||
- If you want to use HDDs, get modern HDDs with Media Cache or SSD Cache: HGST Ultrastar,
|
- If you want to use HDDs, get modern HDDs with Media Cache or SSD Cache: HGST Ultrastar,
|
||||||
Toshiba MG, Seagate EXOS or something similar. If your drives don't have such cache then
|
Toshiba MG, Seagate EXOS or something similar. If your drives don't have such cache then
|
||||||
you also need small SSDs for journal and metadata (even 2 GB per 1 TB of HDD space is enough).
|
you also need small SSDs for journal and metadata (even 2 GB per 1 TB of HDD space is enough).
|
||||||
@@ -31,11 +30,9 @@
|
|||||||
|
|
||||||
## Recommended drives
|
## Recommended drives
|
||||||
|
|
||||||
- NVMe with atomic write support (ideal!): Micron 7450/7500/7550, Kioxia CD6/CD7/CD8/CD9
|
- SATA SSD: Micron 5100/5200/5300/5400, Samsung PM863/PM883/PM893, Intel D3-S4510/4520/4610/4620, Kingston DC500M
|
||||||
- Other NVMe: Micron 9100/9200/9300/9400/9550, Micron 7300, Samsung PM983/PM9A3, Samsung PM1723/1735/1743,
|
- NVMe: Micron 9100/9200/9300/9400, Micron 7300/7450, Samsung PM983/PM9A3, Samsung PM1723/1735/1743,
|
||||||
Intel DC-P3700/P4500/P4600, Intel/Solidigm D5-P4320/P5530, Intel/Solidigm D7-P5500/P5600, Solidigm D7-PS1010/PS1030/P5810,
|
Intel DC-P3700/P4500/P4600, Intel D5-P4320/P5530, Intel D7-P5500/P5600, Intel Optane, Kingston DC1000B/DC1500M
|
||||||
Intel Optane, Kingston DC1000B/DC1500M, Kioxia CD6/CD7/CD8/CD9
|
|
||||||
- SATA SSD: Micron 5100/5200/5300/5400, Samsung PM863/PM883/PM893, Intel/Solidigm D3-S4510/4520/4610/4620, Kingston DC500M
|
|
||||||
- HDD: HGST Ultrastar, Toshiba MG, Seagate EXOS
|
- HDD: HGST Ultrastar, Toshiba MG, Seagate EXOS
|
||||||
|
|
||||||
## Configure monitors
|
## Configure monitors
|
||||||
@@ -53,7 +50,7 @@ On the monitor hosts:
|
|||||||
|
|
||||||
## Configure OSDs
|
## Configure OSDs
|
||||||
|
|
||||||
- Put etcd_address and [osd_network](../config/network.en.md#osd_network) into `/etc/vitastor/vitastor.conf`. Example:
|
- Put etcd_address and osd_network into `/etc/vitastor/vitastor.conf`. Example:
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"etcd_address": ["10.200.1.10:2379","10.200.1.11:2379","10.200.1.12:2379"],
|
"etcd_address": ["10.200.1.10:2379","10.200.1.11:2379","10.200.1.12:2379"],
|
||||||
|
|||||||
@@ -18,9 +18,8 @@
|
|||||||
|
|
||||||
## Подготовка
|
## Подготовка
|
||||||
|
|
||||||
- Возьмите серверы с SSD (SATA или NVMe), желательно с конденсаторами (серверные SSD). Наилучшая
|
- Возьмите серверы с SSD (SATA или NVMe), желательно с конденсаторами (серверные SSD). Можно
|
||||||
производительность достигается на дисках Micron и Kioxia с поддержкой атомарной записи (см. ниже).
|
использовать и десктопные SSD, включив режим отложенного fsync, но производительность будет хуже.
|
||||||
Можно использовать и десктопные SSD, включив режим отложенного fsync, но производительность будет хуже.
|
|
||||||
О конденсаторах читайте [здесь](../config/layout-cluster.ru.md#immediate_commit).
|
О конденсаторах читайте [здесь](../config/layout-cluster.ru.md#immediate_commit).
|
||||||
- Если хотите использовать HDD, берите современные модели с Media или SSD кэшем - HGST Ultrastar,
|
- Если хотите использовать HDD, берите современные модели с Media или SSD кэшем - HGST Ultrastar,
|
||||||
Toshiba MG, Seagate EXOS или что-то похожее. Если такого кэша у ваших дисков нет,
|
Toshiba MG, Seagate EXOS или что-то похожее. Если такого кэша у ваших дисков нет,
|
||||||
@@ -31,11 +30,9 @@
|
|||||||
|
|
||||||
## Рекомендуемые диски
|
## Рекомендуемые диски
|
||||||
|
|
||||||
- NVMe с поддержкой атомарной записи (идеально!): Micron 7450/7500/7550, Kioxia CD6/CD7/CD8/CD9
|
- SATA SSD: Micron 5100/5200/5300/5400, Samsung PM863/PM883/PM893, Intel D3-S4510/4520/4610/4620, Kingston DC500M
|
||||||
- Другие NVMe: Micron 9100/9200/9300/9400/9550, Micron 7300, Samsung PM983/PM9A3, Samsung PM1723/1735/1743,
|
- NVMe: Micron 9100/9200/9300/9400, Micron 7300/7450, Samsung PM983/PM9A3, Samsung PM1723/1735/1743,
|
||||||
Intel DC-P3700/P4500/P4600, Intel/Solidigm D5-P4320/P5530, Intel/Solidigm D7-P5500/P5600, Solidigm D7-PS1010/PS1030/P5810,
|
Intel DC-P3700/P4500/P4600, Intel D5-P4320/P5530, Intel D7-P5500/P5600, Intel Optane, Kingston DC1000B/DC1500M
|
||||||
Intel Optane, Kingston DC1000B/DC1500M, Kioxia CD6/CD7/CD8/CD9
|
|
||||||
- SATA SSD: Micron 5100/5200/5300/5400, Samsung PM863/PM883/PM893, Intel/Solidigm D3-S4510/4520/4610/4620, Kingston DC500M
|
|
||||||
- HDD: HGST Ultrastar, Toshiba MG, Seagate EXOS
|
- HDD: HGST Ultrastar, Toshiba MG, Seagate EXOS
|
||||||
|
|
||||||
## Настройте мониторы
|
## Настройте мониторы
|
||||||
@@ -53,7 +50,7 @@
|
|||||||
|
|
||||||
## Настройте OSD
|
## Настройте OSD
|
||||||
|
|
||||||
- Пропишите etcd_address и [osd_network](../config/network.ru.md#osd_network) в `/etc/vitastor/vitastor.conf`. Например:
|
- Пропишите etcd_address и osd_network в `/etc/vitastor/vitastor.conf`. Например:
|
||||||
```
|
```
|
||||||
{
|
{
|
||||||
"etcd_address": ["10.200.1.10:2379","10.200.1.11:2379","10.200.1.12:2379"],
|
"etcd_address": ["10.200.1.10:2379","10.200.1.11:2379","10.200.1.12:2379"],
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ Replicated setups:
|
|||||||
- Linear read: `min(total network bandwidth, sum(disk read MB/s))`.
|
- Linear read: `min(total network bandwidth, sum(disk read MB/s))`.
|
||||||
- Linear write: `min(total network bandwidth, sum(disk write MB/s / number of replicas))`.
|
- Linear write: `min(total network bandwidth, sum(disk write MB/s / number of replicas))`.
|
||||||
- Saturated parallel read iops: `min(total network bandwidth, sum(disk read iops))`.
|
- Saturated parallel read iops: `min(total network bandwidth, sum(disk read iops))`.
|
||||||
- Saturated parallel write iops: `min(total network bandwidth / number of replicas, sum(disk write iops / number of replicas / write amplification))`.
|
- Saturated parallel write iops: `min(total network bandwidth / number of replicas, sum(disk write iops / number of replicas / (write amplification = 4)))`.
|
||||||
|
|
||||||
EC/XOR setups (EC N+K):
|
EC/XOR setups (EC N+K):
|
||||||
- Single-threaded (T1Q1) read latency: 1.5 network roundtrips + 1 disk read.
|
- Single-threaded (T1Q1) read latency: 1.5 network roundtrips + 1 disk read.
|
||||||
@@ -26,36 +26,28 @@ EC/XOR setups (EC N+K):
|
|||||||
- Linear read: `min(total network bandwidth, sum(disk read MB/s))`.
|
- Linear read: `min(total network bandwidth, sum(disk read MB/s))`.
|
||||||
- Linear write: `min(total network bandwidth, sum(disk write MB/s * N/(N+K)))`.
|
- Linear write: `min(total network bandwidth, sum(disk write MB/s * N/(N+K)))`.
|
||||||
- Saturated parallel read iops: `min(total network bandwidth, sum(disk read iops))`.
|
- Saturated parallel read iops: `min(total network bandwidth, sum(disk read iops))`.
|
||||||
- Saturated parallel write iops: roughly `total iops / (N+K) / WA`. More exactly:
|
- Saturated parallel write iops: roughly `total iops / (N+K) / WA`. More exactly,
|
||||||
- With the new store: `min(total network bandwidth * N/(N+K), sum(disk randrw iops / (2 + N-1 + K*2)))`,
|
`min(total network bandwidth * N/(N+K), sum(disk randrw iops / (N*4 + K*5 + 1)))` with
|
||||||
with random read/write mix corresponding to `(N-1)/(2 + N-1 + K*2)*100 % reads`.
|
random read/write mix corresponding to `(N-1)/(N*4 + K*5 + 1)*100 % reads`.
|
||||||
- For example, with EC 2+1 it is: `(20% randrw iops) / 5`.
|
- For example, with EC 2+1 it is: `(7% randrw iops) / 14`.
|
||||||
- With EC 6+3 it is: `(38% randrw iops) / 13`.
|
- With EC 6+3 it is: `(12.5% randrw iops) / 40`.
|
||||||
- With the old store: `min(total network bandwidth * N/(N+K), sum(disk randrw iops / (3 + N-1 + K*3)))`,
|
|
||||||
with random read/write mix corresponding to `(N-1)/(3 + N-1 + K*3)*100 % reads`.
|
|
||||||
- For example, with EC 2+1 it is: `(14% randrw iops) / 7`.
|
|
||||||
- With EC 6+3 it is: `(30% randrw iops) / 17`.
|
|
||||||
|
|
||||||
Write Amplification factor:
|
Write amplification for 4 KB blocks is usually 3-5 in Vitastor:
|
||||||
- For the new store and for 4 KB writes: WA is always 1 unless you set [atomic_write_size](../config/osd.en.md#atomic_write_size) to 0 manually.
|
1. Journal block write
|
||||||
- For the new store and for 8-124 KB writes: WA is 1 if you use NVMe drives with atomic write support, or roughly 2 if you use other drives.
|
2. Journal data write
|
||||||
- For the old store, WA is roughly `(2 * write size + 4 KB) / (write size)`. So, for 4 KB writes it's 3, and for 8-124 KB writes it's closer to 2.
|
3. Metadata block write
|
||||||
- For both the new and the old store and for writes of [block_size](../config/layout-cluster.en.md#block_size): WA is almost 1.
|
4. Another journal block write for EC/XOR setups
|
||||||
|
5. Data block write
|
||||||
|
|
||||||
Write Amplification consists of:
|
If you manage to get an SSD which handles 512 byte blocks well (Optane?) you may
|
||||||
- For the new store:
|
lower 1, 3 and 4 to 512 bytes (1/8 of data size) and get WA as low as 2.375.
|
||||||
- Buffer block write if non-atomic
|
|
||||||
- Data block write
|
|
||||||
- Metadata write(s) (amortized)
|
|
||||||
- For the old store:
|
|
||||||
- Journal block write (amortized)
|
|
||||||
- Journal data write
|
|
||||||
- Metadata block write
|
|
||||||
- Another journal block write for EC/XOR setups (amortized)
|
|
||||||
- Data block write
|
|
||||||
|
|
||||||
Other possibilities to reduce WA would be to use SSDs with internal 512-byte blocks
|
Implemented NVDIMM support can basically eliminate WA at all - all extra writes will
|
||||||
or NVDIMM, but both options seem unavailable on the market at the moment.
|
go to DRAM memory. But this requires a test cluster with NVDIMM - please contact me
|
||||||
|
if you want to provide me with such cluster for tests.
|
||||||
|
|
||||||
|
Lazy fsync also reduces WA for parallel workloads because journal blocks are only
|
||||||
|
written when they fill up or fsync is requested.
|
||||||
|
|
||||||
## In Practice
|
## In Practice
|
||||||
|
|
||||||
|
|||||||
@@ -27,36 +27,29 @@
|
|||||||
- Линейное чтение: сумма МБ/с чтения всех дисков, либо общая производительность сети, если в сеть упрётся раньше.
|
- Линейное чтение: сумма МБ/с чтения всех дисков, либо общая производительность сети, если в сеть упрётся раньше.
|
||||||
- Линейная запись: сумма МБ/с записи всех дисков * N/(N+K), либо производительность сети * N / (N+K), если в сеть упрётся раньше.
|
- Линейная запись: сумма МБ/с записи всех дисков * N/(N+K), либо производительность сети * N / (N+K), если в сеть упрётся раньше.
|
||||||
- Параллельное случайное мелкое чтение: сумма IOPS чтения всех дисков либо производительность сети, если в сеть упрётся раньше.
|
- Параллельное случайное мелкое чтение: сумма IOPS чтения всех дисков либо производительность сети, если в сеть упрётся раньше.
|
||||||
- Параллельная случайная мелкая запись: грубо `(сумма IOPS / (N+K) / WA)`.
|
- Параллельная случайная мелкая запись: грубо `(сумма IOPS / (N+K) / WA)`. Если точнее, то:
|
||||||
Либо `производительность сети * N/(N+K)`, если в сеть упрётся раньше. Если точнее, то:
|
сумма смешанного IOPS всех дисков при `(N-1)/(N*4 + K*5 + 1)*100 %` чтения, делённая на `(N*4 + K*5 + 1)`.
|
||||||
- С новым хранилищем: сумма смешанного IOPS всех дисков при `(N-1)/(2 + N-1 + K*2)*100 %` чтения, делённая на `(2 + N-1 + K*2)`.
|
Либо, производительность сети * N/(N+K), если в сеть упрётся раньше.
|
||||||
- Например, при EC 2+1 это: `(сумма IOPS при 20% чтения) / 5`.
|
- Например, при EC 2+1 это: `(сумма IOPS при 7% чтения) / 14`.
|
||||||
- При EC 6+3 это: `(сумма IOPS при 38% чтения) / 13`.
|
- При EC 6+3 это: `(сумма IOPS при 12.5% чтения) / 40`.
|
||||||
- Со старым хранилищем: сумма смешанного IOPS всех дисков при `(N-1)/(3 + N-1 + K*3)*100 %` чтения, делённая на `(3 + N-1 + K*3)`.
|
|
||||||
- Например, при EC 2+1 это: `(сумма IOPS при 14% чтения) / 7`.
|
|
||||||
- При EC 6+3 это: `(сумма IOPS при 30% чтения) / 17`.
|
|
||||||
|
|
||||||
WA (Write Amplification, мультипликатор записи):
|
WA (мультипликатор записи) для 4 КБ блоков в Vitastor обычно составляет 3-5:
|
||||||
- С новым хранилищем для 4 КБ записи: WA всегда примерно 1, если только вы не установите [atomic_write_size](../config/osd.ru.md#atomic_write_size) вручную в 0.
|
1. Запись метаданных в журнал
|
||||||
- С новым хранилищем и большими записями (8-124 КБ): WA примерно 1, если вы используете NVMe-диски с поддержкой атомарной записи,
|
2. Запись блока данных в журнал
|
||||||
или примерно 2, если вы используете другие диски.
|
3. Запись метаданных в БД
|
||||||
- Со старым хранилищем, WA примерно `(2 * размер записи + 4 КБ) / (размер записи)`. То есть, для 4 КБ записи WA=3, а для 8-124 КБ WA ближе к 2.
|
4. Ещё одна запись метаданных в журнал при использовании EC
|
||||||
- И с новым, и со старым хранилищем и для записи размером [block_size](../config/layout-cluster.ru.md#block_size): WA примерно равен 1.
|
5. Запись блока данных на диск данных
|
||||||
|
|
||||||
Мультипликатор записи состоит из:
|
Если вы найдёте SSD, хорошо работающий с 512-байтными блоками данных (Optane?),
|
||||||
- С новым хранилищем:
|
то 1, 3 и 4 можно снизить до 512 байт (1/8 от размера данных) и получить WA всего 2.375.
|
||||||
- Запись блока буфера, если диски без поддержки атомарной записи
|
|
||||||
- Запись блока данных
|
|
||||||
- Запись(-и) блоков метаданных (амортизированные)
|
|
||||||
- Со старым хранилищем:
|
|
||||||
- Запись блока журнала (амортизированная)
|
|
||||||
- Запись данных в журнал
|
|
||||||
- Запись блока метаданных
|
|
||||||
- Ещё одна запись блока журнала для EC/XOR пулов (амортизированная)
|
|
||||||
- Запись блока данных
|
|
||||||
|
|
||||||
Другими потенциальными возможностями снижения WA могли бы быть SSD с внутренним 512-байтным блоком
|
Если реализовать поддержку NVDIMM, то WA можно, условно говоря, ликвидировать вообще - все
|
||||||
либо NVDIMM, но и то, и другое сейчас выглядит недоступным на рынке.
|
дополнительные операции записи смогут обслуживаться DRAM памятью. Но для этого необходим
|
||||||
|
тестовый кластер с NVDIMM - пишите, если готовы предоставить такой для тестов.
|
||||||
|
|
||||||
|
Кроме того, WA снижается при использовании отложенного/ленивого сброса при параллельной
|
||||||
|
нагрузке, т.к. блоки журнала записываются на диск только когда они заполняются или явным
|
||||||
|
образом запрашивается fsync.
|
||||||
|
|
||||||
## На практике
|
## На практике
|
||||||
|
|
||||||
|
|||||||
+4
-37
@@ -14,7 +14,6 @@
|
|||||||
- [Removing a failed disk](#removing-a-failed-disk)
|
- [Removing a failed disk](#removing-a-failed-disk)
|
||||||
- [Adding a disk](#adding-a-disk)
|
- [Adding a disk](#adding-a-disk)
|
||||||
- [Restoring from lost pool configuration](#restoring-from-lost-pool-configuration)
|
- [Restoring from lost pool configuration](#restoring-from-lost-pool-configuration)
|
||||||
- [Incompatibility problems](#Incompatibility-problems)
|
|
||||||
- [Upgrading Vitastor](#upgrading-vitastor)
|
- [Upgrading Vitastor](#upgrading-vitastor)
|
||||||
- [OSD memory usage](#osd-memory-usage)
|
- [OSD memory usage](#osd-memory-usage)
|
||||||
|
|
||||||
@@ -36,19 +35,10 @@ PG state consists of exactly 1 base state and an arbitrary number of additional
|
|||||||
|
|
||||||
PG state always includes exactly 1 of the following base states:
|
PG state always includes exactly 1 of the following base states:
|
||||||
- **active** — PG is active and handles user I/O.
|
- **active** — PG is active and handles user I/O.
|
||||||
- **incomplete** — Not enough OSDs are available to activate this PG. More exactly, that
|
- **incomplete** — Not enough OSDs are available to activate this PG. That is, more disks
|
||||||
means one of the following:
|
are lost than it's allowed by the pool's redundancy scheme. For example, if the pool has
|
||||||
- Less than pg_minsize current target OSDs are available for the PG. I.e. more disks
|
pg_size=3 and pg_minsize=1, part of the data may be written only to 1 OSD. If that exact
|
||||||
are lost than allowed by the pool's redundancy scheme.
|
OSD is lost, PG will become **incomplete**.
|
||||||
- All OSDs of some of PG's history records are unavailable, or, for EC pools, less
|
|
||||||
than (pg_size-parity_chunks) OSDs are available in one of the history records.
|
|
||||||
In other words it means that some data in this PG was written to an OSD set such that
|
|
||||||
it's currently impossible to read it back because these OSDs are down. For example,
|
|
||||||
if the pool has pg_size=3 and pg_minsize=1, part of the data may be written only to
|
|
||||||
1 OSD. If that exact OSD is lost, PG becomes **incomplete**.
|
|
||||||
- [allow_net_split](../config/osd.en.md#allow_net_split) is disabled (default) and
|
|
||||||
primary OSD of the PG can't connect to some secondary OSDs marked as alive in etcd.
|
|
||||||
I.e. a network partition happened: OSDs can talk to etcd, but not to some other OSDs.
|
|
||||||
- **offline** — PG isn't activated by any OSD at all. Either primary OSD isn't set for
|
- **offline** — PG isn't activated by any OSD at all. Either primary OSD isn't set for
|
||||||
this PG at all (if the pool is just created), or an unavailable OSD is set as primary,
|
this PG at all (if the pool is just created), or an unavailable OSD is set as primary,
|
||||||
or the primary OSD refuses to start this PG (for example, because of wrong block_size),
|
or the primary OSD refuses to start this PG (for example, because of wrong block_size),
|
||||||
@@ -167,17 +157,6 @@ done
|
|||||||
|
|
||||||
After that all PGs should peer and find all previous data.
|
After that all PGs should peer and find all previous data.
|
||||||
|
|
||||||
## Incompatibility problems
|
|
||||||
|
|
||||||
### ISA-L 2.31
|
|
||||||
|
|
||||||
⚠ It is FORBIDDEN to use Vitastor 2.1.0 and earlier versions with ISA-L 2.31 and newer if
|
|
||||||
you use EC N+K pools and K > 1 on a CPU with GF-NI instruction support, because it WILL
|
|
||||||
lead to **data loss** during EC recovery.
|
|
||||||
|
|
||||||
If you accidentally upgraded ISA-L to 2.31 but didn't upgrade Vitastor and restarted OSDs,
|
|
||||||
then stop them as soon as possible and either update Vitastor or roll back ISA-L.
|
|
||||||
|
|
||||||
## Upgrading Vitastor
|
## Upgrading Vitastor
|
||||||
|
|
||||||
Every upcoming Vitastor version is usually compatible with previous both forward
|
Every upcoming Vitastor version is usually compatible with previous both forward
|
||||||
@@ -231,18 +210,6 @@ Upgrading from <= 0.5.x to >= 0.6.x is not supported.
|
|||||||
|
|
||||||
Downgrade are also allowed freely, except the following specific instructions:
|
Downgrade are also allowed freely, except the following specific instructions:
|
||||||
|
|
||||||
### 3.x -> 2.x
|
|
||||||
|
|
||||||
Versions 3.0.0 and newer contain two store implementations - an old one and a new
|
|
||||||
one, unsupported in 2.x and previous versions. So you should check your OSD store
|
|
||||||
versions before downgrading to 2.x with the following command:
|
|
||||||
|
|
||||||
`vitastor-disk read-sb /dev/vitastor/osdXX-data | jq -r .meta_format`
|
|
||||||
|
|
||||||
If it prints 3 then OSD uses the new store and you can't downgrade it to 2.x.
|
|
||||||
|
|
||||||
If it prints 2 or nothing then OSD uses the old store and the downgrade is allowed.
|
|
||||||
|
|
||||||
### 1.8.0 to 1.7.1
|
### 1.8.0 to 1.7.1
|
||||||
|
|
||||||
Before downgrading from version >= 1.8.0 to version <= 1.7.1
|
Before downgrading from version >= 1.8.0 to version <= 1.7.1
|
||||||
|
|||||||
+3
-37
@@ -14,7 +14,6 @@
|
|||||||
- [Удаление неисправного диска](#удаление-неисправного-диска)
|
- [Удаление неисправного диска](#удаление-неисправного-диска)
|
||||||
- [Добавление диска](#добавление-диска)
|
- [Добавление диска](#добавление-диска)
|
||||||
- [Восстановление потерянной конфигурации пулов](#восстановление-потерянной-конфигурации-пулов)
|
- [Восстановление потерянной конфигурации пулов](#восстановление-потерянной-конфигурации-пулов)
|
||||||
- [Проблемы несовместимости](#проблемы-несовместимости)
|
|
||||||
- [Обновление Vitastor](#обновление-vitastor)
|
- [Обновление Vitastor](#обновление-vitastor)
|
||||||
- [Потребление памяти OSD](#потребление-памяти-osd)
|
- [Потребление памяти OSD](#потребление-памяти-osd)
|
||||||
|
|
||||||
@@ -36,20 +35,10 @@
|
|||||||
|
|
||||||
Состояние PG включает в себя ровно 1 флаг из следующих:
|
Состояние PG включает в себя ровно 1 флаг из следующих:
|
||||||
- **active** — PG активна и обрабатывает запросы ввода-вывода от пользователей.
|
- **active** — PG активна и обрабатывает запросы ввода-вывода от пользователей.
|
||||||
- **incomplete** — Недостаточно живых OSD, чтобы включить эту PG. Если точнее, то это
|
- **incomplete** — Недостаточно живых OSD, чтобы включить эту PG.
|
||||||
означает один из следующих вариантов:
|
То есть, дисков потеряно больше, чем разрешено схемой отказоустойчивости пула и pg_minsize.
|
||||||
- Доступно менее, чем pg_minsize текущих целевых OSD данной PG. Иными словами, потеряно
|
Например, если у пула pg_size=3 и pg_minsize=1, то часть данных может записаться всего на 1 OSD.
|
||||||
больше дисков, чем это разрешает схема отказоустойчивости пула.
|
|
||||||
- Все OSD одной из исторических записей PG недоступны, или, для EC-пулов, в одной
|
|
||||||
из исторических записей PG доступно менее, чем (pg_size-parity_chunks) OSD. Другими
|
|
||||||
словами это означает, что часть данных этой PG была записана в такой набор OSD, из
|
|
||||||
которого их сейчас невозможно прочитать обратно, так как OSD не включены. Например,
|
|
||||||
если у пула pg_size=3 и pg_minsize=1, то часть данных может записаться всего на 1 OSD.
|
|
||||||
Если потом конкретно этот OSD упадёт, PG окажется **incomplete**.
|
Если потом конкретно этот OSD упадёт, PG окажется **incomplete**.
|
||||||
- [allow_net_split](../config/osd.ru.md#allow_net_split) отключено (по умолчанию) и
|
|
||||||
первичный OSD данной PG не может соединиться с частью вторичных OSD этой PG, помеченных
|
|
||||||
как живых в etcd. Это означает, что произошло разделение сети: OSD могут общаться с etcd,
|
|
||||||
но не могут общаться с частью других OSD.
|
|
||||||
- **offline** — PG вообще не активирована ни одним OSD. Либо первичный OSD не назначен вообще
|
- **offline** — PG вообще не активирована ни одним OSD. Либо первичный OSD не назначен вообще
|
||||||
(если пул только создан), либо в качестве первичного назначен недоступный OSD, либо
|
(если пул только создан), либо в качестве первичного назначен недоступный OSD, либо
|
||||||
назначенный OSD отказывается запускать эту PG (например, из-за несовпадения block_size),
|
назначенный OSD отказывается запускать эту PG (например, из-за несовпадения block_size),
|
||||||
@@ -164,17 +153,6 @@ done
|
|||||||
|
|
||||||
После этого все PG должны пройти peering и найти все предыдущие данные.
|
После этого все PG должны пройти peering и найти все предыдущие данные.
|
||||||
|
|
||||||
## Проблемы несовместимости
|
|
||||||
|
|
||||||
### ISA-L 2.31
|
|
||||||
|
|
||||||
⚠ ЗАПРЕЩЕНО использовать Vitastor 2.1.0 и более ранних версий с библиотекой ISA-L версии 2.31
|
|
||||||
или более новой, если вы используете EC-пулы N+K и K > 1 на CPU с поддержкой инструкций GF-NI,
|
|
||||||
так как это приведёт к **потере данных** при восстановлении из EC.
|
|
||||||
|
|
||||||
Если вы случайно обновили ISA-L до 2.31, но не обновили Vitastor, и успели перезапустить OSD,
|
|
||||||
то как можно скорее остановите их все и либо обновите Vitastor, либо откатите ISA-L.
|
|
||||||
|
|
||||||
## Обновление Vitastor
|
## Обновление Vitastor
|
||||||
|
|
||||||
Обычно каждая следующая версия Vitastor совместима с предыдущими и "вперёд", и "назад"
|
Обычно каждая следующая версия Vitastor совместима с предыдущими и "вперёд", и "назад"
|
||||||
@@ -228,18 +206,6 @@ done
|
|||||||
|
|
||||||
Откат (понижение версии) тоже свободно разрешён, кроме указанных ниже случаев:
|
Откат (понижение версии) тоже свободно разрешён, кроме указанных ниже случаев:
|
||||||
|
|
||||||
### 3.x -> 2.x
|
|
||||||
|
|
||||||
Версии 3.0.0 и более новые содержат две реализации хранилища - старую и новую, не
|
|
||||||
поддерживаемую в 2.x и предыдущих версиях. Таким образом, перед откатом на 2.x вам
|
|
||||||
следует проверить, какая версия хранилища используется вашими OSD - командой:
|
|
||||||
|
|
||||||
`vitastor-disk read-sb /dev/vitastor/osdXX-data | jq -r .meta_format`
|
|
||||||
|
|
||||||
Если выводится 3, это новое хранилище и откатить такой OSD до 2.x нельзя.
|
|
||||||
|
|
||||||
Если выводится 2 или не выводится ничего, это старое хранилище и откат разрешён.
|
|
||||||
|
|
||||||
### 1.8.0 -> 1.7.1
|
### 1.8.0 -> 1.7.1
|
||||||
|
|
||||||
Перед понижением версии с >= 1.8.0 до <= 1.7.1 вы должны скопировать ключ
|
Перед понижением версии с >= 1.8.0 до <= 1.7.1 вы должны скопировать ключ
|
||||||
|
|||||||
+11
-30
@@ -100,14 +100,12 @@ List images (only matching `<glob>` pattern(s) if passed).
|
|||||||
Options:
|
Options:
|
||||||
|
|
||||||
```
|
```
|
||||||
--exact Do not match glob patterns as names, select only exact name matches.
|
|
||||||
-p|--pool POOL Filter images by pool ID or name
|
-p|--pool POOL Filter images by pool ID or name
|
||||||
-l|--long Also report allocated size and I/O statistics
|
-l|--long Also report allocated size and I/O statistics
|
||||||
--del Also include delete operation statistics
|
--del Also include delete operation statistics
|
||||||
--sort FIELD Sort by specified field (name, size, used_size, <read|write|delete>_<iops|bps|lat|queue>)
|
--sort FIELD Sort by specified field (name, size, used_size, <read|write|delete>_<iops|bps|lat|queue>)
|
||||||
-r|--reverse Sort in descending order
|
-r|--reverse Sort in descending order
|
||||||
-n|--count N Only list first N items
|
-n|--count N Only list first N items
|
||||||
--tree Show image snapshot/clone tree
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Example output:
|
Example output:
|
||||||
@@ -125,31 +123,18 @@ bench-kaveri kaveri 10 G 10 G 0 B/s 0 0 0 us 0 B/s 0
|
|||||||
|
|
||||||
## create
|
## create
|
||||||
|
|
||||||
`vitastor-cli create -s|--size SIZE [OPTIONS] <name>`
|
`vitastor-cli create -s|--size <size> [-p|--pool <id|name>] [--parent <parent_name>[@<snapshot>]] <name>`
|
||||||
|
|
||||||
Create an image. Options:
|
Create an image. You may use K/M/G/T suffixes for `<size>`. If `--parent` is specified,
|
||||||
|
a copy-on-write image clone is created. Parent must be a snapshot (readonly image).
|
||||||
* `-s|--size SIZE` - New image size in bytes or with a K/M/G/T unit suffix.
|
Pool must be specified if there is more than one pool.
|
||||||
* `-p|--pool POOL` - Specify pool for the new image (may be omitted if there is only 1 pool).
|
|
||||||
* `--parent PARENT` - Create a copy-on-write image clone based on PARENT (or PARENT@SNAPSHOT).
|
|
||||||
If parent is not a snapshot, it must be a read-only image.
|
|
||||||
* `--enc-key random` - Generate a new random AES-256-XTS encryption key for the new image.
|
|
||||||
* `--enc-key HEX` - Set a specified AES-256-XTS key (64 bytes in hex) for the new image.
|
|
||||||
* `--enc-key vault:ID` - Use an encryption key from an external Vault secret with specified ID.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
vitastor-cli create --snapshot <snapshot> [OPTIONS] <image>
|
vitastor-cli create --snapshot <snapshot> [-p|--pool <id|name>] <image>
|
||||||
vitastor-cli snap-create [OPTIONS] <image>@<snapshot>
|
vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
|
||||||
```
|
```
|
||||||
|
|
||||||
Create a snapshot of image `<image>`. May be used live if only a single writer is active.
|
Create a snapshot of image `<name>` (either form can be used). May be used live if only a single writer is active.
|
||||||
|
|
||||||
Options:
|
|
||||||
|
|
||||||
* `-p|--pool POOL` - Move image to pool POOL, leaving the snapshot in the old pool.
|
|
||||||
* `--enc-key random` - Change image encryption key to a new random AES-256-XTS key.
|
|
||||||
* `--enc-key KEY` - Change image encryption key to a specified key, Vault key or to an empty key.
|
|
||||||
By default, the image retains its old encryption key when taking a snapshot.
|
|
||||||
|
|
||||||
See also about [how to export snapshots](qemu.en.md#exporting-snapshots).
|
See also about [how to export snapshots](qemu.en.md#exporting-snapshots).
|
||||||
|
|
||||||
@@ -164,7 +149,6 @@ You should resize file system in the image, if present, before shrinking it.
|
|||||||
* `--deleted 1|0` - Set/clear 'deleted image' flag (set automatically during unfinished deletes).
|
* `--deleted 1|0` - Set/clear 'deleted image' flag (set automatically during unfinished deletes).
|
||||||
* `-f|--force` - Proceed with shrinking or setting readwrite flag even if the image has children.
|
* `-f|--force` - Proceed with shrinking or setting readwrite flag even if the image has children.
|
||||||
* `--down-ok` - Proceed with shrinking even if some data will be left on unavailable OSDs.
|
* `--down-ok` - Proceed with shrinking even if some data will be left on unavailable OSDs.
|
||||||
* `--enc-key HEX` - Change image encryption key (allowed only with `--force`).
|
|
||||||
|
|
||||||
## dd
|
## dd
|
||||||
|
|
||||||
@@ -371,7 +355,7 @@ Set OSD reweight, tags or noout flag. See detail description in [OSD config docu
|
|||||||
|
|
||||||
## pg-list
|
## pg-list
|
||||||
|
|
||||||
`vitastor-cli pg-list|pg-ls|list-pg|ls-pg|ls-pgs|pgs [OPTIONS] [state1+state2] [^state3] [...]`
|
`vitastor-cli pg-list|pg-ls|list-pg|ls-pg|ls-pgs [OPTIONS] [state1+state2] [^state3] [...]`
|
||||||
|
|
||||||
List PGs with any of listed state filters (^ or ! in the beginning is negation). Options:
|
List PGs with any of listed state filters (^ or ! in the beginning is negation). Options:
|
||||||
|
|
||||||
@@ -379,7 +363,6 @@ List PGs with any of listed state filters (^ or ! in the beginning is negation).
|
|||||||
--pool <pool name or number> Only list PGs of the given pool.
|
--pool <pool name or number> Only list PGs of the given pool.
|
||||||
--min <min pg number> Only list PGs with number >= min.
|
--min <min pg number> Only list PGs with number >= min.
|
||||||
--max <max pg number> Only list PGs with number <= max.
|
--max <max pg number> Only list PGs with number <= max.
|
||||||
--osd 1,2,... Only list PGs with some data on specified OSD(s).
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@@ -395,10 +378,10 @@ Examples:
|
|||||||
Create a pool. Required parameters:
|
Create a pool. Required parameters:
|
||||||
|
|
||||||
| <!-- --> | <!-- --> |
|
| <!-- --> | <!-- --> |
|
||||||
|--------------------------|-----------------------------------------------------------------------------------------|
|
|--------------------------|---------------------------------------------------------------------------------------|
|
||||||
| `-s R` or `--pg_size R` | Number of replicas for replicated pools |
|
| `-s R` or `--pg_size R` | Number of replicas for replicated pools |
|
||||||
| `--ec N+K` | Number of data (N) and parity (K) chunks for erasure-coded pools |
|
| `--ec N+K` | Number of data (N) and parity (K) chunks for erasure-coded pools |
|
||||||
| `-n N` or `--pg_count N` | PG count for the new pool (start with 10*\<OSD count\>/pg_size rounded to a power of 2) |
|
| `-n N` or `--pg_count N` | PG count for the new pool (start with 10*<OSD count>/pg_size rounded to a power of 2) |
|
||||||
|
|
||||||
Optional parameters:
|
Optional parameters:
|
||||||
|
|
||||||
@@ -413,11 +396,9 @@ Optional parameters:
|
|||||||
| `--immediate_commit none` | Put pool only on OSDs with this or larger immediate_commit (none < small < all) |
|
| `--immediate_commit none` | Put pool only on OSDs with this or larger immediate_commit (none < small < all) |
|
||||||
| `--level_placement <rules>` | Use additional failure domain rules (example: "dc=112233") |
|
| `--level_placement <rules>` | Use additional failure domain rules (example: "dc=112233") |
|
||||||
| `--raw_placement <rules>` | Specify raw PG generation rules ([details](../config/pool.en.md#raw_placement)) |
|
| `--raw_placement <rules>` | Specify raw PG generation rules ([details](../config/pool.en.md#raw_placement)) |
|
||||||
| `--local_reads primary` | Local read policy for replicated pools: primary, nearest or random |
|
|
||||||
| `--primary_affinity_tags tags` | Prefer to put primary copies on OSDs with all specified tags |
|
| `--primary_affinity_tags tags` | Prefer to put primary copies on OSDs with all specified tags |
|
||||||
| `--scrub_interval <time>` | Enable regular scrubbing for this pool. Format: number + unit s/m/h/d/M/y |
|
| `--scrub_interval <time>` | Enable regular scrubbing for this pool. Format: number + unit s/m/h/d/M/y |
|
||||||
| `--used_for_app fs:<name>` | Mark pool as used for VitastorFS with metadata in image `<name>` |
|
| `--used_for_fs <name>` | Mark pool as used for VitastorFS with metadata in image <name> |
|
||||||
| `--used_for_app s3:<name>` | Mark pool as used for S3 location with name `<name>` |
|
|
||||||
| `--pg_stripe_size <number>` | Increase object grouping stripe |
|
| `--pg_stripe_size <number>` | Increase object grouping stripe |
|
||||||
| `--max_osd_combinations 10000` | Maximum number of random combinations for LP solver input |
|
| `--max_osd_combinations 10000` | Maximum number of random combinations for LP solver input |
|
||||||
| `--wait` | Wait for the new pool to come online |
|
| `--wait` | Wait for the new pool to come online |
|
||||||
|
|||||||
+13
-33
@@ -22,8 +22,6 @@ vitastor-cli - интерфейс командной строки для адм
|
|||||||
- [flatten](#flatten)
|
- [flatten](#flatten)
|
||||||
- [rm-data](#rm-data)
|
- [rm-data](#rm-data)
|
||||||
- [merge-data](#merge-data)
|
- [merge-data](#merge-data)
|
||||||
- [describe](#describe)
|
|
||||||
- [fix](#fix)
|
|
||||||
- [alloc-osd](#alloc-osd)
|
- [alloc-osd](#alloc-osd)
|
||||||
- [rm-osd](#rm-osd)
|
- [rm-osd](#rm-osd)
|
||||||
- [osd-tree](#osd-tree)
|
- [osd-tree](#osd-tree)
|
||||||
@@ -102,14 +100,12 @@ kaveri 2/1 32 0 B 10 G 0 B 100% 0%
|
|||||||
Опции:
|
Опции:
|
||||||
|
|
||||||
```
|
```
|
||||||
--exact Не применять ФС-шаблоны к именам, выводить только точные совпадения
|
|
||||||
-p|--pool POOL Фильтровать образы по пулу (ID или имени)
|
-p|--pool POOL Фильтровать образы по пулу (ID или имени)
|
||||||
-l|--long Также выводить статистику занятого места и ввода-вывода
|
-l|--long Также выводить статистику занятого места и ввода-вывода
|
||||||
--del Также выводить статистику операций удаления
|
--del Также выводить статистику операций удаления
|
||||||
--sort FIELD Сортировать по заданному полю (name, size, used_size, <read|write|delete>_<iops|bps|lat|queue>)
|
--sort FIELD Сортировать по заданному полю (name, size, used_size, <read|write|delete>_<iops|bps|lat|queue>)
|
||||||
-r|--reverse Сортировать в обратном порядке
|
-r|--reverse Сортировать в обратном порядке
|
||||||
-n|--count N Показывать только первые N записей
|
-n|--count N Показывать только первые N записей
|
||||||
--tree Вывести снапшоты и клоны в виде дерева
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Пример вывода:
|
Пример вывода:
|
||||||
@@ -127,32 +123,19 @@ bench-kaveri kaveri 10 G 10 G 0 B/s 0 0 0 us 0 B/s 0
|
|||||||
|
|
||||||
## create
|
## create
|
||||||
|
|
||||||
`vitastor-cli create -s|--size SIZE [ОПЦИИ] <name>`
|
`vitastor-cli create -s|--size <size> [-p|--pool <id|name>] [--parent <parent_name>[@<snapshot>]] <name>`
|
||||||
|
|
||||||
Создать образ. Опции:
|
Создать образ. Для размера `<size>` можно использовать суффиксы K/M/G/T (килобайт-мегабайт-гигабайт-терабайт).
|
||||||
|
Если указана опция `--parent`, создаётся клон образа. Родитель `<parent_name>[@<snapshot>]` должен быть
|
||||||
* `-s|--size SIZE` - Размер нового образа в байтах или с суффиксом K/M/G/T (кило/мега/гига/терабайт).
|
снимком (или просто немодифицируемым образом). Пул обязательно указывать, если в кластере больше одного пула.
|
||||||
* `-p|--pool POOL` - Создать образ в заданном пуле (можно не указывать, если пул всего один).
|
|
||||||
* `--parent PARENT` - Создать легковесный клон на основе образа `PARENT` или снимка `PARENT@SNAP`.
|
|
||||||
Если `PARENT` - не снимок, он должен быть помечен как образ только для чтения.
|
|
||||||
* `--enc-key random` - Сгенерировать случайный ключ шифрования AES-256-XTS для нового образа.
|
|
||||||
* `--enc-key HEX` - Установить заданный ключ AES-256-XTS (64 байта в hex) для нового образа.
|
|
||||||
* `--enc-key vault:ID` - Использовать ключ из внешнего секрета с заданным ID из Vault.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
vitastor-cli create --snapshot <snapshot> [ОПЦИИ] <image>
|
vitastor-cli create --snapshot <snapshot> [-p|--pool <id|name>] <image>
|
||||||
vitastor-cli snap-create [ОПЦИИ] <image>@<snapshot>
|
vitastor-cli snap-create [-p|--pool <id|name>] <image>@<snapshot>
|
||||||
```
|
```
|
||||||
|
|
||||||
Создать снимок образа `<image>` (можно использовать любую форму команды).
|
Создать снимок образа `<name>` (можно использовать любую форму команды). Снимок можно создавать без остановки
|
||||||
Снимок можно создавать без остановки клиентов, если пишущих клиентов не больше одного.
|
клиентов, если пишущий клиент максимум 1.
|
||||||
|
|
||||||
Опции:
|
|
||||||
|
|
||||||
* `-p|--pool POOL` - Переместить образ в пул POOL, оставив снимок в старом пуле.
|
|
||||||
* `--enc-key random` - Изменить ключ шифрования образа на новый случайный ключ AES-256-XTS.
|
|
||||||
* `--enc-key KEY` - Изменить ключ шифрования образа на заданный ключ, ключ из Vault или пустой ключ.
|
|
||||||
По умолчанию шифрованные образы сохраняют старый ключ при снятии снимка.
|
|
||||||
|
|
||||||
Смотрите также информацию о том, [как экспортировать снимки](qemu.ru.md#экспорт-снимков).
|
Смотрите также информацию о том, [как экспортировать снимки](qemu.ru.md#экспорт-снимков).
|
||||||
|
|
||||||
@@ -169,7 +152,6 @@ vitastor-cli snap-create [ОПЦИИ] <image>@<snapshot>
|
|||||||
* `--deleted 1|0` - Установить/снять флаг "образ удалён" (устанавливается при незавершённом удалении).
|
* `--deleted 1|0` - Установить/снять флаг "образ удалён" (устанавливается при незавершённом удалении).
|
||||||
* `-f|--force` - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны.
|
* `-f|--force` - Разрешить уменьшение или перевод в чтение-запись образа, у которого есть клоны.
|
||||||
* `--down-ok` - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD.
|
* `--down-ok` - Разрешить уменьшение, даже если часть данных останется неудалённой на недоступных OSD.
|
||||||
* `--enc-key HEX` - Изменить ключ шифрования образа (разрешено только с `--force`).
|
|
||||||
|
|
||||||
## dd
|
## dd
|
||||||
|
|
||||||
@@ -393,10 +375,9 @@ OSD PARENT UP SIZE USED% TAGS WEIGHT BLOCK BITMAP
|
|||||||
в начале фильтра означает отрицание). Опции:
|
в начале фильтра означает отрицание). Опции:
|
||||||
|
|
||||||
```
|
```
|
||||||
--pool <pool name or number> Вывести только PG в заданном пуле.
|
--pool <pool name or number> Only list PGs of the given pool.
|
||||||
--min <min pg number> Вывести только PG с номерами >= min.
|
--min <min pg number> Only list PGs with number >= min.
|
||||||
--max <max pg number> Вывести только PG с номерами <= max.
|
--max <max pg number> Only list PGs with number <= max.
|
||||||
--osd 1,2,... Вывести только PG с данными на заданных OSD.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Примеры:
|
Примеры:
|
||||||
@@ -412,10 +393,10 @@ OSD PARENT UP SIZE USED% TAGS WEIGHT BLOCK BITMAP
|
|||||||
Создать пул. Обязательные параметры:
|
Создать пул. Обязательные параметры:
|
||||||
|
|
||||||
| <!-- --> | <!-- --> |
|
| <!-- --> | <!-- --> |
|
||||||
|---------------------------|-----------------------------------------------------------------------------------------------|
|
|---------------------------|---------------------------------------------------------------------------------------------|
|
||||||
| `-s R` или `--pg_size R` | Число копий данных для реплицированных пулов |
|
| `-s R` или `--pg_size R` | Число копий данных для реплицированных пулов |
|
||||||
| `--ec N+K` | Число частей данных (N) и чётности (K) для пулов с кодами коррекции ошибок |
|
| `--ec N+K` | Число частей данных (N) и чётности (K) для пулов с кодами коррекции ошибок |
|
||||||
| `-n N` или `--pg_count N` | Число PG для нового пула (начните с 10*\<число OSD\>/pg_size, округлённого до степени двойки) |
|
| `-n N` или `--pg_count N` | Число PG для нового пула (начните с 10*<число OSD>/pg_size, округлённого до степени двойки) |
|
||||||
|
|
||||||
Необязательные параметры:
|
Необязательные параметры:
|
||||||
|
|
||||||
@@ -430,7 +411,6 @@ OSD PARENT UP SIZE USED% TAGS WEIGHT BLOCK BITMAP
|
|||||||
| `--immediate_commit none` | ...только OSD с этим или большим immediate_commit (none < small < all) |
|
| `--immediate_commit none` | ...только OSD с этим или большим immediate_commit (none < small < all) |
|
||||||
| `--level_placement <rules>` | Задать правила дополнительных доменов отказа (пример: "dc=112233") |
|
| `--level_placement <rules>` | Задать правила дополнительных доменов отказа (пример: "dc=112233") |
|
||||||
| `--raw_placement <rules>` | Задать низкоуровневые правила генерации PG ([детали](../config/pool.ru.md#raw_placement)) |
|
| `--raw_placement <rules>` | Задать низкоуровневые правила генерации PG ([детали](../config/pool.ru.md#raw_placement)) |
|
||||||
| `--local_reads primary` | Политика локальных чтений для реплик: primary, nearest или random |
|
|
||||||
| `--primary_affinity_tags tags` | Предпочитать OSD со всеми данными тегами для роли первичных |
|
| `--primary_affinity_tags tags` | Предпочитать OSD со всеми данными тегами для роли первичных |
|
||||||
| `--scrub_interval <time>` | Включить скрабы с заданным интервалом времени (число + единица s/m/h/d/M/y) |
|
| `--scrub_interval <time>` | Включить скрабы с заданным интервалом времени (число + единица s/m/h/d/M/y) |
|
||||||
| `--pg_stripe_size <number>` | Увеличить блок группировки объектов по PG |
|
| `--pg_stripe_size <number>` | Увеличить блок группировки объектов по PG |
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ It supports the following commands:
|
|||||||
- [upgrade-simple](#upgrade-simple)
|
- [upgrade-simple](#upgrade-simple)
|
||||||
- [resize](#resize)
|
- [resize](#resize)
|
||||||
- [raw-resize](#raw-resize)
|
- [raw-resize](#raw-resize)
|
||||||
- [trim](#trim)
|
|
||||||
- [start/stop/restart/enable/disable](#start/stop/restart/enable/disable)
|
- [start/stop/restart/enable/disable](#start/stop/restart/enable/disable)
|
||||||
- [purge](#purge)
|
- [purge](#purge)
|
||||||
- [read-sb](#read-sb)
|
- [read-sb](#read-sb)
|
||||||
@@ -51,9 +50,6 @@ Options (automatic mode):
|
|||||||
```
|
```
|
||||||
--osd_per_disk <N>
|
--osd_per_disk <N>
|
||||||
Create <N> OSDs on each disk (default 1)
|
Create <N> OSDs on each disk (default 1)
|
||||||
--meta_format 3
|
|
||||||
Metadata store version. 3 is the new log-structured store, 2 is the stable store
|
|
||||||
from Vitastor 0.9-2.x, 1 is the legacy store from Vitastor 0.6-0.8.
|
|
||||||
--hybrid
|
--hybrid
|
||||||
Prepare hybrid (HDD+SSD, NVMe+SATA or etc) OSDs using provided devices. By default,
|
Prepare hybrid (HDD+SSD, NVMe+SATA or etc) OSDs using provided devices. By default,
|
||||||
any passed SSDs will be used for journals and metadata, HDDs will be used for data,
|
any passed SSDs will be used for journals and metadata, HDDs will be used for data,
|
||||||
@@ -76,8 +72,6 @@ Options (automatic mode):
|
|||||||
--max_other 10%
|
--max_other 10%
|
||||||
Use disks for OSD data even if they already have non-Vitastor partitions,
|
Use disks for OSD data even if they already have non-Vitastor partitions,
|
||||||
but only if these take up no more than this percent of disk space.
|
but only if these take up no more than this percent of disk space.
|
||||||
--dry-run
|
|
||||||
Check and print new OSD count for each disk but do not actually create them.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Options (single-device mode):
|
Options (single-device mode):
|
||||||
@@ -95,8 +89,6 @@ Options (single-device mode):
|
|||||||
Options (both modes):
|
Options (both modes):
|
||||||
|
|
||||||
```
|
```
|
||||||
--tags tag1,tag2 Set new OSD tag(s)
|
|
||||||
--weight <number> Set new OSD weight (between 0 to 1)
|
|
||||||
--journal_size 1G/32M Set journal size (area or partition size)
|
--journal_size 1G/32M Set journal size (area or partition size)
|
||||||
--block_size 1M/128k Set blockstore object size
|
--block_size 1M/128k Set blockstore object size
|
||||||
--bitmap_granularity 4k Set bitmap granularity
|
--bitmap_granularity 4k Set bitmap granularity
|
||||||
@@ -105,9 +97,6 @@ Options (both modes):
|
|||||||
--data_device_block 4k Override data device block size
|
--data_device_block 4k Override data device block size
|
||||||
--meta_device_block 4k Override metadata device block size
|
--meta_device_block 4k Override metadata device block size
|
||||||
--journal_device_block 4k Override journal device block size
|
--journal_device_block 4k Override journal device block size
|
||||||
--discard_on_start 0 TRIM unused data device blocks every OSD start (default off)
|
|
||||||
--min_discard_size 1M Minimum TRIM block size
|
|
||||||
--json Enable JSON output
|
|
||||||
```
|
```
|
||||||
|
|
||||||
[immediate_commit](../config/layout-cluster.en.md#immediate_commit) setting is
|
[immediate_commit](../config/layout-cluster.en.md#immediate_commit) setting is
|
||||||
@@ -190,19 +179,6 @@ parameters from OSD command line (i.e. from systemd unit or superblock).
|
|||||||
SIZE may include k/m/g/t suffixes. If any of the new layout parameter
|
SIZE may include k/m/g/t suffixes. If any of the new layout parameter
|
||||||
options are not specified, old values will be used.
|
options are not specified, old values will be used.
|
||||||
|
|
||||||
## trim
|
|
||||||
|
|
||||||
`vitastor-disk trim <osd_num>|<osd_device> [<osd_num>|<osd_device>...]`
|
|
||||||
|
|
||||||
Try to discard unused blocks (SSD TRIM) on the data device of each of the OSD(s).
|
|
||||||
|
|
||||||
May only be used on stopped OSDs. Options:
|
|
||||||
|
|
||||||
```
|
|
||||||
--min_discard_size 1M Minimum TRIM block size
|
|
||||||
--discard_granularity 0 Override device's discard granularity
|
|
||||||
```
|
|
||||||
|
|
||||||
## start/stop/restart/enable/disable
|
## start/stop/restart/enable/disable
|
||||||
|
|
||||||
`vitastor-disk start|stop|restart|enable|disable [--now] <device> [device2 device3 ...]`
|
`vitastor-disk start|stop|restart|enable|disable [--now] <device> [device2 device3 ...]`
|
||||||
|
|||||||
@@ -50,9 +50,6 @@ vitastor-disk - инструмент командной строки для уп
|
|||||||
```
|
```
|
||||||
--osd_per_disk <N>
|
--osd_per_disk <N>
|
||||||
Создавать по несколько (<N>) OSD на каждом диске (по умолчанию 1)
|
Создавать по несколько (<N>) OSD на каждом диске (по умолчанию 1)
|
||||||
--meta_format 3
|
|
||||||
Версия хранилища метаданных. 3 - новое лог-структурированное хранилище,
|
|
||||||
2 - стабильное хранилище из Vitastor 0.9-2.x, 1 - старое хранилище из Vitastor 0.6-0.8.
|
|
||||||
--hybrid
|
--hybrid
|
||||||
Инициализировать гибридные (HDD+SSD, NVMe+SATA и т.п.) OSD на указанных дисках.
|
Инициализировать гибридные (HDD+SSD, NVMe+SATA и т.п.) OSD на указанных дисках.
|
||||||
По умолчанию, SSD будут использованы для журналов и метаданных, а HDD - для данных,
|
По умолчанию, SSD будут использованы для журналов и метаданных, а HDD - для данных,
|
||||||
@@ -77,8 +74,6 @@ vitastor-disk - инструмент командной строки для уп
|
|||||||
--max_other 10%
|
--max_other 10%
|
||||||
Использовать диски под данные OSD, даже если на них уже есть не-Vitastor-овые
|
Использовать диски под данные OSD, даже если на них уже есть не-Vitastor-овые
|
||||||
разделы, но только в случае, если они занимают не более данного процента диска.
|
разделы, но только в случае, если они занимают не более данного процента диска.
|
||||||
--dry-run
|
|
||||||
Проверить и вывести число новых OSD для каждого диска, но не создавать их.
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Опции для режима одного OSD:
|
Опции для режима одного OSD:
|
||||||
@@ -96,8 +91,6 @@ vitastor-disk - инструмент командной строки для уп
|
|||||||
Опции для обоих режимов:
|
Опции для обоих режимов:
|
||||||
|
|
||||||
```
|
```
|
||||||
--tags tag1,tag2 Задать теги для новых OSD
|
|
||||||
--weight <number> Задать вес для новых OSD (от 0 до 1)
|
|
||||||
--journal_size 1G/32M Задать размер журнала (области или раздела журнала)
|
--journal_size 1G/32M Задать размер журнала (области или раздела журнала)
|
||||||
--block_size 1M/128k Задать размер объекта хранилища
|
--block_size 1M/128k Задать размер объекта хранилища
|
||||||
--bitmap_granularity 4k Задать гранулярность битовых карт
|
--bitmap_granularity 4k Задать гранулярность битовых карт
|
||||||
@@ -106,9 +99,6 @@ vitastor-disk - инструмент командной строки для уп
|
|||||||
--data_device_block 4k Задать размер блока устройства данных
|
--data_device_block 4k Задать размер блока устройства данных
|
||||||
--meta_device_block 4k Задать размер блока метаданных
|
--meta_device_block 4k Задать размер блока метаданных
|
||||||
--journal_device_block 4k Задать размер блока журнала
|
--journal_device_block 4k Задать размер блока журнала
|
||||||
--discard_on_start 0 Выполнять TRIM пустых блоков данных при запуске OSD (по умолчанию нет)
|
|
||||||
--min_discard_size 1M Минимальный размер блока для TRIM
|
|
||||||
--json Включить JSON-вывод
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Настройка [immediate_commit](../config/layout-cluster.ru.md#immediate_commit)
|
Настройка [immediate_commit](../config/layout-cluster.ru.md#immediate_commit)
|
||||||
@@ -192,20 +182,6 @@ throttle_target_mbs, throttle_target_parallelism, throttle_threshold_us.
|
|||||||
`РАЗМЕР` может быть указан с суффиксами k/m/g/t. Если любой из новых параметров
|
`РАЗМЕР` может быть указан с суффиксами k/m/g/t. Если любой из новых параметров
|
||||||
расположения не указан, он принимается равным старому значению.
|
расположения не указан, он принимается равным старому значению.
|
||||||
|
|
||||||
## trim
|
|
||||||
|
|
||||||
`vitastor-disk trim <osd_num>|<osd_device> [<osd_num>|<osd_device>...]`
|
|
||||||
|
|
||||||
Попробовать пометить пустые блоки дисков данных всех указанных OSD неиспользуемыми
|
|
||||||
(выполнить команду SSD TRIM).
|
|
||||||
|
|
||||||
Можно использовать только с остановленными OSD. Опции:
|
|
||||||
|
|
||||||
```
|
|
||||||
--min_discard_size 1M Минимальный размер блока для TRIM
|
|
||||||
--discard_granularity 0 Кратность размера блока для TRIM
|
|
||||||
```
|
|
||||||
|
|
||||||
## start/stop/restart/enable/disable
|
## start/stop/restart/enable/disable
|
||||||
|
|
||||||
`vitastor-disk start|stop|restart|enable|disable [--now] <device> [device2 device3 ...]`
|
`vitastor-disk start|stop|restart|enable|disable [--now] <device> [device2 device3 ...]`
|
||||||
|
|||||||
+1
-63
@@ -14,9 +14,6 @@ Commands:
|
|||||||
- [upgrade](#upgrade)
|
- [upgrade](#upgrade)
|
||||||
- [defrag](#defrag)
|
- [defrag](#defrag)
|
||||||
|
|
||||||
⚠️ Important: follow the instructions from [Linux NFS write size](#linux-nfs-write-size)
|
|
||||||
for optimal Vitastor NFS performance if you use EC and HDD and mount your NFS from Linux.
|
|
||||||
|
|
||||||
## Pseudo-FS
|
## Pseudo-FS
|
||||||
|
|
||||||
Simplified pseudo-FS proxy is used for file-based image access emulation. It's not
|
Simplified pseudo-FS proxy is used for file-based image access emulation. It's not
|
||||||
@@ -61,7 +58,7 @@ To use VitastorFS:
|
|||||||
2. Create an image for FS metadata, preferably in a faster (SSD or replica-HDD) pool,
|
2. Create an image for FS metadata, preferably in a faster (SSD or replica-HDD) pool,
|
||||||
but you can create it in the data pool too if you want (image size doesn't matter):
|
but you can create it in the data pool too if you want (image size doesn't matter):
|
||||||
`vitastor-cli create -s 10G -p fastpool testfs`
|
`vitastor-cli create -s 10G -p fastpool testfs`
|
||||||
3. Mark data pool as an FS pool: `vitastor-cli modify-pool --used-for-app fs:testfs data-pool`
|
3. Mark data pool as an FS pool: `vitastor-cli modify-pool --used-for-fs testfs data-pool`
|
||||||
4. Either mount the FS: `vitastor-nfs mount --fs testfs --pool data-pool /mnt/vita`
|
4. Either mount the FS: `vitastor-nfs mount --fs testfs --pool data-pool /mnt/vita`
|
||||||
5. Or start the NFS server: `vitastor-nfs start --fs testfs --pool data-pool`
|
5. Or start the NFS server: `vitastor-nfs start --fs testfs --pool data-pool`
|
||||||
|
|
||||||
@@ -89,8 +86,6 @@ POSIX features currently not implemented in VitastorFS:
|
|||||||
instead of actually allocated space
|
instead of actually allocated space
|
||||||
- Access times (`atime`) are not tracked (like `-o noatime`)
|
- Access times (`atime`) are not tracked (like `-o noatime`)
|
||||||
- Modification time (`mtime`) is updated lazily every second (like `-o lazytime`)
|
- Modification time (`mtime`) is updated lazily every second (like `-o lazytime`)
|
||||||
- Permission enforcement is disabled by default (and Linux NFS client doesn't
|
|
||||||
enforce them too). Use `--enforce 1` to enable it.
|
|
||||||
|
|
||||||
Other notable missing features which should be addressed in the future:
|
Other notable missing features which should be addressed in the future:
|
||||||
- Inode ID reuse. Currently inode IDs always grow, the limit is 2^48 inodes, so
|
- Inode ID reuse. Currently inode IDs always grow, the limit is 2^48 inodes, so
|
||||||
@@ -105,62 +100,6 @@ Other notable missing features which should be addressed in the future:
|
|||||||
in the DB. The FS is implemented is such way that this garbage doesn't affect its
|
in the DB. The FS is implemented is such way that this garbage doesn't affect its
|
||||||
function, but having a tool to clean it up still seems a right thing to do.
|
function, but having a tool to clean it up still seems a right thing to do.
|
||||||
|
|
||||||
## Linux NFS write size
|
|
||||||
|
|
||||||
Linux NFS client (nfs/nfsv3/nfsv4 kernel modules) has a hard-coded maximum I/O size,
|
|
||||||
currently set to 1 MB - see `rsize` and `wsize` in [man 5 nfs](https://linux.die.net/man/5/nfs).
|
|
||||||
|
|
||||||
This means that when you write to a file in an FS mounted over NFS, the maximum write
|
|
||||||
request size is 1 MB, even in the O_DIRECT mode and even if the original write request
|
|
||||||
is larger.
|
|
||||||
|
|
||||||
However, for optimal linear write performance in Vitastor EC (erasure-coded) pools,
|
|
||||||
the size of write requests should be a multiple of [block_size](../config/layout-cluster.en.md#block_size),
|
|
||||||
multiplied by the data chunk count of the pool ([pg_size](../config/pool.en.md#pg_size)-[parity_chunks](../config/pool.en.md#parity_chunks)).
|
|
||||||
When write requests are smaller or not a multiple of this number, Vitastor has to first
|
|
||||||
read paired data blocks from disks, calculate new parity blocks and only then write them
|
|
||||||
back. Obviously this is 2-3 times slower than a simple disk write.
|
|
||||||
|
|
||||||
Vitastor HDD setups use 1 MB block_size by default. So, for optimal performance, if
|
|
||||||
you use EC 2+1 and HDD, you need your NFS client to send 2 MB write requests, if you
|
|
||||||
use EC 4+1 - 4 MB and so on.
|
|
||||||
|
|
||||||
But Linux NFS client only writes in 1 MB chunks. 😢
|
|
||||||
|
|
||||||
The good news is that you can fix it by rebuilding Linux NFS kernel modules 😉 🤩!
|
|
||||||
You need to change NFS_MAX_FILE_IO_SIZE in nfs_xdr.h and then rebuild and reload modules.
|
|
||||||
|
|
||||||
The instruction, using Debian as an example (should be ran under root):
|
|
||||||
|
|
||||||
```
|
|
||||||
# download current Linux kernel headers required to build modules
|
|
||||||
apt-get install linux-headers-`uname -r`
|
|
||||||
|
|
||||||
# replace NFS_MAX_FILE_IO_SIZE with a desired number (here it's 4194304 - 4 MB)
|
|
||||||
sed -i 's/NFS_MAX_FILE_IO_SIZE\s*.*/NFS_MAX_FILE_IO_SIZE\t(4194304U)/' /lib/modules/`uname -r`/source/include/linux/nfs_xdr.h
|
|
||||||
|
|
||||||
# download current Linux kernel source
|
|
||||||
mkdir linux_src
|
|
||||||
cd linux_src
|
|
||||||
apt-get source linux-image-`uname -r`-unsigned
|
|
||||||
|
|
||||||
# build NFS modules
|
|
||||||
cd linux-*/fs/nfs
|
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD -j8 modules
|
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD modules_install
|
|
||||||
|
|
||||||
# move default NFS modules away
|
|
||||||
mv /lib/modules/`uname -r`/kernel/fs/nfs ~/nfs_orig_`uname -r`
|
|
||||||
depmod -a
|
|
||||||
|
|
||||||
# unload old modules and load the new ones
|
|
||||||
rmmod nfsv3 nfs
|
|
||||||
modprobe nfsv3
|
|
||||||
```
|
|
||||||
|
|
||||||
After these (not much complicated 🙂) manipulations NFS begins to be mounted
|
|
||||||
with new wsize and rsize by default and it fixes Vitastor-NFS linear write performance.
|
|
||||||
|
|
||||||
## Horizontal scaling
|
## Horizontal scaling
|
||||||
|
|
||||||
Linux NFS 3.0 client doesn't support built-in scaling or failover, i.e. you can't
|
Linux NFS 3.0 client doesn't support built-in scaling or failover, i.e. you can't
|
||||||
@@ -260,5 +199,4 @@ Options:
|
|||||||
| `--nfspath <PATH>` | set NFS export path to \<PATH> (default is /) |
|
| `--nfspath <PATH>` | set NFS export path to \<PATH> (default is /) |
|
||||||
| `--pidfile <FILE>` | write process ID to the specified file |
|
| `--pidfile <FILE>` | write process ID to the specified file |
|
||||||
| `--logfile <FILE>` | log to the specified file |
|
| `--logfile <FILE>` | log to the specified file |
|
||||||
| `--enforce 1` | enforce permissions at the server side (no by default) |
|
|
||||||
| `--foreground 1` | stay in foreground, do not daemonize |
|
| `--foreground 1` | stay in foreground, do not daemonize |
|
||||||
|
|||||||
+1
-67
@@ -14,9 +14,6 @@
|
|||||||
- [upgrade](#upgrade)
|
- [upgrade](#upgrade)
|
||||||
- [defrag](#defrag)
|
- [defrag](#defrag)
|
||||||
|
|
||||||
⚠️ Важно: для оптимальной производительности Vitastor NFS в Linux при использовании
|
|
||||||
HDD и EC (erasure кодов) выполните инструкции из раздела [Размер записи Linux NFS](#размер-записи-linux-nfs).
|
|
||||||
|
|
||||||
## Псевдо-ФС
|
## Псевдо-ФС
|
||||||
|
|
||||||
Упрощённая реализация псевдо-ФС используется для эмуляции файлового доступа к блочным
|
Упрощённая реализация псевдо-ФС используется для эмуляции файлового доступа к блочным
|
||||||
@@ -63,7 +60,7 @@ JSON-формате :-). Для инспекции содержимого БД
|
|||||||
или по крайней мере на HDD, но без EC), но можно и в том же пуле, что данные
|
или по крайней мере на HDD, но без EC), но можно и в том же пуле, что данные
|
||||||
(размер образа значения не имеет):
|
(размер образа значения не имеет):
|
||||||
`vitastor-cli create -s 10G -p fastpool testfs`
|
`vitastor-cli create -s 10G -p fastpool testfs`
|
||||||
3. Пометьте пул данных как ФС-пул: `vitastor-cli modify-pool --used-for-app fs:testfs data-pool`
|
3. Пометьте пул данных как ФС-пул: `vitastor-cli modify-pool --used-for-fs testfs data-pool`
|
||||||
4. Либо примонтируйте ФС: `vitastor-nfs mount --fs testfs --pool data-pool /mnt/vita`
|
4. Либо примонтируйте ФС: `vitastor-nfs mount --fs testfs --pool data-pool /mnt/vita`
|
||||||
5. Либо запустите сетевой NFS-сервер: `vitastor-nfs start --fs testfs --pool data-pool`
|
5. Либо запустите сетевой NFS-сервер: `vitastor-nfs start --fs testfs --pool data-pool`
|
||||||
|
|
||||||
@@ -91,8 +88,6 @@ JSON-формате :-). Для инспекции содержимого БД
|
|||||||
stat(2), так что `du` всегда показывает сумму размеров файлов, а не фактически занятое место
|
stat(2), так что `du` всегда показывает сумму размеров файлов, а не фактически занятое место
|
||||||
- Времена доступа (`atime`) не отслеживаются (как будто ФС смонтирована с `-o noatime`)
|
- Времена доступа (`atime`) не отслеживаются (как будто ФС смонтирована с `-o noatime`)
|
||||||
- Времена модификации (`mtime`) отслеживаются асинхронно (как будто ФС смонтирована с `-o lazytime`)
|
- Времена модификации (`mtime`) отслеживаются асинхронно (как будто ФС смонтирована с `-o lazytime`)
|
||||||
- Привилегии доступа по умолчанию не проверяются сервером (клиент NFS Linux их также не проверяет).
|
|
||||||
Чтобы включить проверки, используйте опцию `--enforce 1`.
|
|
||||||
|
|
||||||
Другие недостающие функции, которые нужно добавить в будущем:
|
Другие недостающие функции, которые нужно добавить в будущем:
|
||||||
- Переиспользование номеров инодов. В текущей реализации номера инодов всё время
|
- Переиспользование номеров инодов. В текущей реализации номера инодов всё время
|
||||||
@@ -109,66 +104,6 @@ JSON-формате :-). Для инспекции содержимого БД
|
|||||||
записи. ФС устроена так, что на работу они не влияют, но для порядка и их стоит
|
записи. ФС устроена так, что на работу они не влияют, но для порядка и их стоит
|
||||||
уметь подчищать.
|
уметь подчищать.
|
||||||
|
|
||||||
## Размер записи Linux NFS
|
|
||||||
|
|
||||||
Клиент Linux NFS (модули ядра nfs/nfsv3/nfsv4) имеет фиксированный в коде максимальный
|
|
||||||
размер запроса ввода-вывода, равный 1 МБ - см. `rsize` и `wsize` в [man 5 nfs](https://linux.die.net/man/5/nfs).
|
|
||||||
|
|
||||||
Это означает, что когда вы записываете в файл в примонтированной по NFS файловой системе,
|
|
||||||
максимальный размер запроса записи составляет 1 МБ, даже в режиме O_DIRECT и даже если
|
|
||||||
исходный запрос записи был больше.
|
|
||||||
|
|
||||||
Однако для оптимальной скорости линейной записи в Vitastor при использовании EC-пулов
|
|
||||||
(пулов с кодами коррекции ошибок) запросы записи должны быть по размеру кратны
|
|
||||||
[block_size](../config/layout-cluster.ru.md#block_size), умноженному на число частей
|
|
||||||
данных пула ([pg_size](../config/pool.ru.md#pg_size)-[parity_chunks](../config/pool.ru.md#parity_chunks)).
|
|
||||||
Если запросы записи меньше или не кратны, то Vitastor приходится сначала прочитать
|
|
||||||
с дисков старые версии парных блоков данных, рассчитать новые блоки чётности и только
|
|
||||||
после этого записать их на диски. Естественно, это в 2-3 раза медленнее простой записи
|
|
||||||
на диск.
|
|
||||||
|
|
||||||
При этом block_size на жёстких дисках по умолчанию устанавливается равным 1 МБ.
|
|
||||||
Таким образом, если вы используете EC 2+1 и HDD, для оптимальной скорости записи вам
|
|
||||||
нужно, чтобы NFS-клиент писал по 2 МБ, если EC 4+1 и HDD - то по 4 МБ, и т.п.
|
|
||||||
|
|
||||||
А Linux NFS-клиент пишет только по 1 МБ. 😢
|
|
||||||
|
|
||||||
Но это можно исправить, пересобрав модули ядра Linux NFS 😉 🤩! Для этого нужно
|
|
||||||
поменять значение переменной NFS_MAX_FILE_IO_SIZE в заголовочном файле nfs_xdr.h,
|
|
||||||
после чего пересобрать модули NFS.
|
|
||||||
|
|
||||||
Инструкция по пересборке на примере Debian (выполнять под root):
|
|
||||||
|
|
||||||
```
|
|
||||||
# скачиваем заголовки для сборки модулей для текущего ядра Linux
|
|
||||||
apt-get install linux-headers-`uname -r`
|
|
||||||
|
|
||||||
# заменяем в заголовках NFS_MAX_FILE_IO_SIZE на желаемый (здесь 4194304 - 4 МБ)
|
|
||||||
sed -i 's/NFS_MAX_FILE_IO_SIZE\s*.*/NFS_MAX_FILE_IO_SIZE\t(4194304U)/' /lib/modules/`uname -r`/source/include/linux/nfs_xdr.h
|
|
||||||
|
|
||||||
# скачиваем исходный код текущего ядра
|
|
||||||
mkdir linux_src
|
|
||||||
cd linux_src
|
|
||||||
apt-get source linux-image-`uname -r`-unsigned
|
|
||||||
|
|
||||||
# собираем модули NFS
|
|
||||||
cd linux-*/fs/nfs
|
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD -j8 modules
|
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD modules_install
|
|
||||||
|
|
||||||
# убираем в сторону штатные модули NFS
|
|
||||||
mv /lib/modules/`uname -r`/kernel/fs/nfs ~/nfs_orig_`uname -r`
|
|
||||||
depmod -a
|
|
||||||
|
|
||||||
# выгружаем старые модули и загружаем новые
|
|
||||||
rmmod nfsv3 nfs
|
|
||||||
modprobe nfsv3
|
|
||||||
```
|
|
||||||
|
|
||||||
После такой (относительно нехитрой 🙂) манипуляции NFS начинает по умолчанию
|
|
||||||
монтироваться с новыми wsize и rsize, и производительность линейной записи в Vitastor-NFS
|
|
||||||
исправляется.
|
|
||||||
|
|
||||||
## Горизонтальное масштабирование
|
## Горизонтальное масштабирование
|
||||||
|
|
||||||
Клиент Linux NFS 3.0 не поддерживает встроенное масштабирование или отказоустойчивость.
|
Клиент Linux NFS 3.0 не поддерживает встроенное масштабирование или отказоустойчивость.
|
||||||
@@ -272,5 +207,4 @@ VitastorFS из GPUDirect.
|
|||||||
| `--nfspath <PATH>` | установить путь NFS-экспорта в \<PATH> (по умолчанию /) |
|
| `--nfspath <PATH>` | установить путь NFS-экспорта в \<PATH> (по умолчанию /) |
|
||||||
| `--pidfile <FILE>` | записать ID процесса в заданный файл |
|
| `--pidfile <FILE>` | записать ID процесса в заданный файл |
|
||||||
| `--logfile <FILE>` | записывать логи в заданный файл |
|
| `--logfile <FILE>` | записывать логи в заданный файл |
|
||||||
| `--enforce 1` | проверять права доступа на стороне сервера (по умолчанию нет) |
|
|
||||||
| `--foreground 1` | не уходить в фон после запуска |
|
| `--foreground 1` | не уходить в фон после запуска |
|
||||||
|
|||||||
+17
-21
@@ -130,16 +130,23 @@ Linux kernel, starting with version 5.15, supports a new interface for attaching
|
|||||||
to the host - VDUSE (vDPA Device in Userspace). QEMU, starting with 7.2, has support for
|
to the host - VDUSE (vDPA Device in Userspace). QEMU, starting with 7.2, has support for
|
||||||
exporting QEMU block devices over this protocol using qemu-storage-daemon.
|
exporting QEMU block devices over this protocol using qemu-storage-daemon.
|
||||||
|
|
||||||
VDUSE advantages:
|
VDUSE is currently the best interface to attach Vitastor disks as kernel devices because:
|
||||||
|
- It avoids data copies and thus achieves much better performance than [NBD](nbd.en.md)
|
||||||
- VDUSE copies memory 1 time instead of 2, and is thus faster than [NBD](nbd.en.md) for linear read/write.
|
- It doesn't have NBD timeout problem - the device doesn't die if an operation executes for too long
|
||||||
- It doesn't have NBD timeout problem - the device doesn't die if an operation executes for too long.
|
|
||||||
- It doesn't have hung device problem - if the userspace process dies it can be restarted (!)
|
- It doesn't have hung device problem - if the userspace process dies it can be restarted (!)
|
||||||
and block device will continue operation (UBLK can do it too).
|
and block device will continue operation
|
||||||
- It doesn't seem to have the device number limit (UBLK also doesn't).
|
- It doesn't seem to have the device number limit
|
||||||
|
|
||||||
At the same time, VDUSE may be slower or faster than [UBLK](ublk.en.md) for linear read/write,
|
Example performance comparison:
|
||||||
and iops-wise it's sometimes even slower than NBD. See performance comparison examples at the page [UBLK](ublk.en.md).
|
|
||||||
|
| | direct fio | NBD | VDUSE |
|
||||||
|
|----------------------|-------------|-------------|-------------|
|
||||||
|
| linear write | 3.85 GB/s | 1.12 GB/s | 3.85 GB/s |
|
||||||
|
| 4k random write Q128 | 240000 iops | 120000 iops | 178000 iops |
|
||||||
|
| 4k random write Q1 | 9500 iops | 7620 iops | 7640 iops |
|
||||||
|
| linear read | 4.3 GB/s | 1.8 GB/s | 2.85 GB/s |
|
||||||
|
| 4k random read Q128 | 287000 iops | 140000 iops | 189000 iops |
|
||||||
|
| 4k random read Q1 | 9600 iops | 7640 iops | 7780 iops |
|
||||||
|
|
||||||
To try VDUSE you need at least Linux 5.15, built with VDUSE support
|
To try VDUSE you need at least Linux 5.15, built with VDUSE support
|
||||||
(CONFIG_VDPA=m, CONFIG_VDPA_USER=m, CONFIG_VIRTIO_VDPA=m).
|
(CONFIG_VDPA=m, CONFIG_VDPA_USER=m, CONFIG_VIRTIO_VDPA=m).
|
||||||
@@ -155,12 +162,10 @@ apt-get install linux-headers-`uname -r`
|
|||||||
apt-get build-dep linux-image-`uname -r`-unsigned
|
apt-get build-dep linux-image-`uname -r`-unsigned
|
||||||
apt-get source linux-image-`uname -r`-unsigned
|
apt-get source linux-image-`uname -r`-unsigned
|
||||||
cd linux*/drivers/vdpa
|
cd linux*/drivers/vdpa
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules
|
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules modules_install
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m modules_install
|
|
||||||
cat Module.symvers >> /lib/modules/`uname -r`/build/Module.symvers
|
cat Module.symvers >> /lib/modules/`uname -r`/build/Module.symvers
|
||||||
cd ../virtio
|
cd ../virtio
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules
|
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules modules_install
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m modules_install
|
|
||||||
depmod -a
|
depmod -a
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -186,12 +191,3 @@ To remove the device:
|
|||||||
vdpa dev del test1
|
vdpa dev del test1
|
||||||
kill <qemu-storage-daemon_process_PID>
|
kill <qemu-storage-daemon_process_PID>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Veeam
|
|
||||||
|
|
||||||
Vitastor QEMU driver has a feature that allows to trick third-party systems like Veeam not able to parse qemu-img
|
|
||||||
vitastor URIs: [qemu_file_mirror_path](../config/client.en.md#qemu_file_mirror_path).
|
|
||||||
|
|
||||||
To make such systems work, you should set this option to an FS directory path (for example, `/mnt/vitastor/`) and
|
|
||||||
mount this directory using [`vitastor-nfs mount --block`](../usage/nfs.en.md). It will make them access
|
|
||||||
your images using files and, hopefully, succeed in doing their normal job :).
|
|
||||||
|
|||||||
+18
-21
@@ -132,16 +132,24 @@ qemu-system-x86_64 -enable-kvm -m 2048 -M accel=kvm,memory-backend=mem \
|
|||||||
к системе - VDUSE (vDPA Device in Userspace), а в QEMU, начиная с версии 7.2, есть поддержка
|
к системе - VDUSE (vDPA Device in Userspace), а в QEMU, начиная с версии 7.2, есть поддержка
|
||||||
экспорта блочных устройств QEMU по этому протоколу через qemu-storage-daemon.
|
экспорта блочных устройств QEMU по этому протоколу через qemu-storage-daemon.
|
||||||
|
|
||||||
Преимущества VDUSE:
|
VDUSE - на данный момент лучший интерфейс для подключения дисков Vitastor в виде блочных
|
||||||
|
устройств на уровне ядра, ибо:
|
||||||
|
- VDUSE не копирует данные и поэтому достигает значительно лучшей производительности, чем [NBD](nbd.ru.md)
|
||||||
|
- Также оно не имеет проблемы NBD-таймаута - устройство не умирает, если операция выполняется слишком долго
|
||||||
|
- Также оно не имеет проблемы подвисающих устройств - если процесс-обработчик умирает, его можно
|
||||||
|
перезапустить (!) и блочное устройство продолжит работать
|
||||||
|
- По-видимому, у него нет предела числа подключаемых в систему устройств
|
||||||
|
|
||||||
- VDUSE копирует данные 1 раз, а не 2, и поэтому он быстрее, чем [NBD](nbd.ru.md) при линейном доступе.
|
Пример сравнения производительности:
|
||||||
- VDUSE не имеет проблемы NBD-таймаута - устройство не умирает, если операция выполняется слишком долго.
|
|
||||||
- VDUSE не имеет проблемы подвисающих устройств - если процесс-обработчик умирает, его можно
|
|
||||||
перезапустить (!) и блочное устройство продолжит работать (в UBLK это тоже поддерживается).
|
|
||||||
- По-видимому, у него нет предела числа подключаемых в систему устройств (в UBLK лимита тоже нет).
|
|
||||||
|
|
||||||
Однако, при линейном доступе VDUSE может быть медленнее UBLK (а может быть и быстрее), а по iops
|
| | Прямой fio | NBD | VDUSE |
|
||||||
VDUSE иногда даже медленнее NBD. Пример сравнения производительности смотрите на странице [UBLK](ublk.ru.md).
|
|--------------------------|-------------|-------------|-------------|
|
||||||
|
| линейная запись | 3.85 GB/s | 1.12 GB/s | 3.85 GB/s |
|
||||||
|
| 4k случайная запись Q128 | 240000 iops | 120000 iops | 178000 iops |
|
||||||
|
| 4k случайная запись Q1 | 9500 iops | 7620 iops | 7640 iops |
|
||||||
|
| линейное чтение | 4.3 GB/s | 1.8 GB/s | 2.85 GB/s |
|
||||||
|
| 4k случайное чтение Q128 | 287000 iops | 140000 iops | 189000 iops |
|
||||||
|
| 4k случайное чтение Q1 | 9600 iops | 7640 iops | 7780 iops |
|
||||||
|
|
||||||
Чтобы попробовать VDUSE, вам нужно ядро Linux как минимум версии 5.15, собранное с поддержкой
|
Чтобы попробовать VDUSE, вам нужно ядро Linux как минимум версии 5.15, собранное с поддержкой
|
||||||
VDUSE (CONFIG_VDPA=m, CONFIG_VDPA_USER=m, CONFIG_VIRTIO_VDPA=m).
|
VDUSE (CONFIG_VDPA=m, CONFIG_VDPA_USER=m, CONFIG_VIRTIO_VDPA=m).
|
||||||
@@ -157,12 +165,10 @@ apt-get install linux-headers-`uname -r`
|
|||||||
apt-get build-dep linux-image-`uname -r`-unsigned
|
apt-get build-dep linux-image-`uname -r`-unsigned
|
||||||
apt-get source linux-image-`uname -r`-unsigned
|
apt-get source linux-image-`uname -r`-unsigned
|
||||||
cd linux*/drivers/vdpa
|
cd linux*/drivers/vdpa
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules
|
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules modules_install
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m modules_install
|
|
||||||
cat Module.symvers >> /lib/modules/`uname -r`/build/Module.symvers
|
cat Module.symvers >> /lib/modules/`uname -r`/build/Module.symvers
|
||||||
cd ../virtio
|
cd ../virtio
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules
|
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m -j8 modules modules_install
|
||||||
make -C /lib/modules/`uname -r`/build M=$PWD CONFIG_VDPA=m CONFIG_VDPA_USER=m CONFIG_VIRTIO_VDPA=m modules_install
|
|
||||||
depmod -a
|
depmod -a
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -188,12 +194,3 @@ vdpa dev add name test1 mgmtdev vduse
|
|||||||
vdpa dev del test1
|
vdpa dev del test1
|
||||||
kill <PID_процесса_qemu-storage-daemon>
|
kill <PID_процесса_qemu-storage-daemon>
|
||||||
```
|
```
|
||||||
|
|
||||||
## Veeam
|
|
||||||
|
|
||||||
Драйвер Vitastor QEMU имеет функцию, которая позволяет обманывать сторонние системы типа Veeam, которые
|
|
||||||
не могут сами по себе разобрать адреса дисков в vitastor: [qemu_file_mirror_path](../config/client.ru.md#qemu_file_mirror_path).
|
|
||||||
|
|
||||||
Чтобы заставить такие системы работать, вам нужно установить эту опцию равной пути к некоторому каталогу
|
|
||||||
в ФС (например, `/mnt/vitastor/`) и примонтировать этот каталог с помощью [`vitastor-nfs mount --block`](../usage/nfs.ru.md).
|
|
||||||
Они начнут обращаться к образам как к файлам и, вероятно, смогут заработать корректно :).
|
|
||||||
|
|||||||
@@ -1,116 +0,0 @@
|
|||||||
[Documentation](../../README.md#documentation) → Usage → UBLK
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Читать на русском](ublk.ru.md)
|
|
||||||
|
|
||||||
# UBLK
|
|
||||||
|
|
||||||
[ublk](https://docs.kernel.org/block/ublk.html) is a new io_uring-based Linux interface
|
|
||||||
for user-space block device drivers, available since Linux 6.0.
|
|
||||||
|
|
||||||
It's not zero-copy, but it's still a fast implementation, outperforming both [NBD](nbd.en.md)
|
|
||||||
and [VDUSE](qemu.en.md#vduse) iops-wise and may or may not outperform VDUSE in linear I/O MB/s.
|
|
||||||
ublk also allows to recover devices even if the server (vitastor-ublk process) dies.
|
|
||||||
|
|
||||||
## Example performance comparison
|
|
||||||
|
|
||||||
TCP (100G), 3 hosts each with 6 NVMe OSDs, 3 replicas, single client
|
|
||||||
|
|
||||||
| | direct fio | NBD | VDUSE | UBLK |
|
|
||||||
|----------------------|-------------|-------------|------------|-------------|
|
|
||||||
| linear write | 3807 MB/s | 1832 MB/s | 3226 MB/s | 3027 MB/s |
|
|
||||||
| linear read | 3067 MB/s | 1885 MB/s | 1800 MB/s | 2076 MB/s |
|
|
||||||
| 4k random write Q128 | 128624 iops | 91060 iops | 94621 iops | 149450 iops |
|
|
||||||
| 4k random read Q128 | 117769 iops | 153408 iops | 93157 iops | 171987 iops |
|
|
||||||
| 4k random write Q1 | 8090 iops | 6442 iops | 6316 iops | 7272 iops |
|
|
||||||
| 4k random read Q1 | 9474 iops | 7200 iops | 6840 iops | 8038 iops |
|
|
||||||
|
|
||||||
RDMA (100G), 3 hosts each with 6 NVMe OSDs, 3 replicas, single client
|
|
||||||
|
|
||||||
| | direct fio | NBD | VDUSE | UBLK |
|
|
||||||
|----------------------|-------------|-------------|-------------|-------------|
|
|
||||||
| linear write | 6998 MB/s | 1878 MB/s | 4249 MB/s | 3140 MB/s |
|
|
||||||
| linear read | 8628 MB/s | 3389 MB/s | 5062 MB/s | 3674 MB/s |
|
|
||||||
| 4k random write Q128 | 222541 iops | 181589 iops | 138281 iops | 218222 iops |
|
|
||||||
| 4k random read Q128 | 412647 iops | 239987 iops | 151663 iops | 269583 iops |
|
|
||||||
| 4k random write Q1 | 11601 iops | 8592 iops | 9111 iops | 10000 iops |
|
|
||||||
| 4k random read Q1 | 10102 iops | 7788 iops | 8111 iops | 8965 iops |
|
|
||||||
|
|
||||||
## Commands
|
|
||||||
|
|
||||||
vitastor-ublk supports the following commands:
|
|
||||||
|
|
||||||
- [map](#map)
|
|
||||||
- [unmap](#unmap)
|
|
||||||
- [ls](#ls)
|
|
||||||
|
|
||||||
## map
|
|
||||||
|
|
||||||
To create a local block device for a Vitastor image run:
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk map [/dev/ublkbN] --image testimg
|
|
||||||
```
|
|
||||||
|
|
||||||
It will output a block device name like /dev/ublkb0 which you can then use as a normal disk.
|
|
||||||
|
|
||||||
You can also use `--pool <POOL> --inode <INODE> --size <SIZE>` instead of `--image <IMAGE>` if you want.
|
|
||||||
|
|
||||||
vitastor-ublk supports all usual Vitastor configuration options like `--config_path <path_to_config>` plus ublk-specific:
|
|
||||||
|
|
||||||
* `--recover` \
|
|
||||||
Recover a mapped device if the previous ublk server is dead.
|
|
||||||
* `--queue_depth 256` \
|
|
||||||
Maximum queue size for the device.
|
|
||||||
* `--max_io_size 1M` \
|
|
||||||
Maximum single I/O size for the device. Default: `max(1 MB, pool block size * EC part count)`.
|
|
||||||
* `--readonly` \
|
|
||||||
Make the device read-only.
|
|
||||||
* `--hdd` \
|
|
||||||
Mark the device as rotational.
|
|
||||||
* `--logfile /path/to/log/file.txt` \
|
|
||||||
Write log messages to the specified file instead of dropping them (in background mode)
|
|
||||||
or printing them to the standard output (in foreground mode).
|
|
||||||
* `--dev_num N` \
|
|
||||||
Use the specified device /dev/ublkbN instead of automatic selection (alternative syntax
|
|
||||||
to /dev/ublkbN positional parameter).
|
|
||||||
* `--foreground 1` \
|
|
||||||
Stay in foreground, do not daemonize.
|
|
||||||
|
|
||||||
Note that `ublk_queue_depth` and `ublk_max_io_size` may also be specified
|
|
||||||
in `/etc/vitastor/vitastor.conf` or in other configuration file specified with `--config_path`.
|
|
||||||
|
|
||||||
## unmap
|
|
||||||
|
|
||||||
To unmap the device run:
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk unmap /dev/ublkb0
|
|
||||||
```
|
|
||||||
|
|
||||||
## ls
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk ls [--json]
|
|
||||||
```
|
|
||||||
|
|
||||||
List mapped images.
|
|
||||||
|
|
||||||
Example output (normal format):
|
|
||||||
|
|
||||||
```
|
|
||||||
/dev/ublkb0
|
|
||||||
image: bench
|
|
||||||
pid: 584536
|
|
||||||
|
|
||||||
/dev/ublkb1
|
|
||||||
image: bench1
|
|
||||||
pid: 584546
|
|
||||||
```
|
|
||||||
|
|
||||||
Example output (JSON format):
|
|
||||||
|
|
||||||
```
|
|
||||||
{"/dev/ublkb0": {"image": "bench", "pid": 584536}, "/dev/ublkb1": {"image": "bench1", "pid": 584546}}
|
|
||||||
```
|
|
||||||
@@ -1,121 +0,0 @@
|
|||||||
[Документация](../../README-ru.md#документация) → Использование → UBLK
|
|
||||||
|
|
||||||
-----
|
|
||||||
|
|
||||||
[Read in English](ublk.en.md)
|
|
||||||
|
|
||||||
# UBLK
|
|
||||||
|
|
||||||
[ublk](https://docs.kernel.org/block/ublk.html) - это новый Linux-интерфейс на основе io_uring
|
|
||||||
для реализации блочных устройств в пространстве пользователя, доступный, начиная с Linux 6.0.
|
|
||||||
|
|
||||||
ublk тоже копирует память (т.е. не является zero-copy), но по IOPS всё равно обгоняет и
|
|
||||||
[NBD](nbd.ru.md), и [VDUSE](qemu.ru.md#vduse), и иногда может даже обгонять VDUSE по
|
|
||||||
скорости линейного доступа. Также ublk позволяет оживлять устройства, у которых умер
|
|
||||||
сервер (процесс-обработчик vitastor-ublk).
|
|
||||||
|
|
||||||
## Пример сравнения производительности
|
|
||||||
|
|
||||||
TCP (100G), 3 сервера с 6 NVMe OSD каждый, 3 реплики, один клиент
|
|
||||||
|
|
||||||
| | Прямой fio | NBD | VDUSE | UBLK |
|
|
||||||
|--------------------------|-------------|-------------|------------|-------------|
|
|
||||||
| линейная запись | 3807 MB/s | 1832 MB/s | 3226 MB/s | 3027 MB/s |
|
|
||||||
| линейное чтение | 3067 MB/s | 1885 MB/s | 1800 MB/s | 2076 MB/s |
|
|
||||||
| 4k случайная запись Q128 | 128624 iops | 91060 iops | 94621 iops | 149450 iops |
|
|
||||||
| 4k случайное чтение Q128 | 117769 iops | 153408 iops | 93157 iops | 171987 iops |
|
|
||||||
| 4k случайная запись Q1 | 8090 iops | 6442 iops | 6316 iops | 7272 iops |
|
|
||||||
| 4k случайное чтение Q1 | 9474 iops | 7200 iops | 6840 iops | 8038 iops |
|
|
||||||
|
|
||||||
RDMA (100G), 3 сервера с 6 NVMe OSD каждый, 3 реплики, один клиент
|
|
||||||
|
|
||||||
| | Прямой fio | NBD | VDUSE | UBLK |
|
|
||||||
|--------------------------|-------------|-------------|-------------|-------------|
|
|
||||||
| линейная запись | 6998 MB/s | 1878 MB/s | 4249 MB/s | 3140 MB/s |
|
|
||||||
| линейное чтение | 8628 MB/s | 3389 MB/s | 5062 MB/s | 3674 MB/s |
|
|
||||||
| 4k случайная запись Q128 | 222541 iops | 181589 iops | 138281 iops | 218222 iops |
|
|
||||||
| 4k случайное чтение Q128 | 412647 iops | 239987 iops | 151663 iops | 269583 iops |
|
|
||||||
| 4k случайная запись Q1 | 11601 iops | 8592 iops | 9111 iops | 10000 iops |
|
|
||||||
| 4k случайное чтение Q1 | 10102 iops | 7788 iops | 8111 iops | 8965 iops |
|
|
||||||
|
|
||||||
## Команды
|
|
||||||
|
|
||||||
vitastor-ublk поддерживает следующие команды:
|
|
||||||
|
|
||||||
- [map](#map)
|
|
||||||
- [unmap](#unmap)
|
|
||||||
- [ls](#ls)
|
|
||||||
|
|
||||||
## map
|
|
||||||
|
|
||||||
Чтобы создать локальное блочное устройство для образа, выполните команду:
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk map [/dev/ublkbN] --image testimg
|
|
||||||
```
|
|
||||||
|
|
||||||
Команда напечатает название блочного устройства вида /dev/ublkb0, которое потом можно
|
|
||||||
будет использовать как обычный диск.
|
|
||||||
|
|
||||||
Для обращения по номеру инода, аналогично другим командам, можно использовать опции
|
|
||||||
`--pool <POOL> --inode <INODE> --size <SIZE>` вместо `--image testimg`.
|
|
||||||
|
|
||||||
vitastor-ublk поддерживает все обычные опции Vitastor, например, `--config_path <path_to_config>`,
|
|
||||||
плюс специфичные для ublk:
|
|
||||||
|
|
||||||
* `--recover` \
|
|
||||||
Восстановить ранее подключённое устройство, у которого умер обработчик.
|
|
||||||
* `--queue_depth 256` \
|
|
||||||
Максимальная глубина очереди устройства.
|
|
||||||
* `--max_io_size 1M` \
|
|
||||||
Максимальный размер запроса ввода-вывода для устройства. По умолчанию: `max(1 MB, блок данных пула * число частей данных EC)`.
|
|
||||||
* `--readonly` \
|
|
||||||
Подключить устройство в режиме только для чтения.
|
|
||||||
* `--hdd` \
|
|
||||||
Пометить устройство как вращающийся жёсткий диск (флаг rotational).
|
|
||||||
* `--logfile /path/to/log/file.txt` \
|
|
||||||
Писать сообщения о процессе работы в заданный файл, вместо пропуска их
|
|
||||||
при фоновом режиме запуска или печати на стандартный вывод при запуске
|
|
||||||
в консоли с `--foreground 1`.
|
|
||||||
* `--dev_num N` \
|
|
||||||
Использовать заданное устройство `/dev/ublkbN` вместо автоматического подбора.
|
|
||||||
* `--foreground 1` \
|
|
||||||
Не уводить процесс в фоновый режим.
|
|
||||||
|
|
||||||
Обратите внимание, что опции `ublk_queue_depth` и `ublk_max_io_size` можно
|
|
||||||
также задавать в `/etc/vitastor/vitastor.conf` или в другом файле конфигурации,
|
|
||||||
заданном опцией `--config_path`.
|
|
||||||
|
|
||||||
## unmap
|
|
||||||
|
|
||||||
Для отключения устройства выполните:
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk unmap /dev/ublkb0
|
|
||||||
```
|
|
||||||
|
|
||||||
## ls
|
|
||||||
|
|
||||||
```
|
|
||||||
vitastor-ublk ls [--json]
|
|
||||||
```
|
|
||||||
|
|
||||||
Вывести подключённые устройства.
|
|
||||||
|
|
||||||
Пример вывода в обычном формате:
|
|
||||||
|
|
||||||
```
|
|
||||||
/dev/ublkb0
|
|
||||||
image: bench
|
|
||||||
pid: 584536
|
|
||||||
|
|
||||||
/dev/ublkb1
|
|
||||||
image: bench1
|
|
||||||
pid: 584546
|
|
||||||
```
|
|
||||||
|
|
||||||
Пример вывода в JSON-формате:
|
|
||||||
|
|
||||||
```
|
|
||||||
{"/dev/ublkb0": {"image": "bench", "pid": 584536}, "/dev/ublkb1": {"image": "bench1", "pid": 584546}}
|
|
||||||
```
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user