Skip to content

Commit 38c96c9

Browse files
bennosteinhubyrod
authored andcommitted
Improve README w/ review comments, fix container name
1 parent d4b5b1a commit 38c96c9

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

examples/hackernews/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,15 @@ reverse-proxy (in `reverse_proxy/`), and a PostgreSQL database (in `db/`).
77
We provide configurations to run it using either Docker Compose or Kubernetes.
88
The Docker Compose version is simpler and easier if you just want to get
99
started with as few dependencies as possible; the Kubernetes version may be
10-
useful for users already using Kubernetes for other deployments.
10+
useful for users who are either already using Kubernetes for other deployments
11+
or require elastic horizontal scaling of their Skip service.
1112

1213
## Docker Compose
1314

1415
To build and run the application using Docker Compose, first install and run
1516
Docker on your system, then run:
1617

17-
```
18+
```bash
1819
$ docker compose up --build
1920
```
2021

@@ -26,7 +27,7 @@ of computing and maintaining resources in a round-robin fashion.
2627

2728
This distributed configuration requires only configuration changes, is
2829
transparent to clients, and can be run with:
29-
```
30+
```bash
3031
$ docker compose -f compose.distributed.yml up --build
3132
```
3233

@@ -50,7 +51,7 @@ configuration) to a local Kubernetes cluster.
5051

5152
3. Build docker images for each component of this example, then tag and publish
5253
each one to the `minikube` registry:
53-
```
54+
```bash
5455
docker compose -f kubernetes/compose.distributed.yml build
5556
for image in web-service reactive-service www db ; do
5657
docker tag reactive-hackernews/$image localhost:5000/$image;
@@ -63,7 +64,7 @@ done
6364
5. Configure and run HAProxy as a Kubernetes ingress controller, mediating
6465
external traffic ("ingress") and distributing it to the relevant Kubernetes
6566
service(s).
66-
```
67+
```bash
6768
kubectl create configmap haproxy-auxiliary-configmap --from-file kubernetes/haproxy-aux.cfg
6869
helm install haproxy haproxytech/kubernetes-ingress -f reverse_proxy/kubernetes.yaml
6970
```

examples/hackernews/kubernetes/web.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ spec:
2929
app.kubernetes.io/name: rhn-web
3030
spec:
3131
containers:
32-
- name: rhn-pg
32+
- name: rhn-web
3333
image: localhost:5000/web-service
3434
ports:
3535
- containerPort: 3031

0 commit comments

Comments
 (0)