Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lxc/terraform-provider-incus
Incus provider for Terraform/OpenTofu
https://github.com/lxc/terraform-provider-incus
containers incus opentofu terraform virtual-machines
Last synced: about 6 hours ago
JSON representation
Incus provider for Terraform/OpenTofu
- Host: GitHub
- URL: https://github.com/lxc/terraform-provider-incus
- Owner: lxc
- License: mpl-2.0
- Created: 2023-12-15T14:44:53.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T01:27:53.000Z (9 days ago)
- Last Synced: 2024-10-30T03:57:37.898Z (8 days ago)
- Topics: containers, incus, opentofu, terraform, virtual-machines
- Language: Go
- Homepage: https://linuxcontainers.org/incus
- Size: 12.5 MB
- Stars: 56
- Watchers: 8
- Forks: 11
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# terraform-provider-incus
Incus Resource provider for Terraform
## Prerequisites
- [Terraform](http://terraform.io)
- [Incus](https://linuxcontainers.org/incus)
## Installation
This provider is published in the [Terraform Registry](https://registry.terraform.io/providers/lxc/incus).
Follow the official instructions for declaring providers in your Terraform configuration
[here](https://www.terraform.io/docs/configuration/provider-requirements.html).
### Quick Example
Add the following to your Terraform configuration:
```hcl
terraform {
required_providers {
incus = {
source = "lxc/incus"
}
}
}
```
### Development
#### Setup
1. Follow these [instructions](https://golang.org/doc/install) to setup a Golang development environment.
2. Checkout the repository `git clone ...`
3. Compile from sources to a development binary:
```shell
cd terraform-provider-incus
go build -v
```
4. Configure Terraform (`~/.terraformrc`) to use the development binary provider:
```shell
$ cat ~/.terraformrc
provider_installation {
dev_overrides {
"lxc/incus" = "/home//git/terraform-provider-incus"
}
}
```
#### Testing
There are two test suites, unit and acceptance. By default the acceptance tests are not run as they require a functional
Incus environment.
##### Unit tests
```shell
make test
```
##### Acceptance tests
```shell
make testacc
# or run an individual test
TESTARGS="-run TestAccImage_basicVM" make testacc
# increase test verbosity. options are trace, debug, info, warn, or error (default)
TF_LOG=info make testacc
```
## Documentation
Full documentation can be found in the [`docs`](docs) directory.
## Known Limitations
Many of the base Incus images don't include an SSH server, therefore terraform
will be unable to execute any `provisioners`. Either use the base ubuntu images
from the `ubuntu` or `ubuntu-daily` or manually prepare a base image that
includes SSH.
## Contributors
Some recognition for great contributors to this project:
- [jgraichen](https://github.com/jgraichen)
- [jtopjian](https://github.com/jtopjian)
- [mjrider](https://github.com/mjrider)
- [sl1pm4t](https://github.com/sl1pm4t)
- [yobert](https://github.com/yobert)