-
Notifications
You must be signed in to change notification settings - Fork 390
feat(opcp): create guide how to see node inventory #8766
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.
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
Merged
Merged
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
72aa66f
feat(opcp): create guide how to see node inventory
ThibautOVH 0cb64a1
update dashboard definition
ThibautOVH 2dd4ee1
Update pages/hosted_private_cloud/opcp/how-to-see-node-inventory/guid…
ThibautOVH a4f2bf1
update from home to openstack-overview dash
ThibautOVH 7b5e884
fix typo
ThibautOVH 6da8c81
fix netbox description
ThibautOVH e85e577
add en version
ThibautOVH 9b3b451
proofreading
benchbzh a639694
images_resizing
benchbzh b23085c
fix screen language
ThibautOVH a1da882
date update & minor update EN version
benchbzh bd8eebe
date update
benchbzh 1095010
Update pages/hosted_private_cloud/opcp/how-to-see-node-inventory/guid…
benchbzh b45453e
Update pages/hosted_private_cloud/opcp/how-to-see-node-inventory/guid…
benchbzh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
180 changes: 180 additions & 0 deletions
180
pages/hosted_private_cloud/opcp/how-to-see-node-inventory/guide.en-gb.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| --- | ||
| title: "OPCP - How to see the node inventory" | ||
| excerpt: "Find out how to access the OPCP node inventory" | ||
| updated: 2026-01-09 | ||
| --- | ||
|
|
||
| ## Objective | ||
|
|
||
| This guide explains how to view the hardware inventory, consumed resources, and available resources on an **OVHcloud On-Prem Cloud Platform (OPCP)** using: | ||
|
|
||
| - **Grafana**: real-time infrastructure monitoring | ||
| - **NetBox**: physical and logical inventory | ||
| - **OpenStack Horizon**: Ironic inventory via Horizon | ||
| - **OpenStack CLI**: Ironic inventory via CLI | ||
|
|
||
| > [!primary] | ||
| > | ||
| > In OpenStack, a node corresponds to a physical server in the OPCP rack. | ||
| > | ||
| > In this guide, the term **node** is therefore used to refer to a physical server. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Be an administrator of the [OPCP](/links/hosted-private-cloud/onprem-cloud-platform) infrastructure and have access to the administration interface `admin.dashboard`. | ||
| - Have **[OpenStack CLI configured](/pages/hosted_private_cloud/opcp/how-to-use-api-and-get-credentials)** with the required permissions (`clouds.yaml` or environment variables). | ||
benchbzh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Instructions | ||
|
|
||
| ### 1. Inventory and monitoring via Grafana | ||
|
|
||
| Grafana provides a real-time monitoring view and allows you to easily track changes in your OPCP infrastructure. | ||
|
|
||
| #### 1.1 Access the Home dashboard | ||
|
|
||
| 1. Log in to the administration URL `admin.dashboard`. | ||
| 2. Click **Grafana**. | ||
| 3. Click **Dashboards** and search for the **OpenStack overview** dashboard. | ||
|
|
||
| You should see a dashboard similar to the following image: | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| #### 1.2 Understanding the OpenStack overview dashboard | ||
|
|
||
| The dashboard allows you to visualize: | ||
|
|
||
| - OpenStack service status: **Service status** | ||
| - Resource usage: **Resource usage** | ||
| - A detailed view of the Keystone service: **Keystone** | ||
| - A detailed view of the Ironic service: **Ironic** | ||
| - A detailed view of the Nova service: **Nova** | ||
| - A detailed view of the Neutron service: **Neutron** | ||
| - A detailed view of the Cinder service: **Cinder** | ||
| - A detailed view of the Glance service: **Glance** | ||
|
|
||
| #### 1.3 Understanding and using the Ironic section | ||
|
|
||
| We will focus on the "Ironic" section, as this is where you can see the status of the different nodes. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| This section allows you to view: | ||
|
|
||
| - Total number of nodes: **Total enrolled Ironic nodes** | ||
| - Number of available nodes not in maintenance: **Available Ironic nodes** | ||
| - Number of nodes in error: **Error Ironic nodes** | ||
| - List of nodes in error or maintenance: **List of failed and maintenance nodes** | ||
| - Number of allocated nodes: **Allocated Ironic nodes** | ||
| - Number of waiting nodes: **Waiting Ironic nodes** | ||
| - Number of nodes in maintenance: **Maintenance Ironic nodes** | ||
|
|
||
| ### 2. Hardware and logical inventory with NetBox | ||
|
|
||
| NetBox is the reference tool for managing the physical, network, and logical inventory of your infrastructure. | ||
|
|
||
| The NetBox inventory is automatically populated; no manual action is required to add or modify nodes. | ||
|
|
||
| #### 2.1 Access NetBox | ||
|
|
||
| 1. Log in to the administration URL `admin.dashboard`. | ||
| 2. Click **NetBox**. | ||
|
|
||
| #### 2.2 View the node inventory | ||
|
|
||
| In **Devices**, you can see the complete list of equipment in your OPCP rack (nodes, network equipment, etc.). | ||
|
|
||
| You can: | ||
|
|
||
| - use the quick search to find an item by name; | ||
| - use **Filters** for advanced searches. | ||
|
|
||
| For example, you can list all non-production nodes by applying the following filters: | ||
|
|
||
| - **Status**: Decommissioned, Inventory, Failed, Planned | ||
| - **Role**: server | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| You can save the search to reuse it later. | ||
|
|
||
| ### 3. OpenStack Horizon – Ironic UI | ||
|
|
||
| #### 3.1 Access the Ironic interface | ||
|
|
||
| 1. Log in to the administration URL `admin.dashboard` | ||
| 2. Click **Horizon** | ||
| 3. Click **Admin** | ||
| 4. Click **System**, then **Ironic Bare Metal Provisioning** | ||
|
|
||
| #### 3.2 List all nodes | ||
|
|
||
| In **Ironic Bare Metal Provisioning**, you can see all nodes. | ||
|
|
||
| You can filter nodes by their status, for example: `Provisioning State = failed`. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ### 4. Resource status via OpenStack CLI | ||
|
|
||
| The OpenStack CLI allows you to obtain the **real-time** status of allocated and available resources. | ||
|
|
||
| #### 4.1 List all nodes | ||
|
|
||
| ```bash | ||
| openstack baremetal node list | ||
| ``` | ||
|
|
||
| **Example output:** | ||
|
|
||
| ```bash | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | 88830859-5b16-4935-8f41-d381b754cbe5 | SERVER-1 | None | power off | available | False | | ||
| | 726bb7e9-3b20-4a44-99d7-2af747983781 | SERVER-2 | None | power off | available | False | | ||
| | af711edf-a579-491e-b474-3c03639ed99b | SERVER-3 | 83b7083b-bbdd-4327-941c-ee91197818c5 | power on | active | False | | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| #### 4.2 Filter nodes | ||
|
|
||
| You can filter results using **--provision-state** to view nodes in a specific state, or **--maintenance** to view nodes in maintenance. | ||
|
|
||
| All available filters can be found using `--help`. | ||
|
|
||
| **Example output:** | ||
|
|
||
| ```bash | ||
| $ openstack baremetal node list --provision-state "clean failed" | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| | 37f96160-16cf-47e6-8bee-0ee42a59fafe | SERVER-1 | None | power off | clean failed | False | | ||
| | 5678b6ff-1909-466f-857a-c8818a5ecd61 | SERVER-2 | None | power off | clean failed | False | | ||
| | cf5ee1ce-913a-4bff-a343-c391d8b3b667 | SERVER-3 | None | power off | clean failed | False | | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| ```bash | ||
| $ openstack baremetal node list --maintenance | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | 4e1108e1-3049-46fc-adb5-b27ba607710d | SERVER-4 | 9b972076-2c58-496b-9690-0f1b40d54660 | None | deploy failed | True | | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| #### 4.3 Node details | ||
|
|
||
| To retrieve all information about a node, for example to identify the last error and understand why the deployment failed: | ||
|
|
||
| ```bash | ||
| openstack baremetal node show <node-id> | ||
| ``` | ||
|
|
||
| ## 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). | ||
180 changes: 180 additions & 0 deletions
180
pages/hosted_private_cloud/opcp/how-to-see-node-inventory/guide.fr-fr.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| --- | ||
| title: "OPCP - Comment visualiser l'inventaire des nœuds" | ||
| excerpt: "Découvrez comment consulter l'inventaire des nœuds OPCP" | ||
| updated: 2026-01-09 | ||
| --- | ||
|
|
||
| ## Objectif | ||
|
|
||
| Ce guide explique comment consulter l’inventaire matériel, les ressources consommées et les ressources disponibles sur une plateforme **OVHcloud On-Prem Cloud Platform (OPCP)**, à l’aide de : | ||
|
|
||
| - **Grafana** : monitoring en temps réel de l’infrastructure | ||
| - **NetBox** : inventaire physique et logique | ||
| - **OpenStack Horizon** : inventaire Ironic via Horizon | ||
| - **OpenStack CLI** : inventaire Ironic via CLI | ||
|
|
||
| > [!primary] | ||
| > | ||
| > Dans OpenStack, un nœud correspond à un serveur physique du rack OPCP. | ||
| > | ||
| > Dans ce guide, le terme **nœud** est donc utilisé pour désigner un serveur physique. | ||
|
|
||
| ## Prérequis | ||
|
|
||
| - Être administrateur de l'infrastructure [OPCP](/links/hosted-private-cloud/onprem-cloud-platform) et avoir accès à l'interface d'administration `admin.dashboard`. | ||
| - Un accès **[OpenStack CLI configuré](/pages/hosted_private_cloud/opcp/how-to-use-api-and-get-credentials)** avec les droits nécessaires (`clouds.yaml` ou variables d’environnement). | ||
|
|
||
| ## En pratique | ||
|
|
||
| ### 1. Inventaire et monitoring via Grafana | ||
|
|
||
| Grafana fournit une vue de monitoring en temps réel et permet de suivre facilement l'évolution de votre parc OPCP. | ||
|
|
||
| #### 1.1 Accéder au dashboard Home | ||
|
|
||
| 1. Connectez-vous à l’URL d'administration `admin.dashboard`. | ||
| 2. Cliquez sur **Grafana**. | ||
| 3. Cliquez sur **Dashboards** et recherchez le dashboard **OpenStack overview**. | ||
|
|
||
| Vous devriez voir un dashboard similaire à l'image suivante : | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| #### 1.2 Comprendre le dashboard OpenStack overview | ||
|
|
||
| Le dashboard permet de visualiser : | ||
|
|
||
| - L'état des services OpenStack : **Service status** | ||
| - L'utilisation des ressources : **Resource usage** | ||
| - Une vue détaillée du service Keystone : **Keystone** | ||
| - Une vue détaillée du service Ironic : **Ironic** | ||
| - Une vue détaillée du service Nova : **Nova** | ||
| - Une vue détaillée du service Neutron : **Neutron** | ||
| - Une vue détaillée du service Cinder : **Cinder** | ||
| - Une vue détaillée du service Glance : **Glance** | ||
|
|
||
| #### 1.3 Comprendre et utiliser la section Ironic | ||
|
|
||
| Nous allons nous focaliser sur la partie « Ironic », c'est ici que nous allons pouvoir voir l'état des différents nœuds. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Cette section permet de visualiser : | ||
|
|
||
| - Le nombre total de nœuds : **Total enrolled Ironic nodes** | ||
| - Le nombre de nœuds disponibles et pas en maintenance : **Available Ironic nodes** | ||
| - Le nombre de nœuds en erreur : **Error Ironic nodes** | ||
| - La liste des nœuds en erreur ou en maintenance : **List of failed and maintenance nodes** | ||
| - Le nombre de nœuds utilisés : **Allocated Ironic nodes** | ||
| - Le nombre de nœuds en attente : **Waiting Ironic nodes** | ||
| - Le nombre de nœuds en maintenance : **Maintenance Ironic nodes** | ||
|
|
||
| ### 2. Inventaire matériel et logique avec NetBox | ||
|
|
||
| NetBox est la référence pour gérer l’inventaire physique, réseau et logique de votre infrastructure. | ||
|
|
||
| L'inventaire de NetBox est automatiquement renseigné, aucune action manuelle n’est requise pour l’ajout ou la modification des nœuds. | ||
|
|
||
| #### 2.1 Accéder à NetBox | ||
|
|
||
| 1. Connectez-vous à l’URL d'administration `admin.dashboard`. | ||
| 2. Cliquez sur **NetBox**. | ||
|
|
||
| #### 2.2 Consulter l’inventaire des nœuds | ||
|
|
||
| Dans **Appareils**, vous pouvez voir la liste complète des équipements de votre rack OPCP (nœuds, équipements réseau, etc.). | ||
|
|
||
| Vous pouvez : | ||
|
|
||
| - utiliser la recherche rapide pour trouver un élément par nom ; | ||
| - utiliser **Filtres** pour une recherche avancée. | ||
|
|
||
| Par exemple, vous pouvez lister tous les nœuds hors production en appliquant les filtres suivants : | ||
|
|
||
| - **Statut** : Démonté, Inventaire, Échoué, Planifié | ||
| - **Rôle** : server | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Vous pouvez enregistrer la recherche pour la réutiliser plus tard. | ||
|
|
||
| ### 3. OpenStack Horizon – Ironic UI | ||
|
|
||
| #### 3.1 Accéder à l'interface Ironic | ||
|
|
||
| 1. Connectez-vous à l’URL d'administration `admin.dashboard` | ||
| 2. Cliquez sur **Horizon** | ||
| 3. Cliquez sur **Admin** | ||
| 4. Cliquez sur **System**, puis sur **Ironic Bare Metal Provisioning** | ||
|
|
||
| #### 3.2 Lister tous les nœuds | ||
|
|
||
| Dans **Ironic Bare Metal Provisioning**, vous pouvez voir tous les nœuds. | ||
|
|
||
| Vous pouvez filtrer les nœuds selon leur statut, par exemple : `Provisioning State = failed`. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ### 4. État des ressources via OpenStack CLI | ||
|
|
||
| Le CLI OpenStack permet d’obtenir l’état **en temps réel** des ressources allouées et disponibles. | ||
|
|
||
| #### 4.1 Lister tous les nœuds | ||
|
|
||
| ```bash | ||
| openstack baremetal node list | ||
| ``` | ||
|
|
||
| **Exemple de sortie :** | ||
|
|
||
| ```bash | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | 88830859-5b16-4935-8f41-d381b754cbe5 | SERVER-1 | None | power off | available | False | | ||
| | 726bb7e9-3b20-4a44-99d7-2af747983781 | SERVER-2 | None | power off | available | False | | ||
| | af711edf-a579-491e-b474-3c03639ed99b | SERVER-3 | 83b7083b-bbdd-4327-941c-ee91197818c5 | power on | active | False | | ||
| +--------------------------------------+----------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| #### 4.2 Filtrer les nœuds | ||
|
|
||
| Vous pouvez filtrer les résultats à l'aide de **--provision-state** pour voir les nœuds dans un statut spécifique, ou encore **--maintenance** pour voir les nœuds en maintenance. | ||
|
|
||
| Tous les filtres sont disponibles via `--help`. | ||
|
|
||
| **Exemple de sortie :** | ||
|
|
||
| ```bash | ||
| $ openstack baremetal node list --provision-state "clean failed" | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| | 37f96160-16cf-47e6-8bee-0ee42a59fafe | SERVER-1 | None | power off | clean failed | False | | ||
| | 5678b6ff-1909-466f-857a-c8818a5ecd61 | SERVER-2 | None | power off | clean failed | False | | ||
| | cf5ee1ce-913a-4bff-a343-c391d8b3b667 | SERVER-3 | None | power off | clean failed | False | | ||
| +--------------------------------------+----------------+---------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| ```bash | ||
| $ openstack baremetal node list --maintenance | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | UUID | Name | Instance UUID | Power State | Provisioning State | Maintenance | | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| | 4e1108e1-3049-46fc-adb5-b27ba607710d | SERVER-4 | 9b972076-2c58-496b-9690-0f1b40d54660 | None | deploy failed | True | | ||
| +--------------------------------------+--------------+--------------------------------------+-------------+--------------------+-------------+ | ||
| ``` | ||
|
|
||
| #### 4.3 Détails d'un nœud | ||
|
|
||
| Pour récupérer toutes les informations concernant un nœud, par exemple pour identifier la dernière erreur et comprendre pourquoi le déploiement a échoué : | ||
|
|
||
| ```bash | ||
| openstack baremetal node show <node-id> | ||
| ``` | ||
|
|
||
| ## Aller plus loin | ||
|
|
||
| Si vous avez besoin d'une formation ou d'une assistance technique pour la mise en oeuvre de nos solutions, contactez votre commercial ou cliquez sur [ce lien](/links/professional-services) pour obtenir un devis et demander une analyse personnalisée de votre projet à nos experts de l’équipe Professional Services. | ||
|
|
||
| Échangez avec notre [communauté d'utilisateurs](/links/community). |
Binary file added
BIN
+105 KB
...to-see-node-inventory/images/01-grafana-dashboard-openstack-overview-ironic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+185 KB
...cp/how-to-see-node-inventory/images/01-grafana-dashboard-openstack-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+168 KB
...ivate_cloud/opcp/how-to-see-node-inventory/images/02-netbox-devices-filters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+62.8 KB
...ate_cloud/opcp/how-to-see-node-inventory/images/03-openstack-horizon-ironic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions
2
pages/hosted_private_cloud/opcp/how-to-see-node-inventory/meta.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| id: f4fe93d1-bd94-4dd9-a443-4057f9c47ef7 | ||
| full_slug: opcp-node-inventory |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.