https://github.com/tedim52/practice-kurtosis-module
https://github.com/tedim52/practice-kurtosis-module
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/tedim52/practice-kurtosis-module
- Owner: tedim52
- Created: 2022-04-16T20:43:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-16T20:51:40.000Z (about 4 years ago)
- Last Synced: 2025-02-05T23:39:47.803Z (over 1 year ago)
- Size: 9.77 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
My Kurtosis Module
=====================
Welcome to your new [Kurtosis module](https://docs.kurtosistech.com/modules.html)! 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
1. 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)
1. Write an implementation of `KurtosisModuleConfigurator` that accepts configuration parameters and produces an instance of your custom Kurtosis module
1. Edit the main file and replace the example `KurtosisModuleConfigurator` with your own implementation that produces your custom `ExecutableKurtosisModule`
1. Run `scripts/build.sh` to package your Kurtosis module into a Docker image that can be used inside Kurtosis