README.md in mkit-0.3.0 vs README.md in mkit-0.4.0
- old
+ new
@@ -1,15 +1,15 @@
# MKIt - Micro Kubernetes on Ruby
This is micro kubernetes(tm) on Ruby(tm), a simple tool to deploy containers to mimic a (very) minimalistic k8 cluster with a nice REST API.
-It contains a internal DNS and uses HAProxy for routing/balancing/fail-over for Pods access.
+It contains an internal DNS and uses HAProxy for routing/balancing/fail-over for Pods access.
The database is a simple sqlite3 db and the server is a Sinatra based application.
-The client is not done yet, only includes a simple wrapper to `curl`
+A client is also included to access the API, e.g. `mkitc ps`.
-The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface.
+The daemon is responsible for HAProxy pods routing configuration. It also provides the cluster DNS and manages the internal host interface and the docker instances.
## Requirements
* Ruby
* HAProxy
@@ -105,10 +105,14 @@
```
service:
name: rabbitmq # unique
image: rabbitmq:3-management-alpine # image
network: bridge # docker network - it will be created if it does not exists
- ports: # haproxy port mapping: <external_port>|<internal_port>|<tcp|http>|round_robin
+ ports: # haproxy port mapping
+ # <external_port>:[internal_port]:<tcp|http>:[round_robin (default)|leastconn]
+ # to define a range on `external_port`, leave `internal_port` blank
+ # - 5000-5100::tcp:round_robin
+ # range on `internal_port` is not supported
- 5672:5672:tcp:round_robin
- 80:15672:http:round_robin
resources:
max_replicas: 1
min_replicas: 1