{% extends "dashboard/base.html" %} {% load i18n %} {% block title-page %}{% trans "Help" %}{% endblock %} {% block content %}

{% trans "Introduction" %}

{% blocktrans %} This is a deployment of CIRCLE Cloud, which is a free and open source cloud manager. {% endblocktrans %} {% blocktrans %} Its most important function is starting and managing virtual machine instances based on templates. These templates are also easy to create. {% endblocktrans %}

{% blocktrans %} Apart from this tutorial we recommend to try the system, it is quite intuitive, and the web interface shows detailed instructions on advanced options. {% endblocktrans %}

{% trans "Dashboard" %}

{% blocktrans with host=request.get_host %} You can reach this service at https://{{host}}/ where you can log in to the dashboard. {% endblocktrans %}

{% blocktrans %} The dashboard is a summary about your virtual machines and other resources, and the main starting point to access the functions of the system. {% endblocktrans %}

{% trans "Virtual machines" %}

{% if not perms.vm %}

{% trans "Sorry, you have no permission to launch virtual machines." %}

{% endif %}

{% blocktrans %} In the virtual machines box you will find your recent virtual machines. A summary view is also available by clicking the dashboard button (). Click on the name of a virtual machine to see its connection details, preferences, or to change its state. {% endblocktrans %} {% blocktrans %} Important or frequently used machines can be pinned by the favorite button (). The search field shows results incrementally, and submitting (⏎) jumps directly to the result, if there is exactly one. You can start a new virtual machine by clicking on the new button, and choosing a template. {% endblocktrans %}

{% blocktrans %} If you select a virtual machine, you get to a page with all the details and operations listed. On the left, you will see the state of the machine and a summary about how you can connect to the machine. In the middle there is a tabbed pane, which contains details about the machine in categories. {% endblocktrans %} {% blocktrans %} The upper right corner is the operation toolbar with the most important actions that control the lifecycle of the machine. {% endblocktrans %}

{% blocktrans %} The tool buttons are color coded by their effect, and enabled/disabled based on the current state of the machine. The recommended operation is always the biggest tool button with the name displayed. You can click on them as the confirmation dialog explains in detail what they do. {% endblocktrans %}

{% blocktrans %} Home pane shows statistics about the virtual machine, and this is where you can change the name, description and tags of the instance. We strongly advise to add a description to make the work of the cloud administrators easier in case of maintenance. Here is a summary about the expiration times as well. Each virtual machine has a deadline for suspending and destroying based on predefined leases. With the renew button you can reset the counters. Of course you will get a notification if the machine is going to expire. {% endblocktrans %}

{% blocktrans %} Resources pane shows details about how much memory and CPU the VM has, and how is it scheduled. {% endblocktrans %} {% blocktrans %} Users with specific permission can change these settings if the machine is stopped.{% endblocktrans %}

{% blocktrans %} Console pane allows to see the console of the virutal machine for troubleshooting and operating system installation.{% endblocktrans %} {% if perms.vm.access_console %} {% trans "You can also use the keyboard and mouse." %} {% else %} {% blocktrans %}You have permission to create screenshots, but not to use the console keyboard or mouse. {% endblocktrans %} {% endif %} {% blocktrans %}You should normally use the machine by connecting remotely over SSH or Remote Desktop.{% endblocktrans %}

{% blocktrans %} Access pane allows sharing the machine with others and transferring the ownership. Users can see the details of the machine, operators can use most functions, and owners can also destroy the machine. {% endblocktrans %}

{% blocktrans %} Network pane shows how the virtual machine is connected to the network. You can add or remove interfaces, and allow remote access of different TCP/UDP ports. {% endblocktrans %}

{% blocktrans %} Activity pane shows the full life history of the virtual machine. This is where you can see the causes of failed actions (just point the mouse to the name of the action). {% endblocktrans %}

{% trans "Templates" %}

{% if not perms.vm.create_template %}

{% trans "Sorry, you have no permission to create templates." %}

{% endif %}

{% blocktrans %} Templates are the prototypes of virtual machine instances: they contain configuration values for the different technical details of a VM to create, and also the network interfaces and disks to attach. {% endblocktrans %}

{% blocktrans %} In the dashboard box you see your own templates and those, for which you have operator permission. This means that you can share them with your groups or other users. {% endblocktrans %}

{% blocktrans %} You can create templates from any virtual machine with the save as template button. {% endblocktrans %} {% blocktrans %} Additionally, you can also click on the new button of the template box, and follow the template creation wizard. {% endblocktrans %}

{% trans "Groups" %}

{% if not perms.auth %}

{% trans "Sorry, you have no permission to create groups." %}

{% endif %}

{% blocktrans %} Groups are the main building blocks of permission management. On the dashboard you see a list of groups you have access to. {% endblocktrans %}

{% blocktrans %} You can also create your own groups by clicking on the new button of the groups box. {% endblocktrans %}

{% blocktrans %} Users logged in with SSO authentication can automatically become members of groups based on its organizational identifier. Those who are administrators of an organizational group (or a professor of a subject in academics) can create groups with the specific organizational identifier set, so members will automatically added if they log in. {% endblocktrans %} {% blocktrans %} You can also add users based on their identifier, also if they have not logged in at the time. {% endblocktrans %}

{% trans "Files" %}

{% if not store %}

{% trans "Sorry, this deployment of CIRCLE does not support file store." %}

{% endif %}

{% blocktrans %} Each user has a simple personal file store, which is the easiest way to keep and retrieve your work done on virtual machines. {% endblocktrans %}

{% blocktrans %} You can get and upload files from both the web interface and from virtual machines. The web interface works like any other graphical file browser. Virtual machines normally don't get the credentials for your personal store, to prevent accidentally sharing them with other users of the same machine. To use the file store, press the mount store button of the virtual machine. {% endblocktrans %}

{% blocktrans %} {% endblocktrans %}

{% endblock %}