Merge pull request #8674 from ovh/TG-OPCP-Node-lifecycle-new

feat(opcp): create guide node lifecycle

Author: Jessica41

pages/hosted_private_cloud/opcp/node-lifecycle/guide.en-gb.md

@@ -0,0 +1,149 @@
+---
+title: "Lifecycle of an OPCP Node"
+excerpt: "Discover the lifecycle of an OPCP node and its different statuses"
+updated: 2025-11-18
+---
+
+## Objective
+
+A node in OpenStack represents the configuration of a physical server in the OPCP rack. It must be distinguished from instances, which represent the operating system running on a node.
+
+**This guide details the different statuses of a node in an OPCP rack and how to modify them.**
+
+## Requirements
+
+- Have an active [OPCP](/links/hosted-private-cloud/onprem-cloud-platform) service.
+- Have a user account with admin rights to log in to Horizon on the OPCP offering.
+- (Optional) Have access to the OpenStack APIs for your project.
+- (Optional) Have installed the Ironic client.
+
+## Instructions
+
+Log in to the Horizon interface of your OPCP on the admin project.
+
+![dashboard](images/01-log-to-horizon.png){.thumbnail}
+
+If you want to follow the OpenStack API section, you will need to install the Ironic packages on your environment:
+
+```bash
+pip install python-ironicclient
+```
+
+### Check the status of a node
+
+You can check the status of a node directly from Horizon via the `Admin` > `System` > `Ironic Bare Metal Provisioning` tab:
+
+![server-status](images/02-server-status.png){.thumbnail}
+
+You will find the list of your nodes and their various statuses.
+
+From the OpenStack APIs, you can retrieve the same list using the following command:
+
+```bash
+baremetal node list
+```
+
+You can also check the status of a specific node:
+
+```bash
+baremetal node show $BAREMETAL_NODE_ID
+```
+
+### Possible statuses
+
+|Status|Description|
+|---|---|
+|Enroll|First state of the node when it has been automatically discovered by OPCP. The server has not yet been validated and must be manually transitioned to `Manageable`.|
+|Manageable|The node has been verified and is managed by Ironic, but it is not yet installable. The node must be moved to the `Available` state before it can be deployed.|
+|Available|The node is available and can be installed.|
+|Active|The node is installed and has an active instance on it.|
+|Verifying|Transitional state when a node moves from `Enroll` to `Manageable`. Ironic verifies it can manage the node using the drivers and hardware properties configured during control-plane discovery.|
+|Cleaning / Clean-wait|Transitional state when an instance is deleted or when leaving the `Manageable` state before becoming `Available` again. Disks are wiped during this step.|
+|Deploying / Wait call-back|Transitional state when the node is being deployed.|
+
+You can find detailed explanations for the different statuses in the [official OpenStack documentation](https://docs.openstack.org/ironic/7.0.1/api/ironic.common.states.html).
+
+### Node lifecycle
+
+![node-lifecyle](images/03-node-lifecycle.png){.thumbnail}
+
+When a node is installed and booted in an OPCP rack, its discovery is automatically performed by the control plane. At this moment, the node retrieves its properties and **traits** based on its hardware profile.
+
+Once the node is in the `Enroll` state, you can change its state so that it is managed by Ironic.
+
+**From the Horizon interface:**
+
+![server-manageable](images/03-server-status-to-manageable.png){.thumbnail}
+
+**From the OpenStack APIs:**
+
+```bash
+baremetal node manage $BAREMETAL_NODE_ID
+```
+
+To make the node available for installation, it must then be transitioned to the `Available` state:
+
+**From the Horizon interface:**
+
+![server-available](images/03-server-status-to-available.png){.thumbnail}
+
+**From the OpenStack APIs:**
+
+```bash
+baremetal node provide $BAREMETAL_NODE_ID
+```
+
+The node then transitions to the `Cleaning` state before reaching `Available`, making it deployable by the various projects in your OPCP environment.
+
+### Maintenance mode
+
+This mode can be enabled to ensure a node cannot be used for installation, even if it is in the `Available` state.
+
+**From the Horizon interface:**
+
+![Maintenance-on](images/04-server-to-maintenance-on.png){.thumbnail}
+
+When enabling maintenance, you may specify a reason so that the team responsible for the nodes has the information. This reason is optional.
+
+![Maintenance-reason](images/04-server-to-maintenance-reason.png){.thumbnail}
+
+Once your maintenance operations are complete, you can disable maintenance:
+
+![Maintenance-off](images/04-server-to-maintenance-off.png){.thumbnail}
+
+**From the OpenStack APIs:**
+
+```bash
+baremetal node maintenance set $BAREMETAL_NODE_ID --reason "Maintenance reason"
+```
+
+You can then retrieve the maintenance status and the reason using the following command:
+
+```bash
+baremetal node show $BAREMETAL_NODE_ID
+```
+
+You will find the following lines:
+
+```bash
+| maintenance              | True
+| maintenance_reason       | "Maintenance reason"
+```
+
+To remove the node from maintenance, use the command:
+
+```bash
+baremetal node maintenance unset $BAREMETAL_NODE_ID
+```
+
+### References
+
+- [OpenStack Official Documentation - Horizon](https://docs.openstack.org/horizon/latest/)
+- [OpenStack Ironic States](https://docs.openstack.org/ironic/7.0.1/api/ironic.common.states.html)
+- [OpenStack Ironic Troubleshooting - Maintenance](https://docs.openstack.org/ironic/latest/install/troubleshooting.html)
+
+## Go further
+
+If you need training or technical assistance for the implementation of our solutions, contact your sales representative or click [this link](/links/professional-services) to request a quote and have your project analyzed by our Professional Services team experts.
+
+Join our [community of users](/links/community).

pages/hosted_private_cloud/opcp/node-lifecycle/guide.fr-fr.md

@@ -0,0 +1,149 @@
+---
+title: "Cycle de vie d'un noeud OPCP"
+excerpt: "Découvrez le cycle de vie d'un noeud OPCP et ses différents status"
+updated: 2025-11-18
+---
+
+## Objectif
+
+Un noeud dans openstack représente la configuration d'un serveur physique du rack OPCP. Il faut les différencer des instances qui représente le système d'exploitation sur un noeud.
+
+Ce guide vous détaille les différents status d'un noeud dans une baie OPCP et comment les modifier.
+
+## Prérequis
+
+- Disposer d'un service [OPCP](/links/hosted-private-cloud/onprem-cloud-platform) actif.
+- Posséder un compte utilisateur avec les droits admin pour se connecter à Horizon sur l'offre OPCP.
+- (Optionnel) Avoir un accès aux API Openstack de votre projet.
+- (Optionnel) Avoir installé le client ironic.
+
+## En pratique
+
+Connectez vous à l'interface Horizon de votre OPCP sur le projet admin.
+
+![dashboard](images/01-log-to-horizon.png){.thumbnail}
+
+Si vous souhaitez suivre la partie API Openstack, il sera nécessaire d'installer les paquets ironic sur votre environnement :
+
+```bash
+pip install python-ironicclient
+```
+
+### Vérifier le status d'un noeud
+
+Vous pouvez vérifier le statut d'un noeud directement depuis Horizon via l'onglet `Admin` > `System` > `Ironic Bare Metal Provisioning` :
+
+![server-status](images/02-server-status.png){.thumbnail}
+
+Vous retrouverez la liste de vos noeuds ainsi que leurs différents status.
+
+Depuis les API Openstack, vous pouvez retrouver la même liste via la commande suivante :
+
+```bash
+baremetal node list
+```
+
+Vous pouvez également vérifier le statut d'un noeud spécifique :
+
+```bash
+baremetal node show $BAREMETAL_NODE_ID
+```
+
+### Différents status possibles
+
+|Statuts|Description|
+|---|---|
+|Enroll|Premier état du noeud lorsqu'il a été découvert automatiquement par OPCP. Le serveur n'a pas encore été vérifié et doit être rendu `Manageable` manuellement.|
+|Manageable|Le noeud a été vérifié et est géré par Ironic, il n'est cependant pas encore installable. Le noeud doit être passé en état `Available` avant de pouvoir être installé.|
+|Available|Le noeud est disponible et peut être installé.|
+|Active|Le noeud est installé et a une instance active sur celui-ci.|
+|Verifying|Etat transitoire lorsqu'un noeud passe de l'état `Enroll` à `Manageable`. Ironic vérifie qu'il peut gérer le noeud via les drivers et propriétés hardware configurés lors de la découverte faite par le control plane.|
+|Cleaning / Clean-wait|Etat transitoire lorsqu'une instance est supprimée ou sort de l'état `Manageable` avant de redevenir `Available`. Les disques sont formatés durant cette étape.|
+|Deploying / Wait call-back|Etat transitoire lorsque le noeud est en cours d'installation.|
+
+Vous pouvez retrouver le détail des différents status dans la [documentation OpenStack officielle](https://docs.openstack.org/ironic/7.0.1/api/ironic.common.states.html).
+
+### Cycle de vie d'un noeud
+
+![node-lifecyle](images/03-node-lifecycle.png){.thumbnail}
+
+Lorsqu'un noeud est installé et démarré dans une baie OPCP, la découverte du noeud est automatiquement effectuée par le control plane. C'est à ce moment que le noeud récupère ses propriétés et **traits** en fonction du profil hardware de celui-ci.
+
+Une fois que le noeud est dans l'état `Enroll`, vous pouvez modifier son état pour qu'il soit géré par Ironic.
+
+**Depuis l'interface Horizon :**
+
+![server-manageable](images/03-server-status-to-manageable.png){.thumbnail}
+
+**Depuis les API Openstack :**
+
+```bash
+baremetal node manage $BAREMETAL_NODE_ID
+```
+
+Pour rendre le noeud disponible à l'installation, il faut ensuite le passer en statut `Available` :
+
+**Depuis l'interface Horizon :**
+
+![server-available](images/03-server-status-to-available.png){.thumbnail}
+
+**Depuis les API Openstack :**
+
+```bash
+baremetal node provide $BAREMETAL_NODE_ID
+```
+
+Le noeud passe alors en status `Cleaning` puis `Available`, ce qui le rend installable par les différents projets de votre environnement OPCP.
+
+### Mode maintenance
+
+Ce mode peut être activé afin de rendre un noeud non disponible pour un installation, même si celui-ci est dans le statut `Available`.
+
+**Depuis l'interface Horizon :**
+
+![Maintenance-on](images/04-server-to-maintenance-on.png){.thumbnail}
+
+Lors de la mise en maintenance, vous pouvez indiquer un motif afin que l'équipe responsable des nœuds dispose de cette information. Cette raison reste optionnelle.
+
+![Maintenance-reason](images/04-server-to-maintenance-reason.png){.thumbnail}
+
+Une fois votre maintenance terminée, vous pouvez retirer la maintenance :
+
+![Maintenance-off](images/04-server-to-maintenance-off.png){.thumbnail}
+
+**Depuis les API openstack :**
+
+```bash
+baremetal node maintenance set $BAREMETAL_NODE_ID --reason "Maintenance reason"
+```
+
+Vous pouvez ensuite retrouver la maintenance et la raison via la commande suivante :
+
+```bash
+baremetal node show $BAREMETAL_NODE_ID
+```
+
+Vous trouverez les lignes :
+
+```bash
+| maintenance              | True
+| maintenance_reason       | "Maintenance reason"
+```
+
+Pour sortir le noeud de la maintenance, vous pouvez utiliser la commande :
+
+```bash
+baremetal node maintenance unset $BAREMETAL_NODE_ID
+```
+
+### Références
+
+- [Openstack Official Documentation - Horizon](https://docs.openstack.org/horizon/latest/)
+- [Openstack Ironic States](https://docs.openstack.org/ironic/7.0.1/api/ironic.common.states.html)
+- [Openstack Ironic Troubleshooting - Maintenance](https://docs.openstack.org/ironic/latest/install/troubleshooting.html)
+
+## Go further
+
+If you need training or technical assistance for the implementation of our solutions, contact your sales representative or click [this link](/links/professional-services) to request a quote and have your project analyzed by our Professional Services team experts.
+
+Join our [community of users](/links/community).