.. _instances: ================= Cloud / Instances ================= .. contents:: :local: Instances view ============== .. image:: /_static/images/newstaff/cloud/instances/instances-view.png The instances view can be displayed in two different types of views: * Card view .. image:: /_static/images/newstaff/cloud/instances/instances-view-card.png :scale: 50 * List view .. image:: /_static/images/newstaff/cloud/instances/instances-view-list.png :scale: 50 Filtering instances ------------------- The instances can be filtered by: * created at * client * status * task state * flavor * flavor name * availability zone * hypervisor * image * image os distro name * region * client status * service status Sorting instances ----------------- The instances can be sorted by: * creation date * name * region * availability zone * status * current cycle traffic * current month traffic Create new instance =================== In order to create a new instance, please click on the `+` sign in the bottom right corner. Upon clicking it, the following form will be available: .. image:: /_static/images/newstaff/cloud/instances/instance-create-form-admin-or-client.png :scale: 50 As you can see, you can chose to create the instance either in the admin project, or in a client's project. Create new instance in admin project ------------------------------------ Choosing to create the instance in the admin project will open the following form: .. image:: /_static/images/newstaff/cloud/instances/instance-create-form-admin.png :scale: 50 The following fields are mandatory, in order to be able to create the instance: * name * region * boot source (you can choose from public images, client images, community images, shared images, volumes and volume snapshots) * configuration (flavor) * network The following optional fields are available: * cloud-init user date * ssh key * root password Create new instance in client's project --------------------------------------- Choosing to create the instance in the client's project will open the following form: .. image:: /_static/images/newstaff/cloud/instances/instance-create-form-client-project.png :scale: 50 Besides the fields already mentioned earlier (when creating instance in the admin project), you will have to also choose the client for which you want to create the instance. .. note:: The client must have an OpenStack project assigned to his OpenStack service in order to be able to deploy instances in his project. Instance details ================ When clicking on an instance, you will be able to see the following instance details: .. image:: /_static/images/newstaff/cloud/instances/instance-details.png :scale: 50 Instance details / Info ----------------------- .. image:: /_static/images/newstaff/cloud/instances/instance-details.png :scale: 50 On the info tab, on the instance details page, you will be able to see the following details: * instance specifications (image, flavor, memory, vCPUs, storage and storage type) * other details (instance UUID, project ID, instance hypervisor, created date, client, region, availability zone, total traffic this billing cycle, total traffic this month) Instance details / System logs ------------------------------ On the system logs tab you will be able to see the instance's system logs: .. image:: /_static/images/newstaff/cloud/instances/instance-details-system-logs.png :scale: 50 Instance details / Metrics -------------------------- .. important:: You need to have Ceilometer service installed and configured in order to use see the metrics. On the metrics tab, you will be able to see the network metrics and the cpu metrics: .. image:: /_static/images/newstaff/cloud/instances/instance-details-metrics-network.png :scale: 50 .. image:: /_static/images/newstaff/cloud/instances/instance-details-metrics-cpu.png :scale: 50 Instance details / Network traffic ---------------------------------- .. important:: You need to have Ceilometer service installed and configured in order to use see the metrics. On the network traffic tab you will be able to see a detailed history of the network traffic for that instance: .. image:: /_static/images/newstaff/cloud/instances/instance-network-traffic.png :scale: 50 Instance details / Snapshots On the Snapshots tab, you will be able to: * create snapshot (in admin project or in client project) * see the already existing snapshots * edit a snapshot * launch a new instance using the desired snapshot * rebuild current instance using the desired snapshot * download image * delete snapshot To create a new snapshot you will need to press the `Create snapshot` button. The following form will be opened: .. image:: /_static/images/newstaff/cloud/instances/instance-details-create-snapshot.png :scale: 50 The snapshot can be created either in the admin project (no charges will be applied to your client) or in the client project. To edit/launch/rebuild current instance/download/delete snapshot you need to use the action buttons available on each snapshot row: .. image:: /_static/images/newstaff/cloud/instances/instance-details-action-buttons-snapshot.png :scale: 50 Instance details / Volumes -------------------------- .. image:: /_static/images/newstaff/cloud/instances/instance-details-volumes.png :scale: 50 On the volumes tab you will be able to: * see the attached volumes * attach / detach volumes to the instances In order to attach a volume you will need to click on the `Attach volume` button. Upon clicking that button, you will see all the available volumes that were created in the same project as the instance was created. To detach a volume you will need to click on the `Detach volume` action button. .. note:: Detaching a volume will not delete that volume. Instance details / History log ------------------------------ On the history log tab, you will be able to see the actions that were done to this instance, such as the following: .. image:: /_static/images/newstaff/cloud/instances/instance-details-history-log.png :scale: 50 Note that the history log will contain all the actions that were done on the instance (including start, stop, resize, etc). and the history is pulled directly from OpenStack. Instance details / Networking ----------------------------- On the networking tab you will be able to see and manage the networking details of your instance. .. image:: /_static/images/newstaff/cloud/instances/instance-details-networking-tab.png :scale: 50 The following actions are available on this tab: * add / delete port * attach / detach port * add /remove ip * add ip automatically * assign floating IP * configure RDNS Instance details / Security groups ---------------------------------- On the security groups tab you will be able to manage the security groups that are assigned to your instance. .. image:: /_static/images/newstaff/cloud/instances/instance-details-security-groups.png :scale: 50 In order to associate a new security group to your instance, you need to click on the `Associate` button in the bottom right corner. To dissociate a security group from your instance, you need to click on the trash bin icon. Instance details / Backups -------------------------- On the backups tab, you will be able to manage your instance's backups: .. image:: /_static/images/newstaff/cloud/instances/instance-details-backups.png :scale: 50 As you can see in the previous picture, you will be able to create a new backup schedule by clicking on the `create new backup schedule` button. This will open the following form: .. image:: /_static/images/newstaff/cloud/instances/instance-details-create-backup-schedule.png :scale: 50 To create a manual backup, you will need to click on the `create new backup` button, which will open the following form: .. image:: /_static/images/newstaff/cloud/instances/instance-details-create-new-backup.png :scale: 50 Available actions for instances =============================== On each instance, a staff user will be able to do the following actions: Shut down instance ------------------ In order to shut down the instance you need to click on the `Shut down instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-shut-down-instance.png :scale: 50 Start instance -------------- In order to start the instance you need to click on the `Start instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-start-instance.png :scale: 50 Reboot instance --------------- In order to reboot the instance you need to click on the `Reboot instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-reboot-instance.png :scale: 50 Resize instance --------------- In order to resize the instance you need to click on the `Resize instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-resize-instance.png :scale: 50 Upon clicking on the resize instance button, the following form will be opened: .. image:: /_static/images/newstaff/cloud/instances/instance-details-resize-instance-2.png :scale: 50 After resizing the instance, you will need to confirm the resize, by clicking on the `confirm resize` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-confirm-resize.png :scale: 50 If you want to revert the resize, you can click on the `revert resize` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-revert-resize.png :scale: 50 Rescue instance --------------- In order to rescue the instance you need to click on the `Rescue instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-rescue-instance.png :scale: 50 Rebuild instance ---------------- In order to rebuild the instance you need to click on the 3 dots available in the top right corner, and then click on the `Rebuild instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-rebuild-instance.png :scale: 50 When rebuilding the instance you will be able to select a new boot source (even a different image than the original one). Console ------- In order to access the console you need to click on the 3 dots available in the top right corner, and then click on the `Console` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-console.png :scale: 50 Rename instance --------------- In order to rename the instance you need to click on the 3 dots available in the top right corner, and then click on the `Rename instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-rename-instance.png :scale: 50 Suspend instance ---------------- In order to suspend the instance you need to click on the 3 dots available in the top right corner, and then click on the `Suspend instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-suspend-instance.png :scale: 50 Shelve instance --------------- In order to shelve the instance you need to click on the 3 dots available in the top right corner, and then click on the `Shelve instance` button: .. image:: /_static/images/staff/cloud/instances/shelve-instance.png :scale: 50 Shelving an instance will create a snapshot and remove it from the compute node eventually freeing up resources for other instances. Only instances with one of the following statuses can be shelved: Running, Stopped, Suspended and Paused Unshelve instance ----------------- In order to unshelve the instance you need to click on the `Unshelve instance` button: .. image:: /_static/images/staff/cloud/instances/unshelve-instance.png :scale: 50 Unshelve will restore the instance to running state. A confirmation dialog will displayed when unshelving instance allowing the user to select an availability zone if the instance is not yet offloaded (status Shelved Offloaded). .. image:: /_static/images/staff/cloud/instances/unshelve-instance-dialog.png Migrate instance ---------------- In order to migrate the instance you need to click on the 3 dots available in the top right corner, and then click on the `Migrate instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-migrate-instance.png :scale: 50 Move instance ------------- In order to move the instance between clients you need to click on the 3 dots available in the top right corner, and then click on the `Move instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-move-instance.png :scale: 50 Boot from ISO ------------- In order to boot the instance from ISO you need to click on the 3 dots available in the top right corner, and then click on the `Boot from iso` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-boot-from-iso.png :scale: 50 Lock instance ------------- In order to lock the instance you need to click on the 3 dots available in the top right corner, and then click on the `Lock` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-lock-instance.png :scale: 50 Change password --------------- In order to change the password you need to click on the 3 dots available in the top right corner, and then click on the `Change password` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-change-password.png :scale: 50 .. important:: This option will not work if you didn't configured the :ref:`password-and-ssh-key-injection` Delete instance --------------- In order to delete the instance you need to click on the 3 dots available in the top right corner, and then click on the `Delete instance` button: .. image:: /_static/images/newstaff/cloud/instances/instance-details-delete-instance.png :scale: 50