Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kurtosis-tech/novu-package
https://github.com/kurtosis-tech/novu-package
kurtosis kurtosis-package
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kurtosis-tech/novu-package
- Owner: kurtosis-tech
- Created: 2023-05-01T15:00:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-23T22:34:50.000Z (about 1 year ago)
- Last Synced: 2024-07-08T13:50:00.337Z (2 months ago)
- Topics: kurtosis, kurtosis-package
- Language: Starlark
- Homepage:
- Size: 21.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Novu Package
============
This is a Novu [Kurtosis package](https://docs.kurtosis.com/concepts-reference/packages).
Run this package
----------------
If you have [Kurtosis installed][install-kurtosis], run:
```bash
kurtosis run github.com/kurtosis-tech/novu-package --enclave novu
```
Note, this package implements an API health-check that is enabled by default.
The health-check ensures that the initialization by Kurtosis doesn't complete before the Novu API is healthy.
This is useful, to avoid interacting with Novu services before they are ready.
Depending on your resources, it may take a while before the health-check completes.
If you want to disable the health-check, run the following command:
```bash
kurtosis run github.com/kurtosis-tech/novu-package --enclave novu '{"health_check":false}'
```
If you don't have Kurtosis installed, [click here to run this package on the Kurtosis playground](https://gitpod.io/?editor=code#https://github.com/kurtosis-tech/novu-package).
To blow away the created [enclave][enclaves-reference], run `kurtosis clean -a`.
## Interacting with the package
Once the script finishes installing and Novu services have finished starting (note the time to load can vary depending on the resources available),
the Novu controller app can be found on `localhost:4200`.
#### Configuration
Click to see configuration
You can configure this package using the JSON structure below. The default values for each parameter are shown.
NOTE: the `//` lines are not valid JSON; you will need to remove them!
```json
{
"name": "John Snow"
}
```
The arguments can then be passed in to `kurtosis run`.
For example:
```bash
kurtosis run github.com/kurtosis-tech/novu-package '{"name":"Maynard James Keenan"}'
```
You can also store the JSON args in a file, and use command expansion to slot them in:
```bash
kurtosis run github.com/kurtosis-tech/novu-package "$(cat args.json)"
```
Use this package in your package
--------------------------------
Kurtosis packages can be composed inside other Kurtosis packages. To use this package in your package:
First, import this package by adding the following to the top of your Starlark file:
```python
this_package = import_module("github.com/kurtosis-tech/novu-package/main.star")
```
Then, call the this package's `run` function somewhere in your Starlark script:
```python
this_package_output = this_package.run(plan, args)
```
Develop on this package
-----------------------
1. [Install Kurtosis][install-kurtosis]
1. Clone this repo
1. For your dev loop, run `kurtosis clean -a && kurtosis run .` inside the repo directory
[install-kurtosis]: https://docs.kurtosis.com/install
[enclaves-reference]: https://docs.kurtosis.com/concepts-reference/enclaves