Skip to content

Commit

Permalink
Add sections for missing services rockstor#460
Browse files Browse the repository at this point in the history
The list of services in our docs does not completely match the
list present in Rockstor's UI: System > Services page. In the
docs, some are missing, while the rest is not listed in the same
order.

This commit thus ensure a match in the services listed and their
order between our docs and Rockstor UI.
  • Loading branch information
FroggyFlox committed Oct 22, 2023
1 parent acf21c7 commit 271bc9d
Show file tree
Hide file tree
Showing 11 changed files with 185 additions and 68 deletions.
Binary file removed images/interface/system/services/nis-config.png
Binary file not shown.
Binary file added images/interface/system/services/nis_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/interface/system/services/ntp-config.png
Binary file not shown.
Binary file added images/interface/system/services/ntp_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/interface/system/services/services_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/interface/system/services/snmp_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion interface/storage/share_replication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.. _sharereplication:

Replication
=================
===========

Redundancy options of a pool operate at the single appliance level. While this
reduces the risk of data loss from bad disks, it does no good if the entire
Expand Down
251 changes: 184 additions & 67 deletions interface/system/services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ Services

Rockstor supports many services that are necessary or useful in a storage system.
Service management, *i.e.* turning on or off, and configuration can be done via the **System** - **Services** page of the Web-UI.
Note that the **spanner icon** next to each service name is used to **configure** that service.

On the **Services** page, all services and their current state are displayed.
On that **Services** page, all services and their current state are displayed.

.. image:: /images/interface/system/services/services_list.png
:width: 100 %
Expand All @@ -18,65 +16,8 @@ To **start** or **stop** a service, click its respective **ON** or **OFF** butto
Some services need to be configured before they can be turned on.
To access the configuration page for a service, click the **wrench** icon next to the service name.

Please note that not all services are documented here as we are currently working on upgrading the documentation.

NFS
---

Rockstor uses Linux NFS server to support exporting Shares to remote clients via NFS.
Custom NFS configuration is not supported, but the service must be turned on in order to export shares. See the :ref:`nfs` section for details.


.. _configure_samba:

Samba
-----

Rockstor supports making shares available to SMB and CIFS clients via the `Samba <https://www.samba.org/>`_ software suite.
Samba is the recommended way to access your Rockstor shares from a Windows client, but can also be used to access shares from a Linux or MacOS client.
See our :ref:`accessshares` section for more details.

Before turning on the Samba service, it must be configured. To do so, simply click on the little wrench icon:

.. image:: /images/interface/system/services/samba_wrench_icon.png
:align: center

The Samba service configuration window will then open:

.. image:: /images/interface/system/services/samba_configuration.png
:align: center

- **Workgroup** is the only *required* setting. This should be set to the Windows NT domain or the workgroup name.
Unless changed, the default domain name for a Windows machine is :code:`WORKGROUP`.
- The **Custom global configuration** (*optional*) box allows you to enter any custom samba setting needed to customize the Samba service to your needs.
The possible options are thus all those supported by Samba in its :code:`smb.conf` file.
See the `Samba wiki <https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html>`_ for a full list of options and their documentation.

When ready, press the *Submit* button to save the configuration changes.

Once you are done configuring it, the Samba service can now be turned ON by toggling the ON/OFF switch located to its right.

You can now proceed to :ref:`create_samba_export` and :ref:`access shares from clients<accessshares_samba>`.

SFTP
----

SFTP stands for Secure File Transfer Protocol and is essentially FTP over SSH.
In Rockstor, user-owned shares exported via this method are mounted within a minimal chroot environment for enhanced security.
Please see our :ref:`sftp` section.
Please note that not all services are documented here as we are currently working on updating the documentation.

.. _ntp:

NTP
---

NTP maintains system time in synchronization with Internet standard time server. This service must always be turned on.

To configure NTP, you can specify the address of an Internet standard time server in the NTP configuration page.

.. image:: /images/interface/system/services/ntp-config.png
:width: 100 %
:align: center

.. _activedirectory:

Expand All @@ -94,10 +35,15 @@ Note that while the Samba service needs to be configured, it doesn't need to be
:width: 75 %
:align: center

.. note::
In recent versions, Rockstor takes care of setting Samba as described above when configuring the AD service itself.
You should thus not need to manually follow the steps above.
It is nevertheless a good idea to verify that these settings were correctly applied if you're experiencing any problem with your AD configuration.

Next, as correct time synchronization with the AD domain is necessary for good performance, the NTP service should be configured and turned ON.
Ideally, both the AD domain and Rockstor machines should thus use the same NTP time server.
Ideally, both the AD domain and Rockstor machines should use the same NTP time server.

Now that the Samba workgroup has been defined, and the NTP service configured and running, the AD service can be configured.
Now that the NTP service has been setup and is running, the AD service can be configured.
To do so, click on the **wrench** icon and fill in the form with the values corresponding to your AD domain.

.. image:: /images/interface/system/services/ad_config.png
Expand Down Expand Up @@ -126,6 +72,13 @@ If Rockstor cannot discover the AD domain, it will report the error back to the

Note that a successful configuration of the AD service does not enroll the system into the AD. To do this, the AD service must be turned ON. To leave the AD, simply turn the AD service OFF.


Bootstrap
---------
The Bootstrap service is created by Rockstor and responsible, among others, for scanning storage devices and mounting :ref:`pools` when the system starts.
It is thus recommended *not* to turn it off.


.. _ldap:

Lightweight Directory Access Protocol (LDAP)
Expand Down Expand Up @@ -155,6 +108,14 @@ As a result, one can edit :code:`/etc/sssd/sssd.conf` to further customize the c
Note that a successful configuration of the LDAP service does not connect the system to the LDAP server.
To do this, the LDAP service must be turned ON. To disconnect from the LDAP server, simply turn the LDAP service OFF.


NFS
---

Rockstor uses Linux NFS server to support exporting Shares to remote clients via NFS.
Custom NFS configuration is not supported, but the service must be turned on in order to export shares. See the :ref:`nfs` section for details.


.. _nis:

Network Information Server (NIS)
Expand All @@ -164,22 +125,171 @@ NIS is a directory service to connect to a NIS server.

To configure NIS, click on the **wrench** icon and submit the form with appropriate values as shown below.

.. image:: /images/interface/system/services/nis-config.png
:width: 100 %
.. image:: /images/interface/system/services/nis_config.png
:width: 70 %
:align: center

* **Domain**: NIS domain.
* **Server**: IP address of NIS server.


.. _ntp:

NTP
---

NTP maintains system time in synchronization with Internet standard time server. This service must always be turned on.

To configure NTP, you can specify the address of an Internet standard time server in the NTP configuration page.

.. image:: /images/interface/system/services/ntp_config.png
:width: 70 %
:align: center


NUT-UPS
-------

A (currently Beta) `Network UPS Tools <https://networkupstools.org/>`_ based service to orchestrate graceful system shutdown in the event of a power outage.
A (currently Beta) `Network UPS Tools <https://networkupstools.org/>`_-based service to orchestrate graceful system shutdown in the event of a power outage.
Please see our: :ref:`ups_setup` section for more details.


.. _configure_replication:

Replication
-----------
The Replication service leverages Btrfs send & receive features to replicate Shares to other Rockstor appliances (see :ref:`sharereplication` for more details).
This can be used, for instance, to asynchronously and automatically replicate important shares on another Rockstor system.
To use this feature, first configure the Replication service by clicking the **wrench** icon next to its name.

.. image:: /images/interface/system/services/rockstor_config.png
:width: 70 %
:align: center

* **Network Interface**: select the network interface to be used by the listener.
* **Listener port**: select the port to be used by the listener. You can choose any number between 0 and 65535.

When ready, click on the **Submit** button to save changes.


Rock-Ons (Docker plugin system)
-------------------------------
Please see :ref:`rockons_intro` for an introduction to Rockstor's `Docker <https://www.docker.com/>`_ based plugin system.
Please see :ref:`rockons_intro` for an introduction to Rockstor's `Docker <https://www.docker.com/>`_-based plugin system.


Rockstor
--------
The network interface and the port used to access Rockstor's UI itself can also be customized.
To do so, click the **wrench** icon next to the service name, and the change the settings as desired:

.. image:: /images/interface/system/services/rockstor_config.png
:width: 70 %
:align: center

* **Network Interface**: select the network interface. If left blank (*default*), it will listen on all interfaces.
* **HTTPS Port**: by default, Rockstor is accessible on port 443 but you can change it to another port if desired.
Note that the port *must be* between 0 and 65535.

When ready, click on the **Submit** button to save changes and Rockstor will automatically restart.
It should thus become accessible again momentarily.

.. warning::
Understandably, you may need to change the URL used to access Rockstor's webUI depending on the changes (such as using a different port).


S.M.A.R.T.
----------
S.M.A.R.T stands for Self-Monitoring, Analysis, And Reporting Technology and
Rockstor uses the tools provided by the `Smartmontools <https://www.smartmontools.org/>`_ project
to interface with the attached hardware that supports this technology.
See our :ref:`smart` how-to for a comprehensive view of S.M.A.R.T. use in Rockstor,
and the :ref:`configsmart` section for instructions on how to configure it.


.. _configure_samba:

Samba
-----

Rockstor supports making shares available to SMB and CIFS clients via the `Samba <https://www.samba.org/>`_ software suite.
Samba is the recommended way to access your Rockstor shares from a Windows client, but can also be used to access shares from a Linux or MacOS client.
See our :ref:`accessshares` section for more details.

Before turning on the Samba service, it must be configured. To do so, simply click on the little wrench icon:

.. image:: /images/interface/system/services/samba_wrench_icon.png
:align: center

The Samba service configuration window will then open:

.. image:: /images/interface/system/services/samba_configuration.png
:align: center

- **Workgroup** is the only *required* setting. This should be set to the Windows NT domain or the workgroup name.
Unless changed, the default domain name for a Windows machine is :code:`WORKGROUP`.
- The **Custom global configuration** (*optional*) box allows you to enter any custom samba setting needed to customize the Samba service to your needs.
The possible options are thus all those supported by Samba in its :code:`smb.conf` file.
See the `Samba wiki <https://www.samba.org/samba/docs/current/man-html/smb.conf.5.html>`_ for a full list of options and their documentation.

When ready, press the *Submit* button to save the configuration changes.

Once you are done configuring it, the Samba service can now be turned ON by toggling the ON/OFF switch located to its right.

You can now proceed to :ref:`create_samba_export` and :ref:`access shares from clients<accessshares_samba>`.


SFTP
----

SFTP stands for Secure File Transfer Protocol and is essentially FTP over SSH.
In Rockstor, user-owned shares exported via this method are mounted within a minimal chroot environment for enhanced security.
Please see our :ref:`sftp` section.


.. _configure_shellinabox:

Shell In A Box
--------------
The Shell In A Box service provides access to a System Shell directly from your browser.
To use this feature, you must first configure it by clicking the **wrench** icon next to its name.

.. image:: /images/interface/system/services/shellinabox_config.png
:width: 70 %
:align: center

* **Shell connection service**: access the resulting System Shell either by *LOGIN* (default) or via *SSH*.
*LOGIN* will require you to elevate your priviledges if you need to run a command as :code:`root`.
*SSH* will allow you to directly connect as :code:`root` but is less secure for the system.
* **Shell color scheme**: You can use either *White text on a Black background*, or *Black text on a White background*.
* **Open shell in a popup window**: if checked, the System Shell will open in a new window (please remember to allow popups in your browser).
By default, the System Shell will be displayed *within* Rockstor's UI.

When ready, click on the **Submit** button to save changes, and the Shell In A Box service can then be turned on.
You can now click on the "*System Shell*" button in the header to access the System Shell.


.. _configure_snmp:

SNMP
----
SNMP is an enterprise monitoring facility.
Turning on this feature will activate the SNMP agent on your Rockstor appliance.
To configure this service, click the **wrench** icon next to its name.

.. image:: /images/interface/system/services/snmp_config.png
:width: 70 %
:align: center

* **System Location**: Set the system location (corresponds to the :code:`sysLocation` setting).
* **System Contact**: Set the contact information for the administrator (corresponds to the :code:`sysContact` setting).
* **RO Community**: specify a community name that will be allowed read-only access (corresponds to the :code:`rocommunity` setting).

Any additional customization can optionally be manually entered in the text box located at the bottom of the configuration window.
All settings specified in this box must be entered one per line, and will be added to the :code:`snmpd.conf` configuration file.

When ready, press the *Submit* button to save the configuration changes.
The SNMP service can now be turned ON by toggling the ON/OFF switch located to its right.


.. _configure_tailscale:

Expand Down Expand Up @@ -230,4 +340,11 @@ This device will appear only *after* the Tailscale service is configured, but wh
Once the Tailscale service is ON, however, a new connection using this *tun* device will be created; this connection is named **tailscale0** and is entirely managed by the Tailscale package.
As with any other network connection, you can monitor its activity using the :ref:`network_activity_widget` of Rockstor's :ref:`dashboard`.


ZTaskd
------
Ztaskd is a service required by Rockstor for running background tasks such as Pools :ref:`scrubs <poolscrub>` or :ref:`balances <poolbalance>`.
It it thus recommended *not* to turn it off.


**To start or stop any service, click the corresponding ON or OFF button**

0 comments on commit 271bc9d

Please sign in to comment.