Getting started with Analytics

Find out how to set up your managed analytic service in the OVHcloud Control Panel

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 Control Panel, API, CLI, or Terraform.

Requirements

A Public Cloud project in your OVHcloud account
Access to the OVHcloud API (API and Terraform methods — create your credentials by consulting the First steps with the OVHcloud API guide)
Terraform installed (Terraform method only — tested with version v1.14.6)

Instructions

Via the OVHcloud Control Panel

Via the OVHcloud API

Via the OVHcloud CLI

Via Terraform

Log in to your , open the Public Cloud section, and select your project. In the left-hand navigation under Databases & Analytics, click Analytics to access Kafka, Kafka Connect, Kafka MirrorMaker, Dashboards, or OpenSearch.

Click Create your managed analytics service (or Create a service if your project already contains analytics services).

Step 1: Select your engine and version

Optionally rename your service (auto-generated by default), then select the engine and version.

Step 2: Select a datacentre

Choose the geographical region of the data centre in which your analytics service will be hosted.

Step 3: Select a service 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 instance

Select the instance. The number of nodes is set by the solution selected above, and cannot be modified in this case.

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 and, depending on the engine, the number of nodes in your cluster can be adjusted.

Step 6: Configure your options

Configure the network and authorised IPs.

Connecting a private network (optional)

If you already have a private subnet available, select Private network (vRack) and choose it from the drop-down menu. This option may not be available for the selected service type.

You can be redirected to create a private network or subnet via the corresponding links. In that case, you will need to restart the analytics service order.

For detailed instructions, see the Configuring vRack for Public Cloud guide.

Authorised IPs

Add the IP addresses or address ranges allowed to connect to your service.

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 right-hand panel displays a live summary of your order that updates as you make selections. Review it, then click Order 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. Messages in the OVHcloud Control Panel notify you when the analytics service 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.

Configuration options vary by analytics type. Examples are available in the public-cloud-databases-examples repository.

Step 1: Gather the set of required parameters

To create an analytics service, specify at minimum:

an engine, and its version (e.g. opensearch 2.0)
the plan (e.g. business)
the nodes of the cluster (e.g. 3 nodes with 4 cores, 15 GiB memory, 100 GiB disk)

List the capabilities

The capabilities endpoint lists the allowed engine, plan, and flavor values.

GET/cloud/project/{serviceName}/database/capabilities

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 allows 3 to 8 nodes. Choose the combination that best fits your needs.

GET/cloud/project/{serviceName}/database/availability

Step 2: Create an OpenSearch analytics service

Warning

Creating a cluster incurs charges.

POST/cloud/project/{serviceName}/database/opensearch

description: a human-readable description for the service.
plan: the desired plan.
version: the OpenSearch version.
nodesPattern: specify the flavor, region, and number of nodes.
nodeslist: leave undefined — use nodesPattern instead for same-region, same-flavor clusters.
ipRestrictions: IP address blocks allowed to connect.

Info

For security, the default network configuration blocks all incoming connections. Authorise a suitable IP address to access your analytics service.

For private networking, also specify networkId (vRack ID) and subnetId (vRack subnet ID).

The call returns the cluster object. Its status is CREATING. Note the id for the next step.

Step 3: Wait for your analytics service to be ready

The cluster takes a few minutes to become usable. Check its status using:

GET/cloud/project/{serviceName}/database/opensearch/{clusterId}

Its status transitions to READY when the cluster is available.

Step 4: Reset the primary user password

List your cluster's users to get the admin user ID:

GET/cloud/project/{serviceName}/database/opensearch/{clusterId}/user

Reset the admin user's password:

POST/cloud/project/{serviceName}/database/opensearch/{clusterId}/user/{userId}/credentials/reset

Note the new password to connect to the cluster.

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 your OVHcloud Control Panel. 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.

Step 1: Gather the set of required parameters

List available engines, plans, and node flavors:

ovhcloud cloud reference managed-analytics list-engines --cloud-project <projectId>
ovhcloud cloud reference managed-analytics list-plans --cloud-project <projectId>
ovhcloud cloud reference managed-analytics list-node-flavors --cloud-project <projectId>

Step 2: Create an OpenSearch analytics service

Warning

Creating a cluster incurs charges.

ovhcloud cloud managed-analytics create \
  --cloud-project <projectId> \
  --engine opensearch \
  --version 2.0 \
  --plan business \
  --nodes-pattern.flavor db1-7 \
  --nodes-pattern.region GRA \
  --nodes-pattern.number 3 \
  --description "My OpenSearch cluster" \
  --ip-restrictions "203.0.113.0/24"

Info

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 ID
ovhcloud cloud managed-analytics user list <clusterId> --cloud-project <projectId>

# Reset the admin user password
ovhcloud 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 your OVHcloud Control Panel. You can now use the cluster.

Step 1: Gather the OVHcloud required parameters

The OVHcloud Terraform provider requires the following credentials:

an application_key
an application_secret
a consumer_key

To retrieve them, follow the First steps with the OVHcloud APIs guide. Generate credentials with the following rights:

GET /cloud/project/*/database/*
POST /cloud/project/*/database/*
PUT /cloud/project/*/database/*
DELETE /cloud/project/*/database/*
Generate OVHcloud API tokens (EU)
Generate OVHcloud API tokens (CA)

The service_name is the ID of your Public Cloud project. Retrieve it via the Copy to clipboard button in the Public Cloud section.

Step 2: Gather the set of required parameters

To create a new OpenSearch cluster, specify at least:

the engine (e.g. opensearch)
the version (e.g. 3.3)
the region (e.g. EU-WEST-PAR)
the plan (e.g. production)
the flavor (e.g. b3-8)

Step 3: Create Terraform files

Create a main.tf file:

terraform {
  required_providers {
    ovh = {
      source  = "ovh/ovh"
      version = ">= 2.11.0"
    }
  }
}

provider "ovh" {
  endpoint           = var.ovh.endpoint
  application_key    = var.ovh.application_key
  application_secret = var.ovh.application_secret
  consumer_key       = var.ovh.consumer_key
}

resource "ovh_cloud_project_database" "service" {
  service_name = var.product.project_id
  description  = var.product.name
  engine       = var.product.engine
  version      = var.product.version
  plan         = var.product.plan
  nodes {
    region = var.product.region
  }
  nodes {
    region = var.product.region
  }
  nodes {
    region = var.product.region
  }
  flavor = var.product.flavor
  ip_restrictions {
    ip = var.product.ip
  }
}

resource "ovh_cloud_project_database_opensearch_user" "analyticsuser" {
  service_name = ovh_cloud_project_database.service.service_name
  cluster_id   = ovh_cloud_project_database.service.id
  name         = var.access.name
}

Create a variables.tf file:

variable "ovh" {
  type = map(string)
  default = {
    endpoint           = "ovh-eu"
    application_key    = ""
    application_secret = ""
    consumer_key       = ""
  }
}

variable "product" {
  type = map(string)
  default = {
    project_id = ""
    name       = ""
    engine     = ""
    region     = "EU-WEST-PAR"
    plan       = "production"
    flavor     = "b3-8"
    version    = ""
    ip         = "0.0.0.0/32"
  }
}

variable "access" {
  type = map(string)
  default = {
    name = "johndoe"
  }
}

Use ovh-eu for the OVHcloud Europe API, or ovh-ca for North America.

Create a secrets.tfvars file with your actual values:

ovh = {
  endpoint           = "ovh-eu"
  application_key    = "<application_key>"
  application_secret = "<application_secret>"
  consumer_key       = "<consumer_key>"
}

product = {
  project_id = "<service_name>"
  name       = "opensearch-terraform"
  engine     = "opensearch"
  region     = "EU-WEST-PAR"
  plan       = "production"
  flavor     = "b3-8"
  version    = "3.3"
  ip         = "<ip_range>"
}

access = {
  name = "johndoe"
}

Info

Replace <service_name>, <application_key>, <application_secret>, <consumer_key>, and <ip_range> with your actual values.

Create an outputs.tf file:

output "cluster_uri" {
  value = ovh_cloud_project_database.service.endpoints.0.uri
}

output "user_name" {
  value = ovh_cloud_project_database_opensearch_user.analyticsuser.name
}

output "user_password" {
  value     = ovh_cloud_project_database_opensearch_user.analyticsuser.password
  sensitive = true
}

Step 4: Run

terraform init
terraform plan -var-file=secrets.tfvars
terraform apply -var-file=secrets.tfvars -auto-approve

Export the credentials and URI:

export PASSWORD=$(terraform output -raw user_password)
export USER=$(terraform output -raw user_name)
export URI=$(terraform output -raw cluster_uri)

Your OpenSearch cluster is now ready.

A Kafka example is available in the public-cloud-databases-examples/kafka/terraform repository.

Go further

OpenSearch capabilities

Starting with OpenSearch analytics service

Configuring vRack for Public Cloud

Visit our dedicated Discord channel to ask questions, provide feedback, and interact directly with the team that builds our Analytics services.

If you need training or technical assistance to implement our solutions, contact your sales representative or our Professional Services experts for a quote and a custom analysis of your project.

Join our community of users.

Was this page helpful?