Merge pull request #16789 from travisn/ec-optimization

docs: Add pool parameter for erasure code optimizations

Documentation/CRDs/Block-Storage/ceph-block-pool-crd.md

@@ -70,6 +70,10 @@ spec:
     dataChunks: 4
     codingChunks: 2
   deviceClass: hdd
+  parameters:
+    # Ceph Tentacle v20 has optimizations that need to be explicitly enabled.
+    # Remove this setting for pre-Tentacle pools.
+    allow_ec_optimizations: "true"
 ```
 
 Various combinations of `dataChunks` and `codingChunks` values are possible, with
@@ -318,3 +322,9 @@ The `failureDomain` must be also be taken into account when determining the numb
 If you do not have a sufficient number of hosts or OSDs for unique placement the pool can be created, writing to the pool will hang and Ceph will report `undersized` or `incomplete` placement groups.
 
 Rook currently only configures two levels in the CRUSH map. It is also possible to configure other levels such as `rack` with by adding [topology labels](../Cluster/ceph-cluster-crd.md#osd-topology) to the nodes.
+
+!!! tip
+    Ceph Tentacle v20 has optimizations that need to be explicitly enabled.
+    Set the following parameter in the pool spec of erasure coded pools:
+    parameters:
+        allow_ec_optimizations: "true"

Documentation/CRDs/Object-Storage/ceph-object-store-crd.md

@@ -31,6 +31,9 @@ spec:
     erasureCoded:
       dataChunks: 2
       codingChunks: 1
+    parameters:
+      # Ceph Tentacle v20 has optimizations that need to be explicitly enabled
+      # allow_ec_optimizations: "true"
   preservePoolsOnDelete: true
   gateway:
     # sslCertificateRef:

Documentation/Storage-Configuration/Object-Storage-RGW/object-storage.md

@@ -54,6 +54,9 @@ spec:
     erasureCoded:
       dataChunks: 2
       codingChunks: 1
+    parameters:
+      # Ceph Tentacle v20 has optimizations that need to be explicitly enabled
+      # allow_ec_optimizations: "true"
   preservePoolsOnDelete: true
   gateway:
     # sslCertificateRef:

deploy/examples/object-ec.yaml

@@ -42,6 +42,9 @@ spec:
       # gives a hint (%) to Ceph in terms of expected consumption of the total cluster capacity of a given pool
       # for more info: https://docs.ceph.com/docs/master/rados/operations/placement-groups/#specifying-expected-pool-size
       #target_size_ratio: ".5"
+      # Ceph Tentacle v20 has optimizations that need to be explicitly enabled
+      # allow_ec_optimizations: "true"
+
   # Whether to preserve metadata and data pools on object store deletion
   preservePoolsOnDelete: true
   # The gateway service configuration

deploy/examples/object-shared-pools.yaml

@@ -47,3 +47,6 @@ spec:
     dataChunks: 2
     codingChunks: 1
   application: rgw
+  parameters:
+    # Ceph Tentacle v20 has optimizations that need to be explicitly enabled
+    # allow_ec_optimizations: "true"

deploy/examples/pool-ec.yaml

@@ -21,3 +21,5 @@ spec:
   parameters:
     # Inline compression mode for the data pool
     compression_mode: none
+    # Ceph Tentacle v20 or newer has EC optimizations that need to be explicitly enabled
+    # allow_ec_optimizations: "true"