Skip to content

Fix devcontainer-utils-vault-s3-init for sccache@v0.7.7 #229

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
trxcllnt merged 3 commits into from
Feb 9, 2024
Merged

Fix devcontainer-utils-vault-s3-init for sccache@v0.7.7 #229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
158398b
fix devcontainer-utils-vault-s3-init for sccache v0.7.7
trxcllnt Feb 9, 2024
2975c85
remove outdated test
trxcllnt Feb 9, 2024
b9a99d4
disable sccache s3 backend if externally provided ones don't work
trxcllnt Feb 9, 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
4 changes: 0 additions & 4 deletions .github/actions/build-and-test-feature/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ inputs:
vault_host: {type: string, defaut: '', required: false}
rw_sccache_bucket: {type: string, defaut: '', required: false}
rw_sccache_region: {type: string, defaut: '', required: false}
ro_sccache_bucket: {type: string, defaut: '', required: false}
ro_sccache_region: {type: string, defaut: '', required: false}

runs:
using: composite
Expand All @@ -34,5 +32,3 @@ runs:
vault_host: "${{ inputs.vault_host }}"
rw_sccache_bucket: "${{ inputs.rw_sccache_bucket }}"
rw_sccache_region: "${{ inputs.rw_sccache_region }}"
ro_sccache_bucket: "${{ inputs.ro_sccache_bucket }}"
ro_sccache_region: "${{ inputs.ro_sccache_region }}"
2 changes: 0 additions & 2 deletions .github/workflows/build-and-test-feature.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ jobs:
vault_host: "${{ secrets.GIST_REPO_READ_ORG_GITHUB_TOKEN && 'https://vault.ops.k8s.rapids.ai' || '' }}"
rw_sccache_bucket: "${{ secrets.GIST_REPO_READ_ORG_GITHUB_TOKEN && 'rapids-sccache-devs' || '' }}"
rw_sccache_region: "${{ vars.AWS_REGION }}"
ro_sccache_bucket: rapids-sccache-east
ro_sccache_region: "${{ vars.AWS_REGION }}"
2 changes: 1 addition & 1 deletion features/src/utils/devcontainer-feature.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "devcontainer-utils",
"id": "utils",
"version": "24.4.5",
"version": "24.4.6",
"description": "A feature to install RAPIDS devcontainer utility scripts",
"containerEnv": {
"BASH_ENV": "/etc/bash.bash_env"
Expand Down
41 changes: 17 additions & 24 deletions features/src/utils/opt/devcontainer/bin/vault/s3/creds/persist.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ store_s3_creds() {
local region=;
local no_bucket=;
local no_region=;
local no_credentials=;
local aws_access_key_id=;
local aws_session_token=;
local aws_secret_access_key=;
Expand All @@ -50,7 +49,6 @@ store_s3_creds() {
region |
no_bucket |
no_region |
no_credentials |
aws_access_key_id |
aws_session_token |
aws_secret_access_key |
Expand All @@ -64,7 +62,6 @@ store_s3_creds() {
reset_envvar "AWS_ACCESS_KEY_ID";
reset_envvar "AWS_SESSION_TOKEN";
reset_envvar "AWS_SECRET_ACCESS_KEY";
reset_envvar "SCCACHE_S3_NO_CREDENTIALS";

mkdir -p ~/.aws;
rm -f ~/.aws/{config,credentials};
Expand Down Expand Up @@ -92,41 +89,37 @@ ________EOF
fi

if test -f ~/.aws/config; then
cat <<________EOF > ~/.aws/config
cat <<________EOF > ~/.aws/config2 && mv ~/.aws/config{2,}
[default]
$(cat ~/.aws/config)
________EOF
fi

if ! grep -qE "^$" <<< "${no_credentials:-}"; then
export_envvar "SCCACHE_S3_NO_CREDENTIALS" "1";
else

if ! grep -qE "^$" <<< "${aws_access_key_id:-}"; then
cat <<____________EOF >> ~/.aws/credentials
if ! grep -qE "^$" <<< "${aws_access_key_id:-}"; then
cat <<________EOF >> ~/.aws/credentials
aws_access_key_id=${aws_access_key_id}
____________EOF
fi
________EOF
fi

if ! grep -qE "^$" <<< "${aws_session_token:-}"; then
cat <<____________EOF >> ~/.aws/credentials
if ! grep -qE "^$" <<< "${aws_session_token:-}"; then
cat <<________EOF >> ~/.aws/credentials
aws_session_token=${aws_session_token}
____________EOF
fi
________EOF
fi

if ! grep -qE "^$" <<< "${aws_secret_access_key:-}"; then
cat <<____________EOF >> ~/.aws/credentials
if ! grep -qE "^$" <<< "${aws_secret_access_key:-}"; then
cat <<________EOF >> ~/.aws/credentials
aws_secret_access_key=${aws_secret_access_key}
____________EOF
fi
________EOF
fi

if test -f ~/.aws/credentials; then
cat <<____________EOF > ~/.aws/credentials
if test -f ~/.aws/credentials; then
cat <<________EOF > ~/.aws/credentials2 && mv ~/.aws/credentials{2,}
[default]
$(cat ~/.aws/credentials)
____________EOF
chmod 0600 ~/.aws/credentials;
fi
________EOF
chmod 0600 ~/.aws/credentials;
fi
}

Expand Down
2 changes: 1 addition & 1 deletion features/src/utils/opt/devcontainer/bin/vault/s3/creds/propagate.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ensure_s3_creds_have_propagated() {

while true; do

if SCCACHE_NO_DAEMON=1 sccache --show-stats >/dev/null 2>&1; then
if sccache --start-server >/dev/null 2>&1; then
if [ "${num_restarts}" -gt "0" ]; then echo "Success!"; fi
exit 0;
fi
Expand Down
46 changes: 12 additions & 34 deletions features/src/utils/opt/devcontainer/bin/vault/s3/creds/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,47 +17,25 @@ test_aws_creds() {
fi
fi

local bucket="${SCCACHE_BUCKET:-"$(grep 'bucket=' ~/.aws/config 2>/dev/null | sed 's/bucket=//' || echo)"}";
local bucket="${SCCACHE_BUCKET:-"$(sed -n 's/bucket=//p' ~/.aws/config 2>/dev/null)"}";
if [ -z "${bucket:-}" ]; then exit 1; fi

local region="${SCCACHE_REGION:-"${AWS_DEFAULT_REGION:-"$(grep 'region=' ~/.aws/config 2>/dev/null | sed 's/region=//' || echo)"}"}";
local aws_access_key_id="${AWS_ACCESS_KEY_ID:-"$(grep 'aws_access_key_id=' ~/.aws/credentials 2>/dev/null | sed 's/aws_access_key_id=//' || echo)"}";
local aws_session_token="${AWS_SESSION_TOKEN:-"$(grep 'aws_session_token=' ~/.aws/credentials 2>/dev/null | sed 's/aws_session_token=//' || echo)"}";
local aws_secret_access_key="${AWS_SECRET_ACCESS_KEY:-"$(grep 'aws_secret_access_key=' ~/.aws/credentials 2>/dev/null | sed 's/aws_secret_access_key=//' || echo)"}";
local region="${SCCACHE_REGION:-"${AWS_DEFAULT_REGION:-"$(sed -n 's/region=//p' ~/.aws/config 2>/dev/null)"}"}";
local aws_access_key_id="${AWS_ACCESS_KEY_ID:-"$(sed -n 's/aws_access_key_id=//p' ~/.aws/credentials 2>/dev/null)"}";
local aws_session_token="${AWS_SESSION_TOKEN:-"$(sed -n 's/aws_session_token=//p' ~/.aws/credentials 2>/dev/null)"}";
local aws_secret_access_key="${AWS_SECRET_ACCESS_KEY:-"$(sed -n 's/aws_secret_access_key=//p' ~/.aws/credentials 2>/dev/null)"}";

if test -n "$(pgrep sccache || echo)"; then
sccache --stop-server >/dev/null 2>&1 || true;
fi

export SCCACHE_NO_DAEMON="1";
export SCCACHE_BUCKET="${bucket:-}";
export SCCACHE_REGION="${region:-}";
export AWS_ACCESS_KEY_ID="${aws_access_key_id:-}";
export AWS_SESSION_TOKEN="${aws_session_token:-}";
export AWS_SECRET_ACCESS_KEY="${aws_secret_access_key:-}";

if ! sccache --show-stats 2>&1 | grep -qE 'Cache location \s+ s3'; then

export SCCACHE_S3_NO_CREDENTIALS="1";

export AWS_ACCESS_KEY_ID=;
export AWS_SESSION_TOKEN=;
export AWS_SECRET_ACCESS_KEY=;
export -n AWS_ACCESS_KEY_ID;
export -n AWS_SESSION_TOKEN;
export -n AWS_SECRET_ACCESS_KEY;
unset AWS_ACCESS_KEY_ID;
unset AWS_SESSION_TOKEN;
unset AWS_SECRET_ACCESS_KEY;

if sccache --show-stats 2>&1 | grep -qE 'Cache location \s+ s3'; then
exit 2;
fi

exit 1;
fi

exit 0;
SCCACHE_BUCKET="${bucket:-}" \
SCCACHE_REGION="${region:-}" \
AWS_ACCESS_KEY_ID="${aws_access_key_id:-}" \
AWS_SESSION_TOKEN="${aws_session_token:-}" \
AWS_SECRET_ACCESS_KEY="${aws_secret_access_key:-}" \
sccache --start-server >/dev/null 2>&1;
sccache --show-stats | grep -qE 'Cache location \s+ s3';
}

if test -n "${devcontainer_utils_debug:-}"; then
Expand Down
43 changes: 15 additions & 28 deletions features/src/utils/opt/devcontainer/bin/vault/s3/init.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ ____EOF

s3_bucket_auth() {
cat <<____EOF
--aws_access_key_id='$(grep 'aws_access_key_id=' ~/.aws/credentials 2>/dev/null | sed 's/aws_access_key_id=//' || echo)'
--aws_session_token='$(grep 'aws_session_token=' ~/.aws/credentials 2>/dev/null | sed 's/aws_session_token=//' || echo)'
--aws_secret_access_key='$(grep 'aws_secret_access_key=' ~/.aws/credentials 2>/dev/null | sed 's/aws_secret_access_key=//' || echo)'
--aws_access_key_id='$(sed -n 's/aws_access_key_id=//p' ~/.aws/credentials 2>/dev/null)'
--aws_session_token='$(sed -n 's/aws_session_token=//p' ~/.aws/credentials 2>/dev/null)'
--aws_secret_access_key='$(sed -n 's/aws_secret_access_key=//p' ~/.aws/credentials 2>/dev/null)'
____EOF
}

Expand All @@ -25,7 +25,7 @@ init_vault_s3_creds() {
&& grep -qE "^$" <<< "${AWS_SECRET_ACCESS_KEY:-}" ; then
if test -n "${VAULT_HOST:-}" ; then
# Generate S3 creds if they don't exist (or are expired)
if devcontainer-utils-vault-s3-creds-test 2>&1 >/dev/null\
if devcontainer-utils-vault-s3-creds-test \
|| devcontainer-utils-vault-s3-creds-generate; then
# Persist creds in ~/.aws dir
devcontainer-utils-vault-s3-creds-persist <<< "
Expand All @@ -37,34 +37,21 @@ init_vault_s3_creds() {
else
devcontainer-utils-vault-s3-creds-persist <<< "--no_bucket --no_region";
fi
elif devcontainer-utils-vault-s3-creds-test; then
# bucket is read + write with the current credentials
devcontainer-utils-vault-s3-creds-persist <<< "
$(s3_bucket_args)
$(s3_bucket_auth)
";
else
# If credentials have been mounted in, ensure they're used
case $(devcontainer-utils-vault-s3-creds-test; echo $?) in
# bucket is read + write with the current credentials
[0] )
devcontainer-utils-vault-s3-creds-persist <<< "
$(s3_bucket_args)
$(s3_bucket_auth)
";;
# bucket is read-only and should be accessed without credentials
[2] )
devcontainer-utils-vault-s3-creds-persist <<< "
--no_credentials
$(s3_bucket_args)
";;
# bucket is inaccessible
* )
devcontainer-utils-vault-s3-creds-persist <<< "--no_bucket --no_region";;
esac
# bucket is inaccessible
devcontainer-utils-vault-s3-creds-persist <<< "--no_bucket --no_region";
fi
elif devcontainer-utils-vault-s3-creds-propagate; then
# Block until the new temporary AWS S3 credentials propagate
echo -n "";
elif ! devcontainer-utils-vault-s3-creds-propagate; then
# bucket is inaccessible
devcontainer-utils-vault-s3-creds-persist <<< "--no_bucket --no_region";
fi
fi
. /etc/profile.d/*-devcontainer-utils.sh;
# start the sccache server
sccache --start-server >/dev/null 2>&1 || true;
fi
}

Expand Down
12 changes: 3 additions & 9 deletions features/test/utils/scenarios.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@
"vault_host": "${localEnv:vault_host}",
"VAULT_S3_TTL": "${localEnv:VAULT_S3_TTL}",
"rw_sccache_bucket": "${localEnv:rw_sccache_bucket}",
"rw_sccache_region": "${localEnv:rw_sccache_region}",
"ro_sccache_bucket": "${localEnv:ro_sccache_bucket}",
"ro_sccache_region": "${localEnv:ro_sccache_region}"
"rw_sccache_region": "${localEnv:rw_sccache_region}"
},
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {
Expand Down Expand Up @@ -53,9 +51,7 @@
"vault_host": "${localEnv:vault_host}",
"VAULT_S3_TTL": "${localEnv:VAULT_S3_TTL}",
"rw_sccache_bucket": "${localEnv:rw_sccache_bucket}",
"rw_sccache_region": "${localEnv:rw_sccache_region}",
"ro_sccache_bucket": "${localEnv:ro_sccache_bucket}",
"ro_sccache_region": "${localEnv:ro_sccache_region}"
"rw_sccache_region": "${localEnv:rw_sccache_region}"
},
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {
Expand Down Expand Up @@ -99,9 +95,7 @@
"vault_host": "${localEnv:vault_host}",
"VAULT_S3_TTL": "${localEnv:VAULT_S3_TTL}",
"rw_sccache_bucket": "${localEnv:rw_sccache_bucket}",
"rw_sccache_region": "${localEnv:rw_sccache_region}",
"ro_sccache_bucket": "${localEnv:ro_sccache_bucket}",
"ro_sccache_region": "${localEnv:ro_sccache_region}"
"rw_sccache_region": "${localEnv:rw_sccache_region}"
},
"features": {
"ghcr.io/devcontainers/features/common-utils:2": {
Expand Down
19 changes: 3 additions & 16 deletions features/test/utils/ubuntu18.04.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,19 +126,6 @@ if test -n "${rw_sccache_bucket:-}"; then
check "bad creds with SCCACHE_BUCKET and no VAULT_HOST uses local disk cache" bad_creds_with_sccache_bucket_and_no_vault_host_uses_local_disk_cache;
fi

if test -n "${ro_sccache_bucket:-}"; then

readonly_sccache_bucket_uses_s3_cache() {
reset_state;
SCCACHE_BUCKET="${ro_sccache_bucket}" \
SCCACHE_REGION="${ro_sccache_region}" \
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}

# check "Readonly SCCACHE_BUCKET uses S3 cache" readonly_sccache_bucket_uses_s3_cache;
fi

if test -n "${gh_token:-}" \
&& test -n "${vault_host:-}" \
&& test -n "${rw_sccache_bucket:-}"; then
Expand Down Expand Up @@ -173,9 +160,9 @@ if test -n "${gh_token:-}" \
reset_state;
export SCCACHE_BUCKET="${rw_sccache_bucket}";
export SCCACHE_REGION="${rw_sccache_region}";
export AWS_ACCESS_KEY_ID="$(grep 'aws_access_key_id=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_access_key_id=//' || echo)";
export AWS_SESSION_TOKEN="$(grep 'aws_session_token=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_session_token=//' || echo)";
export AWS_SECRET_ACCESS_KEY="$(grep 'aws_secret_access_key=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_secret_access_key=//' || echo)";
export AWS_ACCESS_KEY_ID="$(sed -n 's/aws_access_key_id=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SESSION_TOKEN="$(sed -n 's/aws_session_token=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SECRET_ACCESS_KEY="$(sed -n 's/aws_secret_access_key=//p' /tmp/.aws/credentials 2>/dev/null)";
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}
Expand Down
19 changes: 3 additions & 16 deletions features/test/utils/ubuntu20.04.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,19 +126,6 @@ if test -n "${rw_sccache_bucket:-}"; then
check "bad creds with SCCACHE_BUCKET and no VAULT_HOST uses local disk cache" bad_creds_with_sccache_bucket_and_no_vault_host_uses_local_disk_cache;
fi

if test -n "${ro_sccache_bucket:-}"; then

readonly_sccache_bucket_uses_s3_cache() {
reset_state;
SCCACHE_BUCKET="${ro_sccache_bucket}" \
SCCACHE_REGION="${ro_sccache_region}" \
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}

# check "Readonly SCCACHE_BUCKET uses S3 cache" readonly_sccache_bucket_uses_s3_cache;
fi

if test -n "${gh_token:-}" \
&& test -n "${vault_host:-}" \
&& test -n "${rw_sccache_bucket:-}"; then
Expand Down Expand Up @@ -173,9 +160,9 @@ if test -n "${gh_token:-}" \
reset_state;
export SCCACHE_BUCKET="${rw_sccache_bucket}";
export SCCACHE_REGION="${rw_sccache_region}";
export AWS_ACCESS_KEY_ID="$(grep 'aws_access_key_id=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_access_key_id=//' || echo)";
export AWS_SESSION_TOKEN="$(grep 'aws_session_token=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_session_token=//' || echo)";
export AWS_SECRET_ACCESS_KEY="$(grep 'aws_secret_access_key=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_secret_access_key=//' || echo)";
export AWS_ACCESS_KEY_ID="$(sed -n 's/aws_access_key_id=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SESSION_TOKEN="$(sed -n 's/aws_session_token=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SECRET_ACCESS_KEY="$(sed -n 's/aws_secret_access_key=//p' /tmp/.aws/credentials 2>/dev/null)";
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}
Expand Down
19 changes: 3 additions & 16 deletions features/test/utils/ubuntu22.04.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,19 +126,6 @@ if test -n "${rw_sccache_bucket:-}"; then
check "bad creds with SCCACHE_BUCKET and no VAULT_HOST uses local disk cache" bad_creds_with_sccache_bucket_and_no_vault_host_uses_local_disk_cache;
fi

if test -n "${ro_sccache_bucket:-}"; then

readonly_sccache_bucket_uses_s3_cache() {
reset_state;
SCCACHE_BUCKET="${ro_sccache_bucket}" \
SCCACHE_REGION="${ro_sccache_region}" \
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}

# check "Readonly SCCACHE_BUCKET uses S3 cache" readonly_sccache_bucket_uses_s3_cache;
fi

if test -n "${gh_token:-}" \
&& test -n "${vault_host:-}" \
&& test -n "${rw_sccache_bucket:-}"; then
Expand Down Expand Up @@ -173,9 +160,9 @@ if test -n "${gh_token:-}" \
reset_state;
export SCCACHE_BUCKET="${rw_sccache_bucket}";
export SCCACHE_REGION="${rw_sccache_region}";
export AWS_ACCESS_KEY_ID="$(grep 'aws_access_key_id=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_access_key_id=//' || echo)";
export AWS_SESSION_TOKEN="$(grep 'aws_session_token=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_session_token=//' || echo)";
export AWS_SECRET_ACCESS_KEY="$(grep 'aws_secret_access_key=' /tmp/.aws/credentials 2>/dev/null | sed 's/aws_secret_access_key=//' || echo)";
export AWS_ACCESS_KEY_ID="$(sed -n 's/aws_access_key_id=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SESSION_TOKEN="$(sed -n 's/aws_session_token=//p' /tmp/.aws/credentials 2>/dev/null)";
export AWS_SECRET_ACCESS_KEY="$(sed -n 's/aws_secret_access_key=//p' /tmp/.aws/credentials 2>/dev/null)";
devcontainer-utils-post-attach-command;
expect_s3_cache_is_used;
}
Expand Down