Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explicitly detail the recommendations for the rock-ons root share (#340) #341

Merged
merged 3 commits into from
Dec 12, 2021
Merged

Explicitly detail the recommendations for the rock-ons root share (#340) #341

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b912a8
Explicitly detail the recommendations for the rock-ons root share (#340)
FroggyFlox Dec 11, 2021
a8615b3
Update interface/overview.rst
FroggyFlox Dec 12, 2021
66e8489
Update interface/overview.rst
FroggyFlox Dec 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions interface/overview.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,25 @@ The Rock-ons root
All Rock-ons require the **Rock-on service** to be enabled and prior to
enabling this service it must be configured. This is a simple matter of
configuring a sufficiently large share for the rock-ons to be installed into.
It is possible to use the existing 'out of the box' home share but this is not
recommended.

The following shows a **Recommended Minimum 5 GB rock-ons-root** share backed
by a previously created pool named **rock-pool**.
We recommend creating a *dedicated* share to be used as the rock-ons root.
While any share can be chosen as the rock-ons root, we **strongly** recommend
to create a share to be used *only* as the rock-ons root to prevent any
conflict that may arise with a mixed-used share. The rock-ons root share is
indeed used by Docker to store permanent data such as images and container
FroggyFlox marked this conversation as resolved.
Show resolved Hide resolved
layers. As a result, any conflict or alteration of these data that might result
from a mixed used share has the potential to break the installed Rock-ons.
Note also that the rock-ons root share can be part of any :ref:`pool<pools>`
and does not require the creation of a dedicated pool.

.. note::
While it is possible to use the existing 'out of the box' home share but
FroggyFlox marked this conversation as resolved.
Show resolved Hide resolved
this is **not recommended** for the reason described above. Similarly,
while it is possible to create the rock-ons root share on the system pool,
this is **not recommended** either.

As an example, the following shows a **Recommended Minimum 5 GB rock-ons-root**
share backed by a previously created pool named **rock-pool**.

.. image:: /images/interface/docker-based-rock-ons/rockons_root_share.png
:width: 100%
Expand Down