Skip to content

Commit 105d1f7

Browse files
vgavinashGitHub Enterprise
authored andcommitted
Update developer-config.md (#702)
* Update developer-config.md This is as per #576. * Review comment incorporated * Added review comments of David & Arthur This involves all the revamp suggested. * Update developer-config.md * Latest review * Update developer-config.md
1 parent 9c74072 commit 105d1f7

File tree

1 file changed

+21
-19
lines changed

1 file changed

+21
-19
lines changed

docs/developer-config.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,41 @@
22

33
If you build this image with MQ Advanced for Developers, then an optional set of configuration can be applied automatically. This configures your Queue Manager with a set of default objects that you can use to quickly get started developing with IBM MQ. If you do not want the default objects to be created you can set the `MQ_DEV` environment variable to `false`.
44

5-
## Environment variables
6-
7-
The MQ Developer Defaults supports some customization options, these are all controlled using environment variables:
8-
9-
* **MQ_DEV** - Set this to `false` to stop the default objects being created.
10-
* **MQ_ADMIN_PASSWORD** - Specify the password of the `admin` user. Must be at least 8 characters long.
11-
* **MQ_APP_PASSWORD** - Specify the password of the `app` user. If set, this will cause the `DEV.APP.SVRCONN` channel to become secured and only allow connections that supply a valid userid and password. Must be at least 8 characters long.
12-
13-
From IBM MQ v9.4.0.0, environment variables MQ_ADMIN_PASSWORD and MQ_APP_PASSWORD are deprecated. Secrets must be used to set the passwords for `admin` and `app` user.
14-
155
## Using Secrets to set passwords for app & admin users
166

177
Secrets must be used to set the passwords for `admin` and `app` user. For setting password for user `admin`, `mqAdminPassword` secret must be created and for user `app`, `mqAppPassword` secret must be created.
188

199
### Example usage with podman:
2010

21-
Creates a podman secret with secret name as “mqAppPassword”:
11+
Create podman secrets with secret names as “mqAdminPassword” & "mqAppPassword":
2212

13+
- `printf "passw0rd" | podman secret create mqAdminPassword -`
2314
- `printf "passw0rd" | podman secret create mqAppPassword -`
2415

25-
Run container referencing mounted secret:
26-
- `podman run --secret mqAppPassword,type=mount,mode=0777 --env LICENSE=accept --env MQ_QMGR_NAME=QM1 --publish 1414:1414 --publish 9443:9443 --detach --name QM1 icr.io/ibm-messaging/mq:latest`
16+
Run container referencing mounted secrets:
17+
- `podman run --secret mqAdminPassword,type=mount,mode=0777 --secret mqAppPassword,type=mount,mode=0777 --env LICENSE=accept --env MQ_QMGR_NAME=QM1 --publish 1414:1414 --publish 9443:9443 --detach --name QM1 icr.io/ibm-messaging/mq:latest`
2718

2819
### Example usage with docker:
2920

3021
Docker secrets are only available via Docker Swarm services, hence to create a secret using docker, Docker Swarm must be used.
3122

32-
Creates a docker secret with secret name as “mqAppPassword”:
23+
Create docker secrets with secret names as “mqAdminPassword” & "mqAppPassword":
3324

25+
- `printf "passw0rd" | docker secret create mqAdminPassword –`
3426
- `printf "passw0rd" | docker secret create mqAppPassword –`
3527

3628
Run container referencing mounted secret:
37-
- `docker service create --secret mqAppPassword --env LICENSE=accept --env MQ_QMGR_NAME=QM8 --publish 1414:1414 --publish 9443:9443 --detach --name QM8 icr.io/ibm-messaging/mq`
29+
- `docker service create --secret mqAdminPassword --secret mqAppPassword --env LICENSE=accept --env MQ_QMGR_NAME=QM8 --publish 1414:1414 --publish 9443:9443 --detach --name QM8 icr.io/ibm-messaging/mq`
30+
31+
## Environment variables
32+
33+
From IBM MQ v9.4.0.0, environment variables `MQ_ADMIN_PASSWORD` and `MQ_APP_PASSWORD` are deprecated. Secrets as detailed in the previous section must be used to set the passwords for `admin` and `app` user.
34+
35+
The MQ Developer Defaults supports some customization options, these are all controlled using environment variables:
36+
37+
* **MQ_DEV** - Set this to `false` to stop the default objects being created.
38+
* **MQ_ADMIN_PASSWORD** - Specify the password of the `admin` user. Must be at least 8 characters long.
39+
* **MQ_APP_PASSWORD** - Specify the password of the `app` user. If set, this will cause the `DEV.APP.SVRCONN` channel to become secured and only allow connections that supply a valid userid and password. Must be at least 8 characters long.
3840

3941

4042
## Details of the default configuration
@@ -56,18 +58,18 @@ The following queues and topics are created:
5658

5759
Two channels are created, one for administration, the other for normal messaging:
5860

59-
* DEV.ADMIN.SVRCONN - configured to only allow the `admin` user to connect into it. A user and password must be supplied.
60-
* DEV.APP.SVRCONN - does not allow administrative users to connect. Password is optional unless you choose a password for app users.
61+
* DEV.ADMIN.SVRCONN - configured to only allow the admin user to connect into it. The `admin` user can be used with the password configured via secret.
62+
* DEV.APP.SVRCONN - does not allow administrative users to connect. Only the `app` user can connect. The password would be as configured by the secret.
6163

6264
## Web Console
6365

6466
By default the MQ Advanced for Developers image will start the IBM MQ Web Console that allows you to administer your Queue Manager running on your container. When the web console has been started, you can access it by opening a web browser and navigating to `https://<Container IP>:9443/ibmmq/console`. Where `<Container IP>` is replaced by the IP address of your running container.
6567

6668
When you navigate to this page you may be presented with a security exception warning. This happens because, by default, the web console creates a self-signed certificate to use for the HTTPS operations. This certificate is not trusted by your browser and has an incorrect distinguished name.
6769

68-
If you choose to accept the security warning, you will be presented with the login menu for the IBM MQ Web Console. The default login for the console is:
70+
If you choose to accept the security warning, you will be presented with the login menu for the IBM MQ Web Console. The login for the console is:
6971

7072
* **User:** admin
71-
* **Password:** No password by default. The password for the admin user must be specified using the `MQ_ADMIN_PASSWORD` environment variable.
73+
* **Password:** The password for the `admin` user must be specified using a secret, as described above.
7274

7375
If you do not wish the web console to run, you can disable it by setting the environment variable `MQ_ENABLE_EMBEDDED_WEB_SERVER` to `false`.

0 commit comments

Comments
 (0)