Skip to content

Commit 2f2d960

Browse files
author
Arkmq Bot
committed
Update docs to main
1 parent da16e21 commit 2f2d960

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

Diff for: content/en/docs/help/building.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ toc: true
1919

2020
### Go
2121

22-
Download the Go version v1.21.11 from the [download page](https://go.dev/dl/) and install it following the [installation instructions](https://go.dev/doc/install).
22+
Download the Go version v1.22.7 from the [download page](https://go.dev/dl/) and install it following the [installation instructions](https://go.dev/doc/install).
2323

2424
### Operator SDK
2525

Diff for: content/en/docs/help/operator.md

+22-4
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ spec:
628628

629629
### Tolerations
630630

631-
It is possible to configure tolerations on tge deployed broker image . An example of a toleration would be something like:
631+
It is possible to configure tolerations on the deployed broker image . An example of a toleration would be something like:
632632

633633
```yaml
634634
apiVersion: broker.amq.io/v1beta1
@@ -1065,6 +1065,10 @@ The operator supports a level of indirection when resolving versions, there are
10651065
The operator will validate the a CR specifies both image and initImage or a Version. It will also validate that a speficied version matches the internal list of supported versions.
10661066
The CR Status sub resource will contain feedback via the Valid Condition if validation fails.
10671067

1068+
## Disabling reconcile with the `arkmq.org/block-reconcile` annotation
1069+
1070+
In cases where a rollout of the stateful set is necessitated via a new feature or bug fix but not immediately desirable, potentially because of the necessary broker restart, it is possible to block the reconcile of a CR. Applying the `arkmq.org/block-reconcile` boolean annotation to a CR will indicate that the operator should not reconcile the CR. The CR status will reflect the blocked state via an additional `ReconcileBlocked` Condition. Once the annotation is removed or set to false on the CR, reconcile will resume.
1071+
10681072

10691073
## Enable broker's metrics plugin
10701074

@@ -1223,11 +1227,25 @@ The operator uses jolokia endpoints to get broker status and also create queue/a
12231227

12241228
To gain access to jolokia the operator need to have proper credentials (username/password).
12251229

1226-
By default the operator gets the username and password from the broker container's environment variables AMQ_USER and AMQ_PASSWORD. The operator exposes the environment variables with the values defined in the broker CR's **spec.adminUser** and **spec.adminPassword** fields.
1230+
By default, the operator retrieves the username and password from the broker container's environment variables `AMQ_USER` and `AMQ_PASSWORD`. These environment variables are populated with values from the secret **[broker CR name]-credentials-secret**, using the `AMQ_USER` and `AMQ_PASSWORD` keys.
1231+
1232+
If you specify adminUser and adminPassword in the broker CR, these values will be written to the auto-generated secret **[broker CR name]-credentials-secret**, using the `AMQ_USER` and `AMQ_PASSWORD` keys.
12271233

1228-
If you configure **adminUser** and **adminPassword** in the broker CR the values will be populated into the environment variables AMQ_USER and AMQ_PASSWORD respectively.
1234+
Alternatively, you can provide your own secret named **[broker CR name]-credentials-secret**, which must contain four entries: `AMQ_USER` / `AMQ_PASSWORD` for administrative access, and `AMQ_CLUSTER_USER` / `AMQ_CLUSTER_PASSWORD` for intra-cluster communication.
12291235

1230-
Alternatively you can provide a secret called **[broker cr name]-credential-secret** within which contains 2 entries whose keys are `AMQ_USER` and `AMQ_PASSWORD` respectively, with corresponding values for each.
1236+
```yaml
1237+
apiVersion: v1
1238+
metadata:
1239+
name: amq-credentials-secret
1240+
namespace: default
1241+
kind: Secret
1242+
type: Opaque
1243+
stringData:
1244+
AMQ_USER: admin
1245+
AMQ_PASSWORD: adminPassword
1246+
AMQ_CLUSTER_USER: cluster
1247+
AMQ_CLUSTER_PASSWORD: clusterPassword
1248+
```
12311249

12321250
However when you use security CRs, jass login module configs, or init container to configure security login modules,
12331251
The above adminUser and adminPassword may be overridden and jolokia client in the operator won't be able to get the correct credentials to connect to the broker. In that case the user should provide a secret called **[broker cr name]-jolokia-secret**, in which you put 2 entries for username and password for jolokia credential to use. The 2 entries should have keys named **jolokiaUser** and **jolokiaPassword** respectively, the value for **jolokiaUser** is the user name and the value for **jolokiaPassword** is the password.

0 commit comments

Comments
 (0)