Warning: This page is currently under construction. Information may not be ready for users.
OpenStack is an open-source cloud stack that is currently running on Red Cloud. Also, for more information, see the Official Documentation for OpenStack. If you are looking for information on how to migrate an instance from Eucalyptus to OpenStack, please see Migrating from Eucalyptus to OpenStack.
This page is intended as a quick walk-through of the most-used features of OpenStack, so it is not comprehensive, but links to a lot of supporting documentation for more thorough explanations and advanced topics.
Using the OpenStack Web Interface (Horizon)
There are two ways to manage Red Cloud resources:
Most users will use the OpenStack Web Interface (called Horizon). This web-based interface can be used to manage instances and volumes. For Linux Instances, however, some users may choose to use the OpenStack CLI. This section focuses on the OpenStack Web Interface.
Log in to the OpenStack Web Interface to create and manage Red Cloud resources. There are two ways to login:
- CAC Account - Enter cac as the "Domain" and your CAC username and password, not your Cornell NetID. If your CAC password has expired, you will need to reset it before you will be able to login to the OpenStack Web Interface.
- Globus Auth - Log in through Globus
- Currently, this feature is only available to Aristotle users. This feature will be enabled for all users in the future.
- You must link your Cornell account, or any accounts attached to the projects you are on, in order to have access to them when using Globus Auth.
- If you can't log in with Globus Auth, it may be that you have not linked your account yet.
You can use the "Authenticate using" drop-down to switch between the two options. Neither option requires you to enter a project ID; you can switch between the projects you are on once logged in.
The Overview page is the first place you will be taken upon logging into Red Cloud.
- Provides useful metrics on currently selected project
- Before creating an instance, you will need to:
- Select the correct project from the "Project" drop-down at the top right of the page (if you are on multiple projects)
- Create a key pair - for authentication when you log in the first time
- Create a security group - defines allowable types of port access for an instance
- Optional: Set up a private network - if you do not want your instance to be available on the public net
- You may also want to:
This is obviously visible along the top bar when compute is selected: Key Pairs
Can create or upload.
Can't create or upload during Instance setup.
Getting to this is not obvious: Security Groups
Can't create one during Instance setup.
Each instance is a Virtual Machine (VM) in the cloud. You can select CPU/RAM/disk configurations (called "flavors") for the VM. The available VM configurations are:
The root disk size of the instance will default to the size of the image you select. You have the option to extend the root disk size beyond the image size at launch time. Note: we do not oversubscribe physical RAM or CPU cores (with hyperthreading disabled).
To work with instances, select the "Instances" page under the "Compute" tab, as pictured below:
Launch an Instance
This section is a general walk-through for creating a new instance, which is not specific to an Operating System (OS). For more specific information per OS, see either of the Linux Instances or Windows Instances pages.
To launch a new instance
- Create Key Pair
- Create a Security Group and be sure that you select the appropriate rule for connecting to your instance (SSH for Linux Instances and RDP for Windows Instances)
- Select "Launch Instance" on the top right side of the Instances page
The full "Launch Instance" menu will pop up like this:
- Tabs that you are required to fill out are marked with a *
- It is recommended that you also select your own Security Group, otherwise the default security group will be selected, which may not be ideal for your work.
- It is necessary that you select your own Key Pair, even though this field is not marked required, so that you are able to connect to your instance after creation.
Configuring the Instance
- Under the "Details" tab:
- Enter a name for your instance
- Count is the number of identical instances you would like to create (typically 1).
- Note that if you create multiple instances this way, the names will be identical with a dash and number added at the end.
- For example, if you set Instance Name to "my_instance" and you set Count to 3, you would start instances named "my_instance-1", "my_instance-2", and "my_instance-3".
- On the "Source" tab:
- You must Select Boot Source, which is described on the page as "the template used to create an instance."
- You can select a specific source under the Available list by selecting the up arrow on the right-hand side.
- Get more details about the specific source by selecting the right-arrow on the left-hand side next to the name.
- You will have the option to Create New Volume if you have selected either "Image" or "Instance Snapshot" as the source. The default is set to "Yes". This will create a new volume, called a root volume.
- If you do want to create a new volume, select a Volume Size
- The option for Delete Volume on Instance Delete determines whether or not your root volume will be deleted when you terminate the instance. By default, this option is set to "No" to prevent accidental deletion of your data. However, if you do not intend to re-use the root volume, you could unintentionally incur excess storage usage. You can either delete the root volume manually later (it will show up in the list of volumes with the ID the same as the name), or select "Yes" on this option to automatically delete it when you terminate your instance later.
- You can also name the volume under Device Name.
- The "Flavor" tab is where you select the VM configuration discussed above.
- You can select a configuration by selecting the up arrow on the right-hand side.
- Get more details about the configuration by selecting the right-arrow on the left-hand side next to the name.
- The "Total Disk" will show "0 GB" because the disk size will match the image you selected on the "Source" tab.
- For the "Networks" tab, no action is necessary unless you want to set up a private network. Your instance will default to being available on the public net.
- On the "Security Groups" tab, select the security group you already created.
- On the "Key Pairs" tab, select the key pair you already created.
You should not take a snapshot of a file system that's mounted. You will lose all the info that's still in Linux's write cache. So if you want to take a snapshot of the root file system, the OS cannot be running.
Create and Attach a Volume
Volume creation is useful or attaching a data volume or a volume with users' home directories to an instance, as it is often good to separate the concerns of an operating system and user data. This makes it relatively easy to switch operating systems and maintain the same data, and to archive the more important parts of the project (the data) if needed.
- Create a volume
- Go to Volumes/Volumes in the Horizon Web GUI
- Click "Create Volume"
- On the Actions dropdwon menu, click "Manage Attachments"
- Select the instance you wish to attach to and click "Attach Volume"; note the device name specifies is usually not important and not always adhered to.
- - For Linux: Once you have attached the volume, login to your instance and run
lsblkto see which
/dev/vdXis the likely candidate (for some character 'X'). You can then edit
/etc/fstabto have this mounted; see standard Linux documentation for this and how to use the
- - TODO: notes for Windows?
- - For Linux: Once you have attached the volume, login to your instance and run
Snapshots of volumes (and of instances, in which case the volume is implicitly the root volume of the instance) can be created from the Actions dropwdown menu. This creates a state save of the existing volume. This is most useful for OS volumes to create safe checkpoints of working operating system configuration states. It may be less useful for larger data volumes; a more efficient solution might be to use ZFS snapshots on Linux operating systems.
Types of Storage
Use the 'public' net if you want some form of public (but possibly restricted) access from the internet and don't care about having an extremely stable IP. Somewhat counter-intuitively, you want a 'private' network if you want to get a stable "floating" IP address (called an elastic IP address in Eucalyptus and AWS); this is also highly reccomended if you plan to have a registered domain name pointing to the instance. You can also use a private network if you want some or all of the instances on the private network to not be directly accessible from the internet. The list of networks for the currently selected project can be viewed in OpenStack Horizon.
Note that you can actually have an instance that is both part of the 'public' network and a 'private' network.
- No action is needed to use this, other than selecting it.
- This should be acceptable for many uses, e.g. compute instances.
- IP address will be stable through reboots, but not necessarily through hard shutdowns (e.g. shelving).
- You can not assign a floating IP to an instance via its membership in a public network. Please do not allocate floating IP addresses on a public network.
Setting up your own private network
- ssh into linuxlogin.cac.cornell.edu; this can be done using your CU netid and CAC password:
- source the openrc for the desired project, which is obtainable via from OpenStack Horizon once the desired project is selected in Horizone
- Run the network creation script with a single argument (network name), e.g.:
You can switch an instance from public to private by doing attach interface / detach interface from the instance dropdown menu.
Note that network names are not unique, but IDs are. You can rename a network without renaming the subnet (but you can rename it too, separately), all possible via the Horizon web UI. The subnets are private, and exposed externally by a Router. Networks and routers won't be deleted if there are any active connections on them. There is also a delete network script that should be used instead of the Horizon web UI for a cleaner deletion:
Steps for getting a floating (stable) IP:
- See the prerequisite steps above for "Setting up your own private network"
- In Horizon, under the Networks tab, select "Floating IPs", which should send you here.
- Click "Allocate IP to Project"
- The only pool will be "public"; click "allocate".
- From the list of floating IPs, click "Associate"; make sure you pick a "port" that is an instance's interface on a previously created private network, NOT a public network.
- Note that if you not longer need the floating IP, please release it back to the pool by selecting the "Release Floating IP" from the Actions dropdown menu.
- When changing the associated floating IPs of an instance, security groups may be dropped, so you may need to edit the security groups after the fact from the instance dropdown menu.