Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(install-script): show upgrade instructions #125

Merged
merged 3 commits into from
Nov 8, 2024
Merged

chore(install-script): show upgrade instructions #125

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
063db05
chore(install-script): show upgrade instructions
amdprophet Nov 8, 2024
cbb77cd
chore(install-script): use otelcol-config abspath
amdprophet Nov 8, 2024
b0d143f
chore(install-script): upgrade w/version
amdprophet Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 69 additions & 27 deletions install-script/install.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ USER_ENV_DIRECTORY=""
UNINSTALL=""
UPGRADE=""
SUMO_BINARY_PATH=""
SUMO_CONFIG_BINARY_PATH=""
COMMON_CONFIG_PATH=""
PURGE=""
DOWNLOAD_ONLY=""
Expand Down Expand Up @@ -163,6 +164,7 @@ function set_defaults() {
DOWNLOAD_CACHE_DIR="/var/cache/otelcol-sumo" # this is in case we want to keep downloaded binaries
CONFIG_DIRECTORY="/etc/otelcol-sumo"
SUMO_BINARY_PATH="/usr/local/bin/otelcol-sumo"
SUMO_CONFIG_BINARY_PATH="/usr/local/bin/otelcol-config"
USER_ENV_DIRECTORY="${CONFIG_DIRECTORY}/env"
TOKEN_ENV_FILE="${USER_ENV_DIRECTORY}/token.env"

Expand Down Expand Up @@ -400,6 +402,9 @@ function verify_installation() {
echo "WARNING: ${SUMO_BINARY_PATH} is not in \$PATH"
otel_command="${SUMO_BINARY_PATH}"
fi
if ! command -v otelcol-config; then
echo "WARNING: ${SUMO_CONFIG_BINARY_PATH} is not in \$PATH"
fi
echo "Running ${otel_command} --version to verify installation"
OUTPUT="$(${otel_command} --version || true)"
readonly OUTPUT
Expand Down Expand Up @@ -473,7 +478,7 @@ function setup_config() {

if [[ "${INSTALL_HOSTMETRICS}" == "true" ]]; then
echo -e "Installing ${OS_TYPE} hostmetrics configuration"
otelcol-config --enable-hostmetrics
"${SUMO_CONFIG_BINARY_PATH}" --enable-hostmetrics
fi

## Check if there is anything to update in configuration
Expand Down Expand Up @@ -534,7 +539,7 @@ function setup_config_darwin() {

if [[ "${INSTALL_HOSTMETRICS}" == "true" ]]; then
echo -e "Installing ${OS_TYPE} hostmetrics configuration"
otelcol-config --enable-hostmetrics
"${SUMO_CONFIG_BINARY_PATH}" --enable-hostmetrics
fi
}

Expand All @@ -554,7 +559,7 @@ function uninstall() {

function upgrade() {
case "${OS_TYPE}" in
"linux") upgrade_linux ;;
"linux") upgrade_linux "${VERSION}" ;;
*)
echo "upgrading is not supported by this script for OS: ${OS_TYPE}"
exit 1
Expand All @@ -563,16 +568,35 @@ function upgrade() {

}

function upgrade_linux() {
case $(get_package_manager) in
yum | dnf)
yum update --quiet -y
;;
apt-get)
apt-get update --quiet && apt-get upgrade --quiet -y
;;
esac
function upgrade_command_linux() {
if [[ -z "${VERSION}" ]]; then
case $(get_package_manager) in
yum | dnf)
echo "yum update otelcol-sumo --quiet -y"
;;
apt-get)
echo "apt-get update --quiet && apt-get install otelcol-sumo --quiet -y --only-upgrade"
;;
esac
else
case $(get_package_manager) in
yum | dnf)
echo "yum update \"otelcol-sumo-${VERSION}\" --quiet -y"
;;
apt-get)
echo "apt-get update --quiet && apt-get install \"otelcol-sumo=${VERSION}\" --quiet -y --only-upgrade"
;;
esac
fi
}

function upgrade_linux() {
if [[ -z "${VERSION}" ]]; then
echo "Upgrading to the latest version of otelcol-sumo"
else
echo "Upgrading to otelcol-sumo version ${VERSION}"
fi
eval "$(upgrade_command_linux)"
}

# uninstall otelcol-sumo on darwin
Expand All @@ -595,7 +619,7 @@ function uninstall_darwin() {
function uninstall_linux() {
case $(get_package_manager) in
yum | dnf)
yum remove --quiet -yes otelcol-sumo
yum remove --quiet -y otelcol-sumo
;;
apt-get)
if [[ "${PURGE}" == "true" ]]; then
Expand Down Expand Up @@ -649,17 +673,17 @@ function get_launchd_token() {
}

function get_user_api_url() {
if command -v otelcol-config &> /dev/null; then
KV=$(otelcol-config --read-kv .extensions.sumologic.api_base_url)
if command -v "${SUMO_CONFIG_BINARY_PATH}" &> /dev/null; then
KV=$("${SUMO_CONFIG_BINARY_PATH}" --read-kv .extensions.sumologic.api_base_url)
if [[ "${KV}" != "null" ]]; then
echo "${KV}"
fi
fi
}

function get_user_opamp_endpoint() {
if command -v otelcol-config &> /dev/null; then
KV=$(otelcol-config --read-kv .extensions.opamp.endpoint)
if command -v "${SUMO_CONFIG_BINARY_PATH}" &> /dev/null; then
KV=$("${SUMO_CONFIG_BINARY_PATH}" --read-kv .extensions.opamp.endpoint)
if [[ "${KV}" != "null" ]]; then
echo "${KV}"
fi
Expand All @@ -671,7 +695,7 @@ function write_installation_token() {
local token
readonly token="${1}"

otelcol-config --set-installation-token "$token"
"${SUMO_CONFIG_BINARY_PATH}" --set-installation-token "$token"
}

# write ${ENV_TOKEN} to launchd configuration file
Expand Down Expand Up @@ -708,37 +732,37 @@ function write_installation_token_launchd() {

# write sumologic ephemeral: true to user configuration file
function write_ephemeral_true() {
otelcol-config --enable-ephemeral
"${SUMO_CONFIG_BINARY_PATH}" --enable-ephemeral
}

# write api_url to user configuration file
function write_api_url() {
local api_url
readonly api_url="${1}"

otelcol-config --set-api-url "$api_url"
"${SUMO_CONFIG_BINARY_PATH}" --set-api-url "$api_url"
}

# write opamp endpoint to user configuration file
function write_opamp_endpoint() {
local opamp_endpoint
readonly opamp_endpoint="${1}"

otelcol-config --set-opamp-endpoint "$opamp_endpoint"
"${SUMO_CONFIG_BINARY_PATH}" --set-opamp-endpoint "$opamp_endpoint"
}

# write tags to user configuration file
function write_tags() {
arr=("$@")
for field in "${arr[@]}";
do
otelcol-config --add-tag "$field"
"${SUMO_CONFIG_BINARY_PATH}" --add-tag "$field"
done
}

# configure and enable the opamp extension for remote management
function write_opamp_extension() {
otelcol-config --enable-remote-control
"${SUMO_CONFIG_BINARY_PATH}" --enable-remote-control
}

# NB: this function is only for Darwin
Expand Down Expand Up @@ -880,6 +904,10 @@ function install_linux_package() {
esac
}

function show_upgrade_instructions_linux() {
echo "Upgrades can be performed using the native package manager: $(upgrade_command_linux)"
}

function check_deprecated_linux_flags() {
if [[ -n "${BINARY_BRANCH}" ]]; then
echo "warning: --binary-branch is deprecated"
Expand All @@ -895,7 +923,8 @@ function check_deprecated_linux_flags() {
fi

if [[ -n "${DOWNLOAD_ONLY}" ]]; then
echo "--download-only is only supported on darwin, use 'install.sh --upgrade' to upgrade otelcol-sumo"
echo "--download-only is only supported on darwin"
show_upgrade_instructions_linux "${VERSION}"
exit 1
fi
}
Expand All @@ -907,7 +936,12 @@ function is_package_installed() {
yum --cacheonly list --installed otelcol-sumo > /dev/null 2>&1
;;
apt-get)
dpkg --status otelcol-sumo > /dev/null 2>&1
status="$(dpkg-query -Wf '${db:Status-Status}' otelcol-sumo)"
if [[ $? != 0 || "${status}" != "installed" ]]; then
false
else
true
fi
;;
esac
}
Expand Down Expand Up @@ -1018,9 +1052,9 @@ function get_user_token() {

# Check yaml configuration for a token
if [[ -z "${token}" ]]; then
if command -v otelcol-config &> /dev/null; then
if command -v "${SUMO_CONFIG_BINARY_PATH}" &> /dev/null; then
local output=""
output=$(otelcol-config --read-kv .extensions.sumologic.installation_token)
output=$("${SUMO_CONFIG_BINARY_PATH}" --read-kv .extensions.sumologic.installation_token)
if [[ "${output}" != "null" ]]; then
token="${output}"
fi
Expand Down Expand Up @@ -1180,6 +1214,14 @@ if has_prepackaging_installation; then
HAD_PREPACKAGING_INSTALLATION="true"
fi

echo "Version specified: ${VERSION}"

if is_package_installed; then
echo "The otelcol-sumo package is already installed"
show_upgrade_instructions_linux
exit 1
fi

install_linux_package "${package_name}"
verify_installation
setup_config
Expand Down
Loading