sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[docs-only] Update nats and registry related documentation

Browse Source
This commit is contained in:
mmattel
2024-08-26 12:20:06 +02:00
parent 1f6b836217
commit 0fa38b6bd2
3 changed files with 29 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/services/general-info/registry.md
+15 -10
View File
@@ -14,26 +14,31 @@ To be able to communicate with each other, services need to register in a common
The type of registry to use can be configured with the `MICRO_REGISTRY` environment variable. Supported values are:
### `memory`
Setting the environment variable to `memory` starts an in-memory registry. This only works with the single binary deployment.
### `nats-js-kv` (Default)
Set the environment variable to `nats-js-kv` or leave it empty to use a nats-js key value store as registry.
- Note: If not running build-in nats, `MICRO_REGISTRY_ADDRESS` needs to be set to the address of the nats-js cluster, which is the same value as `OCIS_EVENTS_ENDPOINT`.
- Optional: Use `MICRO_REGISTRY_AUTH_USERNAME` and `MICRO_REGISTRY_AUTH_PASSWORD` to authenticate with the nats cluster.
### `kubernetes`
When deploying in a kubernetes cluster, the kubernetes registry can be used. Additionally, the `MICRO_REGISTRY_ADDRESS` environment
variable needs to be set to the url of the kubernetes registry.
When deploying in a kubernetes cluster, the Kubernetes registry can be used. Additionally, the `MICRO_REGISTRY_ADDRESS` environment variable needs to be set to the url of the Kubernetes registry.
### `memory`
Setting the environment variable to `memory` starts an in-memory registry. This only works with the single binary deployment.
### Deprecated Registries
These registries are currently working but will be removed in a later version. It is recommended to switch to a supported one.
- `nats`. Uses a registry based on nats streams. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `etcd`. Uses an etcd cluster as the registry. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `consul`. Uses `HashiCorp Consul` as registry. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `mdns`. Uses multicast dns for registration. This type can have unwanted side effects when other devices in the local network use mdns too.
- `nats`\
Uses a registry based on nats streams. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `etcd`\
Uses an etcd cluster as the registry. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `consul`\
Uses `HashiCorp Consul` as registry. Requires `MICRO_REGISTRY_ADDRESS` to be set.
- `mdns`\
Uses multicast dns for registration. This type can have unwanted side effects when other devices in the local network use mdns too.