kurtosis-engine-server

The Kurtosis Engine server


Project maintained by kurtosis-tech Hosted on GitHub Pages — Theme by mattgraham

Kurtosis Engine Documentation

This documentation describes how to interact with the Kurtosis API from within a testnet. It includes information about starting services, stopping services, repartitioning the network, etc. These objects are particularly useful for writing tests, where pre-test setup involves creating an enclave. Note that any comments specific to a language implementation will be found in the code comments.

Found a bug? File it on the repo!

KurtosisContext

A connection to a Kurtosis engine, used for manipulating enclaves.

createEnclave(EnclaveID enclaveId, boolean isPartitioningEnabled) -> EnclaveContext enclaveContext

Creates a new Kurtosis enclave using the given parameters.

Args

Returns

getEnclaveContext(EnclaveID enclaveId) -> EnclaveContext enclaveContext

Gets the EnclaveContext object for the given enclave ID.

Args

Returns

getEnclaves() -> Set<EnclaveID> enclaveIds

Gets the IDs of the enclaves that the Kurtosis engine knows about.

Returns

stopEnclave(EnclaveID enclaveId)

Stops the enclave with the given ID, but doesn’t destroy the enclave objects (containers, networks, etc.) so they can be further examined.

NOTE: Any EnclaveContext objects representing the stopped enclave will become unusable.

Args

destroyEnclave(EnclaveID enclaveId)

Stops the enclave with the given ID and destroys the enclave objects (containers, networks, etc.).

NOTE: Any EnclaveContext objects representing the stopped enclave will become unusable.

Args

clean(boolean shouldCleanAll) -> Set<EnclaveID> RemovedEnclaveIds

Destroys enclaves in the Kurtosis engine.

Args

Returns


Found a bug? File it on the repo!