Skip to content

KNOX-3364: New loadAliasesFromK8sSecrets method in entrypoint.sh to l… #1282

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

Merged
hanicz merged 1 commit into from
Jun 29, 2026
+49 −1
Merged

KNOX-3364: New loadAliasesFromK8sSecrets method in entrypoint.sh to l… #1282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion gateway-docker/src/main/resources/docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ RUN apt-get update && \
libnss3 \
bash \
passwd \
curl && \
curl \
jq && \
apt-get clean && \
rm -rf /var/lib/apt/lists/*

Expand Down
47 changes: 47 additions & 0 deletions gateway-docker/src/main/resources/docker/gateway-entrypoint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
# TRUSTSTORE_IMPORTS="myRootCA:/mountedpath/enterprise_root_cert.pem myBizPartnerCA:/mountedpath/mybiz_partner_cert.pem"
# Description:
# This will import the specified certificates into the truststore JKS with the provided alias name(s) during the container startup process.
# - KNOX_ALIAS_LABEL - (optional) label selector used to discover Knox alias
# Secrets in the pod's namespace, default 'knox.apache.org/alias=true'.


set -e
Expand Down Expand Up @@ -92,6 +94,49 @@ saveAlias() {
fi
}

## Helper function to load Knox aliases from labeled Kubernetes Secrets.
loadAliasesFromK8sSecrets() {
local sa_token_file="/var/run/secrets/kubernetes.io/serviceaccount/token"
local sa_ca_file="/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
local sa_ns_file="/var/run/secrets/kubernetes.io/serviceaccount/namespace"
local label="${KNOX_ALIAS_LABEL:-knox.apache.org/alias=true}"

if [[ ! -r ${sa_token_file} || ! -r ${sa_ca_file} || ! -r ${sa_ns_file} ]]; then
echo "ServiceAccount token not mounted; skipping k8s-sourced Knox aliases"
return 0
fi

echo "Loading Knox aliases from labeled k8s Secrets (label: ${label}) ..."
local namespace token resp_file http_code secret_names
namespace=$(/bin/cat "${sa_ns_file}")
token=$(/bin/cat "${sa_token_file}")
resp_file=$(mktemp)

http_code=$(curl -sS \
--cacert "${sa_ca_file}" \
-H "Authorization: Bearer ${token}" \
-o "${resp_file}" -w "%{http_code}" \
"https://kubernetes.default.svc/api/v1/namespaces/${namespace}/secrets?labelSelector=${label}") || http_code="000"
Comment on lines +115 to +119

@smolnar82 smolnar82 Jun 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: there's no explicit timeout on the curl call. If the k8s API is slow or unreachable, this could stall container startup. Adding --max-time 10 or similar would make the failure path faster.


if [[ ${http_code} != "200" ]]; then
echo "WARN: failed to list Knox alias Secrets from k8s API (HTTP ${http_code}); continuing without k8s aliases"
/bin/rm -f "${resp_file}"
return 0
fi

secret_names=$(jq -r '.items[].metadata.name' "${resp_file}" | tr '\n' ' ') || secret_names=""
/bin/rm -f "${resp_file}"

if [[ -z ${secret_names} ]]; then
echo "No labeled Knox alias Secrets found"
return 0
fi

# shellcheck disable=SC2086
/home/knox/knox/bin/knoxcli.sh create-k8s-alias ${secret_names} --namespace "${namespace}"
echo "Knox aliases loaded from k8s Secrets: ${secret_names}"
}

export GATEWAY_SERVER_RUN_IN_FOREGROUND=true


Expand Down Expand Up @@ -131,6 +176,8 @@ else
/home/knox/knox/bin/knoxcli.sh generate-jwk --saveAlias knox.token.hash.key
fi

loadAliasesFromK8sSecrets

# If keystore dir is empty use default one
if [[ -z ${KEYSTORE_DIR} ]]
then
Expand Down
Loading