Skip to content

Multinode workflow: use github user's ssh key #2036

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

Open
elelaysh wants to merge 3 commits into
base: stackhpc/2025.1
Choose a base branch
from
+38 −3
Open

Multinode workflow: use github user's ssh key #2036

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9a9ddc1
Multinode workflow: use github user's ssh key
elelaysh Dec 15, 2025
5da25b7
multinode.yml: use tagged version
elelaysh Dec 16, 2025
3330685
stackhpc-multinode: Fix case in visible text
elelaysh Dec 16, 2025
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
41 changes: 38 additions & 3 deletions .github/workflows/stackhpc-multinode.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,52 @@ name: Multinode
description: How long to break execution for (minutes) (note that instances are cleaned up after 12h)
type: number
default: 60
use_my_ssh_key:
description: Authorise my GitHub SSH keys on Ansible control host
default: 'true'
type: boolean
ssh_key:
description: SSH public key to authorise on Ansible control host
description: SSH public key to authorise on Ansible control host (if different from github ssh keys)
type: string
terraform_kayobe_multinode_version:
description: terraform-kayobe-multinode version
type: string
default: main
jobs:
github_user_ssh_keys:
name: Retrieve actor GitHub SSH keys
runs-on: ubuntu-latest
# Map a step output to a job output, this allows other jobs to be gated on the filter results
outputs:
ssh_keys: ${{ steps.compute_ssh_keys.outputs.ssh_keys }}
steps:
- name: Retrieve GitHub user SSH keys or use provided ones
id: compute_ssh_keys
run: |
# encode array using jq: https://jstrieb.github.io/posts/github-actions-multiline-outputs/
if ${{ inputs.use_my_ssh_key }} && [ -z "${{ inputs.ssh_key }}" ]; then
echo "Fetching ssh keys for ${{ github.actor }}"
ssh_keys="$(gh api /users/${{ github.actor }}/keys --jq '[.[].key]' | jq --compact-output)"
if [ -z "${ssh_keys}" ]; then
echo "E: Unable to get '${{ github.actor }}' ssh keys (quotes added for clarity)"
exit 1
fi
elif [ -n "${{ inputs.ssh_key }}" ]; then
# single string to JSON array
ssh_keys="$(jq --raw-input --compact-output '.|[.]' <<<"${{ inputs.ssh_key }}")"
else
ssh_keys=''
fi
echo "ssh_keys=${ssh_keys}" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ github.token }}
- name: Show ssh_keys
run: |
echo "${{ steps.compute_ssh_keys.outputs.ssh_keys }}"
multinode:
name: Multinode
uses: stackhpc/stackhpc-openstack-gh-workflows/.github/workflows/multinode.yml@1.5.0
needs: github_user_ssh_keys
uses: stackhpc/stackhpc-openstack-gh-workflows/.github/workflows/multinode.yml@1.6.0
Copy link
Member

@Alex-Welsh Alex-Welsh Dec 16, 2025

Choose a reason for hiding this comment

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

This is an important change going under the radar. What's actually included here?

Copy link
Contributor Author

@elelaysh elelaysh Dec 16, 2025

Choose a reason for hiding this comment

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

It's the support for the ssh_keys input in our multinode generic workflow.
Please see stackhpc/stackhpc-openstack-gh-workflows#17

with:
multinode_name: ${{ inputs.multinode_name }}
os_distribution: ${{ inputs.os_distribution }}
Expand All @@ -67,7 +102,7 @@ jobs:
break_on: ${{ inputs.break_on }}
# Workaround loss of number type using fromJSON: https://github.com/orgs/community/discussions/67182
break_duration: ${{ fromJSON(inputs.break_duration) }}
ssh_key: ${{ inputs.ssh_key }}
ssh_keys: ${{ needs.github_user_ssh_keys.outputs.ssh_keys }}
Copy link
Member

@Alex-Welsh Alex-Welsh Dec 16, 2025

Choose a reason for hiding this comment

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

If we're no longer passing ssh_key through, please remove it from the inputs at the start of the workflow

Copy link
Contributor Author

@elelaysh elelaysh Dec 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

yes, you're right.
Thank you

stackhpc_kayobe_config_version: ${{ github.ref_name }}
# NOTE(upgrade): Reference the PREVIOUS and CURRENT releases here.
stackhpc_kayobe_config_previous_version: ${{ inputs.upgrade == 'major' && 'stackhpc/2024.1' || 'stackhpc/2025.1' }}
Expand Down
Loading