Upgrade to v3005 Phosphorus

.github/ISSUE_TEMPLATE/bug_report.md

@@ -26,7 +26,7 @@ The full log with the outputted error.
 **Version report (please complete the following information):**
  - Host OS: [e.g. `uname -a`]
  - Docker: [e.g. `docker --version`]
- - Image tag: [e.g. `3004.2`]
+ - Image tag: [e.g. `3005`]
 
 **Additional context**
 Add any other context about the problem here.

.github/workflows/build-and-test.yml

@@ -111,7 +111,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: '3.10'
 
       - name: Execute basic tests
         run: tests/basic/test.sh

CHANGELOG.md

@@ -1,9 +1,19 @@
 # Changelog
 
 This file only reflects the changes that are made in this image.
-Please refer to the [Salt 3004.2 Release Notes](https://docs.saltstack.com/en/latest/topics/releases/3004.2.html)
+Please refer to the [Salt 3005 Release Notes](https://docs.saltstack.com/en/latest/topics/releases/3005.html)
 for the list of changes in SaltStack.
 
+**3005**
+
+- Upgrade `salt-master` to `3005` *Phosphorus*
+- Upgrade `salt-bootstrap` to version `2022.08.13`
+- Change Docker base image to `ubuntu:jammy-20220801`
+- Use `python3` default distro version
+- Install `python3-pygit2` version `1.6.1` from Ubuntu repositories
+- Remove `USERMAP_UID` and `USERMAP_GID` env variables in favor of `PUID` and `PGID`, respectively.
+- CI(tests): Use `python3` version `3.10`
+
 **3004.2**
 
 - Upgrade `salt-master` to `3004.2` *Silicon*

Dockerfile

@@ -1,12 +1,11 @@
-FROM ubuntu:hirsute-20220113
+FROM ubuntu:jammy-20220801
 
 ARG BUILD_DATE
 ARG VCS_REF
 
 # https://github.com/saltstack/salt/releases
-# NOTE: Review org.label-schema.version label if necessary
-ENV SALT_VERSION="3004.2" \
-    PYTHON_VERSION="3.9"
+ENV SALT_VERSION="3005"
+ENV IMAGE_VERSION="${SALT_VERSION}"
 
 ENV SALT_DOCKER_DIR="/etc/docker-salt" \
     SALT_ROOT_DIR="/etc/salt" \
@@ -32,7 +31,7 @@ WORKDIR ${SALT_BUILD_DIR}
 RUN apt-get update \
  && DEBIAN_FRONTEND=noninteractive apt-get install --yes --quiet --no-install-recommends \
     sudo ca-certificates openssl apt-transport-https wget locales openssh-client \
-    python${PYTHON_VERSION} python3-dev libpython3-dev \
+    python3 python3-dev libpython3-dev \
     python3-pip python3-setuptools python3-wheel \
     supervisor logrotate git gettext-base tzdata inotify-tools psmisc \
  && DEBIAN_FRONTEND=noninteractive update-locale LANG=C.UTF-8 LC_MESSAGES=POSIX \
@@ -63,17 +62,19 @@ RUN mkdir -p "${SALT_BASE_DIR}" "${SALT_FORMULAS_DIR}" "${SALT_KEYS_DIR}" "${SAL
 VOLUME [ "${SALT_BASE_DIR}", "${SALT_FORMULAS_DIR}", "${SALT_KEYS_DIR}", "${SALT_CONFS_DIR}", "${SALT_LOGS_DIR}" ]
 
 LABEL \
-    maintainer="[email protected]" \
-    org.label-schema.vendor=cdalvaro \
-    org.label-schema.name="SaltStack Master" \
-    org.label-schema.version="${SALT_VERSION}_6" \
-    org.label-schema.description="Dockerized SaltStack Master" \
-    org.label-schema.url="https://github.com/cdalvaro/docker-salt-master" \
-    org.label-schema.vcs-url="https://github.com/cdalvaro/docker-salt-master.git" \
-    org.label-schema.vcs-ref=${VCS_REF} \
-    org.label-schema.build-date=${BUILD_DATE} \
-    org.label-schema.docker.schema-version="1.0" \
-    com.cdalvaro.docker-salt-master.license=MIT
+    org.opencontainers.image.title="Dockerized Salt Master" \
+    org.opencontainers.image.description="salt-master ${SALT_VERSION} containerized" \
+    org.opencontainers.image.documentation="https://github.com/cdalvaro/docker-salt-master/blob/${IMAGE_VERSION}/README.md" \
+    org.opencontainers.image.url="https://github.com/cdalvaro/docker-salt-master" \
+    org.opencontainers.image.source="https://github.com/cdalvaro/docker-salt-master.git" \
+    org.opencontainers.image.authors="Carlos Álvaro <[email protected]>" \
+    org.opencontainers.image.vendor=cdalvaro \
+    org.opencontainers.image.created=${BUILD_DATE} \
+    org.opencontainers.image.version="${IMAGE_VERSION}" \
+    org.opencontainers.image.revision=${VCS_REF} \
+    org.opencontainers.image.base.digest="sha256:42ba2dfce475de1113d55602d40af18415897167d47c2045ec7b6d9746ff148f" \
+    org.opencontainers.image.base.name="ubuntu:jammy-20220801" \
+    org.opencontainers.image.licenses=MIT
 
 WORKDIR ${SALT_HOME}
 ENTRYPOINT [ "/sbin/entrypoint.sh" ]

VERSION

@@ -1 +1 @@
-3004.2
+3005

assets/build/functions.sh

@@ -139,91 +139,3 @@ function extract()
   log_info "Unpacking file: ${FILE}"
   tar xzf "${FILE}" --strip-components 1
 }
-
-#---  FUNCTION  -------------------------------------------------------------------------------------------------------
-#          NAME:  build_and_install
-#   DESCRIPTION:  Build and install the given package from the current directory using cmake.
-#----------------------------------------------------------------------------------------------------------------------
-function build_and_install()
-{
-  local PACKAGE_NAME="${1}"; shift
-  local CMAKE_ARGS=(
-    -Wno-dev
-    -DCMAKE_BUILD_TYPE=Release
-  )
-
-  # shellcheck disable=SC2206
-  CMAKE_ARGS+=( $@ )
-
-  log_info "Building and installing ${PACKAGE_NAME} ..."
-  log_debug "CMAKE_ARGS: ${CMAKE_ARGS[@]}"
-  cmake ${CMAKE_ARGS[@]} .
-  cmake --build . --target install --config Release
-}
-
-#---  FUNCTION  -------------------------------------------------------------------------------------------------------
-#          NAME:  install_libssh2
-#   DESCRIPTION:  Install libssh2 library.
-#----------------------------------------------------------------------------------------------------------------------
-function install_libssh2()
-{
-  local LIBSSH2_VERSION=1.10.0
-  local LIBSSH2_URL="https://github.com/libssh2/libssh2/releases/download/libssh2-${LIBSSH2_VERSION}/libssh2-${LIBSSH2_VERSION}.tar.gz"
-  local FILE_NAME="libssh2-${LIBSSH2_VERSION}.tar.gz"
-  local SHA256_SUM='2d64e90f3ded394b91d3a2e774ca203a4179f69aebee03003e5a6fa621e41d51'
-
-  local CURRENT_DIR="$(pwd)"
-  local WORK_DIR="$(mktemp -d)" && cd "${WORK_DIR}"
-
-  download "${LIBSSH2_URL}" "${FILE_NAME}"
-  check_sha256 "${FILE_NAME}" "${SHA256_SUM}"
-  extract "${FILE_NAME}"
-
-  _OPTS=(
-    -DLINT=OFF
-    -DBUILD_SHARED_LIBS=ON
-    -DCRYPTO_BACKEND=OpenSSL
-    -DENABLE_ZLIB_COMPRESSION=ON
-    -DENABLE_DEBUG_LOGGING=OFF
-    -DCLEAR_MEMORY=ON
-    -DBUILD_EXAMPLES=OFF
-    -DBUILD_TESTING=OFF
-  )
-
-  build_and_install "libssh2 v${LIBSSH2_VERSION}" ${_OPTS[@]}
-
-  cd "${CURRENT_DIR}"
-  rm -rf "${WORK_DIR}"
-}
-
-#---  FUNCTION  -------------------------------------------------------------------------------------------------------
-#          NAME:  install_libgit2
-#   DESCRIPTION:  Install libgit2 library.
-#----------------------------------------------------------------------------------------------------------------------
-function install_libgit2()
-{
-  local LIBGIT2_VERSION=1.4.2
-  local LIBGIT2_URL="https://github.com/libgit2/libgit2/archive/refs/tags/v${LIBGIT2_VERSION}.tar.gz"
-  local FILE_NAME="libgit2-${LIBGIT2_VERSION}.tar.gz"
-  local SHA256_SUM='901c2b4492976b86477569502a41c31b274b69adc177149c02099ea88404ef19'
-
-  local CURRENT_DIR="$(pwd)"
-  local WORK_DIR="$(mktemp -d)" && cd "${WORK_DIR}"
-
-  download "${LIBGIT2_URL}" "${FILE_NAME}"
-  check_sha256 "${FILE_NAME}" "${SHA256_SUM}"
-  extract "${FILE_NAME}"
-
-  _OPTS=(
-    -DBUILD_SHARED_LIBS=ON
-    -DUSE_SSH=ON
-    -DUSE_THREADS=ON
-    -DBUILD_EXAMPLES=OFF
-    -DBUILD_TESTS=OFF
-  )
-
-  build_and_install "libgit2 v${LIBGIT2_VERSION}" ${_OPTS[@]}
-
-  cd "${CURRENT_DIR}"
-  rm -rf "${WORK_DIR}"
-}

assets/build/install.sh

@@ -10,12 +10,11 @@ source "${FUNCTIONS_FILE}"
 
 log_info "Installing required packages and build dependencies ..."
 REQUIRED_PACKAGES=(
-  libssl1.1 zlib1g libffi7 libpcre3 libgssapi3-heimdal
+  libssl3 zlib1g libffi7 libpcre3 libgssapi3-heimdal
 )
 
 BUILD_DEPENDENCIES=(
-  make gcc g++ cmake pkg-config libssl-dev zlib1g-dev libffi-dev
-  libpcre3-dev heimdal-dev
+  make gcc g++
 )
 
 apt-get update
@@ -35,20 +34,14 @@ log_info "Installing python3 packages ..."
 install_pkgs --quiet \
   python3-mako python3-pycryptodome python3-cherrypy3 \
   python3-git python3-requests python3-redis python3-gnupg \
-  python3-mysqldb python3-dateutil python3-libnacl python3-openssl
-
-pip3 install timelib==0.2.5
-
-# Install pygit2 package
-install_libssh2
-install_libgit2
-pip3 install cached-property cffi==1.14.6 pygit2==1.9.1
+  python3-mysqldb python3-dateutil python3-libnacl python3-openssl \
+  python3-pygit2
 
 # Downloading bootstrap-salt.sh script
-BOOTSTRAP_VERSION='2022.03.15'
+BOOTSTRAP_VERSION='2022.08.13'
 BOOTSTRAP_URL="https://raw.githubusercontent.com/saltstack/salt-bootstrap/v${BOOTSTRAP_VERSION}/bootstrap-salt.sh"
 BOOTSTRAP_FILE='bootstrap-salt.sh'
-BOOTSTRAP_SHA256='ed66dc9e71aed7602b9ae548f8535131831026f934f19f868fdefbe6a3ab9bf9'
+BOOTSTRAP_SHA256='8363e4dc2410c6d540fabab972ffc612b04bf4b5239e2ffb3e366266d9b63b70'
 
 download "${BOOTSTRAP_URL}" "${BOOTSTRAP_FILE}"
 check_sha256 "${BOOTSTRAP_FILE}" "${BOOTSTRAP_SHA256}"
@@ -61,8 +54,7 @@ check_sha256 "${BOOTSTRAP_FILE}" "${BOOTSTRAP_SHA256}"
 ## -d: Disables checking if Salt services are enabled to start on system boot
 ## -P: Allow pip based installations
 ## -p: Extra-package to install
-## -x: Changes the python version used to install a git version of salt
-SALT_BOOTSTRAP_OPTS=( -M -N -X -d -P -p salt-api -p salt-call -x "python${PYTHON_VERSION}" )
+SALT_BOOTSTRAP_OPTS=( -M -N -X -d -P -p salt-api -p salt-call )
 
 ## -I: allow insecure connections while downloading any files
 is_arm32 && SALT_BOOTSTRAP_OPTS+=( -I )

assets/runtime/env-defaults.sh

@@ -1,5 +1,8 @@
 #!/usr/bin/env bash
 
+PUID=${PUID:-1000}
+PGID=${PGID:-1000}
+
 DEBUG=${DEBUG:-False}
 TIMEZONE=${TIMEZONE:-${TZ:-UTC}}
 

assets/runtime/functions.sh

@@ -57,53 +57,12 @@ function log_error()
   (>&2 echo "[ERROR] - $*")
 }
 
-#---  FUNCTION  -------------------------------------------------------------------------------------------------------
-#          NAME:  __check_puid_pgid_env
-#   DESCRIPTION:  Check if the PUID and PGID environment variables are set correctly.
-#----------------------------------------------------------------------------------------------------------------------
-function __check_puid_pgid_env
-{
-  if [[ "${SALT_VERSION}" -ge "3005" ]]; then
-    log_error "The USERMAP_UID and USERMAP_GID environment variables are not supported in Salt >= 3005"
-    exit 1
-  fi
-
-  if [[ -n "${USERMAP_UID}" ]]; then
-    log_warn "The USERMAP_UID environment variable is deprecated. Please use PUID instead."
-    log_warn "Support for USERMAP_UID will be removed in Salt 3005 release."
-    if [[ -z "${PUID}" ]]; then
-      log_warn "Setting PUID to USERMAP_UID (${USERMAP_UID})"
-      export PUID="${USERMAP_UID}"
-    else
-      log_error "The PUID and USERMAP_UID environment variables are set. PUID will be used."
-    fi
-    unset USERMAP_UID
-  fi
-
-  if [[ -n "${USERMAP_GID}" ]]; then
-    log_warn "The USERMAP_GID environment variable is deprecated. Please use PGID instead."
-    log_warn "Support for USERMAP_GID will be removed in Salt 3005 release."
-    if [[ -z "${PGID}" ]]; then
-      log_info "Setting PGID to USERMAP_GID (${USERMAP_GID})"
-      export PGID="${USERMAP_GID}"
-    else
-      log_error "The PGID and USERMAP_GID environment variables are set. PGID will be used."
-    fi
-    unset USERMAP_GID
-  fi
-}
-
 #---  FUNCTION  -------------------------------------------------------------------------------------------------------
 #          NAME:  map_uidgid
 #   DESCRIPTION:  Map salt user with host user.
 #----------------------------------------------------------------------------------------------------------------------
 function map_uidgid()
 {
-  __check_puid_pgid_env
-  # Move this into env-defaults.sh
-  [ -z "${PUID}" ] && export PUID=1000
-  [ -z "${PGID}" ] && export PGID=1000
-
   ORIG_PUID=$(id -u "${SALT_USER}")
   ORIG_PGID=$(id -g "${SALT_USER}")
   PGID=${PGID:-${PUID:-$ORIG_PGID}}

tests/basic/test.sh

@@ -19,10 +19,10 @@ start_container_and_wait || error "container started"
 ok "container started"
 
 # Check salt version
-echo "==> Checking salt version ..."
-docker-exec salt --versions
-[[ "$(docker-exec salt --version)" == "salt $(cat VERSION)" ]] || error "salt version"
-ok "salt version"
+echo "==> Checking salt-master version ..."
+docker-exec salt-master --versions
+[[ "$(docker-exec salt-master --version)" == "salt-master $(cat VERSION)" ]] || error "salt-master version"
+ok "salt-master version"
 
 # Test image calling healthcheck
 echo "==> Executing healthcheck ..."