docs: more enhancements after review 1.411.29 (#1631)

README.md

@@ -103,9 +103,9 @@ This feature is not available in basic CloudStack UI and API. Plugin deployment
 
 **Log View Plugin**
 
-This extension allows users to view VM log files. It uses the Log View backend-plugin that extends the CloudStack API with additional requests providing access the VM log files storage. For the Log View UI-plugin operation, firstly, the Log View backend-plugin should be downloaded from [GitHub](https://github.com/bwsw/cloud-plugin-vm-logs) and deployed. The plugin uses the ELK stack to store machine log files and Filebeat to export log files from a VM to the storage. The plugin is developed and tested only with Apache CloudStack 4.11.1.
+This extension allows users to view VM log files. It uses the Log View backend-plugin that extends the CloudStack API with additional requests providing access the VM log files storage. For the Log View UI-plugin operation, firstly, the Log View backend-plugin should be downloaded from [GitHub](https://github.com/bwsw/cloud-plugin-vm-logs) and deployed. The plugin uses the ELK stack to store machine log files and Filebeat to export log files from a VM to the storage. The plugin is tested with Apache CloudStack 4.11.2.0.
 
-Then, it is necessary to enable the LogView UI-plugin via the CloudStack-UI configuration file. After activation, the _View Logs_ section appears in CloudStack-UI. There a user can select the log files to display by setting up main parameters - a virtual machine and a date for which a user wishes to see the logs.
+Then, it is necessary to enable the LogView UI-plugin via the CloudStack-UI configuration file. After activation, the _System Logs_ section appears in CloudStack-UI. There a user can select the log files to display by setting up main parameters - a virtual machine and a date for which a user wishes to see the logs.
 
 Plugin deployment and configuration instructions can be found at the [plugin page](https://github.com/bwsw/cloudstack-ui/wiki/View-Logs-Plugin).
 

docs/source/CS-UI_Resources.rst

@@ -8,15 +8,11 @@ Resource Limits Management Plugin
 Overview
 ---------------
 
-We introduced a new plugin - *Resource Limits Management* - that allows Domain Administrators to manage resource quotas, and users to change resource limits. The extension helps to avoid such situations when a user has extra resources that are not used but accounted in billing. Or when a user has utilized all the available resources and now needs more. In either of these cases, a user would have to request Administrator to change the resource limits. With the new plugin a user gets access to resource limits, and Administrator can manage resoure quotas via UI.
+We introduced a plugin - *Resource Limits Management* - that allows Domain Administrators to manage resource quotas, and users to request or release account resources in the clouds where billing is based on the requested resource quotas of the account. Now it has become available to a user without contacting an administrator. The business rules for request processing are implemented on the backend and are completely separated from the extension.
 
-The extension uses two backend plugins:
+The extension uses the backend plugin - `µAPI Gateway <https://bitworks.software/en/products/cloudstack-micro-api-gateway/>`_ - developed by our team to help developers to create extensions for CloudStack using any programming language and make these extensions available via additional CloudStack API endpoints. Additional endpoints are implemented with the *Resource Limits Management* backend component developed on Node. Backend services necessary for the extension work (*uAPI Gateway, Resource Limits Management*) and the decision-making backend component based on the business rule are not accessible under the open licensing.
 
-* the `µAPI Gateway plugin <https://bitworks.software/en/products/cloudstack-micro-api-gateway/>`_ developed by us to help developers to create extensions for CloudStack using any programming language. 
-
-* the *Resource Limits Management* backend plugin that extends CloudStack API with additional endpoints.
-
-After the backend plugins are deployed and configured the Resource Limits Management UI-plugin can be activated and configured via the configuration file (see the `configuration guide <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#resource-limits-plugin>`_). Once it is activated, users and administrators get access to resource limits and quotas management via UI.
+The plugin is deactivated by default. 
 
 Plugin Deployment
 -------------------

docs/source/CSUI-LogView.rst

@@ -8,9 +8,9 @@ Log View Plugin
 Overview
 ----------------
 
-In the *Virtual Machines*-*View Logs* section a user can see VM logs. This section appears if the UI-plugin - Log View - is activated. This UI-plugin works together with the backend API plugin developed to process and view virtual machine logs which are handled by ELK and delivered to the storage by Filebeat. The version of the backend API plugin matches Apache CloudStack version that it is built for. The plugin is tested with Apache CloudStack 4.11.2.0.
+In the *Virtual Machines*-*System logs* section a user can see VM logs. This section appears if the UI-plugin - Log View - is activated. This UI-plugin works together with the backend API plugin developed to process and view virtual machine logs which are handled by ELK and delivered to the storage by Filebeat. The version of the backend API plugin matches Apache CloudStack version that it is built for. The plugin is tested with Apache CloudStack 4.11.2.0.
 
-To make the *View logs* section available, first deploy the backend API plugin and then activate the Log View UI-plugin via the ``config.json`` file. See deployment instructions below.
+To make the *System logs* section available, first deploy the backend API plugin and then activate the Log View UI-plugin via the ``config.json`` file. See deployment instructions below.
 
 Deployment Instructions
 -------------------------
@@ -23,10 +23,16 @@ To enable the Log View plugin you need to:
 2. Deploy the necessary components: ElasticSearch, Filebeat, Logstash, Curator.
 3. Enable the UI extension via the ``config.json`` file.
 
-View Logs 
+.. note:: To ramp up the security of the machine logs exporting to the storage, it is required to use a secret token along with the UUID of a VM. You can create and copy a new token via the interface. Find more information in :ref:`VM_Actions`. Detailed instructions on how to configure the log export service in VM to CloudStack are provided in the `plugin documentation <https://github.com/bwsw/cloud-plugin-vm-logs#filebeat-63>`_. The token can be regenerated in case of compromising.
+
+View System Logs 
 -------------------------
 
-After successful deployment you can see the *View logs* section under the *Virtual Machines* menu in UI. In this section you can view the log files for a defined period of time or in a real-time mode. To view logs you should specify an account (for Administrators), a VM for which you wish to see the logs, and a log file to view the logs from. More details are provided below.
+After successful deployment you can see the *System logs* section under the *Virtual Machines* menu in UI. In this section you can view the log files for a defined period of time or in a real-time mode. 
+
+.. figure:: _static/LogView.png 
+
+To view logs you should specify an account (for Administrators), a VM for which you wish to see the logs, and a log file to view the logs from. More details are provided below.
 
 Filtering Logs
 '''''''''''''''''''''''''
@@ -60,7 +66,7 @@ You can change filtering parameters and refresh the list of logs by clicking "SH
 
 The set filtering parameters are saved to user tags. That means, if you log out of the system and then login again, you will continue to view logs with the previously set filtering parameters.
 
-View Logs List
+System Logs List
 ''''''''''''''''''''''''
 By clicking "SHOW LOGS", a user can view log files corresponding to the filtering parameters. Logs are listed in a chronological order from the earliest till the latest. 
 
@@ -80,23 +86,23 @@ You can change filtering parameters and refresh the list of logs by clicking "SH
 
 Sorting Logs
 ~~~~~~~~~~~~~~~~~~~~~~
-The sorting tool allows viewing the newest logs first in the list. Enable the checkbox to the right and click on "Show logs" to refresh the list.
+The sorting tool allows viewing the newest logs first in the list. Enable the checkbox to the right and click on "SHOW LOGS" to refresh the list.
 
 .. figure:: _static/Logs_Newest1.png
 
 Searching Logs
 ~~~~~~~~~~~~~~~~~~~~~~~~~
-Use the search tool to find logs by a word or a text. Enter the text in the search field above the list and click on "Show logs" to refresh the list.
+Use the search tool to find logs by a word or a text. Enter the text in the search field above the list and click "SHOW LOGS" to refresh the list.
 
 .. figure:: _static/Logs_Search2.png
 
 Following Logs
 '''''''''''''''''''''''''
-After setting filtering parameters and clicking "Show logs", a user can start following logs, in other words, start monitoring logs online.
+After setting filtering parameters and clicking "SHOW LOGS", a user can start following logs, in other words, start monitoring logs online.
 
 When the "Follow logs" option is activated, the Log View UI-plugin sends requests to get the latest logs with the defined frequency and for a period, defined in the configuration file. By default, once per 1 second the system requests logs for the last 30 seconds. A user can customize these parameters via the configuration file (see `details <https://github.com/bwsw/cloudstack-ui/blob/master/config-guide.md#log-view-plugin>`_).
 
-To view logs in a real time-mode, click "Follow logs" |follow icon|. This button is available right after selecting a virtual machine in the filtering parameters or after setting all necessary filtering parameters and clicking "Show logs". You will see the filtering options are got disabled and the log list is automatically getting refreshed per every second. 
+To view logs in a real time-mode, click "Follow logs" |follow icon|. This button is available right after selecting a virtual machine in the filtering parameters or after setting all necessary filtering parameters and clicking "SHOW LOGS". You will see the filtering options are got disabled and the log list is automatically getting refreshed per every second. 
 
 .. figure:: _static/Logs_Follow.png
 
@@ -108,14 +114,14 @@ By default, the list contains up to 1000 log records showing logs for the last m
 
 If too many entries are to be displayed in the list, the system loads them by parts when a user scrolls the list down.
 
-You can set up parameters of log following in the "Log View Plugin Settings" section:
+You can set up parameters of log following in the "System Logs (real-time mode)" section:
 
 - **Show last (minutes)** - allows viewing logs for the last set period. You can set the number of minutes from 1 (default) to 10.
 - **Show last (messages)** - allows setting a maximum amount of logs to display. You can set from 1 to any number of log records. By default, 1000 messages are shown.
 
 Click "Update" to apply the settings.
 
-.. figure:: _static/RN_Logs_ViewOnlineSettings.png
+.. figure:: _static/Settings_LogView.png
 
 To stop following logs click on |unfollow icon|.
 

docs/source/CSUI-Start.rst

@@ -96,13 +96,37 @@ In case of errors at data loading the snackbar also notifies of them. In this ca
 Support Information in Error Messages
 -----------------------------------------------
 
-A user can add the information on support services to all error messages to let users get assistance faster in case of a failure. Support information should be specified in the ``support-info.md`` file stored in a `special folder <https://github.com/bwsw/cloudstack-ui/tree/master/src/support>`_ of the project. It may include contacts e.g. phone numbers, emails or any other details.
+A user can add the information on support services to all error messages to let users get assistance faster in case of a failure. Support information may include contacts e.g. phone numbers, emails or any other details. It should be specified in the ``support-info.md`` file stored in a `special folder <https://github.com/bwsw/cloudstack-ui/tree/master/src/support>`_ of the project. We support localization of the file to Russian. As you see, there are two files in the folder:
 
-The specified support details will display under a drop-down menu. Click it in the error message window to expand it.
+- ``support-info.md`` - the main file that contains contact details of the technical support team in English,
+
+- ``support-info.ru.md`` - contains a Russian version of the main file.
+
+If you use the prepared `Docker image <https://github.com/bwsw/cloudstack-ui#deployment>`_ to deploy the project, you should map your custom support information files via Docker-volume when running the container. For example:
+:: 
+ docker run -d -p 80:80 --name cloudstack-ui \
+           -e CLIENT_ENDPOINT=http://cloudstack/client \
+           -e BASE_HREF=base_href \
+           -v /path/to/config.json:/static/config/config.json \
+           -v /path/to/support-info.md:/static/support/support-info.md \
+           -v /path/to/support-info.ru.md:/static/support/support-info.ru.md \
+           bitworks.software:8443/cloudstack-ui:1.411.29
+
+
+The support details specified in the file will display under a drop-down menu. Click it in the error message window to expand.
 
 .. figure:: _static/RN_Supportinfo.png
 
-Localization of the file is supported.
+Adding Custom Scripts
+----------------------------------
+
+We support adding custom JavaScript scripts to extend the UI functionality with the services necessary for a user.  For example, using custom scripts a user can add JivoSite or Google Analytics widgets to the interface.
+
+Custom scripts are added at running the CloudStack-UI Docker-container. All that a user should do is to define the ``/scripts/custom.js`` custom script content and map it via a Docker-volume. By default, the ``/scripts/custom.js`` file is empty.
+
+As a result, you can see the added service in the UI:
+
+.. figure:: _static/RN_CustomScr.png
 
 Adding Custom Scripts
 ----------------------------------

docs/source/CSUI-VirtualMachines.rst

@@ -74,7 +74,7 @@ To create a new VM click the "Create" button |create icon| at the bottom-right c
 
 .. figure:: _static/VMs_Create5.png
 
-The *New virtual machine* form contains two tabs: *General* and *Advanced*. 
+The *New virtual machine* form contains three tabs: *General*, *Advanced* and *VM UserData*. 
 
 In the *General* tab the following fields should be filled in:
 
@@ -254,7 +254,7 @@ In the *Advanced* tab you will find the following fields:
 5. **SSH keypair** - Select an SSH keypair. The list of keys contains the SSH keys available for the account under which the VM is being created. Find more information on SSH keys in the :ref:`SSH_Keys` section.
 6. **Start VM** - Tick the box to start the VM right after its deployment. If this option is activated, the VM acquires an IP and a password (if required by the template). If it is not, the machine IP is not available till VM is started, no password is assigned to it.
 
-In the *User data* tab you can add any custom data for the machine. It allows adding necessary settings to the machine and deploying it configured with necessary services. In this tab, you will find a text area, where you can enter the configurations in any format. The maximum allowed size of data is 32 KB.
+In the *VM UserData* tab you can add any custom data for the machine. It allows adding necessary settings to the machine and deploying it configured with necessary services. In this tab, you will find a text area, where you can enter the configurations in any format. The maximum allowed size of data is 32 KB.
 
 .. figure:: _static/VMs_Create_Udata.png
 
@@ -431,9 +431,9 @@ By clicking a VM line or card you can open a sidebar to the right.
 
 Here and in all other sections the sidebar width is adjustable - you can change it by hovering over its edge and dragging to the width you wish.
 
-.. figure:: _static/VM_Details_Resize1.png
+.. figure:: _static/VMs_Details_Resize1.png
 
-.. figure:: _static/VM_Details_Resize2.png
+.. figure:: _static/VMs_Details_Resize2.png
 
 In the details sidebar you will find the information for the selected virtual machine:
 
@@ -461,8 +461,8 @@ The Virtual Machine tab contains the general setting of the VM. Some settings ca
 
     * VM host name, 
     * Zone selected for the VM to be available in, 
-    * Machine ID.
-    * User data - Allows viewing, editing and copying user data applied to the machine. 
+    * Machine ID,
+    * VM UserData - Allows viewing, editing and copying user data applied to the machine. 
 
       Click |view| to open the modal window and view the user data applied to the machine. Use the scroll tool if the text contains many symbols.