For AI agents: the complete documentation index is available at https://docs.ovhcloud.com/en/llms.txt, the full documentation bundle is available at https://docs.ovhcloud.com/en/llms-full.txt, and this page is available as Markdown at https://docs.ovhcloud.com/en/guides/public-cloud/data-analytics/analytics/update-cluster-network.md.

Update the network configuration of Analytics

View as Markdown

Find out how to switch your Analytics service between the public network (Internet) and a private vRack network via the OVHcloud API

Objective

Learn how to switch your Analytics service between the public network (Internet) and a private network (vRack) without recreating the service.

Requirements

Considerations

  • The network update triggers a service rebuild, during which the service is temporarily unavailable.
  • When switching from private to public network, existing IP restrictions are cleared. Reconfigure them once the service returns to READY status.
  • Ensure your service is in READY status before changing the network. The API rejects the request if the service is in another status (e.g. UPDATING, CREATING).

Instructions

Switching from public to private network

To move an Analytics service that is currently on the public network to a private network, send a PUT request with the networkId (vRack network ID) and subnetId (vRack subnet ID):

PUT/cloud/project/{serviceName}/database/kafka/{clusterId}
Info

Replace kafka in every route on this page with your engine type (e.g. clickhouse, grafana, etc.).

Include the following fields in the request body:

{
  "networkId": "<private-network-uuid>",
  "subnetId": "<subnet-uuid>"
}

The service status transitions to UPDATING. Monitor it using:

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

Once the status returns to READY, your service is available on the private network.

Switching from private to public network

To move your Analytics service back to the public network, send a PUT request with networkId and subnetId set to null:

PUT/cloud/project/{serviceName}/database/kafka/{clusterId}

Include the following fields in the request body:

{
  "networkId": null,
  "subnetId": null
}
Warning

Switching to the public network clears all existing IP restrictions. Once the service returns to READY status, reconfigure your authorised IPs.

The service status transitions to UPDATING. Monitor it as shown above, then reconfigure your IP restrictions as described below.

Reconfiguring IP restrictions

If the switch cleared your IP restrictions, reconfigure them once the service returns to READY status by sending a PUT request with the ipRestrictions field:

PUT/cloud/project/{serviceName}/database/kafka/{clusterId}

Include the following fields in the request body:

{
  "ipRestrictions": [
    {
      "ip": "203.0.113.0/24",
      "description": "My allowed network"
    }
  ]
}
Warning

Until IP restrictions are reconfigured, no client can connect to your service. For security, the default network configuration blocks all incoming connections.

Verifying the network configuration

Once the service returns to READY status, confirm the network type:

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

The networkType field in the response indicates the current configuration: public or private.

We want your feedback!

We would love to help answer questions and appreciate any feedback you may have.

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.

Are you on Discord? Connect to our channel at https://discord.gg/ovhcloud and interact directly with the team that builds our Analytics service!

Join our community of users.

Was this page helpful?