-
Notifications
You must be signed in to change notification settings - Fork 387
feat: add getting started for OPCP #8699
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 all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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
144 changes: 144 additions & 0 deletions
144
pages/hosted_private_cloud/opcp/opcp-getting-started/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,144 @@ | ||
| --- | ||
| title: "Getting started with your OPCP" | ||
| excerpt: "Find out how to manage and configure your On-Prem Cloud Platform" | ||
| updated: 2025-12-02 | ||
| --- | ||
|
|
||
| ## Objective | ||
|
|
||
| This guide has been designed to show you how to log in to the graphical interfaces of your **OPCP** as an administrator of this service. | ||
|
|
||
| ## Requirements | ||
|
|
||
| To follow this guide, you will need the following information | ||
|
|
||
| - The **url** address of the management interface defined for service delivery. | ||
| - Login and password details provided when the service was delivered. | ||
|
|
||
| ## Instructions | ||
|
|
||
| ### User interface composition | ||
|
|
||
| The **url** address provided allows you to access the **OPCP** user interface. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Once you have used your login details to register, you will have access to the product dashboard. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Your interface allows you to access: | ||
|
|
||
| - The configuration of users within *Keycloak* via the IAM link under your login. | ||
| - The OpenStack management interface, *Horizon*. It is a graphical web interface for managing the entire OpenStack infrastructure. It allows the user to make use of the machine resources provided by the administrators. You can do this by creating, launching and stopping instances, configuring networks, and managing instance accessibility. | ||
|
|
||
| The **OPCP** administration interface also groups together access to various APIs such as Keystone (authentication and identity management), Glance (image management), Nova (computing service), Neutron (network management), Ironic (bare metal hardware management), which can be used within your automations. | ||
|
|
||
| ### Introduction to the OpenStack Horizon Interface | ||
|
|
||
| The OpenStack Horizon graphical interface allows you to perform different actions depending on their permissions and the project they belong to. Some of the main features available to an end user include instance management, network management, and resource tracking. | ||
|
|
||
| #### Access to the OpenStack Horizon administration interface | ||
|
|
||
| From the **OPCP** user interface, the OpenStack Horizon interface is accessible via the link in the dashboard. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Once you have logged in, the Horizon OpenStack interface looks like this: | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| The side menu to the left of the interface provides access to the various interface elements. There are two parent entries in this menu: | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| - **Project** which includes four elements: Overview, API Access, Compute and Network. These elements bring together all the management features of dedicated servers and their networks, within defined quota limits. | ||
| - **Identity** which includes Projects, Users, and Application ID elements that contain user management functionality. | ||
|
|
||
| #### Project view | ||
|
|
||
| The main *Project* element is made up of various sub-elements that provide access to all resource management functionality. The first sub-element, called *Overview*, provides a global overview of the project’s allocated resource quotas, as well as a visual tracking of overall resource consumption. | ||
|
|
||
| ##### Overview section | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| The *Overview* section is divided into two main parts: | ||
|
|
||
| - ***Limit Summary**: The quota limits assigned to the project for each resource type. You can also view resource consumption in relation to available capacity. | ||
|
|
||
| Quotas are grouped into two categories, as shown in the image below: | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| - ***Compute** which includes instance limits, vCPUs and RAM. | ||
| - **Network** that monitors network resource quotas: Floating IPs, security groups, group security rules, networks, and ports. | ||
| - **Usage Summary**: A history of resource usage over a period of time that allows you to see how resource usage has changed over time | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### API Access section | ||
|
|
||
| The **API-Access** tab groups together the 10 services available via the API, such as Bare-Metal, Compute, identity, image and network, as well as their access point URLs. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| With these *Endpoints*, you can communicate directly with OpenStack components using API requests. You will need this information if you need to implement HTTP requests yourself using the OpenStack APIs. | ||
|
|
||
| If you are using existing OpenStack integrations, they will retrieve this information the first time you log in to the OpenStack Keystone component. It is responsible for providing this information automatically. | ||
|
|
||
| #### Compute section | ||
|
|
||
| The **Compute** section provides features for configuring your product’s dedicated servers. This section is divided into different sections: | ||
|
|
||
| ##### Instances section | ||
|
|
||
| An interface for listing and managing dedicated servers that have already been configured. An *Instance* corresponds to a dedicated server. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Images section | ||
|
|
||
| You can manage images of the OS available for creating instances. You can also download new images, or select from images already available, to set up instances. This way, you can generate your own images to manage additional operating systems. | ||
|
|
||
| > [!warning] | ||
| > | ||
| > The images must take into account the hardware drivers delivered in your product. Many images available for Glance are only available for virtual environments based on qemu or kvm drivers. | ||
| > | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Key Pairs section | ||
|
|
||
| To authenticate yourself via SSH on your machines after installation, you will need to use asymmetric encryption keys. This interface allows you to import the public keys or create a keypair that will be deployed during the installation of the dedicated servers to ensure an SSH connection. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| #### Network View | ||
|
|
||
| The Network View allows you to view and manage the networks of your **OPCP** service. This interface allows you to create shared or separate networks between your dedicated servers. | ||
|
|
||
| > [!primary] | ||
| > | ||
| > Your entire network configuration is managed via this graphical interface or via the **OpenStack** APIs with the network component named **Neutron**. The switches in your infrastructure will be automatically configured using OpenStack information. | ||
| > | ||
|
|
||
| ##### Network Topology section | ||
|
|
||
| This section shows you all the networks created on this OPCP via a vertical line of color. The squares correspond to services or dedicated servers connected to one or more of these networks. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Networks section | ||
|
|
||
| This section contains the list of networks available for dedicated servers on your **OPCP**. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| To find out more about how networks work with OpenStack, we recommend reading the [OpenStack Networking](https://docs.openstack.org/neutron/2024.1/admin/intro-os-networking.html) documentation. | ||
|
|
||
| ## 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). | ||
145 changes: 145 additions & 0 deletions
145
pages/hosted_private_cloud/opcp/opcp-getting-started/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,145 @@ | ||
| --- | ||
| title: "Mise en route de votre OPCP" | ||
| excerpt: "Découvrez comment prendre en main et configurer votre On-Prem Cloud Platform" | ||
| updated: 2025-12-02 | ||
| --- | ||
|
|
||
| ## Objectif | ||
|
|
||
| Ce guide a été conçu pour vous présenter comment vous connecter aux interfaces graphiques de votre **OPCP** en tant que qu'administrateur de ce service. | ||
|
|
||
| ## Prérequis | ||
|
|
||
| Afin de suivre ce guide, vous aurez besoin des informations suivantes : | ||
|
|
||
| - L'adresse **url** de l'interface de gestion définie pour la livraison du service. | ||
| - Les identifiants (login et mot de passe) fournies lors de la livraison du service. | ||
|
|
||
| ## En pratique | ||
|
|
||
| ### Composition de l'interface utilisateur | ||
|
|
||
| L'adresse **url** fournie vous permet d'accéder à l'interface utilisateur de **OPCP**. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Une fois vos identifiants utilisés pour vous enregistrer, vous aurez accès au tableau de bord du produit. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Votre interface vous permet d'accéder à : | ||
|
|
||
| - la configuration des utilisateurs au sein de *Keycloak* via le lien IAM sous votre identifiant. | ||
| - l'interface de gestion de OpenStack, *Horizon*. C’est une interface web graphique pour gérer l'ensemble de l'infrastructure OpenStack. Elle permet à l’utilisateur d’exploiter les ressources machines mises à disposition par les administrateurs. Ceci passe par la création, le lancement et l’arrêt des instances, la configuration des réseaux, la gestion de l’accessibilité des instances. | ||
|
|
||
| L’interface d’administration de **OPCP** regroupe également les accès aux différentes APIs telles que : Keystone (authentification et gestion des identités), Glance (gestion des images), Nova (service de calcul), Neutron (gestion du réseau), Ironic (gestion du matériel "Bare Metal") qui peuvent être utilisées au sein de vos automatisations. | ||
|
|
||
| ### Présentation de l'Interface OpenStack Horizon | ||
|
|
||
| L'interface graphique d'OpenStack Horizon offre la possibilité de réaliser différentes actions en fonction de leurs autorisations et du projet auquel ells appartiennent. Parmi les principales fonctionnalités disponibles pour un utilisateur final, on peut citer : la gestion des instances, la gestion des réseaux, le suivi des ressources. | ||
|
|
||
| #### Accès à l'interface d'administration OpenStack Horizon | ||
|
|
||
| Depuis l'espace utilisateur de **OPCP**, l’interface OpenStack Horizon est accessible via le lien dans le tableau de bord. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Après s’être connecté, l'interface Horizon OpenStack se présente ainsi : | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Le menu latéral situé à gauche de l'interface offre un accès aux différents éléments de l'interface. Il y a deux entrées parentes dans ce menu : | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| - **Projet** qui comprend quatre éléments : Aperçu (Overview), Accès à l'API (API Access), Compute et Réseau (Network). Ces éléments rassemblent l'ensemble des fonctionnalités de gestion des serveurs dédiés, de leurs réseaux, dans les limites de quotas définis. | ||
| - **Identité (Identity)** qui inclut les éléments Projets, Utilisateurs et identifiants d'application qui contiennent les fonctionnalités de gestion des utilisateurs. | ||
|
|
||
| #### Vue projet | ||
|
|
||
| L'élément principal *Projet* est composé de différents sous-éléments qui permettent d'accéder à toutes les fonctionnalités de gestion des ressources. Le premier sous-élément, appelé *Aperçu* (Overview), offre une vision globale des quotas de ressources attribuées au projet, ainsi qu’un suivi visuel de la consommation globale des ressources. | ||
|
|
||
| ##### Section Overview | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| La section *Overview* (Aperçu) est composée de deux parties principales : | ||
|
|
||
| - **Limit Summary** : Les limites de quotas attribuées au projet pour chaque type de ressource. Ceci permet également de visualiser le niveau de consommation des ressources par rapport aux capacités disponibles. | ||
|
|
||
| Les quotas sont regroupés en deux catégories, telles que représentées dans l'image ci-dessous : | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| - **Compute** qui comprend les limites des instances, les vCPUs et la RAM. | ||
| - **Network** qui surveille les quotas des ressources réseau : les adresses Floating IP, les groupes de sécurité, les règles de sécurité des groupes, les réseaux et les ports. | ||
|
|
||
| - **Usage Summary** (Résumé de l'utilisation) : historique d’utilisation des ressources sur une période qui permet d'observer l'évolution de l'usage des ressources dans le temps. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Section API Access | ||
|
|
||
| L'onglet **API-Access** regroupe les 10 services disponibles via API tels que Bare-Metal, Compute, identité, image et réseau, ainsi que leurs URL de point d'accès. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Grâce à ces *Endpoints*, il est possible de communiquer directement avec les composants OpenStack en utilisant des requêtes API. Ces informations vous sont nécessaires si vous êtes amené à implémenter vous-même des requêtes HTTP avec les API de OpenStack. | ||
|
|
||
| Si vous utilisez des intégrations OpenStack existantes, ces dernières récupéreront ces informations lors de la première connexion au composant OpenStack Keystone. Ce dernier se charge de fournir de manière programmatique ces informations. | ||
|
|
||
| #### Vue Compute | ||
|
|
||
| La vue **Compute** regroupe les fonctionnalités permettant de configurer les serveurs dédiés de votre produit. Cette vue est divisée en différentes sections : | ||
|
|
||
| ##### Section Instances | ||
|
|
||
| Interface permettant de lister et de gérer les serveurs dédiés déjà configurés. Une *Instance* correspond à un serveur dédié. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Section Images | ||
|
|
||
| Vous avez la possibilité de gérer les images des OS disponibles pour créer des instances. Il est aussi possible de télécharger de nouvelles images ou de sélectionner parmi les images déjà disponibles afin de mettre en place des instances. Vous pouvez ainsi générer vos propres images pour gérer des systèmes d'exploitation supplémentaires. | ||
|
|
||
| > [!warning] | ||
| > | ||
| > Les images doivent prendre en compte les drivers du hardware délivré dans votre produit. De nombreuses images disponible pour Glance ne sont disponibles que pour des environnements virtuels basés sur les drivers de qemu ou de kvm. | ||
| > | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Section Key Pairs | ||
|
|
||
| Afin de vous authentifier en SSH sur vos machines après l'installation, il faut utiliser des clés de chiffrement asymétriques. Cette interface permet d'importer les clés publiques ou de créer une paire de clés qui seront déployées durant l'installation des serveurs dédiés afin de vous assurer une connexion SSH. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| #### Vue Network | ||
|
|
||
| La Vue Network (réseau) vous permet de visualiser et gérer les réseaux de votre service **OPCP**. Cette interface permet de créer des réseaux mutualisés ou distincts entre vos serveurs dédiés. | ||
|
|
||
| > [!primary] | ||
| > | ||
| > L'ensemble de votre configuration réseau est pilotée par cette interface graphique ou via les API de **OpenStack** avec le composant réseau nommé **Neutron**. Les switchs de votre infrastructure seront automatiquement configurés à partir des informations de OpenStack. | ||
| > | ||
|
|
||
| ##### Section Network Topology | ||
|
|
||
| Cette section vous représente l'ensemble des réseaux créés sur ce OPCP via une ligne verticale de couleur. Les carrés correspondent à des services ou des serveurs dédiés connectés à un ou plusieurs de ces réseaux. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| ##### Section Networks | ||
|
|
||
| Cette section contient la liste des réseaux disponibles pour les serveurs dédiés sur votre **OPCP**. | ||
|
|
||
| {.thumbnail} | ||
|
|
||
| Pour en savoir plus sur le fonctionnement des réseaux avec OpenStack, nous vous conseillons de consulter la documentation [OpenStack Networking](https://docs.openstack.org/neutron/2024.1/admin/intro-os-networking.html). | ||
|
|
||
| ## 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
+58 KB
pages/hosted_private_cloud/opcp/opcp-getting-started/images/dashboard.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
+40.6 KB
...sted_private_cloud/opcp/opcp-getting-started/images/dashboard_login_horizon.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
+51.3 KB
pages/hosted_private_cloud/opcp/opcp-getting-started/images/horizon_dashboard.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.2 KB
pages/hosted_private_cloud/opcp/opcp-getting-started/images/horizon_image_list.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
+26.1 KB
...hosted_private_cloud/opcp/opcp-getting-started/images/horizon_instance_list.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
+25.9 KB
pages/hosted_private_cloud/opcp/opcp-getting-started/images/horizon_menu.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
+41.5 KB
.../hosted_private_cloud/opcp/opcp-getting-started/images/horizon_network_list.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
+47.1 KB
...ted_private_cloud/opcp/opcp-getting-started/images/horizon_network_topology.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
+60.7 KB
...ed_private_cloud/opcp/opcp-getting-started/images/horizon_project_apiaccess.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
+48.6 KB
...ted_private_cloud/opcp/opcp-getting-started/images/horizon_project_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
+46.2 KB
...ted_private_cloud/opcp/opcp-getting-started/images/horizon_quota_historical.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
+32.8 KB
...s/hosted_private_cloud/opcp/opcp-getting-started/images/horizon_sshkey_list.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
+87.5 KB
pages/hosted_private_cloud/opcp/opcp-getting-started/images/keycloak_login.png
Y0Coss marked this conversation as resolved.
Show resolved
Hide resolved
|
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/opcp-getting-started/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: c2bf929f-bf70-483a-85b6-8ce2251569a0 | ||
| full_slug: opcp-getting-started |
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.