Skip to content

Commit

Permalink
merge dev into staging
Browse files Browse the repository at this point in the history
  • Loading branch information
dweinholz committed May 2, 2024
2 parents 3f16d13 + e4302ac commit 58efde0
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 76 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
111 changes: 35 additions & 76 deletions wiki/simple_vm/instance_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,104 +4,63 @@ On the “Instance Overview” you can list virtual machines, get more informati

![layout](./img/instance_overview/instance_overview_general.png)

## 1. Pagination
## Layout

Set how many VMs you want to see on a page and scroll through the pages.
The layout of the instance overview serves several functions.

## 2. Filter
#### Pagination

Filter the list of VMs:
The pagination allows you to adjust how many VMs you want to see on a page and scroll through the pages.

- By username
- By project name
- By a users Elixir ID
- By an OpenStack VM ID
- By vm name
- By flavor name
#### Filter

Click `Filter`.
You are able to filter the shown VMs as follows:

## 3. Action on many machines
- A string search, which filters machines by name, the name of the project it is part of, the OpenStack ID of the machine or the username.
- Machine state, e.g. only showing active machines
- When having the corresponding permissions, you can also filter by permission type: See your own machines, or also the ones you are allowed to so within your project.

Trigger an action on all selected virtual machines.<br>
`Select all` or `select` specific machines.
The list of machines is adjusted by clicking on "Apply".

## 4. General information
#### Deletion of selected machines

See the name, the status, the project, and the creator of the virtual machine.<br>
Click on the name to get to the [Detail page](instance_detail.md).
## 5. Descriptive icons
Either all or specific machines can be selected by clicking on the checkbox in front of the machine state-indicator and name.
All selected machines can then be deleted by clicking on "Delete Selected".

Get a quick overview of the configuration:
#### Base Information

* See the amount of volumes mounted to the vm.
* See the installed research environment and whether it installed correctly.<br>
Hover to read the name.<br>
Click the icon to copy the URL of your browser-based research environment.
* See the amount of conda tools installed on the virtual machine at launch and whether they installed correctly.
Each machines is represented by a seperate clickable component.
The header of the component shows the following information on first glance:

## 6. Flavor and Image
- **Machine status**
- **Machine name**
- **Descriptive Icons**
<br>The icons allow you to get a quick overview of further machine configurations:

Which flavor and image the virtual machine runs on.
- See the amount of volumes mounted to the vm.
- See the installed research environment and whether it installed correctly. Clicking the icon copies the URL of your browser-based research environment into your clipboard.
- See the amount of conda tools installed on the virtual machine at launch and whether the installation was successful.

## 7. Virtual machine detail page
- **Creation date**

Go to the virtual machine [detail page](instance_detail.md).

## 8. How to connect
#### Further Details and actions

Get commands and information on how to connect to your virtual machine.

![htc](./img/instance_overview/instance_overview_htc.png)

1. The commands you find here differ depending on the chosen configuration.
2. Click to copy only the command, not the descriptive text.

## 9. Action on one machine

Perform actions on the machine.<br>
Depending on the status, you only see a selection of actions.

![actions](./img/instance_overview/instance_overview_actions.png)

###### Attach Volume

Attach an existing volume. This action shows when the machine is active and running.

###### Detach Volume

Detach an attached volume. This action shows when the machine is active and running.

###### Stop VM

Shutoff the virtual machine.

???+ info "Resource usage"
A vm in “SHUTOFF” state still consumes resources.

###### Reboot VM

Soft or hard reboot the virtual machine.<br>
A soft reboot attempts a graceful shut-down and restart of the instance.
A hard reboot power cycles the instance.[^1]

###### Create snapshot

Take a snapshot of the virtual machine.<br>
You, or a project member, can boot a new virtual machine from it.
For more information on snapshots, see [here](./snapshots.md).

###### Delete VM

Delete the virtual machine.<br>
Any attached volume gets detached and not deleted.
By clicking on the header of a specific machine listed, a more detailed description of the machine is shown.
This includes the following information:
- **Flavor and Image**
- **Project**
- **User in charge of the machine**
- **Connection information for SSH and link to Research Environment access, if available**

???+ warning "Backup your data"
All data on the machine gets deleted. Make sure to back up data you can't lose.
See [here](backup.md) for backup recommendations.
This detailed area also includes action buttons, which allow you to quickly control the instance via the overview.
For example, the VM can be stopped or restarted. Snapshots can be created and the machine can be deleted.
All actions are asked to be confirmed.

###### Resume/Restart VM

Boot up the "SHUTOFF" virtual machine.
The overview also has buttons that lead to the details page of the instance. This is divided into different areas, which can be accessed directly using the buttons. This includes a summary of the machine, volume management, port settings, information and settings for the research environment, user management and an event log.

[^1]: https://docs.openstack.org/mitaka/user-guide/cli_reboot_an_instance.html

0 comments on commit 58efde0

Please sign in to comment.