Skip to content

K
k3s
Commit e05964d1 authored by Erik Wilson's avatar Erik Wilson
Browse files
Options

Allow agent install

Modify the install script to allow defining arbitrary service names and commands for k3s.
parent 10be950d
Hide whitespace changes
Inline Side-by-side
Showing with 366 additions and 108 deletions
install.sh
View file @ e05964d1
#!/bin/sh #!/bin/sh
set -e set -e
# Usage:
# curl ... | ENV_VAR=... sh -
# or
# ENV_VAR=... ./install.sh
#
# Example:
# Installing a server without an agent:
# curl ... | INSTALL_K3S_EXEC="--disable-agent" sh -
# Installing an agent to point at a server:
# curl ... | K3S_TOKEN=xxx K3S_URL=https://server-url:6443 sh -
#
# Environment variables:
# - K3S_*
# Environment variables which begin with K3S_ will be preserved for the
# systemd service to use. Setting K3S_URL without explicitly setting
# a systemd exec command will default the command to "agent", and we
# enforce that K3S_TOKEN or K3S_CLUSTER_SECRET is also set.
#
# - INSTALL_K3S_SKIP_DOWNLOAD
# If set to true will not download k3s hash or binary.
#
# - INSTALL_K3S_VERSION
# Version of k3s to download from github. Will attempt to download the
# latest version if not specified.
#
# - INSTALL_K3S_BIN_DIR
# Directory to install k3s binary, links, and uninstall script to, or use
# /usr/local/bin as the default
#
# - INSTALL_K3S_SYSTEMD_DIR
# Directory to install systemd service and environment files to, or use
# /etc/systemd/system as the default
#
# - INSTALL_K3S_EXEC or script arguments
# Command with flags to use for launching k3s in the systemd service, if
# the command is not specified will default to "agent" if K3S_URL is set
# or "server" if not. The final systemd command resolves to a combination
# of EXEC and script args ($@).
#
# The following commands result in the same behavior:
# curl ... | INSTALL_K3S_EXEC="--disable-agent" sh -s -
# curl ... | INSTALL_K3S_EXEC="server --disable-agent" sh -s -
# curl ... | INSTALL_K3S_EXEC="server" sh -s - --disable-agent
# curl ... | sh -s - server --disable-agent
# curl ... | sh -s - --disable-agent
#
# - INSTALL_K3S_NAME
# Name of systemd service to create, will default from the k3s exec command
# if not specified. If specified the name will be prefixed with 'k3s-'.
#
# - INSTALL_K3S_TYPE
# Type of systemd service to create, will default from the k3s exec command
# if not specified.
GITHUB_URL=https://github.com/rancher/k3s/releases
# --- helper functions for logs ---
info() info()
{ {
echo "[INFO] " "$@" echo "[INFO] " "$@"
} }
fatal() fatal()
{ {
echo "[ERROR] " "$@" echo "[ERROR] " "$@"
exit 1 exit 1
} }
if [ -z `which curl || true` ]; then # --- fatal if no systemd ---
fatal "Can not find curl for downloading files" verify_systemd() {
fi if [ ! -d /run/systemd ]; then
fatal "Can not find systemd to use as a process supervisor for k3s"
if [ -n "$1" ]; then fi
VERSION=$1 }
else
info "Finding latest release"
VERSION=`curl -w "%{url_effective}" -I -L -s -S https://github.com/rancher/k3s/releases/latest -o /dev/null | sed -e 's|.*/||'`
fi
info "Using $VERSION as release"
ARCH=`uname -m` # --- define needed environment variables ---
setup_env() {
case $ARCH in # --- use command args if passed or create default ---
amd64) case "$1" in
ARCH=amd64 # --- if we only have flags discover if command should be server or agent ---
SUFFIX= (-*|"")
;; if [ -z "${K3S_URL}" ]; then
x86_64) CMD_K3S=server
ARCH=amd64 else
SUFFIX= if [ -z "${K3S_TOKEN}" ] && [ -z "${K3S_CLUSTER_SECRET}" ]; then
;; fatal "Defaulted k3s exec command to 'agent' because K3S_URL is defined, but K3S_TOKEN or K3S_CLUSTER_SECRET is not defined."
arm64) fi
ARCH=arm64 CMD_K3S=agent
SUFFIX=-${ARCH} fi
;; CMD_K3S_EXEC="${CMD_K3S} $@"
aarch64)
ARCH=arm64
SUFFIX=-${ARCH}
;; ;;
arm*) # --- command is provided ---
ARCH=arm (*)
SUFFIX=-${ARCH}hf CMD_K3S="$1"
CMD_K3S_EXEC="$@"
;; ;;
*) esac
fatal Unknown architecture $ARCH CMD_K3S_EXEC=$(trim() { echo $@; } && trim ${CMD_K3S_EXEC})
esac
BINURL=https://github.com/rancher/k3s/releases/download/${VERSION}/k3s${SUFFIX} # --- use systemd name if defined or create default ---
HASHURL=https://github.com/rancher/k3s/releases/download/${VERSION}/sha256sum-${ARCH}.txt if [ -n "${INSTALL_K3S_NAME}" ]; then
SYSTEMD_NAME=k3s-${INSTALL_K3S_NAME}
else
if [ "${CMD_K3S}" = "server" ]; then
SYSTEMD_NAME=k3s
else
SYSTEMD_NAME=k3s-${CMD_K3S}
fi
fi
SERVICE_K3S=${SYSTEMD_NAME}.service
UNINSTALL_K3S_SH=${SYSTEMD_NAME}-uninstall.sh
if [ -d /run/systemd ]; then # --- use systemd type if defined or create default ---
SYSTEMD=true if [ -n "${INSTALL_K3S_TYPE}" ]; then
else SYSTEMD_TYPE="${INSTALL_K3S_TYPE}"
fatal "Can not find systemd to use as a process supervisor for k3s" else
fi if [ "${CMD_K3S}" = "server" ]; then
SYSTEMD_TYPE=notify
else
SYSTEMD_TYPE=exec
fi
fi
SUDO=sudo # --- use binary install directory if defined or create default ---
if [ `id -u` = 0 ]; then if [ -n "${INSTALL_K3S_BIN_DIR}" ]; then
SUDO= BIN_DIR="${INSTALL_K3S_BIN_DIR}"
fi else
BIN_DIR="/usr/local/bin"
fi
if [ "$SYSTEMD" = "true" ]; then # --- use systemd directory if defined or create default ---
info Creating uninstall script /usr/local/bin/k3s-uninstall.sh if [ -n "${INSTALL_K3S_SYSTEMD_DIR}" ]; then
TMPUNINSTALL=`mktemp -t k3s-install.XXXXXXXXXX` SYSTEMD_DIR="${INSTALL_K3S_SYSTEMD_DIR}"
cat > $TMPUNINSTALL << "EOF" else
#!/bin/sh SYSTEMD_DIR="/etc/systemd/system"
set -x fi
systemctl stop k3s
systemctl disable k3s
systemctl daemon-reload
rm -f /etc/systemd/system/k3s.service
rm -f /usr/local/bin/k3s
if [ -L /usr/local/bin/kubectl ]; then
rm -f /usr/local/bin/kubectl
fi
if [ -L /usr/local/bin/crictl ]; then
rm -f /usr/local/bin/crictl
fi
if [ -e /sys/fs/cgroup/systemd/system.slice/k3s.service/cgroup.procs ]; then
kill -9 `cat /sys/fs/cgroup/systemd/system.slice/k3s.service/cgroup.procs`
fi
umount `cat /proc/self/mounts | awk '{print $2}' | grep '^/run/k3s'`
umount `cat /proc/self/mounts | awk '{print $2}' | grep '^/var/lib/rancher/k3s'`
rm -rf /var/lib/rancher/k3s # --- use sudo if we are not already root ---
rm -rf /etc/rancher/k3s SUDO=sudo
if [ `id -u` = 0 ]; then
SUDO=
fi
}
rm -f /usr/local/bin/k3s-uninstall.sh # --- check if skip download environment variable set ---
EOF can_skip_download() {
chmod 755 $TMPUNINSTALL if [ "${INSTALL_K3S_SKIP_DOWNLOAD}" != "true" ]; then
$SUDO chown root:root $TMPUNINSTALL return 1
$SUDO mv -f $TMPUNINSTALL /usr/local/bin/k3s-uninstall.sh fi
}
# --- verify an executabe k3s binary is installed ---
verify_k3s_is_executable() {
if [ ! -x ${BIN_DIR}/k3s ]; then
fatal "Executable k3s binary not found at ${BIN_DIR}/k3s"
fi
}
# --- set arch and suffix, fatal if architecture not supported ---
setup_verify_arch() {
ARCH=`uname -m`
case $ARCH in
amd64)
ARCH=amd64
SUFFIX=
;;
x86_64)
ARCH=amd64
SUFFIX=
;;
arm64)
ARCH=arm64
SUFFIX=-${ARCH}
;;
aarch64)
ARCH=arm64
SUFFIX=-${ARCH}
;;
arm*)
ARCH=arm
SUFFIX=-${ARCH}hf
;;
*)
fatal "Unsupported architecture $ARCH"
esac
}
# --- fatal if no curl ---
verify_curl() {
if [ -z `which curl || true` ]; then
fatal "Can not find curl for downloading files"
fi
}
# --- create tempory directory and cleanup when done ---
setup_tmp() {
TMP_DIR=`mktemp -d -t k3s-install.XXXXXXXXXX`
TMP_HASH=${TMP_DIR}/k3s.hash
TMP_BIN=${TMP_DIR}/k3s.bin
cleanup() {
code=$?
set +e
trap - EXIT
rm -rf ${TMP_DIR}
exit $code
}
trap cleanup INT EXIT
}
# --- use desired k3s version if defined or find latest ---
get_release_version() {
if [ -n "${INSTALL_K3S_VERSION}" ]; then
VERSION_K3S="${INSTALL_K3S_VERSION}"
else
info "Finding latest release"
VERSION_K3S=`curl -w "%{url_effective}" -I -L -s -S ${GITHUB_URL}/latest -o /dev/null | sed -e 's|.*/||'`
fi
info "Using ${VERSION_K3S} as release"
}
TMPHASH=`mktemp -t k3s-install.XXXXXXXXXX` # --- download hash from github url ---
TMPBIN=`mktemp -t k3s-install.XXXXXXXXXX` download_hash() {
HASH_URL=${GITHUB_URL}/download/${VERSION_K3S}/sha256sum-${ARCH}.txt
info "Downloading hash ${HASH_URL}"
curl -o ${TMP_HASH} -sfL ${HASH_URL} || fatal "Hash download failed"
HASH_EXPECTED=`grep k3s ${TMP_HASH} | awk '{print $1}'`
}
info Downloading $HASHURL # --- check hash against installed version ---
curl -o $TMPHASH -sfL $HASHURL installed_hash_matches() {
if [ -x ${BIN_DIR}/k3s ]; then
HASH_INSTALLED=`sha256sum ${BIN_DIR}/k3s | awk '{print $1}'`
if [ "${HASH_EXPECTED}" = "${HASH_INSTALLED}" ]; then
return
fi
fi
return 1
}
info Downloading $BINURL # --- download binary from github url ---
curl -o $TMPBIN -sfL $BINURL download_binary() {
BIN_URL=${GITHUB_URL}/download/${VERSION_K3S}/k3s${SUFFIX}
info "Downloading binary ${BIN_URL}"
curl -o ${TMP_BIN} -sfL ${BIN_URL} || fatal "Binary download failed"
}
info Verifying download # --- verify downloaded binary hash ---
EXPECTED=`grep k3s $TMPHASH | awk '{print $1}'` verify_binary() {
ACTUAL=`sha256sum $TMPBIN | awk '{print $1}'` info "Verifying binary download"
rm -f $TMPHASH HASH_BIN=`sha256sum ${TMP_BIN} | awk '{print $1}'`
if [ "$EXPECTED" != "$ACTUAL" ]; then if [ "${HASH_EXPECTED}" != "${HASH_BIN}" ]; then
rm -f $TMPBIN fatal "Download sha256 does not match ${HASH_EXPECTED}, got ${HASH_BIN}"
fatal "Download sha256 does not match ${EXPECTED} got ${ACTUAL}"
fi fi
}
chmod 755 $TMPBIN # --- setup permissions and move binary to system directory ---
info Installing k3s to /usr/local/bin/k3s setup_binary() {
chmod 755 ${TMP_BIN}
info "Installing k3s to ${BIN_DIR}/k3s"
$SUDO chown root:root ${TMP_BIN}
$SUDO mv -f ${TMP_BIN} ${BIN_DIR}/k3s
}
# --- download and verify k3s ---
download_and_verify() {
if can_skip_download; then
info "Skipping k3s download and verify"
verify_k3s_is_executable
return
fi
setup_verify_arch
verify_curl
setup_tmp
get_release_version
download_hash
if installed_hash_matches; then
info "Skipping binary downloaded, installed k3s matches hash"
return
fi
$SUDO chown root:root $TMPBIN download_binary
$SUDO mv -f $TMPBIN /usr/local/bin/k3s verify_binary
setup_binary
}
if [ ! -e /usr/local/bin/kubectl ]; then # --- add additional utility links ---
info Creating /usr/local/bin/kubectl symlink to k3s create_symlinks() {
$SUDO ln -s k3s /usr/local/bin/kubectl if [ ! -e ${BIN_DIR}/kubectl ]; then
info "Creating ${BIN_DIR}/kubectl symlink to k3s"
$SUDO ln -s k3s ${BIN_DIR}/kubectl
fi fi
if [ ! -e /usr/local/bin/crictl ]; then if [ ! -e ${BIN_DIR}/crictl ]; then
info Creating /usr/local/bin/crictl symlink to k3s info "Creating ${BIN_DIR}/crictl symlink to k3s"
$SUDO ln -s k3s /usr/local/bin/crictl $SUDO ln -s k3s ${BIN_DIR}/crictl
fi fi
}
# --- create uninstall script ---
create_uninstall() {
info "Creating uninstall script ${BIN_DIR}/${UNINSTALL_K3S_SH}"
$SUDO tee ${BIN_DIR}/${UNINSTALL_K3S_SH} >/dev/null << EOF
#!/bin/sh
set -x
systemctl kill ${SYSTEMD_NAME}
systemctl disable ${SYSTEMD_NAME}
systemctl reset-failed ${SYSTEMD_NAME}
systemctl daemon-reload
rm -f ${SYSTEMD_DIR}/${SERVICE_K3S}
rm -f ${SYSTEMD_DIR}/${SERVICE_K3S}.env
info systemd: Creating /etc/systemd/system/k3s.service remove_uninstall() {
$SUDO tee /etc/systemd/system/k3s.service >/dev/null << "EOF" rm -f ${BIN_DIR}/${UNINSTALL_K3S_SH}
}
trap remove_uninstall EXIT
if ls ${SYSTEMD_DIR}/k3s*.service >/dev/null 2>&1; then
set +x; echo "Additional k3s services installed, skipping uninstall of k3s"; set -x
exit
fi
do_unmount() {
MOUNTS=\`cat /proc/self/mounts | awk '{print \$2}' | grep "^\$1"\`
if [ -n "\${MOUNTS}" ]; then
umount \${MOUNTS}
fi
}
do_unmount '/run/k3s'
do_unmount '/var/lib/rancher/k3s'
nets=\$(ip link show master cni0 | grep cni0 | awk -F': ' '{print \$2}' | sed -e 's|@.*||')
for iface in \$nets; do
ip link delete \$iface;
done
ip link delete cni0
ip link delete flannel.1
if [ -L ${BIN_DIR}/kubectl ]; then
rm -f ${BIN_DIR}/kubectl
fi
if [ -L ${BIN_DIR}/crictl ]; then
rm -f ${BIN_DIR}/crictl
fi
rm -rf /etc/rancher/k3s
rm -rf /var/lib/rancher/k3s
rm -f ${BIN_DIR}/k3s
EOF
$SUDO chmod 755 ${BIN_DIR}/${UNINSTALL_K3S_SH}
$SUDO chown root:root ${BIN_DIR}/${UNINSTALL_K3S_SH}
}
# --- disable current service if loaded --
systemd_disable() {
$SUDO rm -f /etc/systemd/system/${SERVICE_K3S} || true
$SUDO rm -f /etc/systemd/system/${SERVICE_K3S}.env || true
$SUDO systemctl disable ${SYSTEMD_NAME} >/dev/null 2>&1 || true
}
# --- capture current env and create file containing k3s_ variables ---
create_env_file() {
info "systemd: Creating environment file ${SYSTEMD_DIR}/${SERVICE_K3S}.env"
UMASK=`umask`
umask 0377
env | grep '^K3S_' | $SUDO tee ${SYSTEMD_DIR}/${SERVICE_K3S}.env >/dev/null
umask $UMASK
}
# --- write service file ---
create_service_file() {
info "systemd: Creating service file ${SYSTEMD_DIR}/${SERVICE_K3S}"
$SUDO tee ${SYSTEMD_DIR}/${SERVICE_K3S} >/dev/null << EOF
[Unit] [Unit]
Description=Lightweight Kubernetes Description=Lightweight Kubernetes
Documentation=https://k3s.io Documentation=https://k3s.io
After=network.target After=network.target
[Service] [Service]
Type=${SYSTEMD_TYPE}
EnvironmentFile=${SYSTEMD_DIR}/${SERVICE_K3S}.env
ExecStartPre=-/sbin/modprobe br_netfilter ExecStartPre=-/sbin/modprobe br_netfilter
ExecStartPre=-/sbin/modprobe overlay ExecStartPre=-/sbin/modprobe overlay
ExecStart=/usr/local/bin/k3s server ExecStart=${BIN_DIR}/k3s ${CMD_K3S_EXEC}
KillMode=process KillMode=process
Delegate=yes Delegate=yes
LimitNOFILE=infinity LimitNOFILE=infinity
...@@ -152,13 +396,27 @@ TasksMax=infinity ...@@ -152,13 +396,27 @@ TasksMax=infinity
[Install] [Install]
WantedBy=multi-user.target WantedBy=multi-user.target
EOF EOF
}
info systemd: Enabling k3s unit # --- enable and start systemd service ---
$SUDO systemctl enable k3s.service >/dev/null systemd_enable_and_start() {
info "systemd: Enabling ${SYSTEMD_NAME} unit"
$SUDO systemctl enable ${SYSTEMD_DIR}/${SERVICE_K3S} >/dev/null
$SUDO systemctl daemon-reload >/dev/null $SUDO systemctl daemon-reload >/dev/null
info systemd: Starting k3s info "systemd: Starting ${SYSTEMD_NAME}"
$SUDO systemctl start k3s.service $SUDO systemctl restart ${SYSTEMD_NAME}
else }
fatal "Can not find systemd"
fi # --- run the install process --
{
verify_systemd
setup_env ${INSTALL_K3S_EXEC} $@
download_and_verify
create_symlinks
create_uninstall
systemd_disable
create_env_file
create_service_file
systemd_enable_and_start
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment