Skip to content

Commit d552a50

Browse files
authored
Update version formatting and readme (#18)
* Use version formatting as shown in documentation * Update README.md * Update README.md * Update README.md * Add images for documentation * Add images for documentation * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 051a37d commit d552a50

File tree

5 files changed

+18
-6
lines changed

5 files changed

+18
-6
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ To create a qcow2 template that is modified to contain certain programs. This is
1212

1313
## Usage
1414

15-
The following command will create a qcow2 image at 'output-archlinux/golden-arch.qcow2' and create a template with VM ID 9000.
15+
This repo uses the [playbook.yml](https://github.com/Naman1997/arch-cloud-image/blob/main/playbook.yml) file in the root directory to create the golden image. In case you want to install any additional tools or make any changes, make sure to modify that file. The playbook installs a list of packages that are present in the [pkglist.txt](https://github.com/Naman1997/arch-cloud-image/blob/version/http/pkglist.txt) file that you can modify as well.
16+
17+
The following command will create a qcow2 image at `output-archlinux/golden-arch.qcow2` and create a template with ID `9000`.
1618
This command assumes that you'll be using the same public key to ssh into the proxmox node as well as the VMs created by the template to keep things simple.
1719

18-
WARNING: If a VM/Template has ID 9000, then these commands will destroy and replace it with the golden image template for proxmox.
20+
WARNING: If a VM/Template has ID `9000`, then these commands will destroy and replace it with the golden image template for proxmox.
1921

2022
```
2123
make -s template \
@@ -25,15 +27,25 @@ make -s template \
2527
PATH_TO_PUB_KEY=<your_path_to_pub_key>
2628
```
2729
```
28-
#Example
30+
#Example [Make sure you're able to ssh in the proxmox node using the key provided here]
2931
make -s template \
3032
CLOUD_USER=arch \
3133
PROXMOX_USERNAME=root \
3234
PROXMOX_IP=192.168.0.100 \
3335
PATH_TO_PUB_KEY=~/.ssh/id_rsa.pub
3436
```
3537

36-
To use the created template [ID 9000], create a clone using it and attempt to ssh into the VM using user as CLOUD_USER.
38+
To use the created template ID `9000`, create a clone using it and attempt to ssh into the VM using user as CLOUD_USER.
39+
40+
![Creating a Full Clone](images/clone.png)
41+
42+
You will be able to see the IP address of the VM once it boots up as long as you didn't remove the installation of `qemu-guest-agent` from the ansible playbook.
43+
44+
![A cloned node](images/ip.png)
45+
46+
Once the node is up and running, you can use the SSH key you provided to log in the node.
47+
48+
![SSH Login](images/login.png)
3749

3850
## Cleanup
3951

archlinux.pkr.hcl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ packer {
22
required_plugins {
33
qemu = {
44
source = "github.com/hashicorp/qemu"
5-
version = "~> 1"
5+
version = ">= 1.1.1"
66
}
77
ansible = {
88
source = "github.com/hashicorp/ansible"
9-
version = "~> 1"
9+
version = ">= 1.1.3"
1010
}
1111
}
1212
}

images/clone.png

47.1 KB
Loading

images/ip.png

61.1 KB
Loading

images/login.png

71.7 KB
Loading

0 commit comments

Comments
 (0)