Debian Codegraph @

UG9/en/exos-linstor.adoc

raw
1 // vim: :set ft=asciidoc tw=70 fo-=a sw=8 ts=8 noet spell
2 [[ch-exos]]
3 == LINSTOR EXOS Integration
4
5 The https://www.seagate.com/support/raid-storage-systems/all-flash-and-disk-arrays/[EXOS]
6 storage manager from Seagate could be configured as one large block device managed by LINSTOR
7 like a local drive but this would prevent concurrent sharing of LINSTOR resources between
8 multiple servers out of the same pool.
9
10 LINSTOR integration with EXOS enables multiple server nodes to allocate and connect to
11 LINSTOR resources serviced by the same EXOS pool.
12 Thus all of the EXOS storage management features such as SSD/HDD tiering, SSD caching,
13 snapshots, and thin provisioning are available for LINSTOR resources and Kubernetes
14 Storage Classes.
15
16 After configuration, LINSTOR will dynamically map Resource replicas as LUNs
17 presented to server nodes through one of the two EXOS controllers.
18
19 Since the EXOS controllers are managed by a secure network API, LINSTOR must be configured
20 with proper networking and username/password combination. The diagram below is
21 showing the relationship between LINSTOR cluster and EXOS Enclosures.
22
23 image::images/linstor-exos-integration.png[ExosIntegeration]
24
25 IMPORTANT: Multi-host setup allows up to 8 LINSTOR nodes to be directly
26 connected with 48Gbit SAS links for low latency and high throughput.
27
28 Load balancing and server failover are managed & enabled by LINSTOR while
29 volume creation is handled by the EXOS hardware RAID engine.
30
31 The EXOS storage provider in LINSTOR offers native integration with EXOS' REST-API.
32
33 This section will describe how to enable EXOS integration and configure
34 LINSTOR to manage storage backed by an EXOS enclosure.
35
36 EXOS storage systems offer a feature rich set of configuration options to match
37 any enterprise storage demand. To maximize ease of use, this guide
38 is based on the following defaults and assumptions:
39
40 . Dual Controllers - EXOS systems controllers are Active/Active with automatic failover.
41 Both controllers IP address must be configured also in the LINSTOR properties for full support.
42
43 . Dual EXOS Pools - Optimal performance is achieved when data from pool A is
44 accessed through Controller A. If a node is connected to both Controller A and B of
45 same controller, LINSTOR will configure Linux multipath which will detect best route.
46
47 . EXOS Pool Serial Numbers - When a EXOS pool is created, it receives a unique serial number.
48 Each one has to be configured as a backing storage in LINSTOR to create a link between EXOS
49 enclosure & LINSTOR. With that information, LINSTOR can understand if you are referring to
50 EXOS Pool A or Pool B.
51
52 . Creating EXOS Pools - The administrator is required to create EXOS Pools A and B prior to
53 configuring LINSTOR. EXOS features such as thin provisioning, auto tiering, and snapshot options
54 are selected at this time.
55
56 . Replicas Within Enclosures - EXOS system have redundant controllers, power supplies and
57 communication paths to the drives. Some administrators may desire that resource replicas
58 are not stored in the same enclosure. In this case the administrator must create multiple
59 LINSTOR Pools configured with only one EXOS pool member from each enclosure.
60
61 === EXOS Properties as a LINSTOR Storage Provider
62
63 LINSTOR's native integration with EXOS is configured by setting a few properties on the
64 LINSTOR Controller and creating the appropriate LINSTOR objects specific to your EXOS
65 enclosures, as described in the sections below.
66
67 The information in the table below is needed from your EXOS
68 enclosures. This information will be used to populate the
69 appropriate LINSTOR Controller properties and LINSTOR objects in the
70 sub-sections that follow.
71
72 .Required Information
73 [cols="2,5,2",opts="header,100%"]
74 |===
75 |*EXOS Information*|*Description*|*Placeholder in Command Examples*
76 |EXOS Enclosure Name|Uniquely selected by the Admin for a given EXOS enclosure|`<exos_encl_name>`
77 |Controller Hostname|The DNS resolvable hostname for one of the Controllers |`<exos_ctrlr_name>`
78 |Controller IP|IP address of controller |`<exos_ctrlr_ip>`
79 |REST-API Username|Username for REST-API of all EXOS controllers under the given enclosure|`<exos_rest_user>`
80 |REST-API Password|Password for REST-API of all EXOS controllers under the given enclosure|`<exos_rest_pass>`
81 |EXOS Pool Serial Number|The serial number of an EXOS pool to become a member of a LINSTOR Pool|`<exos_pool_sn>`
82 |===
83
84 === Configuration Steps
85
86 Configuring a topology of LINSTOR server nodes and multiple EXOS Storage systems is described by these steps:
87
88 . Set global or unique EXOS Controller usernames and passwords.
89
90 . Define EXOS enclosures and Controller network identities.
91
92 . Create node to enclosure to pool mapping matching physical SAS cabling.
93
94
95
96 ==== Step 1: EXOS Usernames and Passwords
97
98 Usernames and passwords can be unique for each EXOS enclosure or
99 be common for all enclosures depending on how the system administrator
100 has deployed the EXOS systems.
101 The default EXOS username and password will be used if not set for a given
102 EXOS controller.
103 The defaults are set as follows:
104
105 [bash]
106 ----
107 # linstor exos set-defaults --username <exos_rest_name>
108 # linstor exos set-defaults --password <exos_rest_pass>
109 ----
110
111 Unique usernames and passwords For EXOS controllers are set by:
112
113 [bash]
114 ----
115 # linstor controller set-property
116 StorDriver/Exos/<exos_encl_name>/username <exos_rest_name>
117 # linstor controller set-property
118 StorDriver/Exos/<exos_encl_name>/Password <exos_rest_pass>
119 ----
120
121 WARNING: Passwords entered in this fashion will
122 show up as plaintext when using `get-defaults`.
123
124 With the above command, LINSTOR will store your password in cleartext
125 in the LINSTOR properties and visible by a simple
126 `linstor controller list-properties` command. You can hide it under
127 an environment variable, and use the `UsernameEnv` and/or `PasswordEnv`
128 properties. This tells LINSTOR to look in environment variable for the
129 actual username/password, as shown in the following example:
130
131 IMPORTANT: LINSTOR will not modify the environment variables, only read
132 from them. Storage admin has to make sure the env-vars are correctly set.
133
134 [bash]
135 ----
136 # echo $EXOS_PW
137 mySecretPassword
138 # linstor controller set-property \
139 StorDriver/Exos/<exos_encl_name>/PasswordEnv EXOS_PW
140 ----
141
142 If both property-versions (i.e. `Password` and `PasswordEnv`) are set,
143 the non-environment version is preferred.
144
145 NOTE: If the satellite is started before the environment variable is
146 set, the satellite needs to be restarted in order to see the new
147 environment variable
148
149
150 ==== Step 2: Define EXOS enclosures and controller identities.
151
152 Registering an EXOS enclosure in LINSTOR can be done with the `create`
153 command:
154
155 [bash]
156 ----
157 # linstor exos create <exos_encl_name> <exos_ctrl_a_ip> [<exos_ctrl_b_ip>]
158 ----
159
160 If no special `--username` or `--password` is given, the above mentioned
161 defaults are used.
162
163 The Controller's DNS name and IP address may be used interchangeably.
164
165 TIP: If you wish to use a hostname that is not DNS resolvable to
166 reference your EXOS enclosure within LINSTOR, you may use any name in
167 place of `<exos_hostname>`, but you will also have to supply the
168 enclosure's IP address: `linstor node create <desired_name> <enclosure_ip>`
169
170 Use the following example to create and inspect the current controller settings:
171
172 [bash]
173 ----
174 # linstor exos create Alpha 172.16.16.12 172.16.16.13
175 # linstor exos list
176 +------------------------------------------------------------------+
177 | Enclosure | Ctrl A IP | Ctrl B IP | Health | Health Reason |
178 |==================================================================|
179 | Alpha | 172.16.16.12 | 172.16.16.13 | OK | |
180 +------------------------------------------------------------------+
181 ----
182
183 For a more in-depth view, you can always ask the LINSTOR controller
184 and/or the LINSTOR nodes for the `Exos`-related properties:
185
186 [bash]
187 ----
188 # linstor controller list-properties | grep Exos
189 | StorDriver/Exos/Alpha/A/IP | 172.16.16.12 |
190 | StorDriver/Exos/Alpha/B/IP | 172.16.16.13 |
191 ----
192
193
194 ==== Step 3: Create Node to Enclosure to Pool mapping.
195
196 A LINSTOR Satellite node can be created as usual.
197
198 [bash]
199 ----
200 # linstor node create <satellite_hostname>
201 ----
202
203 The storage pool can also be created as usual in LINSTOR. Only
204 the name of the previously registered EXOS enclosure as well as the
205 serial number of the EXOS pool needs to be specified:
206
207 [bash]
208 ----
209 # linstor storage-pool create exos \
210 <satellite_hostname> <linstor_pool_name> <exos_encl_name> <exos_pool_sn>
211 ----
212
213 the linstor_pool_name can be set to (almost) any unique string for
214 the LINSTOR deployment.
215
216 Here is an example of mapping an EXOS Pool in EXOS enclosure Alpha to two Satellite nodes:
217
218 [bash]
219 ----
220 # linstor storage-pool create exos \
221 node1 poolA Alpha 00c0ff29a5f5000095a2075d01000000
222 # linstor storage-pool create exos \
223 node2 poolA Alpha 00c0ff29a5f5000095a2075d01000000
224 ----
225
226 After creating an `exos` storage pool the LINSTOR Satellite will scan
227 the given EXOS enclosure for connected ports. If cabled, these ports will be
228 listed in the following command:
229
230 [bash]
231 ----
232 # linstor exos map -p
233 +----------------------------------------------+
234 | Node Name | Enclosure Name | Connected Ports |
235 |==============================================|
236 | node1 | Alpha | A0, B0 |
237 | node2 | Alpha | A1, B1 |
238 +----------------------------------------------+
239 ----
240
241 The pool configuration is shown by:
242
243 [bash]
244 ----
245 hr01u09:~ # linstor sp list -s poolA -p
246 +----------------------------------------------------------------------------------------------+
247 | StoragePool | Node | Driver | PoolName | FreeCapacity | ... |
248 |==============================================================================================|
249 | poolA | node1 | EXOS | Alpha_00c0ff29a5f5000095a2075d01000000 | 581 TiB | ... |
250 | poolA | node2 | EXOS | Alpha_00c0ff29a5f5000095a2075d01000000 | 581 TiB | ... |
251 +----------------------------------------------------------------------------------------------+
252 ----
253
254 Detailed description of all the available EXOS commands is found with built in help.
255
256
257 [bash]
258 ----
259 # linstor exos -h
260 ----
261
262
263 === Creating Resources Backed by EXOS Storage Pools
264
265 Creating LINSTOR resources from EXOS backed storage-pools follows
266 normal LINSTOR usage patterns as described in other sections of the
267 LINSTOR User's Guide such as the sections describing
268 <<s-linstor-resource-groups,LINSTOR resource groups>> or the more
269 granular
270 <<s-linstor-new-volume,resource-definition, volume-definition,
271 resource creation>> workflow.