Improve tryit doco (#118)

* include some images of docker succes statuses

* remainder of tryit images for rabbit

* revert accidental checkin

* A few small changes

* A few more improvements with added commands

* Added images to Azure

---------

Co-authored-by: John Simons <[email protected]>

Author: PhilBastian

README.md

@@ -13,9 +13,11 @@ To help getting started we have created a few docker compose files that orchestr
 * Third, run the following command:
 
 ```cmd
-docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env up -d
+docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env up -d --build
 ```
 
+![Docker Compose Up](docs/compose-up.png "Docker Compose up results")
+
 ### (Alternative) Run in Docker against **Azure Service Bus**
 
 <details>
@@ -29,7 +31,7 @@ CONNECTIONSTRING="Endpoint=sb://[NAMESPACE].servicebus.windows.net/;SharedAccess
 Run docker command below from the `src` folder in a terminal.
 
 ```cmd
-docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env up -d
+docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env up -d --build
 ```
 
 </details>

docs/azure.md

@@ -3,30 +3,39 @@
 If you encounter any issues running the steps below, try the [troubleshooting](#troubleshooting) section or post a question on [our forum](https://discuss.particular.net/tag/masstransit).
 
 1. Open a terminal and run the following command to shut down the showcase containers if they are running:
-
    ```cmd
    docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-azure.yml --env-file asb.env down
    ```
+   All of the containers should be shown as `Removed` and there should no longer be any containers running under `particular-platform-showcase` in docker.
 
-   - All of the containers should be shown as `Stopped` and there should no longer be any containers running under `particular-platform-showcase` in docker
+   ![Docker Compose Down](./compose-down-azure.png "Docker Compose down results")
 
 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.
+1. To validate that the broker can be reached, run the following command:
+   ```cmd
+   docker run --env-file asb.env --rm particular/servicecontrol-masstransit-connector:latest health-check
+   ```
 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.
+   To automate this task you can run the following CLI command:
+   ```cmd
+   docker run --env-file asb.env --rm particular/servicecontrol-masstransit-connector:latest queues-list
+   ```
+   The command above will output a list of queues, that can be copy-paste into the `src/queues.txt`. **Please ensure you review this list**.
 1. Run the following command to start the required containers with the updated environment settings:
-
    ```cmd
-   docker compose -p particular-platform -f docker-compose-base.yml --env-file asb.env --profile infrastructure up
+   docker compose -p particular-platform -f docker-compose-base.yml --env-file asb.env --profile infrastructure up -d
    ```
 
-   - The containers should all show a status of `Healthy`
-
-1. Verify that the setup was correct by navigating to http://localhost:9090/#/configuration/mass-transit-connector.
-   - All of the configured queues for your system should show here
-   - For each row in the list of queues: if the queues exist, the status should be green `OK`. If the queues don't exist, i.e. there have never been any errors on that consumer, or if there is an issue connecting to the broker then the status will be red `Not ingesting`.
-     - If the status is `Not ingesting`, the reason for this can be found in the log entries shown below the queue list.
-   - Any messages that existed in the error queues should now have been ingested, and will be shown in [Failed Messages](http://localhost:9090/#/failed-messages/all-failed-messages)
+   ServiceControl should show a status of `Healthy`.
 
-## Troubleshooting
+   ![Docker Compose Infrastructure](./compose-infrastructure-up.png "Docker Compose up infrastructure only").
+   
+   Docker should now show a `particular-platform` container group.
+   
+   ![Docker running infrastructure](./local-rabbit-docker.png "Docker running infrastructure")
 
--
--
+1. Verify that the setup was correct by navigating to http://localhost:9090/#/configuration/mass-transit-connector.
+   - All of the configured queues for your system should show here.
+   - For each row in the list of queues: if the queues exist, the status should be green. If the queues don't exist, i.e. there have never been any errors on that consumer, or if there is an issue connecting to the broker then the status will be red.
+     - If the status is red, the reason for this can be found in the log entries shown below the queue list.
+   - Any messages that existed in the error queues should now have been ingested, and will be shown in [Failed Messages](http://localhost:9090/#/failed-messages/all-failed-messages).

docs/compose-down-azure.png

@@ -3,34 +3,43 @@
 If you encounter any issues running the steps below, try the [troubleshooting](#troubleshooting) section or ask on [our forum](https://discuss.particular.net/tag/masstransit).
 
 1. Open a terminal and run the following command to shut down the showcase containers:
-
    ```cmd
    docker compose -p particular-platform-showcase -f docker-compose-base.yml -f compose-rabbitmq.yml --env-file rabbit.env down
    ```
-
-   - All of the containers should be shown as `Stopped` and there should no longer be any containers running under `particular-platform-showcase` in docker
+   All of the containers should be shown as `Removed` and there should no longer be any containers running under `particular-platform-showcase` in docker.
+   
+   ![Docker Compose Down](./compose-down-rabbit.png "Docker Compose down results")
 
 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.
-   - `CONNECTION_STRING` A special connection string to connect to RabbitMQ, see https://docs.particular.net/servicecontrol/transports#rabbitmq for syntax format.
-   - `RABBITMQ_MANAGEMENT_API_URL` The management API URL.
+   - `CONNECTION_STRING` A special connection string to connect to RabbitMQ, see https://docs.particular.net/servicecontrol/transports#rabbitmq for syntax format. NOTE: if your RabbitMQ instance is hosted locally in docker, your connection string will be `host=host.docker.internal;port=<external_docker_port_for_5672>`
+   - `RABBITMQ_MANAGEMENT_API_URL` The management API URL. NOTE: as above, if hosted locally in docker this will be `http://host.docker.internal:<external_docker_port_for_15672>`
    - `RABBITMQ_MANAGEMENT_API_USERNAME` The management API username.
    - `RABBITMQ_MANAGEMENT_API_PASSWORD` The management API password.
+1. To validate that the broker can be reached, run the following command:
+   ```cmd
+   docker run --env-file rabbit.env --rm particular/servicecontrol-masstransit-connector:latest health-check
+   ```
 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`.
+   To automate this task you can run the following CLI command:
+   ```cmd
+   docker run --env-file rabbit.env --rm particular/servicecontrol-masstransit-connector:latest queues-list
+   ```
+   The command above will output a list of queues, that can be copy-paste into the `src/queues.txt`. **Please ensure you review this list**.
 1. Run the following command to start the required containers with the updated environment settings:
-
    ```cmd
-   docker compose -p particular-platform -f docker-compose-base.yml -f compose-rabbitmq-user.yml --env-file rabbit.env --profile infrastructure up
+   docker compose -p particular-platform -f docker-compose-base.yml -f compose-rabbitmq-user.yml --env-file rabbit.env --profile infrastructure up -d
    ```
 
-   - The containers should all show a status of `Healthy`
+   ServiceControl should show a status of `Healthy`.
 
-1. Verify that the setup was correct by navigating to http://localhost:9090/#/configuration/mass-transit-connector.
-   - All of the configured queues for your system should show here
-   - For each row in the list of queues: if the queues exist, the status should be green `OK`. If the queues don't exist, i.e. there have never been any errors on that consumer, or if there is an issue connecting to the broker then the status will be red `Not ingesting`.
-     - If the status is `Not ingesting`, the reason for this can be found in the log entries shown below the queue list.
-   - Any messages that existed in the error queues should now have been ingested, and will be shown in [Failed Messages](http://localhost:9090/#/failed-messages/all-failed-messages)
+   ![Docker Compose Infrastructure](./compose-infrastructure-up.png "Docker Compose up infrastructure only").
 
-## Troubleshooting
+   Docker should now show a `particular-platform` container group.
 
--
--
+   ![Docker running infrastructure](./local-rabbit-docker.png "Docker running infrastructure")
+
+1. Verify that the setup was correct by navigating to http://localhost:9090/#/configuration/mass-transit-connector.
+   - All of the configured queues for your system should show here.
+   - For each row in the list of queues: if the queues exist, the status should be green. If the queues don't exist, i.e. there have never been any errors on that consumer, or if there is an issue connecting to the broker then the status will be red.
+     - If the status is red, the reason for this can be found in the log entries shown below the queue list.
+   - Any messages that existed in the error queues should now have been ingested, and will be shown in [Failed Messages](http://localhost:9090/#/failed-messages/all-failed-messages).