matthew/packer-plugin-xenserver
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Moved explanation of the centos example into the pkr file

Browse Source
This commit is contained in:
4censord 2021-04-16 13:08:15 +02:00
parent 4c183b3bd3
commit 207656b4d1
2 changed files with 44 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/builders/iso/Commented-Example.md
View File

@ -9,15 +9,21 @@ description: |-
# What's this
This Example builds a vanilla Centos 8 Template. No Provisioning or Post-Processing will be done.
If you want to run this example, you have to replace the following variables with your own values.
```hcl
remote_host = "xenserver.example.org"
remote_username = "root"
remote_password = "very-secret-password"
sr_iso_name = "Local-ISO"
sr_name = "Local-SR"
tools_iso_name = "guest-tools.iso"
```
After changing those, run
`packer init examples/http/centos/centos8-example.pkr.hcl` to download the xenserver plugin
and
`packer build examples/http/centos/centos8-example.pkr.hcl` to create the vm
## Parts of this example
This examples composes the following files from the examples folder
@ -25,67 +31,6 @@ This examples composes the following files from the examples folder
* [centos8-example.pkr.hcl](../../examples/http/centos/centos8-example.pkr.hcl)
* [ks-centos8-example.cfg](../../examples/http/centos/ks-centos8-example.cfg)
## Explanation of centos8-example.pkr.hcl
```hcl
packer {
required_plugins {
xenserver= {
version = ">= v0.3.2"
source = "github.com/ddelnano/xenserver"
}
}
}
```
this tells packer that it needs the `xenserver` plugin to run this script.
`version = ">= v0.3.2"` with a version higher than 0.3.2
`source = "github.com/ddelnano/xenserver"` found on github
Both file contain comments explaining what they do
* `source "xenserver-iso" "example" { } ` directs packer to configure an Artifact named example using the `xenserver-iso` builder
* `iso_url = "http://mirrors.ocf.berkeley.edu/centos/8.3.2011/isos/x86_64/CentOS-8.3.2011-x86_64-dvd1.iso" ` use the iso obtainable from this url
* `iso_checksum_type = "sha1"` the checksum is of type sha1
* `iso_checksum = "aaf9d4b3071c16dbbda01dfe06085e5d0fdac76df323e3bbe87cce4318052247"` The checksum for the ISO.
* `sr_name = "Local-SR"` store the vmdisk used during install on the SR named `Local-SR`
* `sr_iso_name = "Local-ISO"` store the iso used during install on the ISO-SR named `Local-ISO`
* `tools_iso_name = "guest-tools.iso"` mount the guest-tools iso with the name `guest-tools.iso`
* `remote_host = "xenserver.example.org"` the ipadress or fqdn of the xenserver. This should be the pool primary
* `remote_username = "root"` the user with witch to connect.
* `remote_password = "very-secret-password"` the password for the user.
* `vm_name = "packer-centos8-example"` How packer will name the vm.
* `vm_description = "This is an example."` The description field of the vm
* `vm_memory = 4096` the Amount of RAM, in MB
* `disk_size = 4096` the Size of the Primary Disk in MB
* `http_directory = "examples/http/centos8'` Packer will spin up a http-server for serving files to the installing vm. the kickstart file `ks-centos8-examples.cfg` is in this directory
* `boot_wait = "10s'` Wait for 10s after starting the VM before typeing the `boot_command`
* `boot_command = ["<tab> text ks=http://{{ .HTTPIP }}:{{ .HTTPPort }}/ks-centos8-examples.cfg<enter><wait>"'`
* The command to type into the installing vm.
* `<tab>` a tab Character `\t`
* `text ks=http://` character literals
* `{{ .HTTPIP }}` will be replaced by the local ip-address.
* `:` character literal
* `{{ .HTTPPort }}` will be replaced by the local port. Will be randomly selectet between 8000 and 9000
* `/ks-centos8-examples.cfg` character literals
* `<enter>` an enter character
* `<wait>` wait for 1s
* `ssh_username = "root"` The ssh user packer uses to connect to the VM
* `ssh_password = "centos"` The ssh password packer uses to connect to the VM
* `ssh_wait_timeout = "10m"` consider install failed if unable to connect via ssh 10m into the build
* `shutdown_command = "/sbin/shutdown"` After connection via ssh issue this command to shut down the vm
* `output_directory = "packer-centos8-local"` Store the resulting xva file in this directory
* `keep_vm = "on_success"` Create a template with the vm after a successfull build
* `build { }` Tell packer what to do while builing
* `sources = ["xenserver-iso.example"]` Build the `xenserver.example` without changing any configuration.
## Explanation of ks-centos8-examples.cfg
The kickstart file is documentd via comments.
[ks-centos8-example.cfg](../../examples/http/centos/ks-centos8-example.cfg)

55
examples/centos/centos8-example.pkr.hcl
View File

@ -1,15 +1,18 @@
# This is for packer to find the xenserver plugin
# so that you no longer need to install it by hand
#this tells packer that it needs the `xenserver` plugin to run this script.
packer {
required_plugins {
xenserver= {
# specifically a version higher than 0.3.2
version = ">= v0.3.2"
# which can be found on github
source = "github.com/ddelnano/xenserver"
}
}
}
# packer configures an Artifact named "example" using the "xenserver-iso" builder
source "xenserver-iso" "example" {
#
# Where to get the iso
@ -20,41 +23,51 @@ source "xenserver-iso" "example" {
#
# Where to store the ISO, vm-disk and where to find the xentools iso
#
sr_iso_name = "Local-ISO"
sr_name = "Local-SR"
tools_iso_name = "guest-tools.iso"
sr_iso_name = "Local-ISO" # store the iso used during install on the ISO-SR named `Local-ISO`
sr_name = "Local-SR" # store the vmdisk used during install on the SR named `Local-SR`
tools_iso_name = "guest-tools.iso" # mount the guest-tools iso with the name `guest-tools.iso`
#
# How to communicate with the xenserver
#
remote_host = "xenserver.example.org"
remote_username = "root"
remote_password = "very-secret-password"
remote_host = "xenserver.example.org" # the ipadress or fqdn of the xenserver. This should be the pool primary
remote_username = "root" # the user with which to connect.
remote_password = "very-secret-password" # the password for the user.
#
# Basic info for the vm
#
vm_name = "packer-centos8-example"
vm_description = "This is an example."
vm_memory = 4096
disk_size = 4096
vm_name = "packer-centos8-example" # how packer will name the vm.
vm_description = "This is an example." # the description field of the vm
vm_memory = 4096 # the Amount of RAM, in MB
disk_size = 4096 # the Amount of RAM, in MB
#
# For the installation
#
http_directory = "examples/http/centos8"
http_directory = "examples/http/centos8" # Packer will spin up a http-server for serving files to the installing vm. the kickstart file `ks-centos8-examples.cfg` is in this directory
boot_wait = "10s" # Wait for 10s after starting the VM before typeing the `boot_command`
boot_command = ["<tab> text ks=http://{{ .HTTPIP }}:{{ .HTTPPort }}/ks-centos8-examples.cfg<enter><wait>"]
boot_wait = "10s"
# The command to type into the installing vm.
# `<tab>` a tab Character `\t`
# `text ks=http://` character literals
# `{{ .HTTPIP }}` will be replaced by the local ip-address.
# `:` character literal
# `{{ .HTTPPort }}` will be replaced by the local port. Will be randomly selectet between 8000 and 9000
# `/ks-centos8-examples.cfg` character literals
# `<enter>` an enter character
# `<wait>` wait for 1s
#
# how packer contacts the vm
#
ssh_username = "root"
ssh_password = "centos"
ssh_wait_timeout = "10m"
shutdown_command = "/sbin/shutdown"
ssh_username = "root" # The ssh user packer uses to connect to the VM
ssh_password = "centos" # The ssh password packer uses to connect to the VM
ssh_wait_timeout = "10m" # consider install failed if unable to connect via ssh 10m into the build
shutdown_command = "/sbin/shutdown" # After connection via ssh issue this command to shut down the vm
#
# What to do with the resulting VM
#
output_directory = "packer-centos8-local"
keep_vm = "on_success"
output_directory = "packer-centos8-local" # Store the resulting xva file in this directory
keep_vm = "on_success" # Create a template with the vm after a successfull build
composes
}
#
# Operations to do while building.