Instance: Workflow Sandbox #38
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Create Instance | |
| on: | |
| issues: | |
| types: [labeled] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| jobs: | |
| create: | |
| runs-on: self-hosted | |
| if: github.event.label.name == 'instance:approved' | |
| steps: | |
| - name: Remove "instance:approved" label | |
| if: ${{ always() }} | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| github.rest.issues.removeLabel({ | |
| issue_number: context.payload.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| name: ["instance:approved"] | |
| }) | |
| - name: Issue Forms Body Parser | |
| id: parse | |
| uses: zentered/[email protected] | |
| - name: Display parsed data | |
| run: | | |
| echo ${{ toJSON(steps.parse.outputs.data) }} | jq . | |
| - name: Extract fields | |
| id: extract | |
| run: | | |
| email=$( | |
| echo ${{ toJSON(steps.parse.outputs.data) }} | | |
| jq -r ".email.text" | |
| ) | |
| echo "email=$email" >> $GITHUB_OUTPUT | |
| instance_flavor=$( | |
| echo ${{ toJSON(steps.parse.outputs.data) }} | | |
| jq -r '."cloud-computing-instance-flavor".text | split(" - ")[0]' | |
| ) | |
| echo "instance_flavor=$instance_flavor" >> $GITHUB_OUTPUT | |
| - name: Define instance name | |
| id: define | |
| run: | | |
| instance_name="morpho-cloud-portal_instance-$ISSUE_NUMBER" | |
| echo "instance_name=$instance_name" >> $GITHUB_OUTPUT | |
| env: | |
| ISSUE_NUMBER: ${{ github.event.issue.number }} | |
| - uses: actions/checkout@v4 | |
| - name: Create instance | |
| run: | | |
| OS_CLOUD=BIO180006_IU # Select openstack auth settings defined in "clouds.yaml" | |
| source ~/venv/bin/activate | |
| echo Creating instance "$INSTANCE_NAME" | |
| # See https://jetstream2.exosphere.app/exosphere/helpabout | |
| exoClientUuid=67296a2e-069b-49ca-9ca4-5dd296869ada | |
| # See "currentExoServerVersion" in exosphere/src/Types/Server.elm | |
| exoServerVersion=5 | |
| openstack server create "$INSTANCE_NAME" \ | |
| --nic net-id="auto_allocated_network" \ | |
| --security-group "default" \ | |
| --security-group "exosphere" \ | |
| --flavor $INSTANCE_FLAVOR \ | |
| --image "Featured-Ubuntu22" \ | |
| --key-name "jcfr" \ | |
| --property "exoGuac={\"v\":1,\"ssh\":true,\"vnc\":true}" \ | |
| --property "exoClientUuid=$exoClientUuid" \ | |
| --property "exoServerVersion=$exoServerVersion" \ | |
| --property "[email protected]" \ | |
| --property "exoFloatingIpOption=automatic" \ | |
| --property "exoSetup={\"status\":\"waiting\",\"epoch\":null}" \ | |
| --user-data ./cloud-config \ | |
| --wait \ | |
| --column created \ | |
| --column flavor \ | |
| --column image \ | |
| --column name \ | |
| --column status | |
| env: | |
| INSTANCE_NAME: ${{ steps.define.outputs.instance_name }} | |
| INSTANCE_FLAVOR: ${{ steps.extract.outputs.instance_flavor }} | |
| - name: Poll instance status | |
| id: instance_poll | |
| run: | | |
| OS_CLOUD=BIO180006_IU # Select openstack auth settings defined in "clouds.yaml" | |
| source ~/venv/bin/activate | |
| echo Polling instance "$INSTANCE_NAME" | |
| max_wait_time=300 # Maximum wait time in seconds (300s -> 5mins) | |
| wait_interval=5 # Interval between status checks in seconds | |
| total_wait_time=0 | |
| while [ $total_wait_time -lt $max_wait_time ]; do | |
| status=$(openstack server show "$INSTANCE_NAME" -f json -c properties | \ | |
| jq -r .properties | \ | |
| jq -r .exoSetup | \ | |
| jq -r .status) | |
| if [ "$status" = "complete" ]; then | |
| echo "Status is complete. Exiting loop." | |
| break | |
| else | |
| echo "Status is $status. Waiting for completion..." | |
| sleep $wait_interval | |
| total_wait_time=$((total_wait_time + wait_interval)) | |
| fi | |
| done | |
| if [ $total_wait_time -ge $max_wait_time ]; then | |
| echo "Maximum wait time ($max_wait_time seconds) exceeded. Exiting." | |
| status="polling_timeout" | |
| fi | |
| echo "status=$status" >> $GITHUB_OUTPUT | |
| env: | |
| INSTANCE_NAME: ${{ steps.define.outputs.instance_name }} | |
| - name: Send mail (not completed) | |
| if: ${{ steps.instance_poll.outputs.status != 'complete' }} | |
| uses: dawidd6/action-send-mail@2cea9617b09d79a095af21254fbcb7ae95903dde # v3.12.0 | |
| with: | |
| server_address: smtp.gmail.com | |
| server_port: 465 | |
| secure: true | |
| username: ${{secrets.MAIL_USERNAME}} | |
| password: ${{secrets.MAIL_PASSWORD}} | |
| from: MorphoCloudPortal | |
| to: ${{ steps.extract.outputs.email }} | |
| subject: | |
| "[MorphoCloudPortal] Instance ${{ steps.define.outputs.instance_name | |
| }} creation failed" | |
| body: | |
| Failed to create instance ${{ steps.define.outputs.instance_name }} | |
| - name: Retrieve metadata | |
| id: instance_metadata | |
| if: ${{ steps.instance_poll.outputs.status == 'complete' }} | |
| run: | | |
| OS_CLOUD=BIO180006_IU # Select openstack auth settings defined in "clouds.yaml" | |
| source ~/venv/bin/activate | |
| echo Retrieving metadata from instance "$INSTANCE_NAME" | |
| # Get instance IP | |
| instance_ip=$( | |
| openstack server show $INSTANCE_NAME -c addresses -f json | \ | |
| jq -r .addresses.auto_allocated_network[1] | |
| ) | |
| echo "instance_ip=$instance_ip" >> $GITHUB_OUTPUT | |
| # Get instance password | |
| instance_pwd=$( | |
| openstack server show $INSTANCE_NAME -c tags -f json | \ | |
| jq -r '.tags[] | select(startswith("exoPw")) | sub("^exoPw:"; "")' | |
| ) | |
| echo "::add-mask::$instance_pwd" | |
| echo "instance_pwd=$instance_pwd" >> $GITHUB_OUTPUT | |
| env: | |
| INSTANCE_NAME: ${{ steps.define.outputs.instance_name }} | |
| - name: Generate Guacamole Connection URL | |
| if: ${{ steps.instance_poll.outputs.status == 'complete' }} | |
| id: guacamole | |
| run: | | |
| # See hard-coded value in exosphere/src/Helpers/Interaction.elm | |
| guacamole_port=49528 | |
| # See cloud_configs.js (allocation region is "IU") | |
| proxy_hostname=proxy-js2-iu.exosphere.app | |
| # See "buildProxyUrl" in src/Helpers/Url.elm | |
| proxified_instance_ip=${INSTANCE_IP//./-} | |
| # See "stepServerGuacamoleAuth" in exosphere/src/Orchestration/GoalServer.elm | |
| tokens_url="https://http-$proxified_instance_ip-$guacamole_port.$proxy_hostname/guacamole/api/tokens" | |
| auth_token=$( | |
| curl -X POST --silent -d "username=exouser&password=$INSTANCE_PWD" $tokens_url | \ | |
| jq -r .authToken | |
| ) | |
| echo "::add-mask::$auth_token" | |
| # See hard-coded value in exosphere/src/Helpers/Interaction.elm | |
| client_id=ZGVza3RvcABjAGRlZmF1bHQ | |
| connection_url="https://http-$proxified_instance_ip-$guacamole_port.$proxy_hostname/guacamole/#/client/$client_id=?token=$auth_token" | |
| echo $connection_url | |
| echo "connection_url=$connection_url" >> $GITHUB_OUTPUT | |
| env: | |
| INSTANCE_IP: ${{ steps.instance_metadata.outputs.instance_ip }} | |
| INSTANCE_PWD: ${{ steps.instance_metadata.outputs.instance_pwd }} | |
| - name: Send mail (completed) | |
| if: ${{ steps.instance_poll.outputs.status == 'complete' }} | |
| uses: dawidd6/action-send-mail@2cea9617b09d79a095af21254fbcb7ae95903dde # v3.12.0 | |
| with: | |
| server_address: smtp.gmail.com | |
| server_port: 465 | |
| secure: true | |
| username: ${{secrets.MAIL_USERNAME}} | |
| password: ${{secrets.MAIL_PASSWORD}} | |
| from: MorphoCloudPortal | |
| to: ${{ steps.extract.outputs.email }} | |
| subject: | |
| "[MorphoCloudPortal] Instance ${{ steps.define.outputs.instance_name | |
| }} created" | |
| body: | | |
| Instance ${{ steps.define.outputs.instance_name }} created | |
| Web connect: ${{ steps.guacamole.outputs.connection_url }} | |
| SSH: ssh exouser@${{ steps.instance_metadata.outputs.instance_ip }} | |
| Passphrase: ${{ steps.instance_metadata.outputs.instance_pwd }} | |
| - name: Add "instance:created" label | |
| if: ${{ success() && steps.instance_poll.outputs.status == 'complete' }} | |
| uses: actions/github-script@v7 | |
| with: | |
| script: | | |
| github.rest.issues.addLabels({ | |
| issue_number: context.payload.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| labels: ["instance:created"] | |
| }) |