manage org vpc via cli

aiven · Dec 12, 2024 · 0da5a6f · 0da5a6f
1 parent 6d1be5a
commit 0da5a6f
Show file tree

Hide file tree

Showing 3 changed files with 217 additions and 45 deletions.
diff --git a/docs/platform/howto/manage-org-vpc-peering.md b/docs/platform/howto/manage-org-vpc-peering.md
@@ -0,0 +1,112 @@
+---
+title: Manage organization VPC peering in Aiven
+sidebar_label: Manage organization VPC peering
+---
+
+import ConsoleLabel from "@site/src/components/ConsoleIcons";
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<!--
+Set up or delete an organization-wide VPC in the Aiven Platform. Enable new Aiven projects in the organization VPC or migrate existing Aiven projects to the organization VPC. Access resources within the organization VPC from the public internet.
+-->
+## Prerequisites
+<!--
+You need the [super admin role](/docs/platform/howto/make-super-admin) to manage an
+organization VPC.
+-->
+## Create a peering connection
+<!--
+Create an organization VPC using a tool of your choice:
+
+<Tabs groupId="group1">
+<TabItem value="console" label="Aiven Console" default>
+
+1. Log in to the [Aiven Console](https://console.aiven.io/), and click **Admin** in the
+   top navigation bar.
+1. Click <ConsoleLabel name="organizationvpcs"/> in the sidebar and **Create VPC** on the
+   **Organization VPCs** page.
+1. In the **Create VPC** window:
+   1. Select a cloud provider.
+   1. Select a cloud region.
+   1. Specify an IP range.
+
+      - Use an IP range that does not overlap with any networks to be connected via VPC
+        peering. For example, if your own networks use the range `11.1.1.0/8`, you can set
+        the range for your Aiven project's VPC to `191.161.1.0/24`.
+      - Use a network prefix that is 20-24 character long.
+
+   1. Click **Create VPC**.
+
+Your new organization VPC is ready to use as soon as its status visible on the
+**Organization VPCs** page changes to **Active**.
+
+</TabItem>
+<TabItem value="cli" label="Aiven CLI">
+
+Run
+
+```bash
+avn organization vpc create
+  --cloud aws-eu-west-1
+  --network-cidr 10.0.0.0/24
+  --organization-id "$org_id"
+```
+
+Check if the VPC has been created:
+
+```bash
+avn organization vpc list
+  --organization-id "$org_id"
+```
+
+</TabItem>
+<TabItem value="api" label="Aiven API">
+
+</TabItem>
+</Tabs>
+-->
+## Delete a peering connection
+<!--
+:::important
+
+- Before deleting an organization VPC, move all services out of this VPC.
+- Once an organization VPC is deleted, the cloud-provider side of the peering connections
+  becomes `inactive` or `deleted`.
+
+:::
+
+Delete an organization VPC using a tool of your choice:
+
+<Tabs groupId="group1">
+<TabItem value="console" label="Aiven Console" default>
+
+1. Log in to the [Aiven Console](https://console.aiven.io/), and click **Admin** in the
+   top navigation bar.
+1. Click <ConsoleLabel name="organizationvpcs"/> in the sidebar.
+1. On the **Organization VPCs** page, find a VPC to be deleted and click
+   <ConsoleLabel name="actions"/> > <ConsoleLabel name="delete"/>.
+1. In the **Confirmation** window, click **Delete VPC**.
+
+</TabItem>
+<TabItem value="cli" label="Aiven CLI">
+
+Run
+
+```bash
+avn organization vpc delete
+  --organization-id $org_id
+  --vpc-id 17528694-efb4-4f97-97e8-8bb4c7d31fee
+```
+
+</TabItem>
+<TabItem value="api" label="Aiven API">
+
+</TabItem>
+</Tabs>
+-->
+## Related pages
+
+- [VPCs in Aiven](/docs/platform/concepts/vpcs)
+- [VPC peering in Aiven](/docs/platform/concepts/vpc-peering)
+- [Manage organization VPCs](/docs/platform/howto/manage-organization-vpc)
diff --git a/docs/platform/howto/manage-organization-vpc.md b/docs/platform/howto/manage-organization-vpc.md
@@ -43,15 +43,35 @@ Your new organization VPC is ready to use as soon as its status visible on the
 </TabItem>
 <TabItem value="cli" label="Aiven CLI">
 
+Run the `avn organization vpc create` command:
+
+```bash
+avn organization vpc create         \
+  --cloud CLOUD_PROVIDER_REGION     \
+  --network-cidr NETWORK_CIDR       \
+  --organization-id ORGANIZATION_ID
+```
+
+Replace the following:
+
+- `CLOUD_PROVIDER_REGION` with the cloud provider and region to host the VPC, for example
+  `aws-eu-west-1`
+- `NETWORK_CIDR` with the CIDR block (a range of IP addresses) for the VPC, for example,
+  `10.0.0.0/24`
+- `ORGANIZATION_ID` with the ID of your Aiven organization where to create the VPC, for
+  example, `org1a2b3c4d5e6`
+
 </TabItem>
 <TabItem value="api" label="Aiven API">
 
 </TabItem>
 </Tabs>
 
-<!--
-## Enable new projects in an organization VPC
+## Create a service in an organization VPC
+
+Create a service in an organization VPC using a tool of your choice:
 
+<!--
 When you create a service, your peered VPC is available as a new
 geolocation on the **VPC** tab under **Select service region**. It can
 take a few minutes for a newly created VPC to appear for service
@@ -65,9 +85,47 @@ belong to the project where that specific VPC was created.
 :::
 -->
 
-<!--
-## Migrate existing projects to an organization VPC
+<Tabs groupId="group1">
+<TabItem value="console" label="Aiven Console" default>
+
+1. Log in to the [Aiven Console](https://console.aiven.io/).
+
+</TabItem>
+<TabItem value="cli" label="Aiven CLI">
+
+Run [avn service create](/docs/tools/cli/service-cli#avn-cli-service-create):
+
+```bash
+avn service create SERVICE_NAME        \
+  --project PROJECT_NAME               \
+  --project-vpc-id ORGANIZATION_VPC_ID \
+  --type SERVICE_TYPE                  \
+  --plan SERVICE_PLAN                  \
+  --cloud CLOUD_PROVIDER_REGION
+```
+
+Replace the following:
+
+- `SERVICE_NAME` with the name of the service to be created, for example,
+  `pg-vpc-test`
+- `PROJECT_NAME` with the name of the project where to create the service, for example,
+  `pj-test`
+- `ORGANIZATION_VPC_ID` with the ID of your organization VPC, for example,
+  `12345678-1a2b-3c4d-5f6g-1a2b3c4d5e6f`
+- `SERVICE_TYPE` with the type of the service to be created, for example, `pg`
+- `SERVICE_PLAN` with the plan of the service to be created, for example, `hobbyist`
+- `CLOUD_PROVIDER_REGION` with the cloud provider and region to host the service to be
+  created, for example `aws-eu-west-1`
 
+</TabItem>
+<TabItem value="api" label="Aiven API">
+
+</TabItem>
+</Tabs>
+
+## Migrate a service to an organization VPC
+
+<!--
 You can migrate any Aiven service to a different VPC:
 
 1. In [Aiven Console](https://console.aiven.io/), open your service and click <ConsoleLabel name="Service settings"/>.
@@ -76,29 +134,35 @@ You can migrate any Aiven service to a different VPC:
 1. In the **Region** section, select the **VPCs** tab, select the VPC and click **Migrate**.
 -->
 
-<!--
-## Access organization VPC resources from the public internet
+Migrate a service to an organization VPC using a tool of your choice:
+
+<Tabs groupId="group1">
+<TabItem value="console" label="Aiven Console" default>
 
-When you move your service to a VPC, access from public networks is
-blocked by default. If you switch to public access, a separate endpoint
-is created with a public prefix. You can enable public internet access
-for your services by following the
-[Enable public access in a VPC](/docs/platform/howto/public-access-in-vpc) instructions.
+1. Log in to the [Aiven Console](https://console.aiven.io/).
 
-IP filtering is available for a service deployed to a VPC. It's recommended to
-[use IP filtering](/docs/platform/howto/restrict-access#restrict-access) when your VPC
-service is also exposed to the public internet.
+</TabItem>
+<TabItem value="cli" label="Aiven CLI">
 
-:::note
-If your service is within a VPC, the VPC configuration filters incoming traffic before the
-IP filter is applied.
-:::
+Run [avn service update](/docs/tools/cli/service-cli#avn-cli-service-update):
 
-Safelisting applies to both internal and external traffic. If you
-safelist an external IP address and want to keep traffic flowing with
-the internal (peered) connections, safelist the CIDR blocks of the peered networks as well
-to avoid disruptions to the service.
--->
+```bash
+avn service update SERVICE_NAME        \
+  --project-vpc-id ORGANIZATION_VPC_ID
+```
+
+Replace the following:
+
+- `SERVICE_NAME` with the name of the service to be migrated, for example,
+  `pg-test`
+- `ORGANIZATION_VPC_ID` with the ID of your organization VPC where to migrate the service,
+  for example, `12345678-1a2b-3c4d-5f6g-1a2b3c4d5e6f`
+
+</TabItem>
+<TabItem value="api" label="Aiven API">
+
+</TabItem>
+</Tabs>
 
 ## Delete an organization VPC
 
@@ -125,32 +189,27 @@ Delete an organization VPC using a tool of your choice:
 </TabItem>
 <TabItem value="cli" label="Aiven CLI">
 
-</TabItem>
-<TabItem value="api" label="Aiven API">
+Run the `avn organization vpc delete` command:
 
-</TabItem>
-</Tabs>
+```bash
+avn organization vpc delete                     \
+  --organization-id ORGANIZATION_ID             \
+  --vpc-id VPC_ID
+```
 
-<!--
-## Troubleshoot VPC connection issues
+Replace the following:
 
-Any network changes to VPC peered hosts external from Aiven can cause
-issues with routing to your Aiven services hosted in a VPC. In such
-case, try to refresh your VPC connections.
+- `ORGANIZATION_ID` with the ID of your Aiven organization, for example, `org1a2b3c4d5e6`
+- `VPC_ID` with the ID of your Aiven organization VPC, for example,
+  `12345678-1a2b-3c4d-5f6g-1a2b3c4d5e6f`
 
-:::note
-Changes to your VPCs (such as adding a new subnet) can take up to 24
-hours to take effect so wait at least 24 hours before refreshing your VPC
-connections.
-:::
+</TabItem>
+<TabItem value="api" label="Aiven API">
 
-To refresh your VCP connections:
+</TabItem>
+</Tabs>
 
-1. In [Aiven Console](https://console.aiven.io/), select <ConsoleLabel name="vpcs"/>.
-1. Find the ID of the affected VPC and select it from the **Internal
-   ID** column.
-1. Select **Refresh VPC connections**.
+## Related pages
 
-The platform checks the VPC peering connection and rebuilds the peering
-connection state if there are any changes detected.
--->
+- [VPC peering](/docs/platform/concepts/vpc-peering)
+- [Manage organization VPC peering connections](/docs/platform/howto/manage-org-vpc-peering)
diff --git a/sidebars.ts b/sidebars.ts
@@ -259,6 +259,7 @@ const sidebars: SidebarsConfig = {
                 'platform/concepts/vpc-peering',
                 'platform/howto/manage-project-vpc',
                 'platform/howto/manage-organization-vpc',
+                'platform/howto/manage-org-vpc-peering',
                 'platform/howto/public-access-in-vpc',
                 'platform/howto/vpc-peering-gcp',
                 'platform/howto/vpc-peering-aws',