Update content previously from wild-cloud repo.
This commit is contained in:
@@ -6,6 +6,9 @@ series:
|
||||
series_order: 5
|
||||
---
|
||||
|
||||
{{<go-deeper>}}
|
||||
This section is mandatory and, we admit, not accessible to non-technical audience. We have plans for this before releasing to early-adopters. These instructions are a placeholder suitable for Wild Cloud devs and will be replaced before the Early-Adopter release.
|
||||
{{</go-deeper>}}
|
||||
|
||||
## Get your hardware
|
||||
|
||||
@@ -13,12 +16,13 @@ Make sure you have a dedicated machine for your DNS server. It can be tiny, like
|
||||
|
||||
## Install your OS
|
||||
|
||||
- Install another Debian-based Linux machine on your LAN (e.g. Debian or Ubuntu).
|
||||
- Install another Debian-based Linux machine on your LAN (e.g. Debian or Ubuntu).
|
||||
- Make sure you can SSH in from your operator machine.
|
||||
- Record it's IP address.
|
||||
|
||||
## Install the DNS software
|
||||
|
||||
- Run `wild-dnsmasq-install` from your operator machine.
|
||||
- Run `wild-dnsmasq-install` from your Wild Cloud Home on your operator machine.
|
||||
|
||||
## Update your LAN router
|
||||
|
||||
|
||||
@@ -10,13 +10,17 @@ series_order: 4
|
||||
|
||||
## Your operator machine
|
||||
|
||||
Your operator machine is your main workspace (I think of it more as play, actually) for managing your wild cloud. You will install the Wild Cloud software on your operator machine and use it to setup and manage everything related to your wild cloud.
|
||||
Your operator machine is the computer you manage your wild cloud with. Below, we will install the Wild Cloud software on your operator machine.
|
||||
|
||||
## Download the Wild Cloud software onto your operator machine
|
||||
Your operator machine should be a [Linux](/learning/linux/) machine on your LAN. It's helpful if it has a nice big hard drive you can use for backing up your wild cloud data.
|
||||
|
||||
Your operator machine should be a [Linux](/learning/linux/) machine on your LAN. It's helpful if it has a nice big hard drive you can use for backing up your cloud data.
|
||||
## Install the Wild Cloud software
|
||||
|
||||
{{< gitea server="https://git.civilsociety.dev" repo="CSTF/wild-cloud" showThumbnail=true >}}
|
||||
{{< go-deeper >}}
|
||||
We recognize that this part of the guide requires more knowledge of `git` and `bash`. We plan to create a `wild` CLI and perhaps even a GUI setup before wider release. For now, we are prototyping our (fully functional) POC by using scripts from this Wild Cloud repo.
|
||||
{{< /go-deeper >}}
|
||||
|
||||
Download the Wild Cloud software using git:
|
||||
|
||||
```bash
|
||||
git clone https://git.civilsociety.dev/CSTF/wild-cloud.git
|
||||
@@ -32,3 +36,21 @@ Install dependencies:
|
||||
```bash
|
||||
scripts/setup-utils.sh
|
||||
```
|
||||
|
||||
## Create your Wild Cloud Home
|
||||
|
||||
Now that you have the Wild Cloud software installed, we are going to create a directory that will hold everything about your personal wild cloud. We call this your "Wild Cloud Home".
|
||||
|
||||
{{< definition >}}
|
||||
Your **Wild Cloud Home** is the directory where all of your wild cloud data will be stored. This includes your configuration files, data files, and any other files related to your wild cloud.
|
||||
{{< /definition >}}
|
||||
|
||||
You can put it in any directory. Here we show an example if you want to make a directory named `my-wild-cloud` in your home directory.
|
||||
|
||||
```bash
|
||||
mkdir -p ~/my-wild-cloud
|
||||
cd ~/my-wild-cloud
|
||||
wild-cloud-scaffold
|
||||
```
|
||||
|
||||
That's it! Your wild cloud operator machine is ready to go! Most of the rest of the instructions in this guide will assume you are working within this directory.
|
||||
|
||||
@@ -6,43 +6,101 @@ series:
|
||||
series_order: 6
|
||||
---
|
||||
|
||||
## Set up your own Wild Cloud!
|
||||
This section of the guide will walk you through setting up your wild cloud cluster. When you are done, you will have a complete wild cloud, all set up, ready for your apps!
|
||||
|
||||
That's it! Now you can start setting up your wild cloud!
|
||||
## Prepare your USB key(s)
|
||||
|
||||
First, make a directory for your wild cloud home. For example `my-wild-cloud` in your home directory.
|
||||
### Download the correct Talos ISO
|
||||
|
||||
You will be using a USB key to boot each of your cluster machines. Let's create the bootable USB key now.
|
||||
|
||||
From your wild cloud home, run:
|
||||
|
||||
```bash
|
||||
mkdir ~/my-wild-cloud
|
||||
cd ~/my-wild-cloud
|
||||
# Upload schematic configuration to get schematic ID from the Talos ISO service.
|
||||
wild-talos-schema
|
||||
|
||||
# Download custom ISO with system extensions.
|
||||
wild-cluster-node-boot-assets-download
|
||||
```
|
||||
|
||||
Now, you can start the setup process! Just run...
|
||||
This will download all the Talos ISOs for your wild cloud configuration.
|
||||
|
||||
The custom ISO includes system extensions needed for a wild cloud cluster and is saved to `.wildcloud/iso/talos-v<VERSION>-metal-amd64.iso`.
|
||||
|
||||
|
||||
### Copy ISO to a USB drive
|
||||
|
||||
```bash
|
||||
# Find your USB device (be careful to select the right device!)
|
||||
lsblk
|
||||
sudo dmesg | tail # Check for recently connected USB devices
|
||||
|
||||
# Create bootable USB (replace /dev/sdX with your USB device and set the version you donwloaded.
|
||||
sudo dd if=.wildcloud/iso/talos-v<VERSION>-metal-amd64.iso of=/dev/sdX bs=4M status=progress sync
|
||||
|
||||
# Verify the write completed
|
||||
sync
|
||||
```
|
||||
|
||||
**⚠️ Warning**: Double-check the device path (`/dev/sdX`). Writing to the wrong device will destroy data!
|
||||
|
||||
TO DO: Look into some utilities (Balena Etcher, Rufus, etc.) to make this simpler/safer.
|
||||
|
||||
|
||||
## How to install Talos OS on a machine
|
||||
|
||||
To add a machine to your Wild Cloud, you will need to install Talos OS on it. The first time the machine boots, it will be in "maintenance mode" which makes it available to be configured as part of your wild cloud.
|
||||
|
||||
To install Talos OS:
|
||||
|
||||
Prepare the machine:
|
||||
|
||||
- The machine should have a ~100GB drive that the Talos OS will be installed to. Talos will never use more space than this, so any larger of a drive will be wasted space.
|
||||
- If the machine is going to be a worker node, any number of additional drives can be inserted.
|
||||
- Connect the machine to your wild cloud network switch.
|
||||
|
||||
1. Insert your Talos USB key and boot the machine.
|
||||
2. Enter EUFI settings (usually F2, F12, DEL, or ESC during startup) and configure the machine to boot from whatever you are selecting as your boot drive.
|
||||
3. For this time only, choose to boot from the USB key.
|
||||
|
||||
That's all you need to do. The machine should boot into maintenance mode and you will see an IP address you will use during setup.
|
||||
|
||||
## Setup!
|
||||
|
||||
Ok, with the Talos USB key and knowing how to boot a machine with it, we're ready to set up our cluster. In your Wild Cloud Home, start the setup process by running...
|
||||
|
||||
```bash
|
||||
wild-setup
|
||||
```
|
||||
|
||||
The rest of this page walks you through a few of the setup details.
|
||||
The setup script will walk you through the process of installing your cluster nodes (part 1), and your cluster services (part 2).
|
||||
|
||||
### Install your control nodes
|
||||
### Part 1: Setup your cluster nodes
|
||||
|
||||
- Make a Talos USB key.
|
||||
`wild-cluster-node-boot-assets`
|
||||
- Instal Talos OS with your USB key.
|
||||
- It will boot into "maintenance mode". Use the IP address it displays in `wild-setup`.
|
||||
- Repeat for the other two control nodes.
|
||||
_To add a node, it is expected to be in "maintenance mode"--as described above_
|
||||
|
||||
### Install your worker nodes
|
||||
Your cluster will be "brought up" after your first control node is added. Each additional control node will be added to the cluster until you have all three nodes running.
|
||||
|
||||
- Install Talos OS with your USB key.
|
||||
- It will boot into "maintenance mode". Use the IP address it displays in `wild-setup`.
|
||||
- Repeat for as many additional worker nodes as you'd like (three minimum).
|
||||
After your three control nodes are setup, you will have the opportunity to add as many worker nodes as you'd like (three minimum).
|
||||
|
||||
### Install cluster services
|
||||
If you ever want to set up more cluster nodes, you don't need to run the full setup. To get back into this part of the setup, you can just run:
|
||||
|
||||
```bash
|
||||
wild-setup-cluster
|
||||
```
|
||||
|
||||
### Part 2: Install your cluster services
|
||||
|
||||
After your control and worker nodes are installed, `wild-setup` will automatically install all of your wild cloud's cluster services.
|
||||
|
||||
The first time through this part of the setup, you will be asked for your preferences as needed and they will be captured in your `config.yaml`. Once your preferences are recorded, the services will be automatically deployed to your cluster.
|
||||
|
||||
If you ever need to change your cluster services, you don't have to re-run the full setup. You can just run:
|
||||
|
||||
```bash
|
||||
wild-setup-services
|
||||
```
|
||||
|
||||
## Check your installation
|
||||
|
||||
|
||||
Reference in New Issue
Block a user