For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/pt/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/pt/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/pt/guides/hosted-private-cloud/opcp/admin-console-getting-started.md.

OPCP Admin Console

Ver como Markdown

Find out how to log in to the OPCP Admin Console, create Organizations, deploy services and enable them for Organizations

Warning

Alpha version — This guide documents the alpha version of Cloud Store. Features, interfaces and procedures will change until general availability (GA), and this guide will be updated along with them.

Objective

This guide shows IT Admins how to use the OPCP Admin Console to create Organizations, deploy services from the Service Catalog and enable them for Organizations.

The OPCP Admin Console is the Cloud Store interface for IT Admins. For an overview of Cloud Store and its concepts, read the guide Getting started with Cloud Store.

Requirements

  • The URL of the OPCP Admin Console and your login credentials, provided during service delivery. These credentials are managed in the OPCP Admin Console Keycloak.
  • HTTPS access (TCP/443) to the OPCP Admin Console URL from your workstation.
  • Bare-metal hosts enrolled in OPCP Core and assigned to OpenStack projects, with available hosts for the services you plan to deploy.

Instructions

Logging in to the OPCP Admin Console

Navigate to the URL of the OPCP Admin Console and click Log in.

OPCP Admin Console login page

You are redirected to the Keycloak authentication page. You have two options to authenticate:

  • Enter your credentials directly in the Keycloak login form.
  • Use the OPCP-SSO button to authenticate through the federated OPCP Core Keycloak. This option allows users already registered in OPCP Core to log in without managing a separate set of credentials. It is required to manage Host Pools, as the user is then identified against OpenStack.
OPCP Admin Console Keycloak login form

Once authenticated, you land on the home page of the OPCP Admin Console.

OPCP Admin Console home page

The sidebar gives access to the following areas:

SectionContent
ServicesEach deployed service, as a shortcut to its Service Deployments.
ManagementOrganizations, Service Catalog and Deployments.
External linksOPCP Dashboard, to reach the OPCP Core tools.

Logging out

To log out, click your user badge at the top right, then choose the logout option in the menu.

The session expires after 30 minutes of inactivity, and at the latest 10 hours after you log in.

Creating an Organization

An Organization is an isolated environment that represents, for example, a company, a department or a team. Create it before enabling services for it.

  1. Go to Management > Organizations. The list shows each Organization with its admin and status. The icons of the Actions column open the OPCP Cloud Console of the Organization and its Keycloak administration console.

    List of Organizations with their admin, status and action icons
  2. Click Create a new organization.

  3. Enter the Organization name, for example dpt-real-estate.

  4. Enter the Organization Admin: email, first name and last name.

    Form to create an Organization and its Organization Admin
  5. Click Create. The Organization is pending, then active.

The platform automatically:

  • creates a dedicated Keycloak realm named account-{name};
  • creates the Organization Admin user. Their login is their email address;
  • sets a first-login default password, defined when Cloud Store was installed. The Organization Admin must change it at first login.
Warning

No email is sent to the Organization Admin. Once the Organization is active, send them their credentials yourself, as described in the Handing over to the Organization section below.

Deploying a service

A Service Deployment runs a service on bare-metal hosts that you allocate to Host Pools. It is deployed once, and you can then enable it for as many Organizations as needed.

  1. Go to Management > Service Catalog. The catalogue shows the services available on your platform, their latest version and whether they are deployed. To update the catalogue, contact OVHcloud support.

    Service Catalog listing the services available on the platform
  2. Open a service. The page lists its existing Service Deployments. Click New deployment.

    Service Deployments of a service
  3. Choose the version of your service, then click Next.

    Choosing the service version in the deployment wizard
  4. Allocate the host pools. For each Host Pool required by the service, for example compute and block-storage for Compute and Block Storage, select the OpenStack project and the hosts to use. The prerequisites of the service (number and type of hosts) are displayed above the list.

    Selecting the OpenStack project and hosts of each Host Pool
  5. Configure your service with the properties defined by the service.

  6. Click Deploy.

Info

Only hosts available in OpenStack are listed. The selected hosts are wiped and reinstalled during the deployment.

Service deployment is asynchronous: the console confirms that the deployment has started, and provisioning runs in the background through Kubernetes and OpenTofu. Its duration depends on the service, from a few minutes to several hours for the most complex ones.

Following a Service Deployment

All Service Deployments are collected in Management > Deployments. They also appear under the service name in the sidebar.

A Service Deployment, like an Enabled Service, has one of three statuses:

StatusMeaning
deployingThe deployment is in progress.
deployedThe deployment is complete.
deletingThe deletion is in progress.

The page of a Service Deployment shows its version, its status and the following tabs:

Service Deployment page with its Organizations, Host pools, Outputs and Settings tabs
TabContent
OrganizationsThe Organizations this Service Deployment is enabled for. Enable for organization enables it for another Organization.
Host poolsThe hosts of each Host Pool: name, management IP, manufacturer, model, CPU, RAM and disk.
OutputsEndpoints and files produced by the service.
SettingsThe configuration chosen at deployment.
Host Pools of a Service Deployment

Scaling capacity

To add hosts to a Service Deployment, open its ⋮ menu and choose Expand capacity. Select available hosts from its OpenStack project, then confirm. The same action exists on Enabled Services that have a dedicated Host Pool.

Actions menu of a Service Deployment Selecting hosts to expand the capacity of a Service Deployment

Scaling is asynchronous: Kubernetes reconciles the configuration and provisions the new hosts.

Enabling a service for an Organization

Enabling a Service Deployment for an Organization creates an Enabled Service. It makes the service visible in the OPCP Cloud Console of the Organization. The platform also creates the necessary Keycloak resources (client, roles and groups) in the Organization's realm, so that only the users of that Organization can access the service.

The Service Deployment must be deployed and the Organization must exist.

  1. In the Organizations tab of the Service Deployment, click Enable for organization. You can also start from the page of an Organization, with Enable a service.

  2. Name your enabled service and select the Organization. If you do not enter a name, the technical ID is used.

    Enabling a service for an Organization
  3. Allocate the host pool when the service needs hosts dedicated to the Organization. For services whose hosts are shared between Organizations, this step is marked not applicable.

  4. Configure your enabled service with the properties defined by the service.

  5. Confirm. The Enabled Service is deploying, then deployed.

The page of an Organization lists its Enabled Services, with their Service Deployment and service type.

Organization page listing its Enabled Services

Disabling a service or deleting a Service Deployment

Every Enabled Service can be disabled. Open the Enabled Service from the Organization page, then choose Delete in its ⋮ menu.

Actions menu of an Enabled Service

A Service Deployment can only be deleted once it has no Enabled Services left. Disable its Enabled Services first, then choose Delete in the ⋮ menu of the Service Deployment. As long as Enabled Services remain, the action is greyed out.

During the deletion, the Enabled Service or Service Deployment is deleting. Once the deletion is complete, its hosts are available again.

Handing over to the Organization

Once the Enabled Service is deployed, the Organization's users find it in the OPCP Cloud Console. From the Organization page, you can open the Enabled Service: its Outputs tab shows the technical data of its deployment. Services can add their own tabs, such as Compute.

Outputs of an Enabled Service

Then send the Organization Admin:

  • the OPCP Cloud Console URL: in Management > Organizations, the house icon opens it with the Organization already selected;
  • their login: the email address entered when creating the Organization;
  • the first-login default password defined at Cloud Store installation.
Warning

The first-login default password is shared and defined at installation. The Organization Admin must change it at their first login.

The Organization Admin can then follow the guide OPCP Cloud Console.

Managing IAM on the OPCP Admin Console Keycloak

To manage users, roles and groups on the OPCP Admin Console Keycloak, first assign the cloudstore-admins role to your user in the OPCP Core Keycloak.

  1. Log in to the OPCP Core Keycloak administration console.

  2. Open the user you want to grant IAM management rights to.

  3. In the Role mapping tab, assign the cloudstore-admins client role.

    Assigning the cloudstore-admins role in OPCP Core Keycloak

Once this role is assigned, the user has the permissions needed to administer the OPCP Admin Console Keycloak, including managing realms, clients, users and roles.

Go further

Getting started with Cloud Store

OPCP Cloud Console

For training or technical assistance implementing our solutions, contact your sales representative or visit our Professional Services page to request a quote and have your project analysed by our experts.

Join our community of users.

Esta página foi útil?