docs(documentation): CloudStack 1.410.19 (#988)

docs/source/CS-UI_Guide.rst

@@ -18,6 +18,7 @@ Here is the documentation structure:
    CSUI-VirtualMachines
    CSUI-Storage
    CSUI-Images
+   CSUI-Snapshots
    CSUI-Firewall
    CSUI-Events
    CSUI-SSHkeys

docs/source/CSUI-Firewall.rst

@@ -8,7 +8,7 @@ The *Firewall* section contains templates to create a security group for a virtu
 
 .. figure:: _static/Firewall_List816.png
 
-**Firewall templates** are presets of rules that can be system or developed by a user (custom). Administrators can specify default presets during the interface deployment in the JSON configuration file (find more in `Configurations Guide <https://github.com/bwsw/cloudstack-ui/blob/master/ConfigGuide.md>`_). Now there are “TCP Permit All”, “UDP Permit All”, “ICMP Permit All” system firewall templates in the system. They just pass all the traffic. We offer them because we would like a user to make his virtual machines accessible without diving into technical details. If it is necessary, a custom firewall template can be created. Find more information on how to create a custom firewall template at :ref:`Create_FTemplate`.
+**Firewall templates** are presets of rules that can be system or developed by a user (custom). Administrators can specify default presets during the interface deployment in the JSON configuration file (find more in `Configurations Guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md>`_). Now there are “TCP Permit All”, “UDP Permit All”, “ICMP Permit All” system firewall templates in the system. They just pass all the traffic. We offer them because we would like a user to make his virtual machines accessible without diving into technical details. If it is necessary, a custom firewall template can be created. Find more information on how to create a custom firewall template at :ref:`Create_FTemplate`.
 
 Upon VM creation the system creates a new security group for a VM on the base of templates. This group is initially filled with all the rules from specified presets. Next, when the user changes the rules for a certain virtual machine, it does not affect other machines. These changed rules make a **private security group** used for that virtual machine only. 
 
@@ -116,7 +116,7 @@ Private Security Groups
 """"""""""""""""""""""""""""
 Private security groups are listed in the *Private Security Groups* section. 
 
-Security groups appear in this section once they are created for a virtual machine (see :ref:`Create_VM`). 
+Security groups appear in this section once they are created for a virtual machine (see :ref:`Create_VM`). A private security group name has the following format - ``sg-{{ virtual machine name }}`` - containing the name of the virtual machine it is created for. 
 
 You can quickly find a group by its name or a part of the name using the searching tool above the list.
 
@@ -136,21 +136,37 @@ Security Group Details Sidebar
 """"""""""""""""""""""""""""""""""""""
 You can see the firewall rules details in the sidebar to the right. 
 
-Click the template/shared/private security group in the list and open the sidebar. You will see the information there:
+Click the template/shared/private security group in the list and open the sidebar. You will see two tabs there - Details and Tags. 
+
+The **Details** tab contains the following information:
 
 - Name of the security group;
 - :ref:`SG_Action_Box` under |actions icon|;
 - ID of the security group;
 - Description giving an idea what the security group contains (not available for private security groups);
-- Type - Defines the security group types. For firewall templates it can be ``custom-template`` for custom templates, or ``predefined-template`` for system templates. For shared security groups it is ``shared``. For privat security groups you will see ``private``.
+- Type - Defines the security group types. For firewall templates it can be ``custom-template`` for custom templates, or ``predefined-template`` for system templates. For shared security groups it is ``shared``. For private security groups you will see ``private``.
 
-.. figure:: _static/Firewall_TemplateDetails.png
+.. figure:: _static/Firewall_TemplateDetails1.png
 
 For shared security groups you also can see what virtual machines this group is assigned to. The machine name in the list is active. You can move to the virtual machine details bar by clicking it.
 
-.. figure:: _static/Firewall_SharedSGDetails.png
+.. figure:: _static/Firewall_SharedSGDetails1.png
+
+For private security groups a VM name is also displayed in the details sidebar, but it is not active.
+
+The **Tags** tab presents the list of tags assigned to the security group. Using the search tool above you can quickly find a tag by its name. 
+
+System tags are listed in a separate card.
+
+.. figure:: _static/Firewall_Tags.png
+
+Сlick |create icon| to add a tag. Enter a key and a value. 
+
+.. figure:: _static/Firewall_Details_Tags.png
+
+Click "Create" to create the new tag. It will be saved in a separate card.
 
-For privat security groups a VM name is also displayed in the details sidebar, but it is not active.
+An existing tag can be edited or deleted by clicking a correspondent icon next to the tag's name.
 
 .. _SG_Action_Box:
 

docs/source/CSUI-Images.rst

@@ -62,7 +62,7 @@ It will open a creation form where you should specify the following information:
 
 #. Zone * - Choose the zone where you want the template to be available.
 
-#. Group - Select a group from the drop-down list. The list of groups is managed by Administrator. The group assigned to a template is saved to template tags with the ``csui.template.group`` tag. The group can be edited or deleted from the :ref:`Image_Details` from the "Template" tab or by editing or deleting the corresponding tag in the "Tags" tab.
+#. Group - Select a group from the drop-down list. The list of groups is managed by Administrator in the `configuration file <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#template-groups>`_. The group assigned to a template is saved to template tags with the ``csui.template.group`` tag. The group can be edited or deleted from the :ref:`Image_Details` from the "Template" tab or by editing or deleting the corresponding tag in the "Tags" tab.
 
 #. Password enabled checkbox - Tick this option if your template has the CloudStack password change script installed. That means the VM created on the base of this template will be accessed by a password, and this password can be reset.
 
@@ -103,7 +103,7 @@ It will open a creation form where you should specify the following information:
 
 #. Zone * - Choose the zone where you want the ISO file to be available.
 
-#. Group - Select a group from the drop-down list. The list of groups is managed by Administrator. The group assigned to ISO is saved to ISO tags with the ``csui.template.group`` tag. The group can be edited or deleted from the :ref:`Image_Details` from the "Template" tab or by editing or deleting the corresponding tag in the "Tags" tab.
+#. Group - Select a group from the drop-down list. The list of groups is managed by Administrator  in the `configuration file <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#template-groups>`_. The group assigned to ISO is saved to ISO tags with the ``csui.template.group`` tag. The group can be edited or deleted from the :ref:`Image_Details` from the "Template" tab or by editing or deleting the corresponding tag in the "Tags" tab.
 
 .. note:: Required fields are marked with an asterisk (*).
 

docs/source/CSUI-Settings.rst

@@ -42,7 +42,7 @@ The value is stored in user’s tags.
 
 The maximum allowed value is 300 minutes. Please, note that a long time period of an idle session decreases the account security.
 
-The session timeout can be set in the configuration file. You will find more information in  `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/ConfigGuide.md>`_.
+The session timeout can be set in the configuration file. You will find more information in the  `configuration guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#session-timeout>`_.
 
 
 Save VM passwords by default
@@ -72,7 +72,7 @@ Regenerate the keys by clicking |refresh icon| above the fields. New keys will b
 
 .. figure:: _static/Settings_APIKeysRefresh.png
 
-Below you can view a connection URL which is used to send requests to CloudStack API. All requests are listed in the Apache CloudStack documentation available by the link below.
+Below you can view a connection URL which is used to send requests to CloudStack API. All requests are listed in the Apache CloudStack documentation available by the link.
 
 .. figure:: _static/Settings_Links.png
 
@@ -96,15 +96,15 @@ From the drop-down list select the day when a week starts: Monday or Sanday.
 
 .. figure:: _static/Settings_DayOfWeek.png
 
-.. The first day of week can be set in the configuration JSON file. You will find more information in the `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/ConfigGuide.md>`_. 
+.. The first day of week can be set in the configuration JSON file. You will find more information in the `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md>`_. 
 
 Time Format
 """""""""""""
 Here you have the opportunity to switch the time format from AM/PM to 24H. You can set it to "Auto" and the time format will be set in correspondence to the interface language: AM/PM if you select English and 24H if you select Russian.
 
 .. figure:: _static/Settings_TimeFormat.png
 
-.. The time format can be set in the configuration JSON file. You will find more information in the `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/ConfigGuide.md>`_. 
+.. The time format can be set in the configuration JSON file. You will find more information in the `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md>`_. 
 
 Theme Color
 """""""""""""""""""
@@ -114,7 +114,7 @@ Click the field and select another color if you wish.
 
 .. figure:: _static/Settings_Theme.png
 
-.. A theme color can be set in the configuration JSON file. You will find more information in the `Config Guide <https://github.com/bwsw/cloudstack-ui/blob/master/ConfigGuide.md>`_. 
+A theme color can be set in the configuration JSON file. You will find more information in the `configuration guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#default-theme-name>`_. 
 
 .. |bell icon| image:: _static/bell_icon.png
 .. |refresh icon| image:: _static/refresh_icon.png

docs/source/CSUI-Snapshots.rst

@@ -0,0 +1,129 @@
+Snapshots
+=============
+.. Contents::
+
+The *Snapshots* section contains the information on snapshots existing in the system.
+
+.. figure:: _static/Snapshots.png
+
+Snapshots List
+-------------------
+The list of snapshots can be presented in the box view or in the list view. Change the view using |view icon|/|box icon| button.
+
+
+Filtering of Snapshots
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Filtering of snapshots is available above the list. 
+
+.. figure:: _static/Snapshots_Filtering.png
+
+You can filter the list by the following parameters:
+
+- by Accounts (for Administrators);
+- by Type - Hourly, Daily, Weekly, Monthly, Manual depending on the schedule of snapshotting.
+- by Creation Date - Select a date using a date picker.
+
+Group snapshots by accounts (available for Administrators) and/or by type.
+
+The searching tool allows to find a snapshot by:
+
+- its name or a part of the name;
+- snapshot description.
+
+For each snapshot in the list the following information is presented:
+
+- State bullet - green for backed up, red for any error behavior, yellow for creating, grey for allocated.
+- Name of the snapshot.
+- Volume the snapshot is created for.
+- Date and time of creation
+- Actions button |actions icon|.
+
+Snapshot Details Sidebar
+-----------------------------------
+A details sidebar presents the information on a snapshot. It appears to the right by clicking a snapshot in the list. 
+
+.. figure:: _static/Snapshots_Details.png
+
+The following information is presented in the details sidebar:
+
+- Date and time of creation;
+- Type - Presents the snapshot type;
+- Volume information and a virtual machine it is assigned to.
+
+Snapshot Actions Box
+-----------------------------------
+The following actions are available for snapshots:
+
+- Create template;
+- Create volume;
+- Revert volume to snapshot;
+- Delete. 
+
+.. figure:: _static/Snapshots_Actions.png
+
+Below you will find details for each action.
+
+**Create Template**
+
+Open a creation form to register a new template from the snapshot.
+
+Fill in the fields:
+
+- Name * - Enter a name of the new template.
+- Description * - Provide a short description of the template.
+- OS type * - Select an OS type from the drop-down list.
+- Group - Select a group from the drop-down list.
+- Password enabled - Tick this option if your template has the CloudStack password change script installed. That means the VM created on the base of this template will be accessed by a password, and this password can be reset.
+- Dynamically scalable - Tick this option if the template contains XS/VM Ware tools to support dynamic scaling of VM CPU/memory.
+
+.. note:: Required fields are marked with an asterisk (*).
+
+Click “Show additional fields” to expand the list of optional settings. It allows creating a template that requires HVM. Tick this option in this case.
+
+Once all fields are filled in click "Create" to create the new template.
+
+.. figure:: _static/Snapshots_CreateTemplate1.png
+
+Click "Cancel" to cancel the template creation.
+
+**Create Volume**
+
+This action allows creating a volume from the snapshot.
+
+Type a name for a new volume into the Name field in the modal window. Click "Create" to register a new volume.
+
+.. figure:: _static/Snapshots_Actions_CreateVolume.png
+
+Click "Cancel" to cancel the volume creation.
+
+**Revert Volume to Snapshot**
+
+This action allows turning the volume back to the state of the snapshot. It is available to those snapshots that have a volume.
+
+In the dialogue window confirm your action. Please, note, the virtual machine the volume is assigned to will be rebooted.
+
+.. figure:: _static/Snapshots_Actions_Revert.png
+
+**Delete**
+
+This action allows deleting a snapshot from the system.
+
+Click "Delete" in the Action box and confirm your action in modal window. The snapshot will be deleted.
+
+.. figure:: _static/Snapshots_Actions_Delete.png
+
+Click "Cancel" to cancel the snapshot deleting.
+
+
+.. |bell icon| image:: _static/bell_icon.png
+.. |refresh icon| image:: _static/refresh_icon.png
+.. |view icon| image:: _static/view_list_icon.png
+.. |view box icon| image:: _static/box_icon.png
+.. |view| image:: _static/view_icon.png
+.. |actions icon| image:: _static/actions_icon.png
+.. |edit icon| image:: _static/edit_icon.png
+.. |box icon| image:: _static/box_icon.png
+.. |create icon| image:: _static/create_icon.png
+.. |copy icon| image:: _static/copy_icon.png
+.. |color picker| image:: _static/color-picker_icon.png
+.. |adv icon| image:: _static/adv_icon.png

docs/source/CSUI-Start.rst

@@ -21,16 +21,18 @@ To enter the platform use your credentials provided by an administrator:
 - Domain - Specify domain when you log in. CloudStak-UI supports three ways to do it. Choose the one which is more convenient for you:
 
    1) Enter a domain in the field under the "Show advanced options" button |adv icon|.
+
+   2) Administrator can set a domain in configurations. Domain field will be prepopulated with the specified value. It is more convenient for a user as he/she does not need to enter the domain every time at logging in. In this case the domain field can be hidden by clicking |adv icon|. Find more information on the feature configuration at the `configuration guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#default-domain-url>`_.
 
-   2) Administrator can set a domain in configurations. Domain field will be prepopulated with the specified value. It is more convenient for a user as he/she does not need to enter the domain every time at logging in. In this case the domain field can be hidden by clicking |adv icon|.
-
-   3) Other way to log in is to enter a URL in the format ``http://<ip-address>/login?domain=<domain>``. The domain will be prepopulated in the logging in form with the value that is specified in the URL. Please, note, the domain value in URL will override the domain set in the configurations by Administrator. Find more information on the feature configuration at the `Configurations page` (link here).
+   3) Other way to log in is to enter a URL in the format ``http://<ip-address>/login?domain=<domain>``. The domain will be prepopulated in the logging in form with the value that is specified in the URL. Please, note, the domain value in URL will override the domain set in the configurations by Administrator.
 
 .. figure:: _static/LoginScreen.png
 
 Push "Login" to proceed to CloudStack. You will see the first section - Virtual Machines. 
 
-To the left you can see the main navigation bar. It allows moving from section to section. It is configured by Root Administrator in the configuration file. The administrator can set it adjustable, i.e. allow a user to reorder elements in the main navigation bar (except the "Logout" section). Please, see the :ref:`Administration_Guide` for more information on configuring the navigation bar elements reordering.
+To the left you can see the main navigation bar. It allows moving from section to section. It is configured by an Administrator in the `configuration file <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#sidebar-order>`_ by setting a list of left-sidebar sections there. The Administrator can set it adjustable, i.e. allow a user to reorder elements in the main navigation bar (except the "Logout" section). Please, see the `configuration guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#allow-reordering-sidebar>`_ for more information on configuring the navigation bar elements.
+
+The navigation bar can be hidden or extended using the icon in the upper-left corner.
 
 .. _Resource_Usage: