Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update(platform): BYOC AWS GA #3

Merged
merged 3 commits into from
Mar 20, 2024
+133 −133
Merged

update(platform): BYOC AWS GA #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
521248e
BYOC AWS GA updates
wojcik-dorota Jan 26, 2024
ff394a3
Jeremy's comments applied
wojcik-dorota Feb 14, 2024
09a734f
Arthur's comments
wojcik-dorota Feb 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/platform/concepts/byoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Bring your own cloud (BYOC)
sidebar_label: Bring your own cloud
---

## About BYOC
Expand Down Expand Up @@ -55,11 +56,16 @@ not all cloud providers support it yet. Meet a few requirements to be eligible f
- You use one of the following public clouds: Amazon Web Services
(AWS), Google Cloud Platform (GCP), or Microsoft Azure (excluding
Azure Germany).
- Your total monthly spend is at least $5,000.00 for at least 12
months.
- You have a commitment deal with Aiven.
- You use at least the [Priority tier of Aiven support
services](https://aiven.io/support-services).

:::note
Check out [Aiven support tiers](https://aiven.io/support-services) and
[Aiven responsibility matrix](https://aiven.io/responsibility-matrix) for BYOC. Contact
the [sales team](mailto:[email protected]) to learn more or upgrade your support tier.
:::

## When to use the regular Aiven deployment

BYOC deployments are not automated, and they add additional complexity
Expand All @@ -72,7 +78,7 @@ utilizing a regular Aiven deployment or

:::tip
If you would like to understand BYOC better or are unsure which
deployment model is the best fit for you, contact [sales@aiven.io](mailto:[email protected]).
deployment model is the best fit for you, contact [the sales team](mailto:[email protected]).
:::

## BYOC pricing and billing
Expand Down
34 changes: 13 additions & 21 deletions docs/platform/howto/byoc/add-customer-info-custom-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,23 @@
---
title: Add or remove customer contacts for your AWS custom cloud in Aiven
sidebar_label: Update customer contacts
---

Update the list of customer contacts for your
[custom cloud](/docs/platform/concepts/byoc).

:::important
Custom cloud configuration in Aiven is an
[early availability feature](/docs/platform/concepts/beta_services). You cover the costs associated with building and
maintaining your custom cloud: payments for your integrated AWS
infrastructure and Aiven services within the custom cloud.
:::
Update the list of customer contacts for your [custom cloud](/docs/platform/concepts/byoc).

## About updating customer contacts

With the BYOC feature enabled, you can
[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven organizations. While setting up a custom cloud
in Aiven, you add customer contacts for this cloud, which is a part of
the initial custom cloud's configuration. Later, you can come back to
the the **Customer contact** setting in your cloud's page in [Aiven
Console](https://console.aiven.io/) and update the contacts list you
initially created for your cloud.
[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven
organizations. While creating a custom cloud in Aiven, add at least the
**Admin** contact. Later, you can come back to the the **Customer contact**
setting in your cloud's page in [Aiven Console](https://console.aiven.io/) and update the
contacts list you initially created for your cloud.

:::important
While you can add multiple different customer contacts for your custom cloud, **Admin** is
a mandatory role that is always required as a primary support contact.
:::

## Prerequisites

Expand Down Expand Up @@ -51,18 +48,13 @@ initially created for your cloud.
from the dropdown menu, enter the email address, and select **+** to
add the provided contact's details.

:::note
You can add multiple customer contacts for your custom cloud.
:::

8. When you're done adding all the contacts, select **Save changes**.

The list of contacts for your cloud has been updated.

## Check it out

You can preview the updated list of contacts by taking the following
steps:
Preview the updated list of contacts:

1. Log in to [Aiven Console](https://console.aiven.io/) as an
administrator.
Expand Down
51 changes: 25 additions & 26 deletions docs/platform/howto/byoc/assign-project-custom-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,48 +1,42 @@
---
title: Enable your AWS custom cloud in Aiven organizations, units, or projects
sidebar_label: Attach projects
---

To use a [custom cloud](/docs/platform/concepts/byoc) in your Aiven organizations, units, or projects, configure its availability.

:::important
Custom cloud configuration in Aiven is an
[early availability feature](/docs/platform/concepts/beta_services). You cover the costs associated with building and
maintaining your custom cloud payments for your integrated AWS
infrastructure and Aiven services within the custom cloud.
:::
Configure the availability of your [custom cloud](/docs/platform/concepts/byoc) to access
it in all the projects, selected organizational units, or specific projects only.

## About making custom clouds available from your projects

With the BYOC feature enabled, you can
[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven organization. As a part of the
[initial custom cloud's setup in Aiven Console](/docs/platform/howto/byoc/create-custom-cloud), you select in what projects you'll be able to use your new
custom cloud to create services and make your
cloud available for all the projects in your organization, selected
organizational units, or specific projects only.

Later, you can come back to the **Available projects** tab in your
[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven
organization. As a part of the
[initial custom cloud's setup in the Aiven Console](/docs/platform/howto/byoc/create-custom-cloud),
you select in what projects you'll be able to use your new custom cloud to host Aiven
services. Later, you can come back to the **Available projects** tab in your
cloud's page in [Aiven Console](https://console.aiven.io/) and update
the settings you configured during the
[initial custom cloud's setup](/docs/platform/howto/byoc/create-custom-cloud).

1. In the **Custom cloud's availability in your organization**
section, select either:
- **By default for all projects** to make your custom cloud
available in all existing and future projects in the
organization, or;
- **By selection** to pick specific projects or organizational
units where you want your custom cloud to be available.
- **By default for all projects** to make your custom cloud
available in all existing and future projects in the
organization, or;
- **By selection** to pick specific projects or organizational
units where you want your custom cloud to be available.
1. If you go for the **By selection** option, the **Assign
organizational units** field and the **Assign projects** field show
up. Enter the names of organizational units and/ or projects in
which you want to be able to use your custom cloud.

## Prerequisites

- Administrator's role for your Aiven organization
- At least one
[custom cloud created](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven organization
- Access to [Aiven Console](https://console.aiven.io/)
- Administrator's role for your Aiven organization
- At least one
[custom cloud created](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven
organization
- Access to [Aiven Console](https://console.aiven.io/)

## Enable projects to use your custom cloud

Expand Down Expand Up @@ -83,8 +77,13 @@ the settings you configured during the
desired units and/ or projects as needed. Confirm your choice by
selecting **Assign projects**.

In the projects and/ or organizational units you assigned, you can
create services using your custom cloud.
As a result, in the projects and/or organizational units for which you enable your
custom cloud, you can:

- Create new services in the custom cloud
- Migrate existing services to your custom cloud if your service and networking
configuration allows it. For more information, contact the
[sales team](mailto:[email protected]).

## Check it out

Expand Down
90 changes: 53 additions & 37 deletions docs/platform/howto/byoc/create-custom-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create an AWS custom cloud in Aiven
sidebar_label: Create custom cloud
sidebar_label: Create custom clouds
---

Create a [custom cloud](/docs/platform/concepts/byoc) in your Aiven organization to better address your specific business needs or project requirements.
Expand All @@ -12,24 +12,16 @@ Create a [custom cloud](/docs/platform/concepts/byoc) in your Aiven organization
[the bring your own cloud (BYOC) feature](/docs/platform/concepts/byoc). Check the
availability of the feature in
[Who is eligible for BYOC](/docs/platform/concepts/byoc#eligible-for-byoc). To
activate BYOC in your Aiven organization, see
activate BYOC in your Aiven organization, follow
[Enable bring your own cloud (BYOC) with Aiven](/docs/platform/howto/byoc/enable-byoc).
- Enabling
[the BYOC feature](/docs/platform/concepts/byoc) or creating custom clouds in your Aiven environment does
not affect the configuration of your existing organizations,
projects, or services. This only makes the new BYOC capabilities
available in your environment.
[the BYOC feature](/docs/platform/concepts/byoc) or creating custom clouds in your
Aiven environment does not affect the configuration of your existing organizations,
projects, or services. This only makes the new BYOC capabilities available in your
environment.

:::

:::important
Custom cloud configuration in Aiven is an
[early availability feature](/docs/platform/concepts/beta_services). You cover the
costs associated with building and
maintaining your custom cloud: payments for your integrated AWS
infrastructure and Aiven services within the custom cloud.
:::

## About creating a custom cloud

Before creating a custom cloud, take note of the
Expand Down Expand Up @@ -63,6 +55,14 @@ contacts for your custom cloud.

- You need at least the Priority tier of Aiven support services to be
eligible for activating BYOC.

:::note
Check out [Aiven support tiers](https://aiven.io/support-services) and
[Aiven responsibility matrix](https://aiven.io/responsibility-matrix) for BYOC.
Contact the [sales team](mailto:[email protected]) to learn more or upgrade your support
tier.
:::

- To build your custom cloud with a cloud provider other
than AWS, request it as detailed in
[Enable bring your own cloud (BYOC) with Aiven](/docs/platform/howto/byoc/enable-byoc).
Expand Down Expand Up @@ -485,6 +485,7 @@ account.
In the **Create custom cloud** wizard:

1. Specify the following:

- Custom cloud name

- Cloud provider (AWS only)
Expand Down Expand Up @@ -525,6 +526,7 @@ In the **Create custom cloud** wizard:
blocks of VPCs you plan to peer your BYOC VPC with. You
cannot change the BYOC VPC CIDR block after your custom
cloud is created.

1. Select **Next**.

Your IaC Terraform template gets generated based on your inputs. You can
Expand Down Expand Up @@ -563,7 +565,7 @@ AWS account. Continue working in the **Create custom cloud** wizard:
Console](https://console.aiven.io/).
:::

1. Use Terraform to deploy the Infrastructure template in your AWS account with the
1. Use Terraform to deploy the infrastructure template in your AWS account with the
provided variables.

:::important
Expand All @@ -583,10 +585,17 @@ AWS account. Continue working in the **Create custom cloud** wizard:

#### Set up your custom cloud's availability

Select in what projects you'll be able to use your new custom cloud to
create services. You can make your cloud available for all the projects
in your organization, selected organizational units, or specific
projects only.
Select in what projects you'll be able to use your new custom cloud as a hosting cloud for
services. In the projects where you enable your custom cloud, you can create new
services in the custom cloud or migrate your existing services to the custom cloud if your
service and networking configuration allows it. For more information on migrating your
existing services to the custom cloud, contact the [sales team](mailto:[email protected]).

wojcik-dorota marked this conversation as resolved.
Show resolved Hide resolved
Your cloud can be available in:

- All the projects in your organization
- Selected organizational units
- Specific projects only

Continue working in the **Create custom cloud** wizard:

Expand Down Expand Up @@ -615,8 +624,11 @@ available from all the projects in this unit.
#### Add customer contacts

Select at least one person whom Aiven can contact in case any technical
issue with the custom cloud needs fixing. Continue working in the
**Create custom cloud** wizard:
issues with your custom cloud need fixing.

:::note
**Admin** is a mandatory role, which is required as a primary support contact.
:::

1. In the **Customer contacts** section, select a contact person's
role using the **Job title** menu, and provide their email
Expand Down Expand Up @@ -645,9 +657,6 @@ Your new custom cloud is ready to use only after its status changes to

#### Check your cloud's status

You can check the status of your custom cloud by taking the following
steps:

1. Log in to [Aiven Console](https://console.aiven.io/) as an
administrator, and go to a desired organization.
1. From the top navigation bar, select **Admin**.
Expand All @@ -656,29 +665,36 @@ steps:
list of available clouds and check its status in the **Status**
column.

If your custom cloud's status is **Active**, its deployment has been
completed. Your custom cloud is ready to use and you can see it on the
list of your custom clouds in the **Bring your own cloud** view. Now you
can create services using your new custom cloud.
When your custom cloud's status is **Active**, its deployment has been completed. Your
custom cloud is ready to use and you can see it on the list of your custom clouds in the
**Bring your own cloud** view. Now you can create new services in the custom cloud or
migrate your existing services to the custom cloud if your service and networking
configuration allows it. For more information on migrating your existing services to the
custom cloud, contact the [sales team](mailto:[email protected]).

## Next steps

### Destroy the Terraform resources
#### Destroy the Terraform resources

As soon as you new custom cloud gets the **Active** status, remove the
Terraform resources your created in your AWS account while creating the
cloud. See the guidelines on how to use the `destroy` command in
[Command: destroy](https://developer.hashicorp.com/terraform/cli/commands/destroy).

### Create a service using the new cloud
## Manage services in custom clouds

### Create new services in the custom cloud

To create a service in [Aiven Console](https://console.aiven.io/) using
your new custom cloud, follow the guidelines in
To create a service in [Aiven Console](https://console.aiven.io/) in your new custom
cloud, follow the guidelines in
[Create a new service](/docs/platform/howto/create_new_service).

When you get to the **Select service region** step while setting up your
service in [Aiven Console](https://console.aiven.io/), you'll be able
to select **Custom clouds** from among available regions.
When creating a service in the [Aiven Console](https://console.aiven.io/), at the
**Select service region** step, select **Custom clouds** from the available regions.

### Migrate existing services to the custom cloud
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would take this part out because we added this text throughout the document already: "Migrating existing services to your custom cloud is possible, depending on your specific service and networking configuration. Please reach out to the sales team to understand your specific migration scenario."

Copy link
Contributor Author

@wojcik-dorota wojcik-dorota Mar 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about we still keep the section for the SEO purposes and making this migration capability visible to the users in the table of contents? I updated the sections accordingly saying what we want to say. Hope that's ok?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SEO is great! I hadn't thought of that. I'll review the draft


Whether you can migrate existing services to the custom cloud depends on your service and
networking configuration. Contact the [sales team](mailto:[email protected]) for more
information.

## Related pages

Expand Down
12 changes: 3 additions & 9 deletions docs/platform/howto/byoc/delete-custom-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
---
title: Delete your AWS custom cloud in Aiven
sidebar_label: Delete custom clouds
---

Delete a [custom cloud](/docs/platform/concepts/byoc) so that it's no longer available in your Aiven
organizations, units, or projects.

:::important
Custom cloud configuration in Aiven is an
[early availability feature](/docs/platform/concepts/beta_services). You cover the costs associated with building and
maintaining your custom cloud payments for your integrated AWS infrastructure and Aiven services within the custom cloud.
:::
Delete a [custom cloud](/docs/platform/concepts/byoc) so that it's no longer available in your Aiven organization, units, or projects.

## About deleting custom clouds

Expand Down Expand Up @@ -48,7 +42,7 @@ them earlier, you're advised to do that if deleting your cloud.
1. From the left sidebar, select **Bring your own cloud**.
1. In the **Bring your own cloud** view, select one of the clouds
available on the list.
1. In the selected cloud's page, use the ellipsis (**...**) menu in
1. In the selected cloud's page, use the **Actions** menu in
the top right corner to select **Delete**.
1. Make sure you understand the impact and, if so, confirm that you
want to delete the cloud by selecting **Delete** in the **Warning**
Expand Down
Loading