Merge branch 'mkuratczyk-live' into live

rabbitmq · Jul 22, 2020 · a18e7ca · a18e7ca
2 parents eb19b2c + e82a77b
commit a18e7ca
Showing 1 changed file with 43 additions and 0 deletions.
diff --git a/site/kubernetes/operator/using-operator.md b/site/kubernetes/operator/using-operator.md
@@ -436,6 +436,38 @@ spec:
     secretName: rabbitmq-server-certs
 </pre>
 
+### <a name='override' class='anchor' href='#override'>Override Resource Properties</a>
+
+**Description:** Use with caution! Customize resources created by the operator by overriding their properties or providing additional settings. This is an advanced feature that allows you to enable features that are not explicitly supported but can easily render your RabbitMQ Cluster unusable if used incorrectly. You can customize the StatefulSet and the Service used by client applications. The values for <code>spec.override.statefulSet</code> and <code>spec.override.clientService</code> should match [StatefulSet object](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#statefulset-v1-apps) and [Service object](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#service-v1-core) specification respectively.
+
+**Default Value:** N/A
+
+**Example:**
+
+<pre class="lang-yaml">
+apiVersion: rabbitmq.com/v1beta1
+kind: RabbitmqCluster
+metadata:
+  name: additional-port
+spec:
+  override:
+    clientService:
+      spec:
+        ports:
+          - name: additional-port # adds an additional port on the client service
+            protocol: TCP
+            port: 12345
+    statefulSet:
+      spec:
+        template:
+          spec:
+            containers:
+              - name: rabbitmq
+                ports:
+                  - containerPort: 12345 # opens an additional port on the rabbitmq server container
+                    name: additional-port
+                    protocol: TCP
+</pre>
 
 ## <a id='update' class='anchor' href='#update'>Update a RabbitMQ Instance</a>
 
@@ -607,6 +639,17 @@ The configurations are listed in the table below.
 	section for the list of always generated configuration.
       </td>
     </tr>
+    <tr>
+      <td>
+        <code>spec.override</code>
+      </td>
+      <td>
+        Arbitrary overrides to the resources created by RabbitMQ Cluster Kubernetes Operator. This feature should be
+        used with <strong>great care</strong> as overriding essential properties can render a RabbitMQ cluster unusable
+        to applications or unreachable to the Operator.
+        See the <a href='#override'>Override section</a> to learn more.
+      </td>
+    </tr>
     </col>
 </table>