Skip to main content

Creating a private network with Gateway

Stephanie R.
Updated

Learn how to create a private network with a gateway.

A Gateway offers a secure outbound connection method from your private network instances or the ability to use Floating IPs with your instance or Load Balancer for service exposition.

This can be created via the OVHcloud Control Panel, the OpenStack API, or the OVHcloud API.

 

Requirements

 

Instructions

Via the OVHcloud Control Panel

Log in to the OVHcloud Control Panel and open your Public Cloud project.

Click on Gateway in the left-hand menu under Network.

Please note that you need to have activated the vRack before proceeding. If you do not have a vRack, please consult this section of the relevant guide.

Next, click Create a Gateway.

PCI_createGateway.png

First, select a location. It is best to create a Public Gateway in the region where you intend to deploy your private instances.

PCI_createGateway_selectLocation.png

Select your gateway size.

PCI_createGateway_selectSize.png

The next step allows you to edit the default name of your gateway and attach a private network to it. You can use the drop-down list to Select a private network. Be aware that only single-region private networks are supported by Gateway.

PCI_createGateway_attachExistingNetwork.png

Otherwise, click on Add a private network to create one (in a simplified dialog box with predefined values).

In the pop-up window, enter a name for your private network, select a subnet, and click Add.

PCI_createGateway_attachNewNetwork.png

Once the network has been added, click Create a gateway.

PCI_createGateway_attachExistingNetwork.png

The creation may take several minutes, you may need to refresh the page after a couple of minutes to display the new service.

Once the creation is done, you now have a private network linked to a public gateway.

You can view the new gateway in the Gateway section.

PCI_listGateways.png

To view your newly created private network, click on Private Networks in the left-hand menu under Network.

PCI_listPrivateNetworks.png

 

Via Terraform

Before proceeding, it is recommended that you consult our How to Use Terraform guide.

Once your environment is ready, you can create a Terraform file called 'private_network_simple.tf' and write the following:

# Create a Private Network
resource "ovh_cloud_project_network_private" "mypriv" {
  service_name  = "my_service_name"  # Replace with your OVHcloud project ID
  vlan_id       = "0"             # VLAN ID (usually 0)
  name          = "mypriv"
  regions       = ["US-EAST-VA-1"]
}
# Create a private subnet
resource "ovh_cloud_project_network_private_subnet" "myprivsub" {
  service_name  = ovh_cloud_project_network_private.mypriv.service_name
  network_id    = ovh_cloud_project_network_private.mypriv.id
  region        = "US-EAST-VA-1"
  start         = "10.0.0.2"
  end           = "10.0.255.254"
  network       = "10.0.0.0/16"
  dhcp          = true
}
# Create a custom gateway
resource "ovh_cloud_project_gateway" "gateway" {
  service_name = ovh_cloud_project_network_private.mypriv.service_name
  name         = "my-gateway"
  model        = "s"  # Gateway model ("s" for small, "m" for medium, etc.)
  region       = ovh_cloud_project_network_private_subnet.myprivsub.region
  network_id   = tolist(ovh_cloud_project_network_private.mypriv.regions_attributes[*].openstackid)[0]
  subnet_id    = ovh_cloud_project_network_private_subnet.myprivsub.id
}

You can create your resources by entering the following command:

terraform apply

 

Via the OpenStack API

Before proceeding, it is recommended that you consult these guides:

Once your environment is ready, type the following at the command line:

openstack network create my_network

openstack subnet create my_subnet --subnet-range <my_private_ip_range/mask> --network my_network --no-dhcp

List the quality of service available.

openstack network qos policy list
+--------------------------------------+---------------+--------+---------+----------------------------------+
| ID                                   | Name          | Shared | Default | Project                          |
+--------------------------------------+---------------+--------+---------+----------------------------------+
| a5524eb5-944e-4106-b209-9478bbdcedab | large_router  | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| c210f5b2-db59-4973-a25f-9131195b6bcf | medium_router | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| ec0ee74d-a1f3-43f6-87aa-b0e69ef8ce45 | small_router  | True   | False   | XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
+--------------------------------------+---------------+--------+---------+----------------------------------+
openstack router create my_router 

openstack router add subnet my_router my_subnet

openstack router set --external-gateway Ext-Net --qos-policy QOS_ID_OF_YOUR_CHOICE my_router

If you omit the --qos-policy parameter the "small" quality of service will be applied.

 

Via the OVHcloud API

Log in to the OVHcloud APIv6 interface according to the relevant guide (First steps with the OVHcloud API).

In case the project ID is unknown, the calls below allow you to retrieve it.

To retrieve a list of projects:

GET /cloud/project

To identify the project via the "description" field:

GET /cloud/project/{serviceName}

Create your private network and gateway:

POST /cloud/project/{serviceName}/region/{regionName}/gateway

Fill in the fields according to the following table.

Field Description
serviceName 'The ID of your project'
regionName Example: US-VA-EAST-1
model size of your gateway (s, m, l, xl, 2xl) depending on your needs
name set a name for your gateway, you can click on the dropdown arrow and select "null" for a default one
name set a name for your private network, you can click on the dropdown arrow and select "null" for a default one
cidr IP block for your subnet
enableDhcp check the box for yes
ipVersion 4

The VLAN identifier (vlanId) is required if you want to create a specific VLAN. You can enter a value (between 2 - 4000) or leave it empty. If left empty, the system will automatically assign one by default.

This is the step of creating the private network and gateway by region.

You will need to do the same for each region where your private instances are present.

The creation will take a few minutes.

To verify the details of your gateway, you can use the following API call:

GET /cloud/project/{serviceName}/region/{regionName}/gateway

 

Go further

For more information and tutorials, please see our other Public Cloud support guides or explore the guides for other OVHcloud products and services.

Related articles