Update Readme
This commit is contained in:
parent
fcd72ffa7a
commit
3b9a53364f
64
README.md
64
README.md
|
@ -1,6 +1,11 @@
|
||||||
# XenServer packer.io builder
|
FORKED FROM https://github.com/ddelnano/packer-plugin-xenserver
|
||||||
|
|
||||||
This builder plugin extends packer.io to support building images for XenServer.
|
The binary must be compiled before usage.
|
||||||
|
I remove the code to plug the guest-tools disk, to have a working Debian install. Tools are installed in the end of the installation (see preseed configuration)
|
||||||
|
|
||||||
|
# XCP-ng packer.io builder
|
||||||
|
|
||||||
|
This builder plugin extends packer.io to support building images for XCP-ng.
|
||||||
|
|
||||||
This is a fork of the original builder since the original project was abandoned and no longer compilied with recent versions of Go or worked with Xenserver 7.6 and later.
|
This is a fork of the original builder since the original project was abandoned and no longer compilied with recent versions of Go or worked with Xenserver 7.6 and later.
|
||||||
|
|
||||||
|
@ -8,66 +13,15 @@ It improves the original project in the following ways:
|
||||||
1. Developed alongside the [Xenorchestra terraform provider](https://github.com/ddelnano/terraform-provider-xenorchestra) to ensure the hashicorp ecosystem is interoperable.
|
1. Developed alongside the [Xenorchestra terraform provider](https://github.com/ddelnano/terraform-provider-xenorchestra) to ensure the hashicorp ecosystem is interoperable.
|
||||||
2. Reimplements how the boot commands are sent over VNC to be compatible with later versions of Xenserver (Citrix hypervisor) and XCP
|
2. Reimplements how the boot commands are sent over VNC to be compatible with later versions of Xenserver (Citrix hypervisor) and XCP
|
||||||
|
|
||||||
## Status
|
|
||||||
|
|
||||||
At the time of this writing the packer builder has been verified to work with Xenserver 7.6 and can launch VMs with the packer output through the xenorchestra terraform provider.
|
|
||||||
|
|
||||||
The following list contains things that are incomplete but will be worked on soon:
|
|
||||||
- The documentation is still in an inconsistent state with upstream
|
|
||||||
- XVA builder is untested
|
|
||||||
- Lots of dead code to remove from upstream
|
|
||||||
|
|
||||||
## Using the builder
|
|
||||||
|
|
||||||
The packer builder can be installed via `packer init` as long as the packer template includes the following in it's `pkr.hcl` file
|
|
||||||
```
|
|
||||||
packer {
|
|
||||||
required_plugins {
|
|
||||||
xenserver= {
|
|
||||||
version = ">= v0.3.2"
|
|
||||||
source = "github.com/ddelnano/xenserver"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
The following command will install the packer plugin using the Ubuntu example provided in this repository.
|
|
||||||
|
|
||||||
```
|
|
||||||
packer init examples/ubuntu/ubuntu-2004.pkr.hcl
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using an older version of packer or are still using json templates you will need to download the relevant release from the project's [releases page](https://github.com/ddelnano/packer-builder-xenserver/releases) and copy the binary to `~/.packer.d/plugins/packer-builder-xenserver-iso`.
|
|
||||||
|
|
||||||
## Developing the builder
|
|
||||||
|
|
||||||
### Dependencies
|
|
||||||
* Packer >= v1.7.1 (https://packer.io)
|
|
||||||
* XenServer / Citrix Hypervisor > 7.6
|
|
||||||
* Golang 1.16
|
|
||||||
|
|
||||||
## Compile the plugin
|
## Compile the plugin
|
||||||
|
|
||||||
Once you have installed Packer, you must compile this plugin and install the
|
Once you have installed Packer, you must compile this plugin and install the
|
||||||
resulting binary.
|
resulting binary.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ go build -o packer-plugin-xenserver
|
$ go build -o packer-plugin-xcp-ng
|
||||||
|
|
||||||
# Add the builder to the location packer expects it to be installed in
|
# Add the builder to the location packer expects it to be installed in
|
||||||
$ mkdir -p ~/.packer.d/plugins/
|
$ mkdir -p ~/.packer.d/plugins/
|
||||||
$ cp builder-xenserver-iso ~/.packer.d/plugins/packer-builder-xenserver-iso
|
$ cp packer-plugin-xcp-ng ~/.packer.d/plugins/packer-plugin-xcp-ng
|
||||||
```
|
```
|
||||||
|
|
||||||
# Documentation
|
|
||||||
|
|
||||||
For complete documentation on configuration commands, see [the
|
|
||||||
xenserver-iso docs](docs/builders/xenserver-iso.html.markdown)
|
|
||||||
|
|
||||||
## Support
|
|
||||||
|
|
||||||
You can discuss any issues you have or feature requests in [Discord](https://discord.gg/ZpNq8ez).
|
|
||||||
|
|
||||||
If you'd like to support my effort on the project, please consider buying me a coffee
|
|
||||||
|
|
||||||
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/ddelnano)
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user