Skip to content

Commit

Permalink
doc: Add third party tools page
Browse files Browse the repository at this point in the history
Closes lxc#556

Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
  • Loading branch information
stgraber authored and mikerobski committed Mar 12, 2024
1 parent efdcc82 commit 8218440
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/external_resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
Project repository <https://github.com/lxc/incus>
Image server <https://images.linuxcontainers.org>
Third party tools </third_party>
```
35 changes: 35 additions & 0 deletions doc/third_party.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Third party tools and integrations
Below are a list of common operations tools which feature Incus support, either natively or through a plugin.

## Terraform / OpenTofu
[Terraform](https://www.terraform.io) and [OpenTofu](https://opentofu.org) are infrastructure as code tools which focus on creating the infrastructure itself.
For Incus, this means the ability to create projects, profiles, networks, storage volumes and of course instances.

In most cases, one will then use Ansible to deploy the workloads
themselves once the instances and everything else they need as been put in place.

The integration with Incus is done through a [dedicated provider](https://github.com/lxc/terraform-provider-incus).

## Ansible
[Ansible](https://www.ansible.com) is an infrastructure as code tool with particular focus on software provisioning and configuration management.
It does most of its work by first connecting to the system that it's deploying software on.

To do that, it can connect over SSH and a variety of other protocols, one of which is [Incus](https://docs.ansible.com/ansible/latest/collections/community/general/incus_connection.html).

That allows for easily deploying software inside of Incus instances without needing to first setup SSH.

## Packer
[Packer](https://www.packer.io) is a tool to generate custom OS images across a wide variety of platforms.

A [plugin](https://developer.hashicorp.com/packer/integrations/bketelsen/incus) exists that allows Packer to generate Incus images directly.

## Distrobuilder
[Distrobuilder](https://github.com/lxc/distrobuilder) is an image building tool most known for producing the official LXC and Incus images.
It consumes YAML definitions for its images and generates LXC container images as well as Incus container and VM images.

The focus of Distrobuilder is in producing clean images from scratch, as opposed to repacking existing images.

## GARM
[GARM](https://github.com/cloudbase/garm) is the Github Actions Runner Manager which allows for running self-hosted Github runners.

It supports a variety of providers for those runners, including [Incus](https://github.com/cloudbase/garm-provider-incus).

0 comments on commit 8218440

Please sign in to comment.