Skip to content

Using the Cloud

This section is for people consuming an UnderStack cloud: driving the
OpenStack APIs and CLI to get bare metal servers, images and networks. If you are
deploying or operating the cloud itself, you want
Deploy or
Operations instead.

UnderStack is an OpenStack cloud, so upstream OpenStack documentation applies
directly. The pages here cover the parts that are specific to UnderStack —
mainly that the compute you get is a real machine rather than a virtual one.

Set up your client

  • OpenStack CLI — installing the client, configuring
    clouds.yaml for single sign-on, and creating application credentials for
    Terraform and Ansible. Start here; the rest of this section assumes a
    working CLI.

Working with servers

  • Operating System Images — listing the available images,
    adding your own, and the image properties that matter for bare metal.
  • Graphical Console — reaching a server's console when
    SSH is not an option, such as during boot or after a network change locked you
    out.
  • Server Firmware Updates — requesting a firmware
    update on a server you hold, via node traits and runbooks.

Automating

For Terraform, the
OpenStack provider
works against UnderStack unchanged; examples/ in the repository has working
configurations for multi-node builds, routers and trunk ports.

Upstream documentation

Anything not specific to UnderStack is covered upstream: