overview.html 18 KB
Newer Older
1 2
{% load i18n %}
<br/>
3 4
<h2 id="overview" >{% trans "Overview" %}</h2>
<br/>
5 6 7

<h3 id="introduction">{% trans "Introduction" %}</h3>

Kálmán Viktor committed
8 9 10 11 12 13 14 15
<p>
  {% blocktrans %}
    This is a deployment of <a href="http://circlecloud.org/">CIRCLE Cloud</a>,
    which is a free and open source cloud manager.
    Its most important function is starting and managing virtual machine instances based on templates.
    These templates are also easy to create.
  {% endblocktrans %}
</p>
16

Kálmán Viktor committed
17 18 19 20 21 22
<p>
  {% 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 %}
</p>
23 24


25
<h3 id="dashboard"><i class="fa fa-dashboard"></i> {% trans "Dashboard" %}</h3>
26

Kálmán Viktor committed
27 28 29 30 31 32 33 34
<p>
  {% blocktrans with host=request.get_host %}
    You can reach this service at <a href="//{{ host }}">https://{{host}}</a>
    where you can log in to the dashboard.
    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 %}
</p>
35 36 37


<h4 id="virtual-machines-box">{% trans "Virtual Machines box" %}</h4>
Kálmán Viktor committed
38 39
<p>
  {% blocktrans %}
40
    In the <em>virtual machines</em> box you will find your recent virtual machines.
Kálmán Viktor committed
41 42 43 44 45
    A summary view is also available by clicking the dashboard button (<i class="fa fa-dashboard"></i>).
    Click on the name of a virtual machine to see its connection details, preferences,
    or to change its state.
  {% endblocktrans %}
</p>
46 47 48 49 50



<h4 id="how-can-i-create-a-vm">{% trans "How can I create a VM?" %}</h4>
<blockquote>
Kálmán Viktor committed
51 52 53 54 55 56 57
  <p>
    {% blocktrans %}
      You can start a machine by clicking the
      <span class="btn btn-success disabled btn-xs"><i class="fa fa-plus-circle"></i> new</span>
      button and selecting a template. The machine starts automatically.
    {% endblocktrans %}
  </p>
58 59 60 61 62
</blockquote>


<h4 id="how-can-i-mark-frequently-used-vms">{% trans "How can I mark frequently used VMs?" %}</h4>
<blockquote>
Kálmán Viktor committed
63 64 65 66 67
  <p>
    {% blocktrans %}
      Important or frequently used machines can be pinned with the <i class="fa fa-star-o"></i> button.
    {% endblocktrans %}
  </p>
68 69 70
</blockquote>


71
<div id="vms" {% if not perms.vm %} class="text-muted" {% endif %}>
Kálmán Viktor committed
72 73 74 75 76 77
  <h3 id="virtual-machines"><i class="fa fa-desktop"></i> {% trans "Virtual Machines" %}</h3>
    {% if not perms.vm %}
      <p class="text-warning">
        {% trans "Sorry, you have no permission to launch virtual machines." %}
      </p>
    {% endif %}
78

79
  <p>
Kálmán Viktor committed
80 81 82 83 84 85 86
    {% blocktrans %}
      After selecting a virtual machine, you will see the machine’s detailed page.
      Here, you can see the <strong>details</strong>, usage <strong>statistics</strong>,
      <strong>manage</strong> the virtual machine, change <strong>access rights</strong> and
      <strong>network interfaces</strong>, modify <strong>resources</strong>
      and show the <strong>activity log</strong>.
    {% endblocktrans %}
87
  </p>
88 89


Kálmán Viktor committed
90 91 92 93
  <h4 id="details">{% trans "Details" %}</h4>
  <p>
    {% blocktrans %}
      If you select a virtual machine, you get to a page with all the details and operations listed.
94
      On the left, you will see the state of the machine and a summary about how you can <strong>connect</strong> to the machine.
Kálmán Viktor committed
95 96 97
      In the middle there is a tabbed pane, which contains details about the machine in categories.
    {% endblocktrans %}
  </p>
98 99


Kálmán Viktor committed
100 101 102 103 104 105 106 107 108
  <h4 id="how-can-i-connect-to-the-virtual-machine">{% trans "How can I connect to the virtual machine?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        If the machine is already started click on the ‘connect’ button or simply copy the connection string to the terminal.
        Another option is using the VNC console.
      {% endblocktrans %}
    </p>
  </blockquote>
109 110


Kálmán Viktor committed
111 112 113 114 115 116 117 118
  <h4 id="how-can-i-change-the-vms-password">{% trans "How can I change the VM’s password?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        Click on the ‘Generate new password!’ link.
      {% endblocktrans %}
    </p>
  </blockquote>
119 120


Kálmán Viktor committed
121 122 123 124 125 126 127 128 129
  <h4 id="operations">{% trans "Operations" %}</h4>
  <p>
    {% blocktrans %}
      The upper right corner is the operation toolbar with the most important actions that control the lifecycle of the machine.
      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 %}
  </p>
130 131


Kálmán Viktor committed
132 133 134 135 136 137 138 139 140
  <h4 id="what-kind-of-operations-are-allowed-to-do-with-my-vm">{% trans "What kind of operations are allowed to do with my VM?" %}</h4>
  <blockquote>
    {% for view, op in operations %}
      <p>
      <span class="btn btn-xs btn-{{ view.effect }} disabled"><i class="fa fa-{{ view.icon }}"></i> {{ op.name }}</span>
      {{ op.description }}
      </p>
    {% endfor %}
  </blockquote>
141 142


Kálmán Viktor committed
143 144 145 146 147 148 149
  <h4 id="home"><i class="fa fa-compass"></i> {% trans "Home" %}</h4>
  <p>
    {% blocktrans %}
      This 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.
    {% endblocktrans %}
  </p>
150 151


Kálmán Viktor committed
152 153 154 155 156 157 158
  <h4 id="expiration">{% trans "Expiration" %}</h4>
  <p>
    {% blocktrans %}
      Here is a summary about the expiration times as well.
      Each virtual machine has a deadline for suspending and destroying based on predefined leases.
    {% endblocktrans %}
  </p>
159 160


Kálmán Viktor committed
161 162 163 164 165 166 167 168 169
  <h4 id="how-can-i-extend-the-vms-expiration-date">{% trans "How can I extend the VM's expiration date?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        With the renew button you can extend the suspend and remove time.
        Before the virtual machine is suspended or removed you get a notification about it.
      {% endblocktrans %}
    </p>
  </blockquote>
170 171


Kálmán Viktor committed
172 173 174 175 176 177 178 179
  <h4 id="how-can-i-share-previously-uploaded-files-with-the-vm">{% trans "How can I share previously uploaded files with the VM?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        With the ‘Mount Store’ option the virtual machine mounts your personal storage.
      {% endblocktrans %}
    </p>
  </blockquote>
180 181


Kálmán Viktor committed
182 183 184 185 186 187 188 189
  <h4 id="resources"><i class="fa fa-tasks"></i> {% trans "Resources" %}</h4>
  <p>
    {% blocktrans %}
      Resources contains details about how much <strong>memory</strong> and
      <strong>CPU</strong> the VM has, and how is it <strong>scheduled</strong>.
      Users with specific permission can change these settings if the machine is stopped.
    {% endblocktrans %}
  </p>
190

Kálmán Viktor committed
191 192 193 194 195
  <p{% if not perms.vm.change_resources %} class="text-muted"{% endif %}>
    {% blocktrans %}
      Users with specific permission can change these settings if the machine is stopped.
    {% endblocktrans %}
  </p>
196 197


Kálmán Viktor committed
198 199 200 201 202 203 204 205
  <h4 id="console"><i class="fa fa-desktop"></i> {% trans "Console" %}</h4>
  <p>
    {% blocktrans %}
      This panel allows to see the console of the virtual machine for troubleshooting and operating system installation.
      You can also use the keyboard and mouse.
      You should normally use the machine by connecting remotely over SSH or Remote Desktop.
    {% endblocktrans %}
  </p>
206 207


Kálmán Viktor committed
208 209 210 211 212 213 214
  <h4 id="access"><i class="fa fa-group"></i> {% trans "Access" %}</h4>
  <p>
    {% blocktrans %}
      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 %}
  </p>
215 216


Kálmán Viktor committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  <h4 id="how-can-i-give-access-to-others">{% trans "How can I give access to others?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        Type the user/group ID, set permissions and click
        <span class="btn btn-success disabled">Save</span>.
      {% endblocktrans %}
    </p>
  </blockquote>


  <h4 id="what-kind-of-permissions-are-available">{% trans "What kind of permissions are available?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
      <strong>User</strong><br>
      User level grants access to the virtual machine’s details page. Users are able to connect to this machine.
      {% endblocktrans %}
    </p>
    <p>
      {% blocktrans %}
      <strong>Operator</strong><br>
      Operator level permit the modification of the name and description fields. Allow the operator to open ports and grant/revoke User level access to the virtual machine.
      {% endblocktrans %}
    </p>
    <p>
      {% blocktrans %}
      <strong>Owner</strong><br>
      Owner level enables all operations on the virtual machine. Owners are able to grant/revoke Operator, User and Owner level access to others.
      The accountable owner (the one who deployed the machine) can not be demoted.
      The accountable ownership can be transferred to other User via the “Transfer onwership” button.
      {% endblocktrans %}
    </p>
  </blockquote>


  <h4 id="network"><i class="fa fa-globe"></i> {% trans "Network" %}</h4>
  <p>
    {% blocktrans %}
      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 %}
  </p>
260 261


Kálmán Viktor committed
262 263 264 265 266 267 268 269 270 271
  <h4 id="how-can-i-add-a-network-interface">{% trans "How can I add a network interface?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        Click on the
        <span class="btn btn-success disabled"><i class="fa fa-globe"></i> add interface</span>
        on the Network pane and select from the list.
      {% endblocktrans %}
    </p>
  </blockquote>
272 273 274



Kálmán Viktor committed
275 276 277 278 279 280 281
  <h4 id="activity"><i class="fa fa-clock-o"></i> {% trans "Activity" %}</h4>
  <p>
    {% blocktrans %}
      Shows the full life cycle 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) with the starting/finishing times.
    {% endblocktrans %}
  </p>
282 283


Kálmán Viktor committed
284 285 286 287 288 289 290 291 292
  <h4 id="multiple-vm-operations">{% trans "Multiple VM operations" %}</h4>
  <p>
    {% blocktrans %}
      On the dashboard, by clicking the
      <span class="btn btn-primary btn-xs disabled"><i class="fa fa-chevron-circle-right"></i> list</span>
      button, the virtual machine list page opens.
      Here the owner can execute operations on multiple virtual machines simultaneously.
    {% endblocktrans %}
  </p>
293 294 295



Kálmán Viktor committed
296 297 298 299 300 301 302 303
  <h4 id="how-can-i-show-shared-or-destroyed-vms">{% trans "How can I see shared or destroyed VMs?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        Check the ‘Include deleted VMs’ checkbox to list already deleted machines.
      {% endblocktrans %}
    </p>
  </blockquote>
304
</div> <!-- vms -->
305

306
<div id="templates" {% if not perms.vm.create_template %}class="text-muted"{% endif %}>
Kálmán Viktor committed
307 308 309 310 311 312
  <h3 id="templates"><i class="fa fa-puzzle-piece"></i> {% trans "Templates" %}</h3>
  {% if not perms.vm.create_template %}
    <p class="text-warning">
      {% trans "Sorry, you have no permission to create templates." %}
    </p>
  {% endif %}
313

Kálmán Viktor committed
314 315 316 317 318 319 320
  <p>
    {% blocktrans %}
      Templates are the prototypes of virtual machine instances:
      they contain <strong>configuration</strong> values for the different technical details
      <strong>of a VM to create</strong>, and also the network interfaces and disks to attach.
    {% endblocktrans %}
  </p>
321

Kálmán Viktor committed
322 323 324 325 326 327
  <p>
    {% 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 %}
  </p>
328 329


Kálmán Viktor committed
330 331 332 333 334
  <h4 id="how-can-i-create-templates">{% trans "How can I create templates?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        You can create templates from any virtual machine with the save as template button.
335 336
        Additionally, you can also click on the <span class="btn btn-success disabled btn-xs"><i class="fa fa-plus-circle"></i> new</span>
        button of the template box, and follow the template creation wizard.
Kálmán Viktor committed
337 338 339
      {% endblocktrans %}
    </p>
  </blockquote>
340

Kálmán Viktor committed
341 342 343 344 345
  <p>
    {% blocktrans %}
      On the template detail page you can modify the template's name and the given resources like CPU count and memory size.
    {% endblocktrans %}
  </p>
346

Kálmán Viktor committed
347 348 349 350
  <h4 id="what-kind-of-options-are-customizable-in-the-template">{% trans "What kind of options are customizable in the template?" %}</h4>
  <blockquote>
    <p>
      <h4>{% trans "Architecture" %}</h4>
Nyíri Tamás committed
351
      {% trans "The user can choose the template's architecture (x86 or x86-64)." %}
Kálmán Viktor committed
352 353 354
    </p>
    <p>
      <h4>{% trans "Access method" %}</h4>
Nyíri Tamás committed
355
      {% trans "The default access method is modifiable. Currently SSH, RDP and NX are supported." %}
Kálmán Viktor committed
356 357 358
    </p>
    <p>
      <h4>{% trans "Boot menu" %} </h4>
Nyíri Tamás committed
359
      {% trans "Check it to turn on the boot menu." %}
Kálmán Viktor committed
360 361 362
    </p>
    <p>
      <h4>{% trans "Traits" %}</h4>
Nyíri Tamás committed
363
      {% trans "By adding or removing traits we can guarantee specific features the host node will have (like <em>GPU</em>) for the virtual machine." %}
Kálmán Viktor committed
364 365 366
    </p>
    <p>
      <h4>{% trans "Operating system" %}</h4>
Nyíri Tamás committed
367
      {% trans "The name of the operating system." %}
Kálmán Viktor committed
368 369 370
    </p>
    <p>
      <h4>{% trans "Agent" %}</h4>
Nyíri Tamás committed
371
      {% trans "Check this if the machine has agent installed and the manager should wait for its start." %}
Kálmán Viktor committed
372 373 374
    </p>
    <p>
      <h4>{% trans "Raw data" %}</h4>
Nyíri Tamás committed
375 376 377 378
      {% blocktrans %}
        The CIRCLE Cloud is using libvirt, so the owner can customize the running VM's options here by
        <a href="https://libvirt.org/formatdomain.html">libvirt domain parameters</a>.
      {% endblocktrans %}
Kálmán Viktor committed
379 380 381 382 383 384 385 386 387 388 389 390 391
    </p>
  </blockquote>


  <h4 id="how-can-i-give-the-template-to-other-user">{% trans "How can I transfer the template ownership to someone else?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}After clicking the ‘Transfer ownership’ you can select a user to give the template to.{% endblocktrans %}
    </p>
  </blockquote>



392
  <h4 id="how-can-i-grant-access-for-users-or-groups-to-the-template">{% trans "How can I grant access for users or groups to the template?" %}</h4>
Kálmán Viktor committed
393 394 395 396 397 398 399 400
  <blockquote>
    <p>
      {% blocktrans %}
        Same as the VM access rights handling.
        You can type the user or group ID at the template detail page's Manage access box and select a suitable access level.
      {% endblocktrans %}
    </p>
  </blockquote>
401
</div>
402

403
<div id="groups" {% if not perms.auth %}class="text-muted"{% endif %}>
Kálmán Viktor committed
404 405 406 407 408 409
  <h3 id="groups"><i class="fa fa-group"></i> {% trans "Groups" %}</h3>
  {% if not perms.auth %}
    <p class="text-warning">
      {% trans "Sorry, you have no permission to create groups." %}
    </p>
  {% endif %}
410

Kálmán Viktor committed
411 412 413 414 415
  <p>
    {% blocktrans %}
      Groups are the main building blocks of permission management. On the dashboard you see a list of groups you have access to.
    {% endblocktrans %}
  </p>
416

Kálmán Viktor committed
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
  <h4 id="how-can-i-create-groups">{% trans "How can I create groups?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        You can create your own groups by clicking on the new button of the groups box.
      {% endblocktrans %}
    </p>
  </blockquote>

  <p{% if not saml %} class="text-muted"{% endif %}>
    {% 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.
      You can also add users based on their identifier, also if they have not logged in at the time.
    {% endblocktrans %}
  </p>
434 435


Kálmán Viktor committed
436 437 438 439 440 441 442 443
  <h4 id="how-can-i-manage-the-users-in-a-group">{% trans "How can I manage the users in a group?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        On the group page the owner can add or remove users or change the access rights over the group.
      {% endblocktrans %}
    </p>
  </blockquote>
444 445


Kálmán Viktor committed
446 447 448 449 450 451 452 453 454
  <h4 id="how-can-i-manage-privileges-with-the-group">{% trans "How can I manage privileges with the group?" %}</h4>
  <blockquote>
    <p>
      {% blocktrans %}
        The owner can add or remove privileges at the bottom of the group page like ‘can download disk’ or ‘can configure port forwards’.
      {% endblocktrans %}
    </p>
  </blockquote>
</div><!-- #groups -->
455

456
<div id="store" {% if not store or not user.is_authenticated %}class="text-muted"{% endif %}>
Kálmán Viktor committed
457 458 459 460 461 462
  <h3 id="files"><i class="fa fa-briefcase"></i> {% trans "Files" %}</h3>
  {% if not store %}
    <p class="text-warning">
      {% trans "Sorry, this deployment of CIRCLE does not support file store." %}
    </p>
  {% endif %}
463

Kálmán Viktor committed
464 465 466 467 468 469 470 471 472 473 474 475 476
  <p>
    {% 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 %}
  </p>
  <p>
    {% 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.
    {% endblocktrans %}
  </p>
477 478


Kálmán Viktor committed
479 480
  <h4 id="how-can-i-share-my-files-with-a-vm">{% trans "How can I share my files with a VM?" %}</h4>
  <blockquote>
481
    <p>{% blocktrans %}To access the file store press the <span class="btn btn-info disabled btn-xs"><i class="fa fa-briefcase"></i> mount store</span> button on the virtual machine's home panel.{% endblocktrans %}</p>
Kálmán Viktor committed
482
  </blockquote>
483
</div>
484 485


Kálmán Viktor committed
486
<h3 id="profile"><i class="fa fa-user"></i> {% trans "Profile" %}</h3>
487 488 489 490


<h4 id="how-can-i-change-my-password">{% trans "How can I change my password?" %}</h4>
<blockquote>
Kálmán Viktor committed
491 492 493 494 495
  <p>
    {% blocktrans %}
      On the profile page type the new password twice and the old password. Users can’t change passwords if the profile is using SSO.
    {% endblocktrans %}
  </p>
496 497 498 499 500
</blockquote>


<h4 id="how-can-i-store-public-keys-on-the-vms">{% trans "How can I store public keys on the VMs?" %}</h4>
<blockquote>
Kálmán Viktor committed
501 502 503
  <p>
    {% blocktrans %}Go to your profile page, click on the ‘add SSH key’ and paste your public key's content to the textarea.{% endblocktrans %}
  </p>
504
</blockquote>