Creating public gateways

Creating a public gateway in the UI

To create a public gateway using the IBM Cloud console, follow these steps:

1. Go to the IBM Cloud console and log in to your account.

2. Select the Navigation Menu icon, then click VPC Infrastructure > Public gateways. The Public gateways for VPC page shows.

3. Click Create to go to the Create public gateway page.

4. Select the Edit location icon and enter values for the following fields:

   • Geography - Select a continent for your public gateway.
   • Region - Select a region for your public gateway.
   • Zone - Select a zone for your public gateway.

5. Enter values for the following fields under details:

   • Public gateway name - Type a unique name for your public gateway.

   • Resource group - Select a resource group for your public gateway collector. You can use the default group for this public gateway, or select from the list (if defined). For more information, see Best practices for organizing resources in a resource group. After provisioning is complete, you cannot change the resource group.

   • VPC - Select a VPC. You can use the default VPC for this public gateway, or select from the list (if defined). For more information, see Getting started with Virtual Private Cloud.

   • Tags - Optionally, add user tags. User tags are visible account-wide. For more information, see Working with tags.

   • Access management tags - Optionally, add access management tags to help organize access control relationships. For more information, see Controlling access to resources by using tags.

6. Copy a sample API call (optional).

7. Click Create.

8. If you don't have a paid account, Upgrade your account might appear instead of Create. If this option is shown, click to update your account to a paid account before creating your public gateway. For more information, see Upgrading your account.

Creating a public gateway from the CLI

Attach a public gateway to the subnet if you want to allow all attached resources to communicate with the public internet.

To create a public gateway, run the following command:

ibmcloud is public-gateway-create my-gateway $vpc us-south-3

From the output that's returned, save the ID in a variable so you can use it later, for example:

gateway="0738-446c0c63-f0b1-4043-b30d-644f55fde391"

To attach the public gateway to your subnet, run the following command:

ibmcloud is subnet-update $subnet --public-gateway-id $gateway

Only one public gateway per zone is allowed in a VPC, but that public gateway can be attached to multiple subnets in the zone. To find the public gateway for a zone, run the ibmcloud is public-gateways command and look for the particular VPC and zone values.

Creating a public gateway with the API

Attach a public gateway to the subnet if you want to allow all attached resources to communicate with the public internet.

Create a public gateway for the zone:

curl -X POST "$vpc_api_endpoint/v1/public_gateways?version=$api_version&generation=2" \
  -H "Authorization:$iam_token" \
  -d '{
        "name": "my-gateway",
        "zone": { "name": "us-south-2" },
        "vpc": { "id": "'$vpc'" }
      }'

Save the ID of the public gateway in a variable.

gateway="0738-ad0cded3-53a3-4d4a-9809-8c59b50d2b80"

Attach the public gateway to your subnet.

curl -X PUT "$vpc_api_endpoint/v1/subnets/$subnet/public_gateway?version=$api_version&generation=2" \
  -H "Authorization:$iam_token" \
  -d '{
        "id": "'$gateway'"
      }'

Only one public gateway per zone is allowed in a VPC, but that public gateway can be attached to multiple subnets in the zone. To find the public gateway for a zone, run the 'ibmcloud is public-gateways` command and look for the particular VPC and zone values.

You can then retrieve and view the public gateway that is attached to the subnet by running the following command.

curl -X GET "$vpc_api_endpoint/v1/subnets/$subnet/public_gateway?version=$api_version&generation=2" \
  -H "Authorization: $iam_token"