Files
my-rook-config/Documentation/pool-crd.md
T

46 lines
1.6 KiB
Markdown
Raw Normal View History

---
2017-08-08 14:03:04 -07:00
title: Pool CRD
weight: 16
indent: true
---
2017-03-27 09:12:56 -07:00
# Creating Rook Storage Pools
2017-08-08 14:03:04 -07:00
Rook allows creation and customization of storage pools through the custom resource definitions (CRDs). The following settings are available
2017-03-27 09:12:56 -07:00
for pools.
## Sample
2017-09-14 16:09:23 -07:00
```yaml
2017-04-10 12:42:02 -07:00
apiVersion: rook.io/v1alpha1
kind: Pool
2017-03-27 09:12:56 -07:00
metadata:
name: ecpool
namespace: rook
2017-04-10 08:47:16 -07:00
spec:
replicated:
2017-04-10 08:47:16 -07:00
# size: 3
erasureCoded:
2017-03-27 09:12:56 -07:00
dataChunks: 2
codingChunks: 1
2017-03-27 09:12:56 -07:00
```
## Pool Settings
### Metadata
2017-04-10 08:47:16 -07:00
- `name`: The name of the pool to create.
- `namespace`: The namespace of the Rook cluster where the pool is created.
2017-03-27 09:12:56 -07:00
### Spec
- `replicated`: Settings for a replicated pool. If specified, `erasureCoded` settings must not be specified.
2017-04-10 08:47:16 -07:00
- `size`: The number of copies of the data in the pool.
- `erasureCoded`: Settings for an erasure-coded pool. If specified, `replicated` settings must not be specified.
- `dataChunks`: Number of data chunks per object in an erasure coded storage pool
- `codingChunks`: Number of coding chunks per object in an erasure coded storage pool
2017-10-05 17:23:12 -07:00
- `failureDomain`: The failure domain across which the replicas or chunks of data will be spread. Possible values are `osd` or `host`,
with the default of `host`. For example, if you have replication of size `3` and the failure domain is `host`, all three copies of the data will be
placed on osds that are found on unique hosts. In that case you would be guaranteed to tolerate the failure of two hosts. If the failure domain were `osd`,
you would be able to tolerate the loss of two devices. Similarly for erasure coding, the data and coding chunks would be spread across the requested failure domain.