Merge pull request #5 from peachcloud/split_setup_script
Split setup script
This commit is contained in:
glyph
GitHub
commit
d972d2776f
51
README.md
51
README.md
|
|
@ -1,18 +1,14 @@
|
|||
# peach-vps
|
||||
|
||||
|
||||
|
||||
|
||||
Scripts for configuring the PeachCloud VPS for various hosting and automation functions.
|
||||
|
||||
Currently:
|
||||
## Setup Build Environment
|
||||
|
||||
- Debian repository of microservices (using [Freight](https://github.com/freight-team/freight))
|
||||
`scripts/setup_build_env.py`
|
||||
|
||||
## Setup Debian Repo
|
||||
|
||||
`scripts/setup_debian_repo.py`
|
||||
|
||||
An idempotent script for initializing the Debian repo on the VPS.
|
||||
An idempotent script for initializing a build and deployment environment for PeachCloud packages.
|
||||
|
||||
The script currently performs the following actions:
|
||||
|
||||
|
|
@ -21,16 +17,15 @@ The script currently performs the following actions:
|
|||
- Installs Rust
|
||||
- Installs `cargo deb`
|
||||
- Installs Rust aarch64 toolchain for cross-compilation
|
||||
- Installs Freight for package archive creation and management
|
||||
- Installs [Freight](https://github.com/freight-team/freight) for package archive creation and management
|
||||
- Configures Freight
|
||||
- Pulls microservices code from GitHub repos
|
||||
- Exports the public GPG key
|
||||
- Configures nginx
|
||||
- Builds and updates microservice packages
|
||||
- Adds packages to Freight library
|
||||
- Adds packages to Freight cache
|
||||
|
||||
Prior to executing the script for the first time, run the following commands on the target system:
|
||||
The script can also be run with the optional `-u` flag (`--update`) to update the Rust compiler and installed toolchains.
|
||||
|
||||
**NB:** Prior to executing the script for the first time, run the following commands on the target system:
|
||||
|
||||
```
|
||||
sudo apt update
|
||||
|
|
@ -40,33 +35,39 @@ cd peach-vps
|
|||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
Open `scripts/setup_debian_repo.py` and set the following constants:
|
||||
Open `scripts/setup_build_env.py` and set the following constants:
|
||||
|
||||
- USER_PATH
|
||||
- GPG_KEY_EMAIL
|
||||
- GPG_KEY_PASS_FILE
|
||||
|
||||
Then execute the script with the `-i` flag to run the full system initialization process (_note: several commands executed by the script require `sudo` permissions. You will be prompted for the user password during the execution of the scipt._):
|
||||
Then execute the script to run the full system initialization process (_note: several commands executed by the script require `sudo` permissions. You will be prompted for the user password during the execution of the scipt._):
|
||||
|
||||
```
|
||||
python3 -u scripts/setup_debian_repo.py -i
|
||||
python3 -u scripts/setup_build_env.py
|
||||
```
|
||||
|
||||
## Update Debian Repo
|
||||
## Build and Serve Debian Packages
|
||||
|
||||
Without the -i flag, the `setup_debian_repo.py` script rebuilds all
|
||||
microservices (cross-compiled to arm64) and updates the Debian repo:
|
||||
`scripts/build_packages.py`
|
||||
|
||||
An idempotent script for building the latest versions of all PeachCloud packages and adding them to the Debian package archive.
|
||||
|
||||
The script currently performs the following actions:
|
||||
|
||||
- Builds and updates microservice packages
|
||||
- Adds packages to Freight library
|
||||
- Adds packages to Freight cache
|
||||
|
||||
```
|
||||
cd peach-vps
|
||||
python3 -u scripts/setup_debian_repo.py
|
||||
python3 -u scripts/build_packages.py
|
||||
```
|
||||
|
||||
Freight supports the ability to have multiple versions of a package in a single Debian package archive. If a particular version of a package already exists in the Freight library, it will not be readded or overwritten.
|
||||
|
||||
## Install from Debian Repo
|
||||
## Install Packages from Debian Package Archive
|
||||
|
||||
To add the PeachCloud Debian repo as an apt source, run the following commands from your Pi:
|
||||
To add the PeachCloud Debian package archive as an apt source, run the following commands from your Pi:
|
||||
|
||||
```
|
||||
vi /etc/apt/sources.list.d/peach.list
|
||||
|
|
@ -75,13 +76,13 @@ vi /etc/apt/sources.list.d/peach.list
|
|||
Append the following line:
|
||||
|
||||
```
|
||||
deb http://apt.peachcloud.org/debian/ buster main
|
||||
deb http://apt.peachcloud.org/ buster main
|
||||
```
|
||||
|
||||
Add the gpg pub key to the apt-key list:
|
||||
|
||||
```
|
||||
wget -O - http://apt.peachcloud.org/peach_pub.gpg | sudo apt-key add -
|
||||
wget -O - http://apt.peachcloud.org/pubkey.gpg | sudo apt-key add -
|
||||
```
|
||||
|
||||
You can then install peach packages with apt:
|
||||
|
|
|
|||
|
|
@ -0,0 +1,62 @@
|
|||
#!/usr/bin/env python3
|
||||
|
||||
import subprocess
|
||||
import os
|
||||
|
||||
|
||||
GPG_KEY_EMAIL = "andrew@mycelial.technology"
|
||||
# save the key passphrase to file and assign the path here:
|
||||
# (ensure the file is only readable by the user running freight)
|
||||
GPG_KEY_PASS_FILE = "/home/rust/passphrase.txt"
|
||||
|
||||
|
||||
FREIGHT_CONF = "/etc/freight.conf"
|
||||
MICROSERVICES_SRC_DIR = "/srv/peachcloud/automation/microservices"
|
||||
MICROSERVICES_DEB_DIR = "/srv/peachcloud/debs"
|
||||
USER_PATH = "/home/rust"
|
||||
|
||||
|
||||
SERVICES = [
|
||||
{"name": "peach-buttons",
|
||||
"repo_url": "https://github.com/peachcloud/peach-buttons.git"},
|
||||
{"name": "peach-menu", "repo_url": "https://github.com/peachcloud/peach-menu.git"},
|
||||
{"name": "peach-monitor",
|
||||
"repo_url": "https://github.com/peachcloud/peach-monitor.git"},
|
||||
{"name": "peach-network",
|
||||
"repo_url": "https://github.com/peachcloud/peach-network.git"},
|
||||
{"name": "peach-oled", "repo_url": "https://github.com/peachcloud/peach-oled.git"},
|
||||
{"name": "peach-stats", "repo_url": "https://github.com/peachcloud/peach-stats.git"},
|
||||
# {"name": "peach-web", "repo_url": "https://github.com/peachcloud/peach-web.git"}, # currently build fails because it needs rust nightly for pear
|
||||
]
|
||||
|
||||
cargo_path = os.path.join(USER_PATH, ".cargo/bin/cargo")
|
||||
|
||||
print("[ BUILDING AND UPDATING MICROSERVICE PACKAGES ]")
|
||||
for service in SERVICES:
|
||||
service_name = service["name"]
|
||||
service_path = os.path.join(MICROSERVICES_SRC_DIR, service_name)
|
||||
print("[ BUILIDING SERVICE {} ]".format(service_name))
|
||||
subprocess.call(["git", "pull"], cwd=service_path)
|
||||
debian_package_path = subprocess.run(
|
||||
[
|
||||
cargo_path,
|
||||
"deb",
|
||||
"--target",
|
||||
"aarch64-unknown-linux-gnu"],
|
||||
cwd=service_path,
|
||||
stdout=subprocess.PIPE).stdout.decode("utf-8").strip()
|
||||
subprocess.call(["cp", debian_package_path, MICROSERVICES_DEB_DIR])
|
||||
|
||||
print("[ ADDING PACKAGES TO FREIGHT LIBRARY ]")
|
||||
for package in os.scandir(MICROSERVICES_DEB_DIR):
|
||||
if package.name.endswith(".deb"):
|
||||
print("[ ADDING PACKAGE {} ]".format(package.name))
|
||||
subprocess.call(["freight", "add", "-c", FREIGHT_CONF,
|
||||
package.path, "apt/buster"])
|
||||
|
||||
print("[ ADDING PACKAGES TO FREIGHT CACHE ]")
|
||||
# needs to be run as sudo user
|
||||
subprocess.call(["sudo", "freight", "cache", "-g",
|
||||
GPG_KEY_EMAIL, "-p", GPG_KEY_PASS_FILE])
|
||||
|
||||
print("[ MICROSERVICE PACKAGE ARCHIVE UPDATED ]")
|
||||
|
|
@ -6,14 +6,9 @@ import subprocess
|
|||
import os
|
||||
import argparse
|
||||
|
||||
|
||||
# before running this script run `gpg --gen-key` on the server
|
||||
# assign the email address of the key id here:
|
||||
GPG_KEY_EMAIL = "andrew@mycelial.technology"
|
||||
# save the key passphrase to file and assign the path here:
|
||||
# (ensure the file is only readable by the user running freight)
|
||||
GPG_KEY_PASS_FILE = "/home/rust/passphrase.txt"
|
||||
# if you need to list the existing keys: `gpg --list-keys`
|
||||
|
||||
|
||||
# constants
|
||||
|
|
@ -22,7 +17,6 @@ FREIGHT_CONF = "/etc/freight.conf"
|
|||
FREIGHT_LIB = "/var/lib/freight"
|
||||
FREIGHT_CACHE = "/var/www/apt.peachcloud.org"
|
||||
MICROSERVICES_SRC_DIR = "/srv/peachcloud/automation/microservices"
|
||||
MICROSERVICES_DEB_DIR = "/srv/peachcloud/debs"
|
||||
USER_PATH = "/home/rust"
|
||||
|
||||
|
||||
|
|
@ -39,21 +33,31 @@ SERVICES = [
|
|||
# {"name": "peach-web", "repo_url": "https://github.com/peachcloud/peach-web.git"}, # currently build fails because it needs rust nightly for pear
|
||||
]
|
||||
|
||||
cargo_path = os.path.join(USER_PATH, ".cargo/bin/cargo")
|
||||
|
||||
# parse CLI args
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument(
|
||||
"-i",
|
||||
"--initialize",
|
||||
help="initialize and update debian repo",
|
||||
action="store_true")
|
||||
"-u",
|
||||
"--update",
|
||||
help="Update Rust installation",
|
||||
action="store_true"
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
cargo_path = os.path.join(USER_PATH, ".cargo/bin/cargo")
|
||||
|
||||
# initializing debian repo from a blank slate
|
||||
# (but this code is idempotent so it can be re-run if already initialized)
|
||||
if args.initialize:
|
||||
|
||||
# update rust installation
|
||||
if args.update:
|
||||
print("[ UPDATING RUST ]")
|
||||
rustup_path = os.path.join(USER_PATH, ".cargo/bin/rustup")
|
||||
if not os.path.exists(rustup_path):
|
||||
print("rustup installation not found")
|
||||
print("rerun this script without the '-u' flag to install rust")
|
||||
else:
|
||||
subprocess.call([rustup_path, "update"])
|
||||
else:
|
||||
# initialize debian package build environment from a blank slate
|
||||
# (but this code is idempotent so it can be re-run if already initialized)
|
||||
print("[ INSTALLING SYSTEM REQUIREMENTS ]")
|
||||
subprocess.call(["sudo",
|
||||
"apt-get",
|
||||
|
|
@ -120,7 +124,7 @@ if args.initialize:
|
|||
subprocess.call(["git", "clone", repo_url, service_path])
|
||||
|
||||
print("[ EXPORTING PUBLIC GPG KEY ]")
|
||||
output_path = "{}/peach_pub.gpg".format(FREIGHT_CACHE)
|
||||
output_path = "{}/pubkey.gpg".format(FREIGHT_CACHE)
|
||||
if not os.path.exists(output_path):
|
||||
subprocess.call(["gpg", "--armor", "--output",
|
||||
output_path, "--export", GPG_KEY_EMAIL])
|
||||
|
|
@ -137,33 +141,4 @@ if args.initialize:
|
|||
subprocess.call(["sudo", "cp", nginx_conf_tmp_path,
|
||||
"/etc/nginx/sites-enabled/apt.peachcloud.org"])
|
||||
|
||||
# update the microservices from git and build the debian packages
|
||||
print("[ BUILDING AND UPDATING MICROSERVICE PACKAGES ]")
|
||||
for service in SERVICES:
|
||||
service_name = service["name"]
|
||||
service_path = os.path.join(MICROSERVICES_SRC_DIR, service_name)
|
||||
print("[ BUILIDING SERVICE {} ]".format(service_name))
|
||||
subprocess.call(["git", "pull"], cwd=service_path)
|
||||
debian_package_path = subprocess.run(
|
||||
[
|
||||
cargo_path,
|
||||
"deb",
|
||||
"--target",
|
||||
"aarch64-unknown-linux-gnu"],
|
||||
cwd=service_path,
|
||||
stdout=subprocess.PIPE).stdout.decode("utf-8").strip()
|
||||
subprocess.call(["cp", debian_package_path, MICROSERVICES_DEB_DIR])
|
||||
|
||||
print("[ ADDING PACKAGES TO FREIGHT LIBRARY ]")
|
||||
for package in os.scandir(MICROSERVICES_DEB_DIR):
|
||||
if package.name.endswith(".deb"):
|
||||
print("[ ADDING PACKAGE {} ]".format(package.name))
|
||||
subprocess.call(["freight", "add", "-c", FREIGHT_CONF,
|
||||
package.path, "apt/buster"])
|
||||
|
||||
print("[ ADDING PACKAGES TO FREIGHT CACHE ]")
|
||||
# needs to be run as sudo user
|
||||
subprocess.call(["sudo", "freight", "cache", "-g",
|
||||
GPG_KEY_EMAIL, "-p", GPG_KEY_PASS_FILE])
|
||||
|
||||
print("[ DEBIAN REPO SETUP COMPLETE ]")
|
||||
print("[ DEBIAN PACKAGE BUILD ENVIRONMENT SETUP COMPLETE ]")
|
||||
Loading…
Reference in New Issue