diff --git a/REFERENCE.md b/REFERENCE.md index 5d5a351..a723668 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -12,6 +12,13 @@ * [`start`](#start): Create or start Lima VM * [`stop`](#stop): Stop Lima VM +### Plans + +* [`lima::cluster::delete`](#lima--cluster--delete): Delete the cluster of Lima VMs +* [`lima::cluster::start`](#lima--cluster--start): Create/start the cluster of Lima VMs +* [`lima::cluster::stop`](#lima--cluster--stop): Stop the cluster of Lima VMs +* [`lima::clusters`](#lima--clusters): Return the cluster definition + ## Tasks ### `delete` @@ -144,3 +151,132 @@ Data type: `String[1]` VM name +## Plans + +### `lima::cluster::delete` + +Delete the cluster of Lima VMs + +#### Parameters + +The following parameters are available in the `lima::cluster::delete` plan: + +* [`name`](#-lima--cluster--delete--name) +* [`clusters`](#-lima--cluster--delete--clusters) +* [`target`](#-lima--cluster--delete--target) + +##### `name` + +Data type: `String[1]` + +Cluster name + +##### `clusters` + +Data type: `Optional[Hash]` + +Hash of all defined clusters. Populated from Hiera usually. + +Default value: `undef` + +##### `target` + +Data type: `TargetSpec` + +The host to run the limactl on + +Default value: `'localhost'` + +### `lima::cluster::start` + +Create/start the cluster of Lima VMs + +#### Parameters + +The following parameters are available in the `lima::cluster::start` plan: + +* [`name`](#-lima--cluster--start--name) +* [`clusters`](#-lima--cluster--start--clusters) +* [`target`](#-lima--cluster--start--target) + +##### `name` + +Data type: `String[1]` + +Cluster name + +##### `clusters` + +Data type: `Optional[Hash]` + +Hash of all defined clusters. Populated from Hiera usually. + +Default value: `undef` + +##### `target` + +Data type: `TargetSpec` + +The host to run the limactl on + +Default value: `'localhost'` + +### `lima::cluster::stop` + +Stop the cluster of Lima VMs + +#### Parameters + +The following parameters are available in the `lima::cluster::stop` plan: + +* [`name`](#-lima--cluster--stop--name) +* [`clusters`](#-lima--cluster--stop--clusters) +* [`target`](#-lima--cluster--stop--target) + +##### `name` + +Data type: `String[1]` + +Cluster name + +##### `clusters` + +Data type: `Optional[Hash]` + +Hash of all defined clusters. Populated from Hiera usually. + +Default value: `undef` + +##### `target` + +Data type: `TargetSpec` + +The host to run the limactl on + +Default value: `'localhost'` + +### `lima::clusters` + +Return the cluster definition + +#### Parameters + +The following parameters are available in the `lima::clusters` plan: + +* [`name`](#-lima--clusters--name) +* [`clusters`](#-lima--clusters--clusters) + +##### `name` + +Data type: `String[1]` + +Cluster name + +##### `clusters` + +Data type: `Hash` + +Hash of all defined clusters. Populated from Hiera usually. + +Default value: `lookup('lima::clusters', 'default_value' => {})` +