Skip to content

Commit ee35de8

Browse files
committed
Fix typo in README
1 parent 3e73172 commit ee35de8

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,27 @@
22

33
This is an example project that combines several cloud native technologies that I really like and have been meaning to get working in a meaningful way:
44

5-
* The [Bazel](https://bazel.build) build tool
6-
* [Kubernetes](https://kubernetes.io) and [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/)
7-
* [Protocol Buffers](https://developers.google.com/protocol-buffers/) and [gRPC](https://grpc.io)
8-
* [Docker](https://docker.com)
5+
- The [Bazel](https://bazel.build) build tool
6+
- [Kubernetes](https://kubernetes.io) and [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/)
7+
- [Protocol Buffers](https://developers.google.com/protocol-buffers/) and [gRPC](https://grpc.io)
8+
- [Docker](https://docker.com)
99

1010
Colossus is basically a microservice architecture consisting of three services:
1111

12-
Service | Where the code lives | Language
13-
:-------|:---------------------|:--------
14-
An HTTP service that takes web requests. This is the entry point into the backend services. | [`web`](web) | Go
15-
An authentication/authorization service | [`auth`](auth) | Go
16-
A "data" service that handles data requests | [`data`](data) | Java
17-
A "user info" service that doesn't do anything interesting yet, but it works and it's in C++! | [`userinfo`](userinfo) | C++
12+
| Service | Where the code lives | Language |
13+
| :-------------------------------------------------------------------------------------------- | :--------------------- | :------- |
14+
| An HTTP service that takes web requests. This is the entry point into the backend services. | [`web`](web) | Go |
15+
| An authentication/authorization service | [`auth`](auth) | Go |
16+
| A "data" service that handles data requests | [`data`](data) | Java |
17+
| A "user info" service that doesn't do anything interesting yet, but it works and it's in C++! | [`userinfo`](userinfo) | C++ |
1818

1919
## The services
2020

2121
What do these services actually do?
2222

23-
* The web service requires a `Password` header and a `String` header. The `Password` header is used for authentication and the `String` header is used as a data input. You need to make `POST` requests to the `/string` endpoint.
24-
* The auth service verifies the password passed to the web service. There is only one password that actually works: `tonydanza`. Use any other password and you'll get a `401 Unauthorized` HTTP error.
25-
* The data service handles words or strings that you pass to the web service using the `String` header. The data service simply capitalizes whatever you pass via that header and returns it.
23+
- The web service requires a `Password` header and a `String` header. The `Password` header is used for authentication and the `String` header is used as a data input. You need to make `POST` requests to the `/string` endpoint.
24+
- The auth service verifies the password passed to the web service. There is only one password that actually works: `tonydanza`. Use any other password and you'll get a `401 Unauthorized` HTTP error.
25+
- The data service handles words or strings that you pass to the web service using the `String` header. The data service simply capitalizes whatever you pass via that header and returns it.
2626

2727
> Wait a second, these services don't do anything meaningful! Nope, they sure don't. But that's okay because the point of this project is to show you how to get the basic (yet not-at-all-trivial) plumbing to work. Colossus is a **boilerplate project** that's meant as a springboard to more complex and meaningful projects.
2828
@@ -59,7 +59,7 @@ $ minikube addons enable ingress
5959
$ make minikube-setup
6060

6161
# Set up the Docker environment for Minikube
62-
$ eval $(minkube docker-env)
62+
$ eval $(minikube docker-env)
6363
```
6464

6565
Now Minikube is all set. The one required dependency for Colossus is a Redis cluster. To run a one-node Redis cluster in Kubernetes-on-Minikube (configuration in [`k8s/redis.yaml`](k8s/redis.yaml)):
@@ -202,12 +202,12 @@ $ make k8s-monitoring-deploy
202202

203203
This is a humble start but I'd like to expand it a great deal in the future. In particular I'd like to add:
204204

205-
* A service mesh like [Conduit](https://conduit.io) or [Istio](https://istio.io/).
206-
* A [Helm](https://helm.sh/) chart
207-
* Some "real" services that do meaningful things, like interact with databases running on k8s or even a cloud service like Google BigTable.
208-
* Real REST capabilities. Right now our web service doesn't do anything cool. At the very least it should provide some interesting CRUD operations.
209-
* More languages. Right now Go and Java are pretty much the only languages that can be easily incorporated into a gRPC-plus-Bazel setup. I'm sure that support for Python, C++, and others is on the way, and I'll use those capabilities as the opportunity arises.
210-
* Componentize service building. Right now each service is its own self-contained universe. I'd like to create a reusable service abstraction (or re-use abstractions built by others) for creating new services, especially more robust configuration management.
211-
* Integration testing for specific services and the whole thing
205+
- A service mesh like [Conduit](https://conduit.io) or [Istio](https://istio.io/).
206+
- A [Helm](https://helm.sh/) chart
207+
- Some "real" services that do meaningful things, like interact with databases running on k8s or even a cloud service like Google BigTable.
208+
- Real REST capabilities. Right now our web service doesn't do anything cool. At the very least it should provide some interesting CRUD operations.
209+
- More languages. Right now Go and Java are pretty much the only languages that can be easily incorporated into a gRPC-plus-Bazel setup. I'm sure that support for Python, C++, and others is on the way, and I'll use those capabilities as the opportunity arises.
210+
- Componentize service building. Right now each service is its own self-contained universe. I'd like to create a reusable service abstraction (or re-use abstractions built by others) for creating new services, especially more robust configuration management.
211+
- Integration testing for specific services and the whole thing
212212

213213
The good news is that the hard part---especially getting Bazel to build the right things and Kubernetes to use a local image registry---is already behind me, so adding new services is fairly trivial.

0 commit comments

Comments
 (0)