Skip to content

Commit

Permalink
add silent mode tab
Browse files Browse the repository at this point in the history
  • Loading branch information
@jean-christophe81
jean-christophe81 committed Dec 6, 2024
1 parent 1542e7b commit 290db09
Show file tree
Hide file tree
Showing 2 changed files with 84 additions and 12 deletions.
55 changes: 48 additions & 7 deletions ...-docs-pp/current/integrations/plugin-packs/getting-started/how-to-guides/cma.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -355,19 +355,63 @@ Les niveaux de logs possibles sont:
</TabItem>
<TabItem value="Windows" label="Windows">

1. [Téléchargez l'installer de l'agent] (https://github.com/centreon/centreon-collect/releases/download/centreon-collect-24.04.6/centreon-monitoring-agent-24.10.0.exe) sur tous les serveurs que vous voulez superviser.
[Téléchargez l'installer de l'agent] (https://github.com/centreon/centreon-collect/releases/download/centreon-collect-24.04.6/centreon-monitoring-agent-24.10.0.exe) sur tous les serveurs que vous voulez superviser.

2. Lancez l'installer (durant la configuration, vous pourrez cliquer sur les (i) pour avoir de l'aide).

3. Configurez l'endpoint et le type de connexion :
Le programme d'installation de l'agent peut s'utiliser suivant deux modes:

<Tabs groupId="sync">
<TabItem value="Mode interactif" label="Mode interactif">

1. Lancez l'installer (durant la configuration, vous pourrez cliquer sur les (i) pour avoir de l'aide).

2. Configurez l'endpoint et le type de connexion :
* Dans le champ **Host name in Centreon**, entrez le nom de l'hôte à superviser tel que vous l'avez saisi dans l'interface Centreon.
* Dans le cas le plus courant (l'agent se connecte au poller), saisissez l'adresse IP ou le nom DNS suivi du port OpenTelemetry sur lequel écoute le poller, sous la forme \<adresse IP ou nom DNS\>:port, par exemple 192.168.45.32:4317.
* Si vous activez l'option **Poller-initiated connection** (le collecteur se connecte à l'agent), vous devez choisir l'interface (toutes les interfaces : 0.0.0.0) et le port (généralement 4317) sur lequel l'agent va accepter les connections venant du collecteur.

4. Configurez les options de log. Deux types de log sont disponibles :
3. Configurez les options de log. Deux types de log sont disponibles :
* **File** : les logs sont écrits dans un fichier
* **EventLog** : les logs sont envoyés vers les [journaux d'évènements](/docs/alerts-notifications/event-log).
Si vous choisissez de logger dans un fichier, vous pouvez configurer la rotation de logs en renseignant **Max File Size** et **Max number of files**.

4. Configurez les paramètres de chiffrement.
Le chiffrement est activé par défaut. Dans le cas où l'option **Poller-initiated connection** est activée, renseignez **Max File Size** et **Max number of files**.
</TabItem>

<TabItem value="Mode silencieux" label="Silent mode (console)">
Dans ce mode, aucune Ihm est lancée. Comme cet installer n'est pas un programme console, il rend immédiatement la main même s'il n'a pas encore fini. Vous devez attendre de voir apparaitre dans la console le message indiquant qu'il a terminé.
Si vous devez tester le succès de l'installation, vous devez récupérer l'exit status. Vous pouvez le lancer dans un powershell et attendre la fin du processus. L'exit status vaudra 0 si tout s'est bien passé.

Pour le lancer en mode silencieux, vous devez mettre en premier argument /S.
Vous pouvez avoir une liste des arguments avec la ligne de commande:
```shell
centreon-monitoring-agent.exe /S --help
```

Les différents arguments sont:

| | |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --install_cma | Si ce flag est présent, l'agent sera installé |
| --install_plugins | Si ce flag est présent, les plugins seront installés |
| --hostname | Le nom de l'hôte à superviser tel que vous l'avez saisi dans l'interface Centreon |
| --endpoint | Dans le cas le plus courant (l'agent se connecte au poller), saisissez l'adresse IP ou le nom DNS suivi du port OpenTelemetry sur lequel écoute le poller, sous la forme \<adresse IP ou nom DNS\>:port, par exemple 192.168.45.32:4317. Si vous activez l'option **--reverse** (le collecteur se connecte à l'agent), vous devez choisir l'interface (toutes les interfaces : 0.0.0.0) et le port (généralement 4317) sur lequel l'agent va accepter les connections venant du collecteur. |
| --reverse | Si ce flag est présent, l'agent accepte les connections venant du collecteur |
| --log_type | event_log ou file. Si vous choisissez fichier, le paramètre log_file est obligatoire |
| --log_level | Choisir parmi: off, critical, error, warning, debug ou trace |
| --log_file | Chemin du fichier de log |
| --log_max_file_size | Taille maximale du fichier de log en Mo avant rotation. |
| --log_max_files | Nombre maximal de fichiers de log. Pour que la rotation des logs soit activée, ces deux paramètres sont nécessaires. |
| --encryption | Si ce flag est présent le chiffrement est activé. |
| --private_key | Chemin du fichier contenant la clé privée. Obligatoire si le chiffrement et le mode reverse sont activés. |
| --public_cert | Chemin du fichier contenant la clé publique. Obligatoire si le chiffrement et le mode reverse sont activés. |
| --ca | Chemin du fichier contenant le certificat de confiance. |
| --ca_name | TLS certificate common name (CN). Ne pas utiliser en cas de doute. |

</TabItem>
</Tabs>

Les niveaux de logs possibles sont:
* off: aucun log
* critical: erreurs critiques
Expand All @@ -376,9 +420,6 @@ Les niveaux de logs possibles sont:
* debug: quelques informations sur les connections en plus
* trace: le niveau de trace le plus bavard qui permet de voir les messages envoyés et reçus vers le poller

5. Configurez les paramètres de chiffrement.
Le chiffrement est activé par défaut. Dans le cas où l'option **Poller-initiated connection** est activée, renseignez **Max File Size** et **Max number of files**.

</TabItem>
</Tabs>

Expand Down
41 changes: 36 additions & 5 deletions pp/integrations/plugin-packs/getting-started/how-to-guides/cma.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -359,16 +359,20 @@ systemctl restart centagent
</TabItem>
<TabItem value="Windows" label="Windows">

1. [Download the CMA installer](https://github.com/centreon/centreon-collect/releases/download/centreon-collect-24.04.6/centreon-monitoring-agent-24.10.0.exe) on every server you want to monitor.
[Download the CMA installer](https://github.com/centreon/centreon-collect/releases/download/centreon-collect-24.04.6/centreon-monitoring-agent-24.10.0.exe) on every server you want to monitor.

2. Start the installer (during the configuration, you can click on the (i) icons for help).

<Tabs groupId="sync">
<TabItem value="Interactive mode" label="Interactive mode">

1. Start the installer (during the configuration, you can click on the (i) icons for help).

3. Configure the endpoint and the connection:
2. Configure the endpoint and the connection:
* **Host name in Centreon**. This must be the host name you have defined in the Centreon interface.
* In most cases (the agent connects to the poller), you have to enter the poller's endpoint. The correct format is \<poller IP or DNS name\>:port (OpenTelemetry listening port on the poller, usually 4317), for example 192.168.45.32:4317.
* In case of a poller-initiated connection (the poller connects to the agent), you have to choose a host interface (0.0.0.0 for all interfaces) and the listening port on which poller will connect, usually 4317.

4. Configure logging options. You can configure two kinds of log output:
3. Configure logging options. You can configure two kinds of log output:
* File: the CMA logs into a file
* EventLog: the CMA logs in the [event logs page](/docs/alerts-notifications/event-log).

Expand All @@ -382,8 +386,35 @@ Allowed log levels are:
* debug: more information about connections
* trace: the most verbose trace level showing messages sent and received to the poller

5. Configure encryption
4. Configure encryption
Encryption is activated by default. In case of a poller-initiated connection, the private key file and certificate file are mandatory.
</TabItem>

<TabItem value="Silent mode" label="Silent mode (console)">
In this mode no UI is started. As this installer is not a console program, it returns immediately despite he hasn't finished. You have to wait for message telling that all is finished.
If you need to have exit status, you can launch it in a powershell session and wait for exit code. Exit code will be 0 if all isright
| | |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --install_cma | Set this flag if you want to install centreon monitoring agent |
| --install_plugins | Set this flag if you want to install centreon plugins |
| --hostname | The name of the host as defined in the Centreon interface. |
| --endpoint | IP address of DNS name of the poller the agent will connect to. In case of Poller-initiated connection mode, it is the interface and port on which the agent will accept connections from the poller. 0.0.0.0 means all interfaces. The format is (IP or DNS name):(port) |
| --reverse | Add this flag for Poller-initiated connection mode. |
| --log_type | event_log or file. In case of logging in a file, log_file param is mandatory |
| --log_level | can be off, critical, error, warning, debug or trace |
| --log_file | log files path. |
| --log_max_file_size | max file in Mo before rotate. |
| --log_max_files | max number of log files before delete. For the rotation of logs to be active, it is necessary that both parameters 'Max File Size' and 'Max number of files' are set. |
| --encryption | Add this flag for encrypt connection with poller. |
| --private_key | Private key file path. Mandatory if encryption and poller-initiated connection are active. |
| --public_cert | Public certificate file path. Mandatory if encryption and poller-initiated connection are active. |
| --ca | Trusted CA's certificate file path. |
| --ca_name | Expected TLS certificate common name (CN). Don't use it if unsure. |


</TabItem>
</Tabs>


</TabItem>
</Tabs>
Expand Down

0 comments on commit 290db09

Please sign in to comment.