For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/it/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/it/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/it/guides/public-cloud/data-analytics/analytics/getting-started.md.
Find out how to set up your managed analytic service in the OVHcloud Console
Objective
OVHcloud Public Cloud Analytics services let you focus on building and deploying cloud applications while OVHcloud handles the analytics infrastructure and maintenance.
This guide explains how to order a Public Cloud Analytics service via the OVHcloud Console, API, CLI, or Terraform.
Terraform installed (Terraform method only — tested with version v1.14.6)
OVHcloud Console Access
Direct link:
Navigation path:Public Cloud > Select your project > Analytics
Instructions
OVHcloud Console
OVHcloud API
OVHcloud CLI
Terraform
In the left-hand menu of your Public Cloud project, the Analytics group gives access to Kafka (Kafka, Kafka Connect and Kafka MirrorMaker), ClickHouse, OpenSearch and Managed Dashboards. Click the product of your choice, then Create a service. The Create a service page for that product opens.
Step 1: Select your engine and version
Under Database engine, select the engine and its Version. Optionally rename your service in the Name field (auto-generated by default).
Step 2: Select a region
Under Select a region, choose the geographical region of the data centre in which your analytics service will be hosted.
Step 3: Select a service plan
Under Plan, choose a service plan. You can upgrade it after creation.
See the capabilities page of your selected analytics type for plan property details.
Step 4: Select your node type
Under Node type, select the node model. The number of nodes is set by the plan selected above.
See the capabilities page of your selected analytics service type for hardware and configuration details.
Take note of the pricing information.
Step 5: Sizing
Additional storage can be ordered under Storage and, depending on the engine, the number of nodes in your cluster can be adjusted under Nodes.
Step 6: Configure the network and IP restrictions
Connecting a private network (optional)
Under Network, if you already have a private subnet available, select Private network (vRack), then choose the Private network and the Subnet. This option may not be available for the selected service type.
If no private network exists in the region, the Create a private network link redirects you to create one. In that case, you will need to restart the analytics service order.
Under IP restrictions, add the IP addresses or address ranges allowed to connect to your service (Add an IP, Add my current IP).
Info
For security, the default network configuration blocks all incoming connections. Authorise a suitable IP address to access your analytics service.
Step 7: Summary and confirmation
The Summary of your order updates as you make selections. Review it, then click Create the database to confirm.
To view the equivalent API or Terraform call before ordering, click API and Terraform equivalent.
Your analytics service deploys within a few minutes. Its status changes to Active when it is ready to use.
To configure your service after installation, see the Configure your instance to accept incoming connections guide for your analytics service type, available in our catalog.
The call returns an object listing the allowed engines (with versions), plans, and flavors.
Get the availability
The availability endpoint lists the valid parameter combinations. For example, an OpenSearch Essential plan allows clusters with a single node, whereas Business uses 3 nodes and Enterprise 6 nodes. Choose the combination that best fits your needs.
This password will not be available later: OVHcloud does not store user passwords.
Step 5: Start using the cluster
The cluster connection information is available in the Connection details card of the Overview tab of your service in the OVHcloud Console. You can now use the cluster.
Info
All commands require either the --cloud-project <projectId> flag or the OVH_CLOUD_PROJECT_SERVICE environment variable, set to your Public Cloud project ID.
For security, the default network configuration blocks all incoming connections. Authorise a suitable IP address to access your analytics service.
For private networking, add --network-id <networkId> and --subnet-id <subnetId>.
Step 3: Wait for your analytics service to be ready
ovhcloud cloud managed-analytics get <clusterId> --cloud-project <projectId>
Its status transitions to READY when the cluster is available.
Step 4: Reset the primary user password
# List users and retrieve the admin user IDovhcloud cloud managed-analytics user list <clusterId> --cloud-project <projectId># Reset the admin user passwordovhcloud cloud managed-analytics user credentials-reset <clusterId> <userId> --cloud-project <projectId>
Warning
This password will not be available later: OVHcloud does not store user passwords.
Step 5: Start using the cluster
The cluster connection information is available in the Connection details card of the Overview tab of your service in the OVHcloud Console. You can now use the cluster.
Step 1: Gather the OVHcloud required parameters
The OVHcloud Terraform provider requires the following credentials:
The service_name is the ID of your Public Cloud project. To copy it, click the Project selector at the top of the left-hand menu of your Public Cloud project, then click the copy icon on the row of your project.
Step 2: Gather the set of required parameters
To create a new OpenSearch cluster, specify at least:
Visit our dedicated Discord channel to ask questions, provide feedback, and interact directly with the team that builds our Analytics services.
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.