Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dyllamt committed Feb 16, 2024
1 parent 5adead3 commit 1dae8e2
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
21 changes: 21 additions & 0 deletions coinbase-connector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# coinbase-connector

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)

Forwarding service from coinbase to kafka.

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| connector.appName | string | `"coinbase-connector"` | app name linking deployment and service |
| connector.deploymentName | string | `"coinbase-connector-deployment"` | name of deployment in k8s |
| connector.image | string | `"coinbase-connector:latest"` | deployment image |
| connector.imagePullPolicy | string | `"Never"` | image pull policy |
| connector.replicas | int | `1` | replicas for deployment |
| connector.serviceName | string | `"coinbase-connector-service"` | name of service in k8s |
| kafka.address | string | `"coinbase-cluster-kafka-bootstrap.dev.svc.cluster.local:9092"` | address of the kafka cluster |
| kafka.clusterName | string | `"coinbase-cluster"` | name of the kafka cluster |
| kafka.clusterNamespace | string | `"dev"` | namespace where kafka is deployed |
| kafka.topic | string | `"ticker"` | the topic to forward data to |

15 changes: 15 additions & 0 deletions coinbase-kafka/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# coinbase-kafka

![Version: 0.0.1](https://img.shields.io/badge/Version-0.0.1-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square)

Strimzi: Apache Kafka running on Kubernetes

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| cluster.kafka.replicas | int | `1` | number of broker replicas |
| cluster.storage | string | `"ephemeral"` | storage class for broker logs |
| cluster.zookeeper.replicas | int | `1` | number of zookeper replicas |
| topics | list | `["ticker"]` | topics on the cluster |

0 comments on commit 1dae8e2

Please sign in to comment.