1
0
mirror of git://sourceware.org/git/lvm2.git synced 2024-10-26 17:25:10 +03:00

man: update for new syntax

This commit is contained in:
Zdenek Kabelac 2023-07-04 21:34:37 +02:00
parent 70c911b63f
commit 9ba9e99716
6 changed files with 168 additions and 16 deletions

View File

@ -84,6 +84,11 @@ Replace the maximum of 2 PVs /dev/sd[bc]1 with PVs /dev/sd[gh]1 in a raid6 LV.
.br
.B lvconvert --replace /dev/sdb1 --replace /dev/sdc1 vg/lvol1 /dev/sd[gh]1
.P
Convert a thick LV into a thin-pool data volume and continue using this LV
through thinLV and for the conversion set the pool metadata size to 1GiB.
.br
.B lvconvert --type thin --poolmetadatasize 1G vg/lvol1
.P
Convert an LV into a thin LV in the specified thin pool. The existing LV
is used as an external read-only origin for the new thin LV.
.br

View File

@ -502,6 +502,39 @@ LV1 types: linear striped thin cache raid error zero
.P
\(em
.P
Convert LV to a thin LV, using LV as thin-pool data volume.
.br
.P
\fBlvconvert\fP \fB--type\fP \fBthin\fP \fILV1\fP
.br
.RS 4
.ad l
[ \fB-T\fP|\fB--thin\fP ]
.br
[ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ]
.br
[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ]
.br
[ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ]
.br
[ \fB--poolmetadata\fP \fILV\fP ]
.br
[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ]
.br
[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ]
.br
[ \fB--metadataprofile\fP \fIString\fP ]
.br
[ COMMON_OPTIONS ]
.ad b
.RE
.P
.RS 4
LV1 types: linear striped cache vdo raid error zero writecache
.RE
.P
\(em
.P
Attach a cache pool to an LV, converts the LV to type cache.
.br
.P
@ -1729,6 +1762,40 @@ LV1 types: linear striped thin cache raid error zero
.P
\(em
.P
Convert LV to a thin LV, using LV as thin-pool data volume.
.br
.P
\fBlvconvert\fP \fB-T\fP|\fB--thin\fP \fILV1\fP
.br
.RS 4
.ad l
[ \fB--type thin\fP ] (implied)
.br
.br
[ \fB-r\fP|\fB--readahead\fP \fBauto\fP|\fBnone\fP|\fINumber\fP ]
.br
[ \fB-c\fP|\fB--chunksize\fP \fISize\fP[k|UNIT] ]
.br
[ \fB-Z\fP|\fB--zero\fP \fBy\fP|\fBn\fP ]
.br
[ \fB--poolmetadata\fP \fILV\fP ]
.br
[ \fB--poolmetadatasize\fP \fISize\fP[m|UNIT] ]
.br
[ \fB--poolmetadataspare\fP \fBy\fP|\fBn\fP ]
.br
[ \fB--metadataprofile\fP \fIString\fP ]
.br
[ COMMON_OPTIONS ]
.ad b
.RE
.P
.RS 4
LV1 types: linear striped cache vdo raid error zero writecache
.RE
.P
\(em
.P
Attach a cache pool to an LV.
.br
.P

View File

@ -518,6 +518,7 @@ Prepends source file name and code line number with libdm debugging.
.BR lvm (8),
.BR lvm.conf (5),
.BR lvmconfig (8),
.BR lvmdevices (8),
.P
.BR pvchange (8),
.BR pvck (8),
@ -540,6 +541,7 @@ Prepends source file name and code line number with libdm debugging.
.BR vgextend (8),
.BR vgimport (8),
.BR vgimportclone (8),
.BR vgimportdevices (8),
.BR vgmerge (8),
.BR vgmknodes (8),
.BR vgreduce (8),
@ -572,12 +574,14 @@ Prepends source file name and code line number with libdm debugging.
.BR lvmlockctl (8),
.BR cmirrord (8),
.BR lvmdbusd (8),
.BR fsadm (8),
.P
.BR lvmsystemid (7),
.BR lvmreport (7),
.BR lvmcache (7),
.BR lvmraid (7),
.BR lvmthin (7),
.BR lvmcache (7),
.BR lvmvdo (7),
.BR lvmautoactivation (7),
.P
.BR dmsetup (8),

View File

@ -207,11 +207,35 @@ Create a snapshot of the first snapshot:
thin1s2 vg Vwi---tz-k 1.00t pool0 thin1
thin1s1s1 vg Vwi---tz-k 1.00t pool0 thin1s1
.
.SS \n+[step]. Create ThinLV with ThinPoolLV
.
Create a new thin LV together with thin pool LV and let lvm2
to allocate data and metadata volume.
.P
.B lvcreate -T -n ThinLV -V VirtualSize -L PoolSize VG/ThinPoolLV
.P
.I Example
.br
Create a 50MiB thin LV and 10MiB thin pool:
.br
# lvcreate -T -n thin -V 52M -L 12M vg/pool
.P
# lvs -a vg
LV VG Attr LSize Pool Origin Data% Meta%
[lvol0_pmspare] vg ewi------- 4,00m
pool vg twi-aotz-- 12,00m 0,00 10,94
[pool_tdata] vg Twi-ao---- 12,00m
[pool_tmeta] vg ewi-ao---- 4,00m
thin vg Vwi-a-tz-- 52,00m pool 0,00
.
.SS \n+[step]. Activate SnapLV
.
Thin snapshots are created with the persistent "activation skip"
flag, indicated by the "k" attribute. Use -K with lvchange
or vgchange to activate thin snapshots with the "k" attribute.
User can preset default behavior with
.BR lvm.conf (5)
.BR auto_set_activation_skip .
.P
.B lvchange -ay -K VG/SnapLV
.P
@ -223,6 +247,31 @@ or vgchange to activate thin snapshots with the "k" attribute.
LV VG Attr LSize Pool Origin
thin1s1 vg Vwi-a-tz-k 1.00t pool0 thin1
.
.SS \n+[step]. Convert thick LV to thin LV
.
Convert existing thick LV (linear, stripe,...) to thin LV with move of
existing data to thin pool and using thin LV from such thin pool.
Once the volume is converted, user is using it like ordinary thin-pool.
Note: Conversion cannot be reverted and thin volume cannot be reverted
back to thick LV type.
.P
.B lvconvert --type thin VG/ThickLV
.P
.I Example
.br
Create thick 12MiB LV.
.br
# lvcreate -L 12M -n thick vg
.P
Convert LV to a thin pool with chunk size 256KiB.
.br
# lvconvert --thin --chunksize 256K vg/thick
.P
# lvs -o+chunksize vg
LV VG Attr LSize Pool Origin Data% Meta% Chunk
thick vg Vwi-a-tz-- 12,00m thick_tpool0 100,00 0
thick_tpool0 vg twi---tz-- 12,00m 100,00 10,94 256,00k
.
.SH THIN TOPICS
.
.B Automatic pool metadata LV
@ -304,7 +353,7 @@ to use fast devices for the metadata LV.
.P
.B lvcreate -n ThinDataLV -L LargeSize VG LargePV
.br
.B lvcreate -n ThinMetaLV -L SmallSize VG SmallPV
.B lvcreate -n ThinMetaLV -L SmallSize VG FastPV
.br
.B lvconvert --type thin-pool --poolmetadata VG/ThinMetaLV VG/ThinDataLV
.P
@ -376,21 +425,27 @@ If thin pool metadata is damaged, it may be repairable.
Checking and repairing thin pool metadata is analogous to
running fsck/repair on a file system.
.P
When a thin pool LV is activated, lvm runs the thin_check command
to check the correctness of the metadata on the pool metadata LV.
When a thin pool LV is activated, lvm runs the
.BR thin_check (8)
command to check the correctness of the metadata on the pool metadata LV.
.P
.BR lvm.conf (5)
.B thin_check_executable
.br
can be set to an empty string ("") to disable the thin_check step.
This is not recommended.
can be set to an empty string ("") to disable the
.BR thin_check (8)
step. This is not recommended.
.P
.BR lvm.conf (5)
.B thin_check_options
.br
controls the command options used for the thin_check command.
controls the command options used for the
.BR thin_check (8)
command.
.P
If the thin_check command finds a problem with the metadata,
If the
.BR thin_check (8)
command finds a problem with the metadata,
the thin pool LV is not activated, and the thin pool metadata needs
to be repaired.
.P
@ -409,7 +464,9 @@ Repair performs the following steps:
.IP \n[step] 3
Creates a new, repaired copy of the metadata.
.br
lvconvert runs the thin_repair command to read damaged metadata
lvconvert runs the
.BR thin_repair (8)
command to read damaged metadata
from the existing pool metadata LV, and writes a new repaired
copy to the VG's pmspare LV.
.IP \n+[step] 3
@ -437,8 +494,9 @@ from a backup. In such case the content of unmodified original damaged
ThinPoolLV_metaN volume can be used by your support for more
advanced recovery methods.
.P
If metadata is manually restored with thin_repair directly,
the pool metadata LV can be manually swapped with another LV
If metadata is manually restored with
.BR thin_repair (8)
directly, the pool metadata LV can be manually swapped with another LV
containing new metadata:
.P
.B lvconvert --thinpool VG/ThinPoolLV --poolmetadata VG/NewThinMetaLV
@ -1069,7 +1127,8 @@ Configurable setting
.BR allocation / thin_pool_crop_metadata
gives control over cropping to 15.81GiB to stay backward compatible with older
versions of lvm2. With enabled cropping there can be observed some problems when
using volumes above this size with thin tools (i.e. thin_repair).
using volumes above this size with thin tools (i.e.
.BR thin_repair (8)).
Cropping should be enabled only when compatibility is required.
.
.SS Create a thin snapshot of an external, read only LV
@ -1275,12 +1334,12 @@ After the first mount with the above approach, the UUID can subsequently be
changed using:
.P
# xfs_admin -U generate /dev/VG/SnapLV
.P
.br
# mount /dev/VG/SnapLV /mnt
.P
Once the UUID has been changed, the mount command will no longer require
the nouuid option.
.P
.br
If the snapshot LV is readonly, the log recovery and uuid check need to be
skipped while mounting readonly:
.P
@ -1300,6 +1359,7 @@ skipped while mounting readonly:
.BR lvremove (8),
.BR lvs (8),
.P
.BR thin_check (8),
.BR thin_dump (8),
.BR thin_repair (8),
.BR thin_restore (8)

View File

@ -300,7 +300,20 @@ be activated. You have to deactivate the VDODataLV first to continue to use the
.SS \n[step]. Stacking VDO
.
You can convert or stack a VDOPooLV with these currently supported
volume types: linear, stripe, raid, and cache with cachepool.
volume types: linear, stripe, raid and cache with cachepool.
.
.SS \n[step]. Using multiple volumes using same VDOPoolLV
.
You can convert existing VDO LV into a thin volume. After this conversion
you can create a thin snapshot or you can add more thin volumes
with thin-pool named after orignal LV name LV_tpool0.
.P
.I Example
.nf
# lvcreate --type vdo -L 5G -V 10G -n vdo1 vg/vdopool
# lvconvert --type thin vg/vdo1
# lvcreate -V20 vg/vdo1_tpool0
.fi
.
.SS \n+[step]. VDOPoolLV on top of raid
.

View File

@ -66,6 +66,9 @@
.P
.BR lvmsystemid (7),
.BR lvmreport (7),
.BR lvmcache (7),
.BR lvmraid (7),
.BR lvmthin (7),
.BR lvmcache (7)
.BR lvmvdo (7),
.BR lvmautoactivation (7)