1STRATIS(8)                                                          STRATIS(8)
2
3
4

NAME

6       stratis - Configure Stratis local storage pools
7

SYNOPSIS

9       stratis [GLOBAL OPTIONS] pool <command> [args] [COMMAND OPTIONS]
10       stratis [GLOBAL OPTIONS] filesystem|fs <command> [args] [COMMAND OPTIONS]
11       stratis [GLOBAL OPTIONS] blockdev <command> [args] [COMMAND OPTIONS]
12       stratis [GLOBAL OPTIONS] daemon <redundancy|version>
13

DESCRIPTION

15       stratis is a command-line tool to create, modify, and destroy Stratis
16       pools, and the filesystems allocated from the pool.
17
18       Stratis creates a pool from one or more block devices (blockdevs), and
19       then enables multiple filesystems to be created from the pool.
20
21       If the block device is already in use, its signature has to be erased
22       using wipefs -a <blockdev> before trying to add it to a pool.
23

GLOBAL OPTIONS

25       --version
26           Show stratis-cli version.
27
28       --help, -h
29           Show help on command.
30
31       --propagate
32           (For debugging.) Allow exceptions raised during execution to
33           propagate.
34

COMMANDS

36       pool create <pool_name> <blockdev> [<blockdev>..]
37           Create a pool from one or more block devices, with the given pool
38           name.
39
40       pool list
41           List all pools on the system.
42
43       pool rename <old_pool_name> <new_pool_name>
44           Rename a pool.
45
46       pool destroy <pool_name>
47           Destroy a pool and all the filesystems created from it.
48
49       pool add-data <pool_name> <blockdev> [<blockdev>..]
50           Add one or more blockdevs to an existing pool, to enlarge its
51           storage capacity.
52
53       pool add-cache <pool_name> <blockdev> [<blockdev>..]
54           Add one or more blockdevs to an existing pool, to be used as a
55           cache instead of additional storage. Typically, smaller and faster
56           drives, such as SSDs, are used for this purpose.
57
58       filesystem create <pool_name> <fs_name> [<fs_name>..]
59           Create one or more filesystems from the specified pool.
60
61       filesystem snapshot <pool_name> <fs_name> <snapshot_name>
62           Snapshot the filesystem in the specified pool.
63
64       filesystem list [pool_name]
65           List all filesystems that exist in the specified pool, or all
66           pools, if no pool name is given.
67
68       filesystem destroy <pool_name> <fs_name> [<fs_name>..]
69           Destroy one or more filesystems that exist in the specified pool.
70
71       filesystem rename <pool_name> <fs_name> <new_name>
72           Rename a filesystem.
73
74       blockdev list [pool_name]
75           List all blockdevs that make up the specified pool, or all pools,
76           if no pool name is given.
77
78       daemon redundancy
79           List the redundancy levels that the Stratis service supports.
80
81       daemon version
82           Show the Stratis service’s version.
83

EXAMPLES

85       Example 1. Creating a Stratis pool
86
87       stratis pool create mypool /dev/sdb /dev/sdc
88
89       Example 2. Creating a filesystem from a pool
90
91       stratis filesystem create mypool data1
92

SEE ALSO

94       mount(8), umount(8), fstab(5)
95

REPORTING BUGS & DEVELOPMENT

97       GitHub for issues and development
98           https://github.com/stratis-storage, against either stratis-cli or
99           stratisd projects, based on likelihood of issue being with the
100           command-line tool or the service daemon.
101
102       Mailing list
103           stratis-devel@lists.fedorahosted.org for general development
104           discussion
105
106       Unknown values
107           stratis-cli uses the Stratis API. If the API returns values that
108           stratis-cli cannot interpret, stratis-cli will substitute "???". If
109           encountered, upgrading to the latest version of stratis-cli, or
110           filing an issue, is recommended.
111

LICENSE

113       stratis-cli is licensed under the Apache License, Version 2.0. Software
114       distributed under this license is distributed on an "AS IS" BASIS,
115       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either expressed or
116       implied.
117
118
119
120                                  05/14/2019                        STRATIS(8)
Impressum