package
0.0.0-20240205173956-f266d1fc04c9
Repository: https://github.com/caesium-cloud/caesium.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Constants

Created occurs immediately after engine.Create is called successfully.
Deleted occurs after a atom has been deleted, and the Atom no longer appears in the list of Atoms returned by engine.List.
Deleting occurs immediately after engine.Delete is called successfully.
Failure result is returned if the underlying job has failed, but the Atom itself behaved as expected.
Invalid occurs if a atom.Engine returns an unknown or unexpected state.
Killed result is returned if the Atom was ungracefully terminated via a SIGKILL signal.
Label to apply to the Atom to identify that it is managed by Caesium.
ResourceFailure result is returned if the Atom was unable to successfully complete its job due to resource exhaustion.
Running occurs after a Atom has been created, and has begun executing its job.
StartupFailure result is returned if the Atom was misconfigured and was unable to ever reach a running state upon creation.
Stopped occurs after a atom has been stopped, and has returned at least one subsequent State() call after engine.Stop is called.
Stopping occurs immediately after engine.Stop is called successfully.
Success result is returned if the Atom was able to successfully complete its Job with an exit code of 0 returned by the underlying code.
Terminated result is returned if the Atom was gracefully terminated via a SIGTERM signal.
Unknown result is returned if the atom.Engine returns an unexpected exit code.

# Structs

EngineCreateRequest defines the input parameters to an Engine.Create request.
EngineGetRequest defines the input parameters to an Engine.Get request.
EngineListRequest defines the input parameters to an Engine.List request.
EngineLogsRequest defines the input parameters to an Engine.Logs request.
EngineStopRequest defines the input paramters to an Engine.Stop request.

# Interfaces

Atom defines the interface for interacting with an individual Atom.
Engine defines the interface for interacting with a Atom environment.

# Type aliases

Result defines the various end states that the Atom terminates in, depending on where and why in during the lifecycle it was terminated.
State defines the various states a Atom can be in during its lifecycle while executing jobs.