lima

Puppet Bolt tasks to manage VMs in a lima-vm environment

Project URL RSS Feed Report issues

Module Stats

783 downloads

189 latest version

5.0 quality score

Version information

released Feb 21st 2023

This version is compatible with:

Puppet Enterprise 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
Puppet >= 4.10.0 < 9.0.0
, , , , , , , ,

Tasks:

delete

list

resolve_reference

start

stop

Plans:

delete

start

stop

clusters

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'jay7x-lima', '1.1.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add jay7x-lima

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install jay7x-lima --version 1.1.1

Documentation

jay7x/lima — version 1.1.1 Feb 21st 2023

lima

Table of Contents

Description
Requirements
Inventory plugin usage
Cluster management plans usage

Description

The Lima module is a "glue" between Puppet Bolt and lima

Requirements

You will need to have installed limactl on the system you wish to run Bolt from.

Inventory plugin usage

The resolve_reference task supports looking up target objects from a limactl list output. It accepts following parameters:

limactl: Location of the limactl binary if not in $PATH.
only_matching_names: Only VM with names matching this regex will be included into the inventory. This regex is passed to Regexp.new() as a string.
except_matching_names: VMs with names matching this regex will be excluded from the inventory. This regex is passed to Regexp.new() as a string.

NOTE 1: Only running VMs are returned.

NOTE 2: If both only_matching_names and except_matching_names are specified then only VMs matching only_matching_names and not matching except_matching_names are returned.

Examples

groups:
  - name: lima-vms
    targets:
      - _plugin: lima
        except_matching_names: '^default'

Cluster management plans usage

This module provides a way to define and manage clusters of Lima VMs. It's expected to define clusters in the plan_hierarchy of your Bolt project's Hiera.

Below is the example of a Hiera file under plan_hierarchy:

---
# Leverage YAML features to define templates required
x-ubuntu2004: &ubuntu2004
  images:
  - location: "https://cloud-images.ubuntu.com/releases/20.04/release-20230117/ubuntu-20.04-server-cloudimg-amd64.img"
    arch: "x86_64"
    digest: "sha256:3e44e9f886eba6b91662086d24028894bbe320c1de89be5c091019fedf9c5ce6"
  - location: "https://cloud-images.ubuntu.com/releases/20.04/release-20230117/ubuntu-20.04-server-cloudimg-arm64.img"
    arch: "aarch64"
    digest: "sha256:4ea4700f7b1de194a2f6bf760b911ea3071e0309fcea14d3a465a3323d57c60e"
  - location: "https://cloud-images.ubuntu.com/releases/20.04/release/ubuntu-20.04-server-cloudimg-amd64.img"
    arch: "x86_64"
  - location: "https://cloud-images.ubuntu.com/releases/20.04/release/ubuntu-20.04-server-cloudimg-arm64.img"
    arch: "aarch64"
  mounts:
  - location: "~"

# Cluster definitions
lima::clusters:
  example: # `example` cluster
    nodes:
      - example1
        template: ubuntu  # Use latest ubuntu version on this VM
      - example2
      - example3
    config:
      <<: *ubuntu2004

Now when you have some clusters defined you can use cluster management plans to start/stop/delete a cluster. E.g.:

# Start the cluster (create example[123] VMs)
bolt plan run lima::cluster::start name=example
# Stop the cluster (stop example[123] VMs)
bolt plan run lima::cluster::stop name=example
# Delete the cluster (delete example[123] VMs)
bolt plan run lima::cluster::delete name=example

Reference

Reference documentation for the module is generated using puppet-strings and available in REFERENCE.md

Reference

Tasks

delete: Delete Lima VM
list: Return list of Lima VMs
resolve_reference: Generate Bolt targets from Lima VMs
start: Create or start Lima VM
stop: Stop Lima VM

Plans

lima::cluster::delete: Delete the cluster of Lima VMs
lima::cluster::start: Create/start the cluster of Lima VMs
lima::cluster::stop: Stop the cluster of Lima VMs
lima::clusters: Return the cluster definition

Tasks

`delete`

Delete Lima VM

Supports noop? false

Parameters

`limactl_path`

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

`name`

Data type: String[1]

VM name

`list`

Return list of Lima VMs

Supports noop? false

Parameters

`limactl_path`

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

`names`

Data type: Optional[Array[String[1]]]

VM names to list

`resolve_reference`

Generate Bolt targets from Lima VMs

Supports noop? false

Parameters

`limactl_path`

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

`only_matching_names`

Data type: Optional[Pattern]

Only VM with names matching this regex will be included into the inventory.

`except_matching_names`

Data type: Optional[Pattern]

VMs with names matching this regex will be excluded from the inventory.

`start`

Create or start Lima VM

Supports noop? false

Parameters

`limactl_path`

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

`name`

Data type: String[1]

VM name

`timeout`

Data type: Optional[String[1]]

Duration to wait for the instance to be running before timing out

`url`

Data type: Optional[String[1]]

Remote URL containing YAML configuration to create the instance from

`template`

Data type: Optional[String[1]]

Lima template to create the instance from

`config`

Data type: Optional[Hash]

Configuration hash to create the instance from

`stop`

Stop Lima VM

Supports noop? false

Parameters

`limactl_path`

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

`name`

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
clusters
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
clusters
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
clusters
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
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' => {})

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

delete

Delete Lima VM

Parameters
limactl_path	Location of the `limactl` binary if not in PATH `Optional[String[1]]`
name	VM name `String[1]`

list

Return list of Lima VMs

Parameters
limactl_path	Location of the `limactl` binary if not in PATH `Optional[String[1]]`
names	VM names to list `Optional[Array[String[1]]]`

resolve_reference

Generate Bolt targets from Lima VMs

Parameters
except_matching_names	VMs with names matching this regex will be excluded from the inventory. `Optional[Pattern]`
limactl_path	Location of the `limactl` binary if not in PATH `Optional[String[1]]`
only_matching_names	Only VM with names matching this regex will be included into the inventory. `Optional[Pattern]`

Input method

stdin

start

Create or start Lima VM

Parameters
config	Configuration hash to create the instance from `Optional[Hash]`
limactl_path	Location of the `limactl` binary if not in PATH `Optional[String[1]]`
name	VM name `String[1]`
template	Lima template to create the instance from `Optional[String[1]]`
timeout	Duration to wait for the instance to be running before timing out `Optional[String[1]]`
url	Remote URL containing YAML configuration to create the instance from `Optional[String[1]]`

Input method

stdin

stop

Stop Lima VM

Parameters
limactl_path	Location of the `limactl` binary if not in PATH `Optional[String[1]]`
name	VM name `String[1]`

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Modules

Discover

Contribute

Resources

About Forge

Getting Started

lima

Version information

This version is compatible with:

Tasks:

Plans:

Start using this module

Documentation

lima

Description

Requirements

Inventory plugin usage

Examples

Cluster management plans usage

Reference

Reference

Table of Contents

Tasks

Plans

Tasks

delete

Parameters

limactl_path

name

list

Parameters

limactl_path

names

resolve_reference

Parameters

limactl_path

only_matching_names

except_matching_names

start

Parameters

limactl_path

name

timeout

url

template

config

stop

Parameters

limactl_path

name

Plans

lima::cluster::delete

Parameters

name

clusters

target

lima::cluster::start

Parameters

name

clusters

target

lima::cluster::stop

Parameters

name

clusters

target

lima::clusters

Parameters

name

clusters

What are tasks?

Tasks in this module release

delete

list

resolve_reference

start

stop

What are plans?

Change log

v1.1.1 (2023-02-21)

`delete`

`limactl_path`

`name`

`list`

`limactl_path`

`names`

`resolve_reference`

`limactl_path`

`only_matching_names`

`except_matching_names`

`start`

`limactl_path`

`name`

`timeout`

`url`

`template`

`config`

`stop`

`limactl_path`

`name`

`lima::cluster::delete`

`name`

`clusters`

`target`

`lima::cluster::start`

`name`

`clusters`

`target`

`lima::cluster::stop`

`name`

`clusters`

`target`

`lima::clusters`

`name`

`clusters`