Skip to content

Commit 32f21ac

Browse files
committed
separate steps into single actions and include troubleshooting section
1 parent a0761f5 commit 32f21ac

File tree

2 files changed

+48
-20
lines changed

2 files changed

+48
-20
lines changed

src/frontend/public/azure.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
11
# Running against your own Azure Service Bus system
22

3-
##
3+
1. Open a terminal and run the following command to shut down the showcase containers:
44

5-
1. Open the `src/asb.env` file in an editor and update the `CONNECTION_STRING` to point to your own Azure Service Bus namespace.
6-
2. Update the list of queues you want to monitor by editing the `queues.txt` file from the `src` folder. Remember that Azure Service Bus queues are all lowercased.
7-
3. Open a terminal and run these commands:
5+
```cmd
6+
docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env down
7+
```
88

9-
```cmd
10-
docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env down
11-
docker compose -p particular-platform -f docker-compose-base.yml --env-file asb.env --profile infrastructure up
12-
```
9+
- All of the containers should be shown as `Stopped` and there should no longer be any containers running under `particular-platform-showcase` in docker
10+
11+
1. Open the `src/asb.env` file, located in the folder that the showcase is cloned to, in an editor and update the `CONNECTION_STRING` to point to your own Azure Service Bus namespace.
12+
1. Update the list of queues you want to monitor by editing the `src/queues.txt` file, also located in the folder that the showcase is cloned to. Remember that Azure Service Bus queue names are all lowercase.
13+
1. Run the following command to start the required containers with the updated environment settings:
14+
15+
```cmd
16+
docker compose -p particular-platform -f docker-compose-base.yml --env-file asb.env --profile infrastructure up
17+
```
18+
19+
- The containers should all show a status of `Healthy`
20+
21+
## Troubleshooting
22+
23+
-
24+
-
25+
- If you encounter any other issues, ask on [our forum](https://discuss.particular.net/tag/masstransit)

src/frontend/public/rabbit.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
11
# Running with your own RabbitMQ system
22

3-
1. Open the `src/rabbit.env` file in an editor and update the RabbitMQ configuration to point to your own RabbitMQ instance.
4-
1. `CONNECTION_STRING` A special connection string to connect to RabbitMQ, see https://docs.particular.net/servicecontrol/transports#rabbitmq for syntax format.
5-
2. `RABBITMQ_MANAGEMENT_API_URL` The management API URL.
6-
3. `RABBITMQ_MANAGEMENT_API_USERNAME` The management API username.
7-
4. `RABBITMQ_MANAGEMENT_API_PASSWORD` The management API password.
8-
2. Update the list of queues you want to monitor by editing the `src/queues.txt` file. RabbitMQ is case-sensitive so make sure the names are exact. e.g. `myqueue_error`.
9-
3. Open a terminal and run these commands:
10-
11-
```cmd
12-
docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env down
13-
docker compose -p particular-platform -f docker-compose-base.yml -f compose-rabbitmq-user.yml --env-file rabbit.env --profile infrastructure up
14-
```
3+
1. Open a terminal and run the following command to shut down the showcase containers:
4+
5+
```cmd
6+
docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env down
7+
```
8+
9+
- All of the containers should be shown as `Stopped` and there should no longer be any containers running under `particular-platform-showcase` in docker
10+
11+
1. Open `src/rabbit.env` file, located in the folder that the showcase is cloned to, in an editor and update the RabbitMQ configuration to point to your own RabbitMQ instance.
12+
- `CONNECTION_STRING` A special connection string to connect to RabbitMQ, see https://docs.particular.net/servicecontrol/transports#rabbitmq for syntax format.
13+
- `RABBITMQ_MANAGEMENT_API_URL` The management API URL.
14+
- `RABBITMQ_MANAGEMENT_API_USERNAME` The management API username.
15+
- `RABBITMQ_MANAGEMENT_API_PASSWORD` The management API password.
16+
1. Update the list of queues you want to monitor by editing the `src/queues.txt` file, also located in the folder that the showcase is cloned to. RabbitMQ is case-sensitive so make sure the names are exact. e.g. `myqueue_error`.
17+
1. Run the following command to start the required containers with the updated environment settings:
18+
19+
```cmd
20+
docker compose -p particular-platform -f docker-compose-base.yml -f compose-rabbitmq-user.yml --env-file rabbit.env --profile infrastructure up
21+
```
22+
23+
- The containers should all show a status of `Healthy`
24+
25+
## Troubleshooting
26+
27+
-
28+
-
29+
- If you encounter any other issues, ask on [our forum](https://discuss.particular.net/tag/masstransit)

0 commit comments

Comments
 (0)