Skip to content

Commit

Permalink
docs: naming change (console -> webui / hub -> control-panel) (#10)
Browse files Browse the repository at this point in the history
* docs: change console -> webui / hub -> control-panel

* docs: update KO translation to reflect webui naming change

* refactor: rename webui to Web-UI

* refactor: change Webui to Web-UI

* refactor: further rename: Webui -> Web-UI

* Add missing translation
  • Loading branch information
adrysn committed Mar 2, 2021
1 parent 5bf5ff2 commit ddb3a9c
Show file tree
Hide file tree
Showing 30 changed files with 1,605 additions and 1,583 deletions.
35 changes: 19 additions & 16 deletions docs/admin_menu/admin_menu.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,9 @@ according to the user's pattern.
Share group storage folders with group members
-------------------------------------------------

Backend.AI provides storage folders for groups, in addition to user's own storage folder. A group storage folder is a folder belonging to a specific group, not a
specific user, and can be accessed by all users in that group.
Backend.AI provides storage folders for groups, in addition to user's own
storage folder. A group storage folder is a folder belonging to a specific
group, not a specific user, and can be accessed by all users in that group.

.. note::
Group folders can be created only by administrators. Normal users can only
Expand Down Expand Up @@ -166,8 +167,8 @@ Manage Resource Policy

In Backend.AI, admins can set a limit on the total amount of resources available
for each user and group. Resource limits per group can only be set through the
enterprise-dedicated administrator GUI Hub, but resource limits per user
(precisely per user's keypair) can be set in the user GUI console.
enterprise-dedicated administrator GUI Control-Panel, but resource limits per user
(precisely per user's keypair) can be set in the user Web-UI.

Resource policies allow you to set maximum allowed resources and/or
other compute session related settings per keypair basis. If necessary, multiple
Expand All @@ -176,13 +177,14 @@ apply them separately to each keypair.

.. note::
To set resource policies at the domain and group level, you have to use
Manager Hub, a UI for superadmin only. In the Console UI, you can only set
resource policies based on keypairs. Manager Hub is a part of the enterprise
version.

In Resource Policies tab on the Users page, the admin can check the list of currently registered resource policies.
In the figure below, there are a total of three policies (gardener, STUDENT, default).
The infinity (∞) marks for resources such as Cores, Ram, and fGPU in the Resources panel means that no
admin Control-Panel, a UI for superadmin only. In the Web-UI, you can only set
resource policies based on keypairs. Control-Panel is a part of the
enterprise version.

In Resource Policies tab on the Users page, the admin can check the list of
currently registered resource policies. In the figure below, there are a total
of three policies (gardener, STUDENT, default). The infinity (∞) marks for
resources such as Cores, Ram, and fGPU in the Resources panel means that no
resource restrictions have been placed for those resources.

.. image:: resource_policy_page.png
Expand Down Expand Up @@ -361,7 +363,7 @@ images in the registry, immediately. Just as you had to register the allowed hos
to use the storage host, you must register the registry in the allowed docker
registries field at the domain or group level, after registering the registry,
so that users in the domain or group can access the registry image. Allowed
docker registries can be registered using the Manager Hub with domain and group
docker registries can be registered using the Control-Panel with domain and group
management. The function to set the allowed docker registries in the keypair's
resource policy is not provided yet.

Expand Down Expand Up @@ -398,9 +400,10 @@ would not be shown.
:align: center
:alt: Modify resource preset dialog

Also you can create resource preset by Clicking CREATE PRESETS button in the right top
of the Resource Presets tab. You cannot create the same resource preset name that
already exists, since it is the key value for distinguishing each resource preset.
Also you can create resource preset by Clicking CREATE PRESETS button in the
right top of the Resource Presets tab. You cannot create the same resource
preset name that already exists, since it is the key value for distinguishing
each resource preset.

.. image:: create_resource_preset_dialog.png
:width: 350
Expand All @@ -413,7 +416,7 @@ Query agent nodes

Superadmins can view the list of agent worker nodes, currently connected to
Backend.AI, by visiting the Resources page. You can check agent node's IP,
connecting time, actual resources currently in use, etc. The Console does
connecting time, actual resources currently in use, etc. The Web-UI does
not provide the function to manipulate agent nodes.

.. image:: agent_list.png
Expand Down
26 changes: 13 additions & 13 deletions docs/appendix/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ the resources become available again, the pended request is resumed to
create a compute session.

You can check the operation of the job scheduler in a simple way from the
user GUI console. When the GPU host can allocate up to 2 fGPUs,
user Web-UI. When the GPU host can allocate up to 2 fGPUs,
let's create 3 compute sessions at the same time requesting
allocation of 1 fGPU, respectivley. In the Custom allocation section of the session launch
dialog, there are GPU and Sessions sliders. If you specify a value greater than
Expand All @@ -94,7 +94,7 @@ total of 3 fGPUs are created when only 2 fGPUs exist.
:width: 350
:align: center

Wait for a while and you will see three compute sessions being listed.
Wait for a while and you will see three compute sessions being listed.
If you look closely at the Status panel, you can see that two of the
three compute sessions are in RUNNING state, but the other compute session
remains in PENDING state. This PENDING session is only registered in the
Expand Down Expand Up @@ -183,7 +183,7 @@ optimal performance, just double the amount of each resources.

* Manager: 2 cores, 4 GiB memory
* Agent: 4 cores, 32 GiB memory, NVIDIA GPU (for GPU workload), > 512 GiB SSD
* Console-Server: 2 cores, 4 GiB memory
* Webserver: 2 cores, 4 GiB memory
* WSProxy: 2 cores, 4 GiB memory
* PostgreSQL DB: 2 cores, 4 GiB memory
* Redis: 1 core, 2 GiB memory
Expand All @@ -192,12 +192,12 @@ optimal performance, just double the amount of each resources.
The essential host dependent packages that must be pre-installed before installing
each service are:

* GUI console: Operating system that can run the latest browsers (Windows, Mac
* Web-UI: Operating system that can run the latest browsers (Windows, Mac
OS, Ubuntu, etc.)
* Manager: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
* Agent: docker (≥19.03), CUDA/CUDA Toolkit (≥8, 11 recommend),
nvidia-docker v2, Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
* Console-Server: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
* Webserver: Python (≥3.8), pyenv/pyenv-virtualenv (≥1.2)
* WSProxy: docker (≥19.03), docker-compose (≥1.24)
* PostgreSQL DB: docker (≥19.03), docker-compose (≥1.24)
* Redis: docker (≥19.03), docker-compose (≥1.24)
Expand Down Expand Up @@ -268,23 +268,23 @@ Worker node which manages the lifecycle of compute sessions (containers).
# see logs
sudo journalctl --output cat -u backendai-agent
Console-Server
^^^^^^^^^^^^^^
Webserver
^^^^^^^^^

Serves user GUI Console and provides authentication by email and password.
Serves user Web-UI and provides authentication by email and password.

.. code-block:: shell
# check status
sudo systemctl status backendai-console-server
sudo systemctl status backendai-webserver
# start service
sudo systemctl start backendai-console-server
sudo systemctl start backendai-webserver
# stop service
sudo systemctl stop backendai-console-server
sudo systemctl stop backendai-webserver
# restart service
sudo systemctl restart backendai-console-server
sudo systemctl restart backendai-webserver
# see logs
sudo journalctl --output cat -u backendai-console-server
sudo journalctl --output cat -u backendai-webserver
WSProxy
^^^^^^^
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.local.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# -- Project information -----------------------------------------------------

project = 'Backend.AI Console User Guide'
project = 'Backend.AI Web-UI User Guide'
copyright = '2020, Lablup Inc.'
author = 'Lablup Inc.'
version = '20.09'
Expand Down Expand Up @@ -122,7 +122,7 @@ def setup(app):
\centering
\vspace*{15mm} %% * is used to give space from top
\sphinxlogo
\textbf{\Huge Backend.AI Console\\User's Guide}\par
\textbf{\Huge Backend.AI Web-UI\\User's Guide}\par
{\LARGE (\version)}\par
\vspace{25mm}
\textbf{\LARGE \@author}\par
Expand All @@ -138,8 +138,8 @@ def setup(app):
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc,
'backendaiconsoleuserguide.tex',
'Backend.AI Console User\'s Guide',
'backendaiwebuiuserguide.tex',
'Backend.AI Web-UI User\'s Guide',
author, 'manual'),
]

Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# -- Project information -----------------------------------------------------

project = 'Backend.AI Console User Guide'
project = 'Backend.AI Web-UI User Guide'
copyright = '2020, Lablup Inc.'
author = 'Lablup Inc.'
version = '20.09'
Expand Down Expand Up @@ -118,7 +118,7 @@ def setup(app):
\centering
\vspace*{15mm} %% * is used to give space from top
\sphinxlogo
\textbf{\Huge Backend.AI Console\\User's Guide}\par
\textbf{\Huge Backend.AI Web-UI\\User's Guide}\par
{\LARGE (\version)}\par
\vspace{25mm}
\textbf{\LARGE \@author}\par
Expand All @@ -134,8 +134,8 @@ def setup(app):
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc,
'backendaiconsoleuserguide.tex',
'Backend.AI Console User\'s Guide',
'backendaiwebuiuserguide.tex',
'Backend.AI Web-UI User\'s Guide',
author, 'manual'),
]

Expand Down
12 changes: 6 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
.. Backend.AI Console User Guide master file, created by
.. Backend.AI Web-UI User Guide master file, created by
sphinx-quickstart on Wed Feb 5 01:58:48 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Backend.AI GUI Console User Guide
Backend.AI Web-UI User Guide
=================================

User's guide for the Backend.AI GUI Console.
User's guide for the Backend.AI Web-UI.

Backend.AI GUI Console is a web or app that provides easy-to-use GUI interface
Backend.AI Web-UI is a web or app that provides easy-to-use GUI interface
to work with the Backend.AI server.

The latest versions of this document can be found from sites below:

- https://console.docs.backend.ai/en/stable (English)
- https://console.docs.backend.ai/ko/stable (Korean)
- https://webui.docs.backend.ai/en/stable (English)
- https://webui.docs.backend.ai/ko/stable (Korean)

.. toctree::
:maxdepth: 2
Expand Down
12 changes: 6 additions & 6 deletions docs/installation/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
Installation
============

The GUI console can be used in two forms. It can be used as a web service by
The Web-UI can be used in two forms. It can be used as a web service by
connecting to a separate web address prepared by the admins, or as an
app provided as a stand-alone executable file that does not require separate
installation.
installation.

With the web-based GUI console, users do not need to install a
With the web-based Web-UI, users do not need to install a
platform-dependent desktop applications and just need the latest versions of
browsers such as Chrome.
browsers such as Chrome.

* Recommended browser: the latest version of Chrome (at least version > 80)
* Requirement: any machine that runs Web Browser (2 cores, 4 GiB memory)
Expand All @@ -19,8 +19,8 @@ browsers such as Chrome.
is deprecated and does not follow web standard and support up-to-date brower
features.

The stand-alone GUI console app can be downloaded from following address:
https://github.com/lablup/backend.ai-console/releases
The stand-alone Web-UI app can be downloaded from following address:
https://github.com/lablup/backend.ai-webui/releases

.. note::
In the case of an app, depending on the security setting of the
Expand Down
18 changes: 13 additions & 5 deletions docs/license_agreement/license_agreement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,25 @@ API Client libraries and auxiliary components for accessing Backend.AI server
(hereinafter "Backend.AI Client") are distributed under the MIT License. Even if
LGPL complies, commercial contracts with Lablup Co., Ltd. ("Lablup") are
required depending on the conditions when performing profit activities using the
Backend.AI server. Several additional plug-ins and management Hubs that apply to
Backend.AI enterprise solutions are not open source, but commercial software.
Backend.AI server. Several additional plug-ins and admin's GUI Control-Panel
that apply to Backend.AI enterprise solutions are not open source, but
commercial software.

**Term Definition**

- Hardware: Includes physical computers, virtual machine and container environments that users own or lease and have rights to run software.
- Hardware: Includes physical computers, virtual machine and container
environments that users own or lease and have rights to run software.
- Organization: Individuals, corporations, organizations, institutions
(including non-profit and commerical organizations; however, subsidiaries that
are separate corporations are not included)

LGPL must be followed when users use and change Backend.AI Server (Manager /
Agent / Common) or develop and distribute software that uses it. However, in the case of distributing software which import Backend.AI server as a module without changing it (e.g. Python import), it is regarded as a dynamic link and code disclosure under the LGPL is exempted. When Backend.AI server is installed on the hardware and used by the general public through the network, there is no obligation under the LGPL.
Agent / Common) or develop and distribute software that uses it. However, in the
case of distributing software which import Backend.AI server as a module without
changing it (e.g. Python import), it is regarded as a dynamic link and code
disclosure under the LGPL is exempted. When Backend.AI server is installed on
the hardware and used by the general public through the network, there is no
obligation under the LGPL.

The correct interpretation of all other cases is subject to the LGPL original
text and court judgment.
Expand Down Expand Up @@ -55,7 +62,8 @@ In other cases, you can use the Backend.AI server for free.
- Paid distribution: The software does not need to be (L)GPL, but a commercial
contract with Lablup is required.

- When Backend.AI server is installed on the hardware and it is used by the public through network,
- When Backend.AI server is installed on the hardware and it is used by the
public through network,

- Free distribution: No separate contract with Lablup is required.
- Paid distribution: A commercial contract with Lablup is required.
Expand Down

0 comments on commit ddb3a9c

Please sign in to comment.