Research Red Hat Console Provisioning Service

[TomasTomecek]

API: https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/RHEnVision/provisioning-backend/main/api/openapi.gen.json#operation/getReservationByID

Notes from our meeting with @ezr-ondrej today:

• The provisioned machines need an account from which the costs are paid
  • Console uses a concept of Sources (check the API above)
• We also need to figure out how people access the machines - SSH keys
  • An idea was to use SSH keys that we all have on GitHub
• One idea is to run an "internal" workflow in the beginning for folks who have access to console.redhat.com

[TomasTomecek]

Doing a poor-man's research, here in a comment.

• pubkeys can be easily created using the provisioning API:

  • https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/RHEnVision/provisioning-backend/main/api/openapi.gen.json#operation/createPubkey

• even better: we can obtain pubkeys from github:

  $ curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer $TOKEN"\
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/users/TomasTomecek/keys
  [
    {
      "id": 4051289,
      "key": "ssh-rsa AAAAB3NzaC1..."
    }
  ]
  

• Creating VMs in the cloudz requires a source, but sadly these can't be created using API (Mar 2023)

  • For our PoC, we'd need to create the source ourselves using the webui and tie it to our AWS account
  • We'd then hardcode this source ID to all the creations

A simple reservation flow:

REQUEST
Packit → Provisioning API

{
"amount": 0,                    # we'd hardcode 1, we always want only a single VM in our PoC
"image_id": "string",           # using the one from image builder
"instance_type": "string",      # again, hardcode the smallest thing possible
"launch_template_id": "string", # (optional), we could create our own template in AWS
"name": "string",               # yes
"poweroff": true,               # false - should be live asap
"pubkey_id": 0,                 # we'd first create it, then use it
"region": "string",             # probably hardcode, would be configurable over time
"source_id": "string"           # hardcode
}

RESPONSE
Provisioning API → Packit

{
"amount": 0,
"aws_reservation_id": "string", # probably an ID in context of console.rh.c
"image_id": "string",
"instance_type": "string",
"instances":                    # we'd probably need to use AWS' API to get an IP address
"string"
],
"launch_template_id": "string",
"name": "string",
"poweroff": true,
"pubkey_id": 0,
"region": "string",
"reservation_id": 0,
"source_id": "string"
}

[ezr-ondrej]

Hi all and @TomasTomecek !

I believe it is possible to create source through API , I agree it's not very obvious and put the correct request together is non-trivial, here is what we've come up with to seed data through api in local develepement instance of sources: https://github.com/RHEnVision/provisioning-backend/blob/main/scripts/sources.seed.sh

Happy to help with getting the correct payload together with you for your needs ;)

Another good news (hopefully) is that we are currently working on a last step of the launch, that would wait for the instance to come up and fetch it's IP & FQDN, it's not perfect and if the instance does not come up within some time (currently we are thinking 6 secs) the IP wont be there, but still it might be usable in your usecase :)

[TomasTomecek]

https://issues.redhat.com/browse/HMS-1133 card for the IPs and FQDN