Merge pull request #263 from DefangLabs/linda-bullmq

Bullmq changes

Author: jordanstephens

samples/bullmq-bullboard-redis/README.md

@@ -2,29 +2,66 @@
 
 [![1-click-deploy](https://defang.io/deploy-with-defang.png)](https://portal.defang.dev/redirect?url=https%3A%2F%2Fgithub.com%2Fnew%3Ftemplate_name%3Dsample-bullmq-bullboard-redis-template%26template_owner%3DDefangSamples)
 
-This sample project demonstrates how to deploy a BullMQ message queue on top of managed Redis with a queue processor and a dashboard to monitor the queue.
+This sample demonstrates how to deploy a BullMQ message queue on top of managed Redis with a queue processor and a dashboard to monitor the queue.
 
-Once your app is up and running you can go to the `/board` route for the `board` service to see the Bull Board dashboard and use the username `admin` and the password you set to log in (see [Deploying](#deploying)).
+Once your app is up and running you can go to the `/board` route for the `board` service to see the Bull Board dashboard and use the username `admin` and the board password you set to log in (see [Configuration](#configuration)).
 
-To add a job to the queue, you can go to the `/add` route of the `api` service. This will use some default values so you can test things out. You can also see an example of a post request in the [sample http request](./api/add.test.http) file.
+To add a job to the queue, you can go to the `/add` route of the `api` service. This will use some default values so you can test things out. You can also see an example of a post request in the [sample HTTP request](./api/add.test.http) file.
 
 The `worker` service is the queue processor that will process the jobs added to the queue. You can see in the `compose.yaml` file that the `worker` service is set to scale to 2 instances. This means that there will be 2 workers processing jobs from the queue. You can set this to your desired number of workers, but we wanted to show how you can increase the number of workers to handle more jobs.
 
 ## Prerequisites
 
-1. Download <a href="https://github.com/defang-io/defang">Defang CLI</a>
-2. (optional) If you are using <a href="https://docs.defang.io/docs/concepts/defang-byoc">Defang BYOC</a>, make sure you have properly <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html">authenticated your AWS account</a>.
+1. Download [Defang CLI](https://github.com/DefangLabs/defang)
+2. (Optional) If you are using [Defang BYOC](https://docs.defang.io/docs/concepts/defang-byoc) authenticate with your cloud provider account
+3. (Optional for local development) [Docker CLI](https://docs.docker.com/engine/install/)
 
-## Deploying
+## Development
 
-1. Open the terminal and type `defang login`
-2. Run `defang config set BOARD_PASSWORD` to set the password for the BullBoard dashboard.
-3. Type `defang compose up` in the CLI.
-4. Your app will be running within a few minutes.
+To run the application locally, you can use the following command:
 
-## Local Development
+```bash
+docker compose -f compose.dev.yaml up --build
+```
 
-1. Run `docker compose -f compose.dev.yaml up --build`
+## Configuration
+
+For this sample, you will need to provide the following [configuration](https://docs.defang.io/docs/concepts/configuration): 
+
+> Note that if you are using the 1-click deploy option, you can set these values as secrets in your GitHub repository and the action will automatically deploy them for you.
+
+### `BOARD_PASSWORD`
+Set a board password and use together with the board username `admin` when signing in.
+```bash
+defang config set BOARD_PASSWORD
+```
+
+### `QUEUE`
+```bash
+defang config set QUEUE
+```
+
+## Deployment
+
+> [!NOTE]
+> Download [Defang CLI](https://github.com/DefangLabs/defang)
+
+### Defang Playground
+
+Deploy your application to the Defang Playground by opening up your terminal and typing:
+```bash
+defang compose up
+```
+
+### BYOC (AWS)
+
+If you want to deploy to your own cloud account, you can use Defang BYOC:
+
+1. [Authenticate your AWS account](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html), and check that you have properly set your environment variables like `AWS_PROFILE`, `AWS_REGION`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY`.
+2. Run in a terminal that has access to your AWS environment variables:
+    ```bash
+    defang --provider=aws compose up
+    ```
 
 ---
 

samples/bullmq-bullboard-redis/api/Dockerfile

@@ -1,6 +1,11 @@
 # Use the slim version of Node.js v20 on Debian Bookworm as the base image
 FROM node:20-bookworm-slim
 
+# Install tools for healthcheck
+RUN apt-get update && apt-get install -y \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
 # Set the working directory
 WORKDIR /app
 

samples/bullmq-bullboard-redis/board/Dockerfile

@@ -1,6 +1,11 @@
 # Use the slim version of Node.js on Debian Bookworm as the base image
 FROM node:20-bookworm-slim
 
+# Install tools for healthcheck
+RUN apt-get update && apt-get install -y \
+    curl \
+    && rm -rf /var/lib/apt/lists/*
+
 # Set the working directory
 WORKDIR /app
 

samples/bullmq-bullboard-redis/compose.yaml

@@ -12,6 +12,8 @@ services:
       - REDIS=redis://redisx:6379
       - BOARD_PASSWORD
       - QUEUE
+    healthcheck:
+      test: ["CMD", "curl", "-f", "127.0.0.1:3000"]
     depends_on:
       - redisx
     #deploy:
@@ -31,6 +33,8 @@ services:
     environment:
       - REDIS=redis://redisx:6379
       - QUEUE
+    healthcheck:
+      test: ["CMD", "curl", "-f", "127.0.0.1:3001"]
     depends_on:
       - redisx
     #deploy:
@@ -41,15 +45,13 @@ services:
   worker:
     restart: unless-stopped
     deploy:
-      replicas: 2
+      replicas: 1
     build:
       context: ./worker
       dockerfile: Dockerfile
     environment:
       - REDIS=redis://redisx:6379
       - QUEUE
-    healthcheck:
-      test: ["CMD", "wget", "-q", "--spider", "127.0.0.1:3000"]
     depends_on:
       - redisx
     #deploy: