Skip to content

Commit f20abfb

Browse files
RoRoJnerda-codesjcirinosclwy
authored
fix(pgw): doc review (#4100)
* fix(pgw): doc review * Update network/public-gateways/quickstart.mdx Co-authored-by: nerda-codes <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: nerda-codes <[email protected]> Co-authored-by: Jessica <[email protected]>
1 parent 12894ec commit f20abfb

File tree

7 files changed

+44
-28
lines changed

7 files changed

+44
-28
lines changed
14.3 KB
Loading

network/public-gateways/how-to/create-a-public-gateway.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
meta:
33
title: How to create a Public Gateway
4-
description: This page explains how to create a Public Gateway
4+
description: Discover how to create a Public Gateway on Scaleway. Follow this comprehensive guide to enable internet access and manage network traffic effectively.
55
content:
66
h1: How to create a Public Gateway
7-
paragraph: This page explains how to create a Public Gateway
7+
paragraph: Discover how to create a Public Gateway on Scaleway. Follow this comprehensive guide to enable internet access and manage network traffic effectively.
88
tags: public-gateway public gateway
99
dates:
10-
validation: 2024-06-05
11-
posted: 2021-05-26
10+
validation: 2024-12-10
11+
posted: 2024-12-10
1212
categories:
1313
- network
1414
---
@@ -27,9 +27,9 @@ categories:
2727
3. Complete the following steps in the wizard:
2828
- Choose an **Availability Zone**, which is the geographical location in which your Public Gateway will be created. Note that in order to attach a Public Gateway to a Private Network, the gateway must be in an Availability Zone within the Private Network's region.
2929
- Choose a **Public Gateway Type**, which impacts the pricing and bandwidth of your gateway.
30-
- Choose an **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP.
30+
- Choose a public **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP.
3131
- Choose a **Name** for your Public Gateway, and, optionally, tags.
32-
<Macro id="network-resource-naming"/>
32+
<Macro id="network-resource-naming"/>
3333
- Verify the **Estimated Cost** of your Public Gateway, based on the specifications you chose.
3434
4. Click **Create Public Gateway** to finish.
3535

network/public-gateways/how-to/delete-a-public-gateway.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
meta:
33
title: How to delete a Public Gateway
4-
description: This page explains how to delete a Public Gateway
4+
description: Find out how to safely delete a Public Gateway on Scaleway. Follow this step-by-step guide to remove gateways while preserving your network configuration.
55
content:
66
h1: How to delete a Public Gateway
7-
paragraph: This page explains how to delete a Public Gateway
7+
paragraph: Find out how to safely delete a Public Gateway on Scaleway. Follow this step-by-step guide to remove gateways while preserving your network configuration.
88
tags: public-gateway public gateway
99
dates:
10-
validation: 2024-06-05
10+
validation: 2024-12-10
1111
posted: 2021-05-26
1212
categories:
1313
- network
@@ -24,6 +24,9 @@ This page shows you how to delete a [Public Gateway](/network/public-gateways/co
2424
1. Click **Public Gateways** in the **Network** section of the side menu.
2525
2. Click <Icon name="more" /> next to the Public Gateway you wish to delete, and select **Delete** from the drop-down menu.
2626
<Lightbox src="scaleway-delete-gw.webp" alt="" />
27+
<Message type="note">
28+
If there is an associated default route in the VPC's route table, it will automatically be deleted.
29+
</Message>
2730
3. Confirm the action when prompted by typing **DELETE** in the pop-up window, then click **Delete Public Gateway**.
2831

2932

network/public-gateways/how-to/use-flexible-ips.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
meta:
33
title: How to use flexible IP addresses with Public Gateways
4-
description: This page explains how to use flexible IP addresses with your Public Gateways
4+
description: Learn how to use Flexible IPs with Scaleway Public Gateways. Follow this guide to manage IP addresses and enhance your network's flexibility and scalability.
55
content:
66
h1: How to use flexible IP addresses with Public Gateways
7-
paragraph: This page explains how to use flexible IP addresses with your Public Gateways
7+
paragraph: Learn how to use Flexible IPs with Scaleway Public Gateways. Follow this guide to manage IP addresses and enhance your network's flexibility and scalability.
88
tags: public-gateway public gateway flexible-ip
99
dates:
10-
validation: 2024-06-05
11-
posted: 2021-05-26
10+
validation: 2024-12-10
11+
posted: 2024-12-10
1212
categories:
1313
- network
1414
---

network/public-gateways/how-to/use-ssh-bastion.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ content:
77
paragraph: This page explains how to use SSH bastion
88
tags: ssh-bastion ssh bastion activation reimport public-gateway
99
dates:
10-
validation: 2024-06-05
10+
validation: 2024-12-10
1111
posted: 2022-03-31
1212
categories:
1313
- network

network/public-gateways/quickstart.mdx

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
meta:
33
title: Public Gateways - Quickstart
4-
description: This page shows you how to get started with Scaleway Public Gateways.
4+
description: Learn how to quickly set up and configure a Public Gateway on Scaleway. Follow this step-by-step guide to manage internet access and secure your network with ease.
55
content:
66
h1: Public Gateways - Quickstart
7-
paragraph: This page shows you how to get started with Scaleway Public Gateways.
7+
paragraph: Learn how to quickly set up and configure a Public Gateway on Scaleway. Follow this step-by-step guide to manage internet access and secure your network with ease.
88
tags: private-network private network public-gateway public-gateway egress
99
dates:
10-
validation: 2024-06-05
10+
validation: 2024-12-10
1111
posted: 2021-05-26
1212
categories:
1313
- network
@@ -27,7 +27,7 @@ categories:
2727
3. Complete the following steps in the wizard:
2828
- Choose an **Availability Zone**, which is the geographical location in which your Public Gateway will be created. Note that in order to attach a Public Gateway to a Private Network, the gateway must be in an Availability Zone within the Private Network's region.
2929
- Choose a **Public Gateway Type**, which impacts the pricing and bandwidth of your gateway.
30-
- Choose an **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP.
30+
- Choose a public **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP.
3131
- Choose a **Name** for your Public Gateway, and, optionally, tags.
3232
<Macro id="network-resource-naming"/>
3333
- Verify the **Estimated Cost** of your Public Gateway, based on the specifications you chose.
@@ -40,15 +40,28 @@ categories:
4040
1. Click **Public Gateways** in the **Network** section of the side menu.
4141
2. Click the Public Gateway that you want to attach to a Private Network. You are taken to the **Overview** page for that Public Gateway.
4242
3. Click the **Private Networks** tab. A list of Private Networks attached to the Public Gateway displays.
43-
4. Click <Icon name="plus" /> to attach a new Private Network to the Public Gateway. A pop-up displays.
44-
5. Choose to attach an existing or a new Private Network.
45-
- If you want to attach an existing Private Network, select **Attach to an existing Private Network** and choose the desired network from the drop-down list.
43+
4. Click **Attach to a Private Network** to attach a new Private Network to the Public Gateway. A pop-up displays.
44+
5. Select an existing Private Network from the list, or select **Create a new Private Network**.
4645
<Message type="note">
4746
Only Private Networks which are in the same region as the Public Gateway are displayed in this list.
4847
</Message>
49-
- If you want to create and attach a new Private Network, select **Attach to a new Private Network**. A default name will be suggested for you, but feel free to overwrite this with a new name of your choice.
5048
6. Choose whether to **auto-allocate an available IP from the pool** (the [CIDR block](/network/vpc/concepts/#cidr-block) defined at the time of creating the Private Network), or use a **[reserved IP address](/network/ipam/concepts/#reserved-ip-address)** for the attachment.
5149
7. Use the toggle <Icon name="toggle" /> to tell the gateway whether or not it should [advertise the default route](/network/public-gateways/concepts/#default-route) to the internet for attached resources.
5250
8. Click **Attach to Private Network** to finish. You are taken back to the Private Networks tab, where the network you attached now appears, along with the services configured and the IP address of the Public Gateway.
5351

54-
Your Private Network is now attached to your Public Gateway. You can repeat the steps above to attach more Private Networks to the same Public Gateway if you wish.
52+
Your Private Network is now attached to your Public Gateway. You can repeat the steps above to attach more Private Networks to the same Public Gateway if you wish.
53+
54+
## How to activate SSH bastion
55+
56+
When you activate SSH bastion on your Public Gateway, all [SSH keys held in your Project](https://console.scaleway.com/project/ssh-keys/) are imported to the SSH bastion. This provides a single point of entry to Instances and other resources behind the bastion, allowing you to connect to them via the Public Gateway, instead of via their public IP addresses.
57+
58+
1. Click **Public Gateways** in the **Network** section of the Scaleway console side menu.
59+
2. Click the Public Gateway for which you want to activate SSH bastion. You are taken to the **Overview** page for that Public Gateway.
60+
3. Under **SSH Bastion**, click the **Activate** button. A pop-up displays.
61+
4. Enter the port that you want your SSH bastion to listen on (or leave the default port in place).
62+
<Message type="tip">
63+
The default port is `61000`. When setting your own port, you must choose a port number between `1024` and `59999`. The port that the SSH bastion listens on must not be a port already in use by a [NAT rule](/network/public-gateways/concepts/#nat).
64+
</Message>
65+
5. Copy the command to connect to a resource, and click **Save SSH bastion settings**.
66+
67+
You are redirected to your Public Gateway's **Overview** page, where SSH bastion is now activated. All the SSH keys in your [Project credentials](/identity-and-access-management/iam/concepts/#api-key) at the time of activation are copied to the SSH bastion. The command to use to connect to resources behind the bastion is displayed. See the [SSH bastion documentation](/network/public-gateways/how-to/use-ssh-bastion/) for further help.

network/public-gateways/troubleshooting/gw-limitations.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
22
meta:
33
title: Public Gateway Limitations
4-
description: This page sets out some known limitations of the Public Gateway
4+
description: This page sets out some known limitations of the Scaleway Public Gateway
55
content:
66
h1: Public Gateway Limitations
7-
paragraph: This page sets out some known limitations of the Public Gateway
7+
paragraph: This page sets out some known limitations of the Scaleway Public Gateway
88
tags: public-gateway public gateway ipv4
99
dates:
10-
validation: 2024-06-05
11-
posted: 2021-05-26
10+
validation: 2024-12-10
11+
posted: 2024-12-10
1212
categories:
1313
- network
1414
---
1515

1616
#### The Public Gateway currently supports only IPv4.
1717

18-
IPv6 support will be coming soon.
18+
IPv6 support is planned for the future.
1919

2020
#### Modifying a DHCP subnet requires a renew on the client side.
2121

0 commit comments

Comments
 (0)