Skip to content

Commit 2eb1738

Browse files
minor: Update README with information about running the demo with ARM laptos (#35)
1 parent b5d2d74 commit 2eb1738

File tree

1 file changed

+28
-13
lines changed

1 file changed

+28
-13
lines changed

README.md

Lines changed: 28 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,40 +24,51 @@ cd sample-go-rabbitmq
2424

2525
#### Install RabbitMQ via Helm
2626

27-
Since the Helm stable repositoty was migrated to the Bitnami repository (https://github.com/helm/charts/tree/master/stable/rabbitmq), add the Bitnami repo and use it during the installation (bitnami/<chart> instead of stable/<chart>)
27+
Since the Helm stable repositoty was migrated to the [Bitnami Repository](https://github.com/helm/charts/tree/master/stable/rabbitmq), add the Bitnami repo and use it during the installation:
2828

2929
```cli
30-
$ helm repo add bitnami https://charts.bitnami.com/bitnami
30+
helm repo add bitnami https://charts.bitnami.com/bitnami
3131
```
3232

3333
##### Helm 3
3434

3535
RabbitMQ Helm Chart version 7.0.0 or later
36+
3637
```cli
3738
helm install rabbitmq --set auth.username=user --set auth.password=PASSWORD bitnami/rabbitmq --wait
3839
```
3940

40-
NOTE: With RabbitMQ Helm Chart version 6.x.x or earlier, username and password should be specified with rabbitmq.username and rabbitmq.password parameters https://hub.helm.sh/charts/bitnami/rabbitmq
41+
**Notes:**
4142

42-
NOTE: if you are running the rabbitMQ image on KinD, you will run into permission issues unless you set ``volumePermissions.enabled=true``
43+
* The default RabbitMQ image built by bitnami does not support ARM CPU architecture so if running this demo on a computer with a ARM Processor use the [official rabbitmq image](https://hub.docker.com/_/rabbitmq) instead. To install RabbitMQ using the official rabbitmq image run the following command:
4344

44-
Use the following command if you are using KinD
45+
```cli
46+
helm install rabbitmq --set auth.username=user --set auth.password=PASSWORD --set image.tag=latest --set image.repository=rabbitmq bitnami/rabbitmq --wait
47+
```
4548
46-
```cli
47-
helm install rabbitmq --set auth.username=user --set auth.password=PASSWORD --set volumePermissions.enabled=true bitnami/rabbitmq --wait
48-
```
49-
NOTE: For RabbitMQ Helm Chart version 6.x.x or earlier, refer to the earlier note
49+
* If you are running the rabbitMQ image on KinD, you will run into permission issues unless you set `volumePermissions.enabled=true`. Use the following command if you are using KinD:
50+
51+
```cli
52+
helm install rabbitmq --set auth.username=user --set auth.password=PASSWORD --set volumePermissions.enabled=true bitnami/rabbitmq --wait
53+
```
54+
55+
* With RabbitMQ Helm Chart version 6.x.x or earlier, username and password should be specified with rabbitmq.username and rabbitmq.password parameters [https://hub.helm.sh/charts/bitnami/rabbitmq](https://hub.helm.sh/charts/bitnami/rabbitmq)
5056
5157
##### Helm 2
5258
5359
RabbitMQ Helm Chart version 7.0.0 or later
60+
5461
```cli
5562
helm install --name rabbitmq --set auth.username=user --set auth.password=PASSWORD bitnami/rabbitmq --wait
5663
```
5764

58-
NOTE: For RabbitMQ Helm Chart version 6.x.x or earlier, refer to the earlier note
65+
**Notes:**
66+
67+
* If running this demo on a computer with a ARM Processor, refer to the earlier note
68+
* If using KinD refer to the earlier note
69+
* For RabbitMQ Helm Chart version 6.x.x or earlier, refer to the earlier note
5970

60-
#### Wait for RabbitMQ to deploy
71+
#### Wait for RabbitMQ to Deploy
6172

6273
⚠️ Be sure to wait until the deployment has completed before continuing. ⚠️
6374

@@ -71,18 +82,20 @@ rabbitmq-0 1/1 Running 0 3m3s
7182
### Deploying a RabbitMQ consumer
7283

7384
#### Deploy a consumer
85+
7486
```cli
7587
kubectl apply -f deploy/deploy-consumer.yaml
7688
```
7789

7890
#### Validate the consumer has deployed
91+
7992
```cli
8093
kubectl get deploy
8194
```
8295

83-
You should see `rabbitmq-consumer` deployment with 0 pods as there currently aren't any queue messages. It is scale to zero.
96+
You should see `rabbitmq-consumer` deployment with 0 pods as there currently aren't any queue messages and for that reason it is scaled to zero.
8497

85-
```
98+
```cli
8699
NAME DESIRED CURRENT UP-TO-DATE AVAILABLE AGE
87100
rabbitmq-consumer 0 0 0 0 3s
88101
```
@@ -100,13 +113,15 @@ kubectl apply -f deploy/deploy-publisher-job.yaml
100113
```
101114

102115
#### Validate the deployment scales
116+
103117
```cli
104118
kubectl get deploy -w
105119
```
106120

107121
You can watch the pods spin up and start to process queue messages. As the message length continues to increase, more pods will be pro-actively added.
108122

109123
You can see the number of messages vs the target per pod as well:
124+
110125
```cli
111126
kubectl get hpa
112127
```

0 commit comments

Comments
 (0)