Skip to content

Commit

Permalink
Update overview.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
reiden21 committed Oct 30, 2020
1 parent 25a1f0f commit b5b102e
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions docs/overview/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ plug-in.

A GUI client package is also provided to easily take advantage of the features
supported by the Backend.AI server. Backend.AI Console is a GUI client in the
form of a web service or standlone app. It provides a convenient graphical
form of a web service or stand-alone app. It provides a convenient graphical
interface for accessing the Backend.AI server to utilize computing resources and
manage its environment. Most tasks can be done with mouse clicks and brief
typing, which achieves more intuitive use.
Expand All @@ -29,7 +29,7 @@ Key Concepts
.. image:: key_concepts.png
:alt: Diagram explaining key concepts

- User: The user is the person who connects to Backend.AI and performs work.
- User: The user is a person who connects to Backend.AI and performs work.
Users are divided into normal users, domain admins, and superadmins according
to their privileges. While ordinary users can only perform tasks related to
their computing sessions, domain admins have the authority to perform
Expand All @@ -45,9 +45,9 @@ Key Concepts
- Domain: This is the top layer for authority and resource control supported by
Backend.AI. For companies or organizations, you can view domains as an
affiliate and set up per-domain (or per-affiliate) permissions and resource
policies. A user should belong to only one domain, and can create sessions or
do some other jobs only in their own domain. A domain can have one or
more domain admins, who can set policies within the domain or manage
policies. Users should belong to only one domain, and can create sessions or
do some other jobs only in their own domain. A domain can have one domain admin or
more, who can set policies within the domain or manage
sessions. For example, if you set the total amount of resources available in a
domain, the resources of all containers created by users in the domain cannot
be greater than the amount set.
Expand All @@ -62,32 +62,28 @@ Key Concepts
- Image: Each container has a pre-installed language-specific runtime and
various computational frameworks. The state of such snapshots before they are
executed is called an image. You can choose to run an image provided by the
cluster admin, create your own image with the software you want to
use, and ask the admin to register it.
cluster admin or create your own image with the software you want to
use and ask the admin to register it.
- Virtual Folder (vfolder): A "cloud" folder that is always accessible and
mountable in a container on a per-user basis, regardless of which node the
container runs on. After creating your own virtual folder, you can upload your
own program code, data, etc. in advance, and mount it when you run the
own program code, data, etc. in advance and mount the folder when you run the
compute session to read from and write to it as if it is on your local disk.
- Application service, service port: A feature that allows you to access various
user applications (eg DIGITS, Jupyter Notebook, shell terminal, TensorBoard,
etc.) running within the compute session. You do not need to know the
container's address and port number directly, but you can use the provided CLI
client or GUI console to directly access the desired daemon of the session.
- Console App: A GUI client that is served as a web or standalond app.
- Console App: A GUI client that is served as a web or stand-alone app.
You can use the service after logging in by specifying the address of the
Backend.AI server and entering the user account information.
- Local wsproxy: Proxy server built into the console app. Services such as
Jupyter Notebook and Terminal that can be used in the console app communicate
with the server through websocket, which converts general HTTP requests to and
from the console app into websocket to deliver messages.

- Local wsproxy: Proxy server built into the console app. Local wsproxy converts general HTTP requests between the server and console app to websocket and deliver the messages.
- If the console app loses its connection to wsproxy or the wsproxy server is
dead, it will not be possible to access services such as Jupyter Notebook
and Terminal.

- Web wsproxy: In the case of the console app provided as a web, the built-in
server cannot be operated due to the nature of the browser. In this case, you
- Web wsproxy: In the case of the console app provided in a web, the built-in
server cannot be used due to the nature of the browser. In this case, you
can use services such as Jupyter Notebook, Terminal, etc. in the web
environment by making the wsproxy server as a separate web server
so that the console app can see the web wsproxy.

0 comments on commit b5b102e

Please sign in to comment.