Skip to content

Commit

Permalink
doc about config samples
Browse files Browse the repository at this point in the history
  • Loading branch information
gaetancollaud committed Feb 6, 2024
1 parent 223d2f0 commit ce14ace
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/manual/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
<<<
include::src/introduction.adoc[]

<<<
include::src/config_samples.adoc[]

<<<
include::src/pricing_rules.adoc[]

Expand Down
13 changes: 13 additions & 0 deletions docs/manual/src/config_samples.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
=== Config samples

If you want to quickly get started, you can create pricing rules and context data using the link:https://github.com/spoud/kafka-cost-control/tree/master/config[config sample folder]. All you need is node JS 20+.

Be sure to edit the files `pricing-rules.json` and `context-data.json` to match your environment.

To persist the configuration you can use the following command:

```bash
node index.js --url=https://<your-host>/graphql --user=admin --password=your-password
```

If you have issues you can try to add the `--verbose` options. This will display all the requests.

0 comments on commit ce14ace

Please sign in to comment.