add a README to the ocis package

This commit is contained in:
David Christofas
2022-11-02 17:12:28 +01:00
parent b7482e5410
commit 56c3d9d76f
+22
View File
@@ -0,0 +1,22 @@
# ocis
The ocis package contains the Infinite Scale runtime and the commands for the Infinite Scale cli.
## Service registry
This package also configures the service registry which will be used to lookup the service addresses. It defaults to mDNS, so mind that, when using systems with mDNS disabled by default (i.e SUSE).
Available registries are:
- nats
- kubernetes
- etcd
- consul
- memory
- mdns (default)
To configure which registry to use you have to set the environment variable `MICRO_REGISTRY` and for all except `memory` and `mdns` you also have to set the registry address via `MICRO_REGISTRY_ADDRESS`.
### etcd
To authenticate the connection to the etcd registry you have to set `ETCD_USERNAME` and `ETCD_PASSWORD`.