Skip to content

Commit 6dfb361

Browse files
fix(backup): clarify special core apps restore
Traefik, Samba, Loki core components have special restore behaviors: it's worth mentioning it.
1 parent 952e8d1 commit 6dfb361

File tree

4 files changed

+44
-13
lines changed

4 files changed

+44
-13
lines changed

backup.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -144,17 +144,32 @@ To restore an application, at least one backup destination must be
144144
available.
145145

146146
* Click on the :guilabel:`Restore an app` button.
147-
* A dialog box will list all applications in the defined backup
147+
* A dialog box lists all applications found in the configured backup
148148
destinations. Select the application you want to restore.
149149
* If the selected application is already installed, a ``Replace existing
150-
app`` checkbox becomes visible. If enabled, the existing instance will
151-
be removed upon restore.
152-
* Select an older backup snapshot if the latest one is not preferable.
150+
app`` checkbox becomes visible. When enabled, the existing instance will
151+
be removed during the restore.
152+
* Select an older backup snapshot if the latest one is not suitable.
153153
* Select the target node. Note that in some cases, restoring to certain
154154
cluster nodes may be restricted due to application policies or node
155155
resource limitations.
156156
* Click on the :guilabel:`Restore` button.
157157

158+
Some core applications have special behavior during restore:
159+
160+
- **Traefik** restores only uploaded certificates and user-defined HTTP
161+
routes. Refer to :ref:`uploaded-certificates-section` and
162+
:ref:`custom-http-route-section`.
163+
164+
- **Loki** restore installs an additional *inactive* Loki instance. It can
165+
be used only for log searches, as explained in
166+
:ref:`system-logs-section`.
167+
168+
- **Samba** restore behavior depends on whether the AD user domain is
169+
already present in the cluster. If present, only shared folder data is
170+
restored. If not present, the DC LDAP database is restored as well. See
171+
:ref:`file-server-restore` for more information.
172+
158173

159174
.. _selective-content-restore:
160175

certificates.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,9 @@ key, and chain.
152152
An application uses the uploaded certificate if it matches its configured
153153
host name. Wildcard names are supported.
154154

155+
Uploaded certificates are added to Traefik's backup and can be restored
156+
from it.
157+
155158
.. _certificate-alerts-section:
156159

157160
Receive certificate expiration alerts

log_server.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,20 +127,30 @@ and best practices, a recommended retention period is 200 days or longer.
127127
Inactive Loki instances
128128
-----------------------
129129

130-
When a worker node is promoted to leader, a new Loki instance is installed
131-
on it and becomes the active instance, while the old instance is marked as
132-
*inactive*.
130+
In a NS8 cluster, Loki instances are managed automatically. Only one Loki
131+
instance is configured as *active* and receives log streams from
132+
applications. Other instances are *inactive*: they can only be used for
133+
log searches.
133134

134-
- The new active instance inherits the retention setting from the old one.
135+
An inactive Loki instance can originate from two situations:
135136

136-
- An inactive instance retains logs based on its last retention setting.
137+
1. A Loki instance is restored from backup.
138+
2. When a worker node is promoted to leader, a new Loki instance is
139+
installed on the new leader and becomes the active instance, while the
140+
previous active instance is marked as *inactive*.
137141

138-
- Log searches can still be performed within an inactive instance.
142+
In case of a leader promotion, the following also applies:
139143

140-
- Restoring a Loki instance from backup renders it inactive.
144+
- The new active instance inherits the retention setting of the previous
145+
active instance.
141146

142-
- To remove an inactive instance, select the three-dots menu and choose
143-
the ``Uninstall`` action.
147+
- An inactive instance continues to retain logs according to its last
148+
retention setting.
149+
150+
As noted, log searches can still be performed on an inactive instance.
151+
152+
To remove an inactive instance, select the three-dots menu and choose the
153+
``Uninstall`` action.
144154

145155
.. _logs-forwarding-section:
146156

proxy.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,9 @@ the following details:
114114
listing allowed IPv4 addresses or CIDR networks, one per line. By
115115
default, the route is open to all networks.
116116

117+
Custom HTTP routes are added to Traefik's backup and can be restored from
118+
it.
119+
117120
.. _lets_encrypt_routes:
118121

119122
Let's Encrypt certificate for HTTP routes

0 commit comments

Comments
 (0)