Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Waldemar Quevedo <wally@synadia.com>
  • Loading branch information
wallyqs committed Mar 20, 2022
1 parent 5fafb7a commit 11f5e3a
Showing 1 changed file with 61 additions and 59 deletions.
120 changes: 61 additions & 59 deletions README.md
Expand Up @@ -7,83 +7,85 @@ This repo is used to capture architectural and design decisions as a reference o
# Architecture Decision Records
## Client

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-1](adr/ADR-1.md)|jetstream, client, server|JetStream JSON API Design|
|[ADR-2](adr/ADR-2.md)|jetstream, server, client|NATS Typed Messages|
|[ADR-4](adr/ADR-4.md)|server, client|NATS Message Headers|
|[ADR-5](adr/ADR-5.md)|server, client|Lame Duck Notification|
|[ADR-6](adr/ADR-6.md)|server, client|Protocol Naming Conventions|
|[ADR-7](adr/ADR-7.md)|server, client, jetstream|NATS Server Error Codes|
|[ADR-8](adr/ADR-8.md)|jetstream, client, kv|JetStream based Key-Value Stores|
|[ADR-9](adr/ADR-9.md)|server, client, jetstream|JetStream Consumer Idle Heartbeats|
|[ADR-10](adr/ADR-10.md)|server, client, jetstream|JetStream Extended Purge|
|[ADR-11](adr/ADR-11.md)|client|Hostname resolution|
|[ADR-13](adr/ADR-13.md)|jetstream, client|Pull Subscribe internals|
|[ADR-14](adr/ADR-14.md)|client, security|JWT library free jwt user generation|
|[ADR-15](adr/ADR-15.md)|jetstream, client|JetStream Subscribe Workflow|
|[ADR-17](adr/ADR-17.md)|jetstream, client|Ordered Consumer|
|[ADR-18](adr/ADR-18.md)|client|URL support for all client options|
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views:|
|[ADR-20](adr/ADR-20.md)|jetstream, client, objectstore|JetStream based Object Stores|
|[ADR-21](adr/ADR-21.md)|client|NATS Configuration Contexts|
| Index | Tags | Description |
|-------------------------|------------------------------------|------------------------------------------------|
| [ADR-1](adr/ADR-1.md) | jetstream, client, server | JetStream JSON API Design |
| [ADR-2](adr/ADR-2.md) | jetstream, server, client | NATS Typed Messages |
| [ADR-4](adr/ADR-4.md) | server, client | NATS Message Headers |
| [ADR-5](adr/ADR-5.md) | server, client | Lame Duck Notification |
| [ADR-6](adr/ADR-6.md) | server, client | Protocol Naming Conventions |
| [ADR-7](adr/ADR-7.md) | server, client, jetstream | NATS Server Error Codes |
| [ADR-8](adr/ADR-8.md) | jetstream, client, kv | JetStream based Key-Value Stores |
| [ADR-9](adr/ADR-9.md) | server, client, jetstream | JetStream Consumer Idle Heartbeats |
| [ADR-10](adr/ADR-10.md) | server, client, jetstream | JetStream Extended Purge |
| [ADR-11](adr/ADR-11.md) | client | Hostname resolution |
| [ADR-13](adr/ADR-13.md) | jetstream, client | Pull Subscribe internals |
| [ADR-14](adr/ADR-14.md) | client, security | JWT library free jwt user generation |
| [ADR-15](adr/ADR-15.md) | jetstream, client | JetStream Subscribe Workflow |
| [ADR-17](adr/ADR-17.md) | jetstream, client | Ordered Consumer |
| [ADR-18](adr/ADR-18.md) | client | URL support for all client options |
| [ADR-19](adr/ADR-19.md) | jetstream, client, kv, objectstore | API prefixes for materialized JetStream views: |
| [ADR-20](adr/ADR-20.md) | jetstream, client, objectstore | JetStream based Object Stores |
| [ADR-21](adr/ADR-21.md) | client | NATS Configuration Contexts |
| [ADR-22](adr/ADR-22.md) | jetstream, client | JetStream Publish Retries on No Responders |

## Jetstream

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-1](adr/ADR-1.md)|jetstream, client, server|JetStream JSON API Design|
|[ADR-2](adr/ADR-2.md)|jetstream, server, client|NATS Typed Messages|
|[ADR-7](adr/ADR-7.md)|server, client, jetstream|NATS Server Error Codes|
|[ADR-8](adr/ADR-8.md)|jetstream, client, kv|JetStream based Key-Value Stores|
|[ADR-9](adr/ADR-9.md)|server, client, jetstream|JetStream Consumer Idle Heartbeats|
|[ADR-10](adr/ADR-10.md)|server, client, jetstream|JetStream Extended Purge|
|[ADR-12](adr/ADR-12.md)|jetstream|JetStream Encryption At Rest|
|[ADR-13](adr/ADR-13.md)|jetstream, client|Pull Subscribe internals|
|[ADR-15](adr/ADR-15.md)|jetstream, client|JetStream Subscribe Workflow|
|[ADR-17](adr/ADR-17.md)|jetstream, client|Ordered Consumer|
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views:|
|[ADR-20](adr/ADR-20.md)|jetstream, client, objectstore|JetStream based Object Stores|
| Index | Tags | Description |
|-------------------------|------------------------------------|------------------------------------------------|
| [ADR-1](adr/ADR-1.md) | jetstream, client, server | JetStream JSON API Design |
| [ADR-2](adr/ADR-2.md) | jetstream, server, client | NATS Typed Messages |
| [ADR-7](adr/ADR-7.md) | server, client, jetstream | NATS Server Error Codes |
| [ADR-8](adr/ADR-8.md) | jetstream, client, kv | JetStream based Key-Value Stores |
| [ADR-9](adr/ADR-9.md) | server, client, jetstream | JetStream Consumer Idle Heartbeats |
| [ADR-10](adr/ADR-10.md) | server, client, jetstream | JetStream Extended Purge |
| [ADR-12](adr/ADR-12.md) | jetstream | JetStream Encryption At Rest |
| [ADR-13](adr/ADR-13.md) | jetstream, client | Pull Subscribe internals |
| [ADR-15](adr/ADR-15.md) | jetstream, client | JetStream Subscribe Workflow |
| [ADR-17](adr/ADR-17.md) | jetstream, client | Ordered Consumer |
| [ADR-19](adr/ADR-19.md) | jetstream, client, kv, objectstore | API prefixes for materialized JetStream views: |
| [ADR-20](adr/ADR-20.md) | jetstream, client, objectstore | JetStream based Object Stores |
| [ADR-22](adr/ADR-22.md) | jetstream, client | JetStream Publish Retries on No Responders |

## Kv

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-8](adr/ADR-8.md)|jetstream, client, kv|JetStream based Key-Value Stores|
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views:|
| Index | Tags | Description |
|-------------------------|------------------------------------|------------------------------------------------|
| [ADR-8](adr/ADR-8.md) | jetstream, client, kv | JetStream based Key-Value Stores |
| [ADR-19](adr/ADR-19.md) | jetstream, client, kv, objectstore | API prefixes for materialized JetStream views: |

## Objectstore

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-19](adr/ADR-19.md)|jetstream, client, kv, objectstore|API prefixes for materialized JetStream views:|
|[ADR-20](adr/ADR-20.md)|jetstream, client, objectstore|JetStream based Object Stores|
| Index | Tags | Description |
|-------------------------|------------------------------------|------------------------------------------------|
| [ADR-19](adr/ADR-19.md) | jetstream, client, kv, objectstore | API prefixes for materialized JetStream views: |
| [ADR-20](adr/ADR-20.md) | jetstream, client, objectstore | JetStream based Object Stores |

## Observability

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-3](adr/ADR-3.md)|observability, server|NATS Service Latency Distributed Tracing Interoperability|
| Index | Tags | Description |
|-----------------------|-----------------------|-----------------------------------------------------------|
| [ADR-3](adr/ADR-3.md) | observability, server | NATS Service Latency Distributed Tracing Interoperability |

## Security

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-14](adr/ADR-14.md)|client, security|JWT library free jwt user generation|
| Index | Tags | Description |
|-------------------------|------------------|--------------------------------------|
| [ADR-14](adr/ADR-14.md) | client, security | JWT library free jwt user generation |

## Server

|Index|Tags|Description|
|-----|----|-----------|
|[ADR-1](adr/ADR-1.md)|jetstream, client, server|JetStream JSON API Design|
|[ADR-2](adr/ADR-2.md)|jetstream, server, client|NATS Typed Messages|
|[ADR-3](adr/ADR-3.md)|observability, server|NATS Service Latency Distributed Tracing Interoperability|
|[ADR-4](adr/ADR-4.md)|server, client|NATS Message Headers|
|[ADR-5](adr/ADR-5.md)|server, client|Lame Duck Notification|
|[ADR-6](adr/ADR-6.md)|server, client|Protocol Naming Conventions|
|[ADR-7](adr/ADR-7.md)|server, client, jetstream|NATS Server Error Codes|
|[ADR-9](adr/ADR-9.md)|server, client, jetstream|JetStream Consumer Idle Heartbeats|
|[ADR-10](adr/ADR-10.md)|server, client, jetstream|JetStream Extended Purge|
| Index | Tags | Description |
|-------------------------|---------------------------|-----------------------------------------------------------|
| [ADR-1](adr/ADR-1.md) | jetstream, client, server | JetStream JSON API Design |
| [ADR-2](adr/ADR-2.md) | jetstream, server, client | NATS Typed Messages |
| [ADR-3](adr/ADR-3.md) | observability, server | NATS Service Latency Distributed Tracing Interoperability |
| [ADR-4](adr/ADR-4.md) | server, client | NATS Message Headers |
| [ADR-5](adr/ADR-5.md) | server, client | Lame Duck Notification |
| [ADR-6](adr/ADR-6.md) | server, client | Protocol Naming Conventions |
| [ADR-7](adr/ADR-7.md) | server, client, jetstream | NATS Server Error Codes |
| [ADR-9](adr/ADR-9.md) | server, client, jetstream | JetStream Consumer Idle Heartbeats |
| [ADR-10](adr/ADR-10.md) | server, client, jetstream | JetStream Extended Purge |

## When to write an ADR

Expand Down

0 comments on commit 11f5e3a

Please sign in to comment.