Home

Awesome

Novu Package

This is a Novu Kurtosis package.

Run this package

If you have Kurtosis installed, run:

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:

kurtosis run github.com/kurtosis-tech/novu-package --enclave novu '{"health_check":false}'
<!-- TODO Add a URL-encoded version of github.com/YOURUSER/THISREPO to right after "KURTOSIS_PACKAGE_LOCATOR=" in the link below --> <!-- TODO You can URL-encode a string using https://www.urlencoder.org/ -->

If you don't have Kurtosis installed, click here to run this package on the Kurtosis playground.

To blow away the created enclave, 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

<details> <summary>Click to see configuration</summary>

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!

<!-- TODO Parameterize your package as you prefer; see https://docs.kurtosis.com/next/concepts-reference/args for more --> 
{
  "name": "John Snow"
}

The arguments can then be passed in to kurtosis run.

For example:

<!-- TODO replace YOURUSER and THISREPO with the correct values --> 
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:

<!-- TODO replace YOURUSER and THISREPO with the correct values --> 
kurtosis run github.com/kurtosis-tech/novu-package "$(cat args.json)"
</details>

Use this package in your package

Kurtosis packages can be composed inside other Kurtosis packages. To use this package in your package:

<!-- TODO Replace YOURUSER and THISREPO with the correct values! -->

First, import this package by adding the following to the top of your Starlark file:

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:

this_package_output = this_package.run(plan, args)

Develop on this package

  1. Install Kurtosis
  2. Clone this repo
  3. For your dev loop, run kurtosis clean -a && kurtosis run . inside the repo directory
<!-------------------------------- LINKS ------------------------------->