Skip to content

Commit

Permalink
Updating edits
Browse files Browse the repository at this point in the history
  • Loading branch information
konstructcarrie committed Nov 25, 2024
1 parent 6d703c7 commit cab5071
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Choose an option to install Colony in an environment and start bare
sidebar_position: 2
---

# Get Started
## Get Started

If you're new to Colony we recommend checking out the [Overview](/docs/index.md) to learn more about Colony.

Expand Down
19 changes: 10 additions & 9 deletions docs/install/proxmox/proxmox-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ The steps here are optional, but we recommend completing these to create a Proxm

### Debian image

These steps use a `debian cloudinit image for laptop VM`.
These steps use a `debian cloudinit image for laptop VM`. The commands below should be issued in the Proxmox host machine. You can SSH into the host or use the shell in the Proxmox UI.

Check failure on line 21 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces

docs/install/proxmox/proxmox-setup.md:21:185 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
To access the shell select `Datacenter` > your node (choose one if you have multiple > `shell`.

- You will need to install `libguestfs-tools` to interact with cloud-init image.

Expand All @@ -27,8 +28,9 @@ These steps use a `debian cloudinit image for laptop VM`.
apt install libguestfs-tools
```


- Might to prepend sudo if you running user different than `root`
:::tip
We recommend prepending sudo to these commands if you are running a user other than `root`.

Check failure on line 32 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces

docs/install/proxmox/proxmox-setup.md:32:92 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md
:::

Start by creating a directory. This will contain temporary artifacts we need to create template VM. Then download Debian cloud-init image [debian download image](https://cloud.debian.org/images/cloud/).

Check failure on line 35 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Trailing spaces

docs/install/proxmox/proxmox-setup.md:35:203 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md009.md

Expand All @@ -40,8 +42,7 @@ wget https://cloud.debian.org/images/cloud/bookworm/20241004-1890/debian-12-gene
```

### Guest agent and VIM

Check failure on line 44 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Headings should be surrounded by blank lines

docs/install/proxmox/proxmox-setup.md:44 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Guest agent and VIM"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md022.md

Install `qemu-guest-agent` and `vim`. This enables information to report back from the guest machine to the host. Allows power off commands to pass to the guest.
We recommend using `virt-customize` to install `qemu-guest-agent` and `vim`. The `qemu-guest-agent` provides a communication channel between a virtual machine and its Proxmox, enabling features like shutdown, time synchronization, and better management of guest systems.

```shell
virt-customize -a debian-12-genericcloud-amd64-20241004-1890.qcow2 --install qemu-guest-agent
Expand Down Expand Up @@ -72,7 +73,7 @@ virt-customize -a debian-12-genericcloud-amd64-20241004-1890.qcow2 --copy-in ./k

### Resize config

Remove machine config and resize root disk to `32 Gb`. This allows new virtual machines created from the template to have unique machine ID.
To prepare the virtual machine increase the disk size to `32 Gb` and remove any machine-specific information generated in the previous step. This ensures that the image can be cloned and reused without conflicts.

```shell
virt-sysprep -a debian-12-genericcloud-amd64-20241004-1890.qcow2
Expand Down Expand Up @@ -175,10 +176,10 @@ sudo mv colony /usr/local/bin
Install colony. Better wording would be creaste a Colony cluste or something. Check the interface you are listening on with `ip a` command.
Colony will use this interface to listen to DHCPOFFER traffic and respond with boot files.

``` shell
colony init \
--apiKey $YOUR_COLONY_API_KEY \
--loadBalancerInterface eth0 \
--api-key=$COLONY_API_KEY \
--load-balancer-interface=$INTERFACE \
--load-balancer-ip=$LOAD_BALANCER_IP
--loadBalancerIP <loadbalancer>
```

Check failure on line 184 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Fenced code blocks should be surrounded by blank lines

docs/install/proxmox/proxmox-setup.md:184 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md031.md

Check failure on line 184 in docs/install/proxmox/proxmox-setup.md

View workflow job for this annotation

GitHub Actions / check-markdown (.md, **.md, md.markdownlint.json)

Fenced code blocks should have a language specified

docs/install/proxmox/proxmox-setup.md:184 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md040.md
Expand Down
2 changes: 1 addition & 1 deletion docs/install/proxmox/proxmox-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 4

## Using Colony

With Proxmox installed and Colony running you should be able to view all of the infrastructure you created in the Colony UI.
With Proxmox installed and Colony running you should be able to view all of the infrastructure you created in the Colony UI.

## Creating Clusters

Expand Down
5 changes: 3 additions & 2 deletions docs/install/vagrant/virtual-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ description: Follow the steps to install Colony in a virtual Vagrant environment
sidebar_position: 3
---

# Installing Colony
## Installing Colony

## Summary

This installation guide walks through what you need to install Colony into a repeatable Vagrant virtual environment. The virtual data center `colony-vagrant` creates an environment that you can host on a single Civo compute instance to explore Colony
This installation guide walks through what you need to install Colony into a repeatable Vagrant virtual environment.
The virtual data center `colony-vagrant` creates an environment that you can host on a single Civo compute instance to explore Colony

_We’re working to expand support for this virtual data center to include AWS soon._

Expand Down
2 changes: 1 addition & 1 deletion docs/install/vagrant/virtual-install2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Use Colony with Vagrant
description: Use Colony in a virtual environment to learn more
sidebar_position: 4
---
# Use Colony in the VM
## Using Colony in the VM

## Summary

Expand Down

0 comments on commit cab5071

Please sign in to comment.