CASMHMS-6324: Added support for ppprof builds

[jwlv]

Summary and Scope

Added support for pprof builds. Profiling adds runtime overhead so pprof support is not enabled by default. It is meant to be a debug tool. In order to enable pprof support, the following ARG in the Dockerfile should be changed from false to true:

ARG ENABLE_PPROF=true

After completing this step, rebuild the application and pprof support will be enabled after it is deployed.

Adopted app version 1.22.0 for CSM 1.6.1 (helm chart 3.1.3)

Issues and Related PRs

• Resolves CASMHMS-6324

Testing

Tested on:

• mug

Test description:

• Deployed service with pprof enabled - confirmed pprof functionality
• Deployed services with pprof disabled - confirmed pprof support not built into binary
• Functional tests (if they exist) was successfully ran with and without pprof enabled

Test Checklist:

• Were the install/upgrade-based validation checks/tests run (goss tests/install-validation doc)? Y
• Were continuous integration tests run? If not, why? Y
• Was upgrade tested? If not, why? Y
• Was downgrade tested? If not, why? Y

Pull Request Checklist

• Version number(s) incremented, if applicable
• Copyrights updated
• License file intact
• Target branch correct
• CHANGELOG.md updated
• Testing is appropriate and complete, if applicable

[github-actions]

👋 Hey! Here is the image we built for you (Artifactory Link):

artifactory.algol60.net/csm-docker/unstable/cray-hbtd-test:1.22.0-20241223212958.5fa88f9

Use podman or docker to pull it down and inspect locally:

podman pull artifactory.algol60.net/csm-docker/unstable/cray-hbtd-test:1.22.0-20241223212958.5fa88f9

Or, use this script to pull the image from the build server to a dev system:

Dev System Pull Script

Note the following script only applies to systems running CSM 1.2 or later.

#!/usr/bin/env bash

IMAGE=artifactory.algol60.net/csm-docker/unstable/cray-hbtd-test:1.22.0-20241223212958.5fa88f9

podman run --rm --network host  \
    quay.io/skopeo/stable copy \
    --src-tls-verify=false \
    --dest-tls-verify=false \
    --dest-username "$(kubectl -n nexus get secret nexus-admin-credential -o json | jq -r '.data.username | @base64d')" \
    --dest-password "$(kubectl -n nexus get secret nexus-admin-credential -o json | jq -r '.data.password | @base64d')" \
    docker://$IMAGE \
    docker://registry.local/$IMAGE

Snyk Report

Coming soon

Software Bill of Materials

cosign download sbom artifactory.algol60.net/csm-docker/unstable/cray-hbtd-test:1.22.0-20241223212958.5fa88f9 > container_image.spdx

If you don't have cosign, then you can get it here.

Note: this SHA is the merge of 7dc6e39 and the PR base branch. Good luck and make rocket go now! 🌮 🚀

[github-actions]

👋 Hey! Here is the image we built for you (Artifactory Link):

artifactory.algol60.net/csm-docker/unstable/cray-hbtd:1.22.0-20241223212958.5fa88f9

Use podman or docker to pull it down and inspect locally:

podman pull artifactory.algol60.net/csm-docker/unstable/cray-hbtd:1.22.0-20241223212958.5fa88f9

Or, use this script to pull the image from the build server to a dev system:

Dev System Pull Script

Note the following script only applies to systems running CSM 1.2 or later.

#!/usr/bin/env bash

IMAGE=artifactory.algol60.net/csm-docker/unstable/cray-hbtd:1.22.0-20241223212958.5fa88f9

podman run --rm --network host  \
    quay.io/skopeo/stable copy \
    --src-tls-verify=false \
    --dest-tls-verify=false \
    --dest-username "$(kubectl -n nexus get secret nexus-admin-credential -o json | jq -r '.data.username | @base64d')" \
    --dest-password "$(kubectl -n nexus get secret nexus-admin-credential -o json | jq -r '.data.password | @base64d')" \
    docker://$IMAGE \
    docker://registry.local/$IMAGE

Snyk Report

Coming soon

Software Bill of Materials

cosign download sbom artifactory.algol60.net/csm-docker/unstable/cray-hbtd:1.22.0-20241223212958.5fa88f9 > container_image.spdx

If you don't have cosign, then you can get it here.

Note: this SHA is the merge of 7dc6e39 and the PR base branch. Good luck and make rocket go now! 🌮 🚀