Creating a private network with Gateway

View as Markdown

Discover how to create a private network with a Gateway via the OVHcloud Control Panel, OVHcloud API, OVHcloud CLI, OpenStack API, or Terraform

Objective

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.

Learn how to create a private network with a Gateway.

Requirements

A Public Cloud project in your OVHcloud account
For the OVHcloud API: API credentials (First steps with the OVHcloud API)
For the OVHcloud CLI: the OVHcloud CLI installed and configured with your credentials
For the OpenStack API: an OpenStack environment configured (Preparing the environment)
For Terraform: Terraform installed and the OVHcloud provider configured (How to use Terraform)

OVHcloud Control Panel Access

Direct link:
Navigation path: Public Cloud > Select your project

Instructions

Gateway models

Before creating a Gateway, choose the model suited to your bandwidth needs:

Model	Bandwidth
S	up to 200 Mbps
M	up to 500 Mbps
L	up to 2 Gbps
XL	up to 4 Gbps
2XL	up to 8 Gbps
3XL	up to 16 Gbps

Create a private network with a Gateway

OVHcloud Control Panel

OVHcloud API

OVHcloud CLI

OpenStack API

Terraform

Step 1 — Access the creation page

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

You must have an active vRack before proceeding. If you do not have a vRack, consult the vRack activation section of the relevant guide.

Next, click on Create a Gateway.

Step 2 — Select the region and size

Select the region where you want to deploy the Gateway. It is best to choose the region where your private instances are located.

Then select the size of your Gateway (see the models table above).

Step 3 — Name the Gateway and attach a private network

Edit the default name of your Gateway and select an existing private network from the drop-down list.

Info

Only single-region private networks are supported by Gateway.

You can also click on Add private network to create a new private network inline.

In the popup window, enter a name for your private network, select a subnet and click on Add.

Step 4 — Confirm creation

Click on Create a Gateway to start the deployment.

The creation may take several minutes. Refresh the page if necessary.

Once done, the private network is visible in the Private Network section under Network.

The Gateway appears in the Gateway section.

Retrieve the project ID

If the project ID is unknown, use the following calls:

GET/cloud/project

Info

This call retrieves the list of projects.

GET/cloud/project/{serviceName}

Info

This call identifies the project via the "description" field.

Create the private network with a Gateway

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

Fill in the fields according to the following table:

Field	Description
`serviceName`	Your project ID
`regionName`	Example: `GRA9`
`model`	Gateway size (`s`, `m`, `l`, `xl`, `2xl`, `3xl`)
`name`	Name for your Gateway (`null` for default)
`network.name`	Name for the private network (`null` for default)
`network.cidr`	IP block for your subnet (e.g. `192.168.1.0/24`)
`network.enableDhcp`	Check box to enable DHCP
`network.ipVersion`	`4` (IPv6 not available)
`network.vlanId`	Value between 2 and 4000, or empty for automatic assignment

Info

Repeat for each region where your private instances are present.

To verify the details of your Gateway:

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

Leave subnetId blank to list all Gateways in the specified region.

Use the OVHcloud CLI to create a private network with a Gateway. Set your cloud project with --cloud-project <project_id> or configure it in your profile.

Create a Gateway with a new private network:

ovhcloud cloud network gateway create <region> \
  --cloud-project <project_id> \
  --name my-gateway \
  --model s \
  --network-name my-network \
  --subnet-cidr 192.168.1.0/24 \
  --subnet-enable-dhcp \
  --wait

Create a Gateway in an existing private network:

ovhcloud cloud network gateway create <region> \
  --cloud-project <project_id> \
  --name my-gateway \
  --model s \
  --network-id <network_id> \
  --subnet-id <subnet_id> \
  --wait

Available models: s, m, l, xl, 2xl, 3xl.

Info

Only single-region private networks are supported by Gateway.

Before proceeding, consult the following guides:

Step 1 — Create a network and subnet

openstack network create my_network

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

Step 2 — List quality of service policies

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 |
+--------------------------------------+---------------+--------+---------+----------------------------------+

Step 3 — Create the router and configure the Gateway

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.

Before proceeding, consult the guide: How to use Terraform

Create a Terraform file (e.g. private_network_gateway.tf) with the following content:

resource "ovh_cloud_project_network_private" "mypriv" {
  service_name = "<project_id>"
  vlan_id      = "0"
  name         = "mypriv"
  regions      = ["GRA9"]
}

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       = "GRA9"
  start        = "10.0.0.2"
  end          = "10.0.255.254"
  network      = "10.0.0.0/16"
  dhcp         = true
}

resource "ovh_cloud_project_gateway" "gateway" {
  service_name = ovh_cloud_project_network_private.mypriv.service_name
  name         = "my-gateway"
  model        = "s"
  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
}

Apply the configuration:

terraform apply

Go further

Learn more about Gateway and its scenarios on our dedicated page.

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 analyzed by our experts.

Join our community of users.

Was this page helpful?