Skip to content
Snippets Groups Projects
Commit 93d04002 authored by Riabokon Stanislav(EPAM)[GCP]'s avatar Riabokon Stanislav(EPAM)[GCP]
Browse files

Merge branch 'readme-update' into 'master' 

Updated readme

See merge request !383
parents fb6ff524 393438fd
No related branches found
No related tags found
1 merge request!383Updated readme
Pipeline #181908 failed
Stage: build
Stage: coverage
Stage: containerize
Stage: scan
Stage: deploy
Stage: integration
Stage: publish
Hide whitespace changes
Inline Side-by-side
provider/notification-gc/docs/anthos/README.md
+ 16
− 7
View file @ 93d04002
......@@ -205,15 +205,18 @@ curl -L -X PATCH 'https://dev.osdu.club/api/partition/v1/partitions/opendes' -H
</details>
## PubSub configuration
## RabbitMQ configuration
At PubSub should be created set of topics and subscriptions.
At RabbitMQ should be created set of exchanges and queues.
| topic name | subscription name pattern | description | sensitive? |
|-------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------|------------|
| `register-subscriber-control` | `notification-control-topic-{data-partition-id}` | Register subscriber control topic | yes |
| `{topic-name}` e.g. `records-changed` | `notification-{topic-name}-service` | Service topics from `topics.json` on Register service | yes |
| `{topic-name}-publish` e.g. `records-changed-publish` | `notification-{topic-name}-publish}` | Publish topics in relation 1-on-1 for each service topic | yes |
| topic name | subscription name pattern | description | sensitive? |
|-------------------------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| `register-subscriber-control` | `notification-control-topic-{data-partition-id}` | Register subscriber control topic | yes |
| `register-subscriber-control-exchange` | `notification-control-topic-{data-partition-id}` | Register subscriber control delay topic | yes |
| `{topic-name}` e.g. `records-changed` | `notification-{topic-name}-service` | Service topics from [topics.json](https://community.opengroup.org/osdu/platform/system/register/-/blob/master/provider/register-gc/src/main/resources/topics.json) on Register service | yes |
| `{topic-name}-exchange` e.g. `records-changed-exchange` | `notification-{topic-name}-service` | Service delay topics from [topics.json](https://community.opengroup.org/osdu/platform/system/register/-/blob/master/provider/register-gc/src/main/resources/topics.json) on Register service | yes |
| `{topic-name}-publish` e.g. `records-changed-publish` | `notification-{topic-name}-publish` | Publish topics in relation 1-on-1 for each service topic | yes |
| `{topic-name}-publish-exchange` e.g. `records-changed-publish-exchange` | `notification-{topic-name}-publish` | Publish delay topics in relation 1-on-1 for each service topic | yes |
Control topic name can be overridden by:
......@@ -223,6 +226,12 @@ Control topic name can be overridden by:
![Screenshot](./pics/rabbit.PNG)
### Important. Dead lettering configuration
For every service exchange special delay exchange with postfix `-exchange`
and type `x-delayed-message` should exist.
Retries and delays configured by `rabbitmqRetryLimit` and `rabbitmqRetryDelay` OQM properties.
## Keycloak configuration
[Keycloak service accounts setup](https://www.keycloak.org/docs/latest/server_admin/#_service_accounts)
......
provider/notification-gc/docs/gc/README.md
+ 25
− 5
View file @ 93d04002
......@@ -114,14 +114,34 @@ $ (cd notification-core/ && mvn clean install)
At PubSub should be created set of topics and subscriptions. (see [Overview](#overview))
| topic name | subscription name pattern | description | sensitive? |
|-------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------|------------|
| `register-subscriber-control` | `notification-control-topic-{data-partition-id}` | Register subscriber control topic | yes |
| `{topic-name}` e.g. `records-changed` | `notification-{topic-name}-service` | Service topics from `topics.json` on Register service | yes |
| `{topic-name}-publish` e.g. `records-changed-publish` | `notification-{topic-name}-publish}` | Publish topics in relation 1-on-1 for each service topic | yes |
| topic name | subscription name pattern | description | sensitive? |
|-------------------------------------------------------|--------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
| `register-subscriber-control` | `notification-control-topic-{data-partition-id}` | Register subscriber control topic | yes |
| `{topic-name}` e.g. `records-changed` | `notification-{topic-name}-service` | Service topics from [topics.json](https://community.opengroup.org/osdu/platform/system/register/-/blob/master/provider/register-gc/src/main/resources/topics.json) on Register service | yes |
| `{topic-name}-publish` e.g. `records-changed-publish` | `notification-{topic-name}-publish}` | Publish topics in relation 1-on-1 for each service topic | yes |
Control topic name can be overridden by:
* through the Spring Boot property `oqm-register-subscriber-control-topic-name`
* environment variable `OQM_REGISTER_SUBSCRIBER_CONTROL_TOPIC_NAME`
### Important. Dead lettering configuration
Default values of subscription settings `Dead lettering = Disabled`,
and `Retry policy = Retry immediately` leads to a **significant increase in paying bills**.
To avoid such a situation need to configure the dead letter topic and set
parameters:
- Maximum delivery attempts = 5
- Retry policy = Retry after exponential backoff delay
- Minimum backoff duration = 10 seconds
- Maximum backoff duration = 600 seconds
On the subscription dead lettering settings tab:
- Select an active dead letter topic
- Assign Publisher role
- Assign Subscriber role
- Dead letter topic should not be the source topic
Notification service uses a common `dead-lettering-notification` topic because dead lettering logic is not supported yet.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment