Go to file
Alberto Soutullo Rendo 3b2c1e0262 First stable version 2022-12-01 17:38:36 +01:00
kurtosis-module First stable version 2022-12-01 17:38:36 +01:00
scripts Initial commit 2022-10-13 18:46:01 +02:00
.dockerignore Initial commit 2022-10-13 18:46:01 +02:00
.gitignore Initial commit 2022-10-13 18:46:01 +02:00
README.md Initial commit 2022-10-13 18:46:01 +02:00
kurtosis.yml First stable version 2022-12-01 17:38:36 +01:00
main.star First stable version 2022-12-01 17:38:36 +01:00
package.json Initial commit 2022-10-13 18:46:01 +02:00
tsconfig.json Initial commit 2022-10-13 18:46:01 +02:00
yarn.lock Initial commit 2022-10-13 18:46:01 +02:00

README.md

My Kurtosis Module

Welcome to your new Kurtosis module! You can use the ExampleExecutableKurtosisModule implementation as a pattern to create your own Kurtosis module.

Quickstart steps:

  1. Customize your own Kurtosis module by editing the generated files inside the /path/to/your/code/repos/kurtosis-module/impl folder
    1. Rename files and objects, if you want, using a name that describes the functionality of your Kurtosis module
    2. Write the functionality of your Kurtosis module inside your implementation of the ExecutableKurtosisModule.execute method by using the serialized parameters (validating & sanitizing the parameters as necessary)
    3. Write an implementation of KurtosisModuleConfigurator that accepts configuration parameters and produces an instance of your custom Kurtosis module
    4. Edit the main file and replace the example KurtosisModuleConfigurator with your own implementation that produces your custom ExecutableKurtosisModule
    5. Run scripts/build.sh to package your Kurtosis module into a Docker image that can be used inside Kurtosis