Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/administrator-manual/applications/mattermost.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,15 @@ Mattermost authentication is *not* integrated with any user domain. The Mattermo
The administrator should always use Mattermost wizard to create the admin user, then send team invitation link to each user.

:::

## Reset a user password

Since Mattermost authentication is not integrated with a user domain, there is no self-service password recovery. If the administrator password set during the initial wizard is lost, or any other user's password needs to be reset, use the `mmctl` command-line tool.

Mattermost also provides an email-based reset (`mmctl user reset-password`), but it requires SMTP to be already configured on the instance, so it does not help in this case.

Run the following command as `root` on the NS8 node that hosts the Mattermost instance:

runagent -m mattermost0 podman exec -ti mattermost-app mmctl --local user change-password MY_USER --password NEW_PASSWORD

Replace `mattermost0` with the actual Mattermost instance name, `MY_USER` with the target user name or email address, and `NEW_PASSWORD` with the new password.
19 changes: 15 additions & 4 deletions docs/administrator-manual/configuration/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ All nodes are managed through the Web user interface, which operates on the lead

An NS8 cluster consisting solely of the leader node is a fully functional system. Worker nodes can be added or removed at any time.

Distinct NS8 clusters cannot be merged together. However, individual applications can be migrated between clusters with the [backup/restore procedure](backup.md). Since each application instance has a universally unique identifier (UUID), never run two restored copies of the same application on different clusters at the same time.

The VPN network chosen during the initial leader node setup determines the limit on the number of possible cluster nodes. Note that a node's VPN IP is never released once allocated: removing a node does not free its VPN IP address.

The default VPN network `10.5.4.0/24` supports up to 254 cluster nodes.
Expand All @@ -36,14 +38,16 @@ The **See details** button opens a detailed view of the selected node.

### Add a node

You can add (join) a worker node to an existing cluster. The process consists of the following steps:
You can add (join) a new node to an existing cluster as a **worker node**. The process consists of the following steps:

- ensure the leader node is running the latest Core version
- install the new node using the same Core version installed on the leader node
- obtain the join code from the leader node
- enter the join code into the worker node

First, prepare a machine with the same Linux distribution and Core version as the leader node. Then follow the [install instruction](../installation/install.md) until the login to the Web user interface.
First, prepare a machine with the same Linux distribution as the leader node. A removed NS8 node can be reused, provided it has first been cleaned up by running the [uninstall script](../installation/install.md#uninstall).

Then follow the [install instructions](../installation/install.md) until the login to the Web user interface.

After the login on the worker node, click the **Join cluster** button.

Expand All @@ -67,10 +71,17 @@ If the node is not reachable, or is not responding, the provider replica removal

Access the `Nodes` page, go to the three-dots menu of the node and click on `Remove from cluster` to open a confirmation window. Applications installed on the node are listed: review that list carefully because node removal is not recoverable.

Back up application data before proceeding. To reuse those applications elsewhere — for example, on the leader of a new, independent cluster — restore their backups once the new cluster is set up. See [Restore applications](backup.md#application_restore-section).

If the node removal window is confirmed by pushing the **I
understand, remove node** button, the node and its applications are disconnected, their authorizations are revoked and they cannot access the cluster any more.
understand, remove node** button, the node and its applications are disconnected from the cluster, their authorizations are revoked, and they can no longer access the cluster or its backup destinations.

When a node is removed from the cluster, the applications running on it, along with their scheduled backups, are not affected and are left in a running state. Hence, to finalize the node removal:

- Shut down and switch off the node.
- Or run the [uninstall script](../installation/install.md#uninstall).

When a node is removed from the cluster the applications running on it are not affected and they are left in a running state. Shutdown and switch off the node to finalize the node removal.
This finalization step is mandatory and should be performed immediately, to avoid running duplicate copies of the same application once its backup is restored elsewhere. Until finalized, a removed NS8 node cannot join the old cluster or another one, nor can it be elected leader.

### Change FQDN {#set-fqdn}

Expand Down
6 changes: 4 additions & 2 deletions docs/administrator-manual/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,14 @@ Not sure where to go from here? You can:
- Set up a [metric dashboard](../configuration/metrics.md).
- Read [SSD space reclamation](../../tutorial/disk_usage.md#fstrim-periodic) section to enable periodic `fstrim` runs.

## Uninstall
## Uninstall {#uninstall}

You can uninstall NS8 from your Linux distribution.

The uninstall command attempts to stop and erase core components and additional modules. Handle it with care because it erases everything under `/home` and `/var/lib/nethserver` directories.
The bundled uninstall script stops and erases the core components and additional applications, and cleans Wireguard and Firewalld configuration. Handle it with care because it erases all application data and directories like `/var/lib/nethserver`.

To uninstall NS8, execute:

bash /var/lib/nethserver/node/uninstall.sh

After the script run, it is possible to start a new NS8 installation.
6 changes: 4 additions & 2 deletions docs/administrator-manual/installation/system_requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@ Read the section [Operating system updates](../../tutorial/os_updates.md#neth-mi

## Swap space {#swap-reqs}

Set up a swap partition or swap file. In most environments, [4 GB of swap space](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/getting-started-with-swap_managing-storage-devices#recommended-system-swap-space_getting-started-with-swap) provides a good balance between performance and resource usage. The decision to allocate more space depends on the system's memory workload.
Set up a swap partition or swap file. In most environments, **4 GB of swap space** provides a good balance between performance and resource usage. The decision to allocate more space depends on the system's memory workload.

The [Rocky Linux pre-built image](../installation/install.md#install_image-section) already provides a 4 GB swap file configured as default.
The [Rocky Linux pre-built image](../installation/install.md#install_image-section) already provides a 4 GB swap file, `/swapfile`, configured as default.

To expand the available swap space, refer to chapter 15 of the official RHEL 9 documentation, [Getting started with swap](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/getting-started-with-swap_managing-storage-devices#recommended-system-swap-space_getting-started-with-swap). That chapter recommends the correct swap size and illustrates step-by-step procedures for swap files, partitions, and LVM volumes. It also applies to Debian systems. Its swap file examples use the same `/swapfile` name as the NS8 default: when adding another swap file, choose a different name to avoid overwriting it.

## Disk and partitions {#disk-partitions}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,15 @@ L'autenticazione di Mattermost *non* è integrata con alcun dominio utenti. L'am
L'amministratore dovrebbe sempre usare la procedura guidata di Mattermost per creare l'utente admin, quindi inviare il link di invito al team a ogni utente.

:::

## Ripristinare la password di un utente

Poiché l'autenticazione di Mattermost non è integrata con un dominio utenti, non esiste un recupero password self-service. Se la password dell'amministratore impostata durante la procedura guidata iniziale viene persa, o se è necessario reimpostare la password di un altro utente, usa lo strumento a riga di comando `mmctl`.

Mattermost offre anche un ripristino basato su email (`mmctl user reset-password`), ma richiede che l'SMTP sia già configurato sull'istanza, quindi non è utile in questo caso.

Esegui il seguente comando come `root` sul nodo NS8 che ospita l'istanza Mattermost:

runagent -m mattermost0 podman exec -ti mattermost-app mmctl --local user change-password MY_USER --password NEW_PASSWORD

Sostituisci `mattermost0` con il nome effettivo dell'istanza Mattermost, `MY_USER` con il nome utente o l'indirizzo email di destinazione, e `NEW_PASSWORD` con la nuova password.
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ Tutti i nodi sono gestiti tramite l'interfaccia utente Web, che opera sul nodo l

Un cluster NS8 composto unicamente dal nodo leader è un sistema completamente funzionale. I nodi worker possono essere aggiunti o rimossi in qualsiasi momento.

Cluster NS8 distinti non possono essere uniti tra loro. Tuttavia, è possibile migrare singole applicazioni tra cluster diversi con la [procedura di backup/restore](backup.md). Poiché ogni istanza di applicazione possiede un identificatore univoco universale (UUID), non eseguire mai contemporaneamente due copie ripristinate della stessa applicazione su cluster diversi.

La rete VPN scelta durante la configurazione iniziale del nodo leader determina il limite sul numero di nodi del cluster. Si noti che l'indirizzo IP VPN di un nodo non viene mai rilasciato una volta assegnato: la rimozione di un nodo non libera il suo indirizzo IP VPN.

La rete VPN predefinita `10.5.4.0/24` supporta fino a 254 nodi del cluster.

In teoria, il numero massimo di nodi in un cluster NS8 è limitato solo dalla dimensione della rete VPN. Tuttavia, è consigliabile aggiungere i nodi gradualmente per evitare un degrado delle prestazioni del leader a causa dell'aumento del carico di lavoro.

## Panoramica e dettagli dei nodi {#node-views}

La pagina `Nodes` mostra una panoramica dei nodi del cluster configurati. Ogni scheda visualizza gli attributi di base del nodo, il contatore degli avvisi del nodo e le azioni relative al nodo, che sono spiegate in dettaglio nelle sezioni seguenti.
Expand All @@ -35,14 +38,16 @@ Il pulsante **See details** apre una vista dettagliata del nodo selezionato.

### Aggiungere un nodo

È possibile aggiungere (unire) un nodo worker a un cluster esistente. Il processo consiste nei seguenti passaggi:
È possibile aggiungere (unire) un nuovo nodo a un cluster esistente come nodo **worker**. Il processo consiste nei seguenti passaggi:

- assicurarsi che il nodo leader stia eseguendo l'ultima versione di Core
- installare il nuovo nodo utilizzando la stessa versione di Core installata sul nodo leader
- ottenere il codice di unione dal nodo leader
- inserire il codice di unione nel nodo worker

Per prima cosa, preparare una macchina con la stessa distribuzione Linux e versione di Core del nodo leader. Quindi seguire le [istruzioni di installazione](../installation/install.md) fino al login nell'interfaccia utente Web.
Per prima cosa, preparare una macchina con la stessa distribuzione Linux del nodo leader. Un nodo NS8 rimosso può essere riutilizzato, a condizione che sia stato prima pulito eseguendo lo [script di disinstallazione](../installation/install.md#uninstall).

Quindi seguire le [istruzioni di installazione](../installation/install.md) fino al login nell'interfaccia utente Web.

Dopo il login sul nodo worker, fare clic sul pulsante **Join cluster**.

Expand All @@ -66,9 +71,16 @@ Se il nodo non è raggiungibile o non risponde, la rimozione della replica del p

Accedere alla pagina `Nodes`, andare al menu a tre punti del nodo e fare clic su `Remove from cluster` per aprire una finestra di conferma. Le applicazioni installate sul nodo sono elencate: esaminare attentamente tale elenco poiché la rimozione del nodo non è recuperabile.

Se la finestra di rimozione del nodo viene confermata premendo il pulsante **I understand, remove node**, il nodo e le sue applicazioni vengono disconnessi, le loro autorizzazioni vengono revocate e non possono più accedere al cluster.
Eseguire il backup dei dati delle applicazioni prima di procedere. Per riutilizzare tali applicazioni altrove — per esempio, sul leader di un nuovo cluster indipendente — ripristinare i relativi backup una volta configurato il nuovo cluster. Consultare [Ripristino delle applicazioni](backup.md#application_restore-section).

Se la finestra di rimozione del nodo viene confermata premendo il pulsante **I understand, remove node**, il nodo e le sue applicazioni vengono disconnessi dal cluster, le loro autorizzazioni vengono revocate e non possono più accedere al cluster o alle sue destinazioni di backup.

Quando un nodo viene rimosso dal cluster, le applicazioni in esecuzione su di esso, insieme ai relativi backup pianificati, non vengono influenzate e rimangono in esecuzione. Per completare la rimozione del nodo, occorre quindi:

- Spegnere e disattivare il nodo.
- Oppure eseguire lo [script di disinstallazione](../installation/install.md#uninstall).

Quando un nodo viene rimosso dal cluster, le applicazioni in esecuzione su di esso non vengono influenzate e rimangono in esecuzione. Spegnere e disattivare il nodo per completare la rimozione del nodo.
Questo passaggio di finalizzazione è obbligatorio e deve essere eseguito immediatamente, per evitare di eseguire copie duplicate della stessa applicazione una volta ripristinato il suo backup altrove. Finché non viene completato, un nodo NS8 rimosso non può unirsi nuovamente al vecchio cluster né a un altro, né può essere eletto leader.

### Modifica FQDN {#set-fqdn}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,14 @@ Non sai da dove iniziare? Puoi:
- Aggiungere [nuovi nodi](../configuration/cluster.md).
- Configurare un [cruscotto di metriche](../configuration/metrics.md).
- Leggere la sezione [Recupero spazio SSD](../../tutorial/disk_usage.md#fstrim-periodic) per abilitare esecuzioni periodiche di `fstrim`.
## Disinstallazione
## Disinstallazione {#uninstall}

È possibile disinstallare NS8 dalla propria distribuzione Linux.

Il comando di disinstallazione tenta di arrestare ed eliminare i componenti principali e i moduli aggiuntivi. Usarlo con cautela, poiché elimina tutto il contenuto delle directory `/home` e `/var/lib/nethserver`.
Lo script di disinstallazione incluso arresta ed elimina i componenti principali e le applicazioni aggiuntive, e ripulisce la configurazione di Wireguard e Firewalld. Usarlo con cautela, poiché elimina tutti i dati delle applicazioni e directory come `/var/lib/nethserver`.

Per disinstallare NS8, eseguire:

bash /var/lib/nethserver/node/uninstall.sh
bash /var/lib/nethserver/node/uninstall.sh

Dopo l'esecuzione dello script, è possibile avviare una nuova installazione di NS8.
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ Leggi la sezione [Aggiornamenti del sistema operativo](../../tutorial/os_updates

## Spazio di swap {#swap-reqs}

Configura una partizione di swap o un file di swap. Nella maggior parte degli ambienti, [4 GB di spazio di swap](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/getting-started-with-swap_managing-storage-devices#recommended-system-swap-space_getting-started-with-swap) offrono un buon equilibrio tra prestazioni e utilizzo delle risorse. La decisione di allocare più spazio dipende dal carico di lavoro della memoria del sistema.
Configura una partizione di swap o un file di swap. Nella maggior parte degli ambienti, **4 GB di spazio di swap** offrono un buon equilibrio tra prestazioni e utilizzo delle risorse. La decisione di allocare più spazio dipende dal carico di lavoro della memoria del sistema.

L'[immagine preconfigurata di Rocky Linux](../installation/install.md#install_image-section) fornisce già un file di swap da 4 GB configurato come predefinito.
L'[immagine preconfigurata di Rocky Linux](../installation/install.md#install_image-section) fornisce già un file di swap da 4 GB, `/swapfile`, configurato come predefinito.

Per espandere lo spazio di swap disponibile, consulta il capitolo 15 della documentazione ufficiale di RHEL 9, [Getting started with swap](https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/getting-started-with-swap_managing-storage-devices#recommended-system-swap-space_getting-started-with-swap). Quel capitolo indica la dimensione di swap corretta e illustra procedure passo passo per file di swap, partizioni e volumi LVM. Si applica anche ai sistemi Debian. I suoi esempi di file di swap usano lo stesso nome `/swapfile` predefinito di NS8: quando aggiungi un altro file di swap, scegli un nome diverso per evitare di sovrascriverlo.

## Disco e partizioni {#disk-partitions}

Expand Down
Loading