diff --git a/docs/platform/concepts/byoc.md b/docs/platform/concepts/byoc.md index 764417347..ca5e6d5af 100644 --- a/docs/platform/concepts/byoc.md +++ b/docs/platform/concepts/byoc.md @@ -1,5 +1,6 @@ --- title: Bring your own cloud (BYOC) +sidebar_label: Bring your own cloud --- ## About BYOC @@ -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:sales@aiven.io) 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 @@ -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:sales@aiven.io). +deployment model is the best fit for you, contact [the sales team](mailto:sales@aiven.io). ::: ## BYOC pricing and billing diff --git a/docs/platform/howto/byoc/add-customer-info-custom-cloud.md b/docs/platform/howto/byoc/add-customer-info-custom-cloud.md index 8cdf91462..41a5f45b2 100644 --- a/docs/platform/howto/byoc/add-customer-info-custom-cloud.md +++ b/docs/platform/howto/byoc/add-customer-info-custom-cloud.md @@ -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 @@ -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. diff --git a/docs/platform/howto/byoc/assign-project-custom-cloud.md b/docs/platform/howto/byoc/assign-project-custom-cloud.md index 20940c7c0..12e09a81c 100644 --- a/docs/platform/howto/byoc/assign-project-custom-cloud.md +++ b/docs/platform/howto/byoc/assign-project-custom-cloud.md @@ -1,37 +1,30 @@ --- 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 @@ -39,10 +32,11 @@ the settings you configured during the ## 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 @@ -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:sales@aiven.io). ## Check it out diff --git a/docs/platform/howto/byoc/create-custom-cloud.md b/docs/platform/howto/byoc/create-custom-cloud.md index 38d1e53aa..17dce4d2c 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.md +++ b/docs/platform/howto/byoc/create-custom-cloud.md @@ -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. @@ -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 @@ -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:sales@aiven.io) 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). @@ -485,6 +485,7 @@ account. In the **Create custom cloud** wizard: 1. Specify the following: + - Custom cloud name - Cloud provider (AWS only) @@ -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 @@ -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 @@ -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:sales@aiven.io). + +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: @@ -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 @@ -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**. @@ -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:sales@aiven.io). -## 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 + +Whether you can migrate existing services to the custom cloud depends on your service and +networking configuration. Contact the [sales team](mailto:sales@aiven.io) for more +information. ## Related pages diff --git a/docs/platform/howto/byoc/delete-custom-cloud.md b/docs/platform/howto/byoc/delete-custom-cloud.md index a2a119d0b..47e5e9fc3 100644 --- a/docs/platform/howto/byoc/delete-custom-cloud.md +++ b/docs/platform/howto/byoc/delete-custom-cloud.md @@ -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 @@ -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** diff --git a/docs/platform/howto/byoc/enable-byoc.md b/docs/platform/howto/byoc/enable-byoc.md index 1759d03cc..e470a08fc 100644 --- a/docs/platform/howto/byoc/enable-byoc.md +++ b/docs/platform/howto/byoc/enable-byoc.md @@ -1,16 +1,14 @@ --- title: Enable bring your own cloud (BYOC) +sidebar_label: Enable BYOC --- -Enabling -[the bring your own cloud (BYOC) feature](/docs/platform/concepts/byoc) allows you to -[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven organization. For more information on BYOC and -custom clouds, check -[Bring your own cloud (BYOC)](/docs/platform/concepts/byoc). +Enabling [the bring your own cloud (BYOC) feature](/docs/platform/concepts/byoc) allows you to [create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven organization. For more information on BYOC and custom clouds, check [Bring your own cloud (BYOC)](/docs/platform/concepts/byoc). :::note Enabling -[the BYOC feature](/docs/platform/concepts/byoc) or creating custom clouds in your Aiven environment does not +[the BYOC feature](/docs/platform/concepts/byoc) or creating custom clouds in your +Aiven environment does not affect the configuration of your existing Aiven organizations, projects, or services. This only allows you to run Aiven services in your cloud provider account. @@ -28,7 +26,8 @@ eligibility for the feature. :::important Before getting down to enabling BYOC, check the availability of the feature in -[Who is eligible for BYOC](/docs/platform/concepts/byoc#eligible-for-byoc), make sure you understand all the +[Who is eligible for BYOC](/docs/platform/concepts/byoc#eligible-for-byoc), make sure +you understand all the [limitations](/docs/platform/howto/byoc/enable-byoc#byoc-enable-limitations), and meet all the [prerequisites](/docs/platform/howto/byoc/enable-byoc#byoc-enable-prerequisites). @@ -53,16 +52,16 @@ and meet all the 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. -2. Select the organization you want to use from the dropdown menu in +1. Select the organization you want to use from the dropdown menu in the top right corner. -3. From the top navigation bar, select **Admin**. +1. From the top navigation bar, select **Admin**. -4. From the left sidebar, select **Bring your own cloud**. +1. From the left sidebar, select **Bring your own cloud**. -5. In the **Bring your own cloud** view, select **Contact us**. +1. In the **Bring your own cloud** view, select **Contact us**. -6. In the **Contact us** window, enter your email address and country. +1. In the **Contact us** window, enter your email address and country. Select the cloud provider you want to use, add any other information you think might be relevant, and select **Confirm**. @@ -70,12 +69,12 @@ and meet all the call with the Aiven sales team to proceed on your BYOC enablement request. -7. Using the scheduling assistant, select a date and time when you want +1. Using the scheduling assistant, select a date and time when you want to talk to our sales team to share your requirements and make sure BYOC suits your needs. Confirm the selected time, make sure you add the call to your calendar, and close the the scheduling assistant. -8. Join the scheduled call with our sales team to follow up with them +1. Join the scheduled call with our sales team to follow up with them on enabling BYOC in your environment. If the call reveals BYOC addresses your needs and your environment diff --git a/docs/platform/howto/byoc/rename-custom-cloud.md b/docs/platform/howto/byoc/rename-custom-cloud.md index a6352a467..196c28107 100644 --- a/docs/platform/howto/byoc/rename-custom-cloud.md +++ b/docs/platform/howto/byoc/rename-custom-cloud.md @@ -1,22 +1,17 @@ --- title: Rename your AWS custom cloud in Aiven +sidebar_label: Rename custom clouds --- -Change the name of 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. -::: +Change the name of your [custom cloud](/docs/platform/concepts/byoc). ## About renaming custom clouds 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](/docs/platform/howto/byoc/create-custom-cloud), you specify its name, which is a part of the initial custom +[create custom clouds](/docs/platform/howto/byoc/create-custom-cloud) in your Aiven +organizations. While +[setting up a custom cloud in Aiven](/docs/platform/howto/byoc/create-custom-cloud), you +specify its name, which is a part of the initial custom cloud's configuration. Later, you can come back to the **Rename** setting in your cloud's page in [Aiven Console](https://console.aiven.io/) and update the name you initially @@ -33,31 +28,30 @@ specified. 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. -2. Select the organization you want to use from the dropdown menu in +1. Select the organization you want to use from the dropdown menu in the top right corner. -3. From the top navigation bar, select **Admin**. -4. From the left sidebar, select **Bring your own cloud**. -5. In the **Bring your own cloud** view, select one of the clouds +1. From the top navigation bar, select **Admin**. +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. -6. 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 **Rename**. -7. In the **Rename custom cloud** window, enter a new name into the +1. In the **Rename custom cloud** window, enter a new name into the **Custom cloud name** field and select **Rename**. The name of your custom cloud has been updated. ## Check it out -You can preview the updated name of your cloud by taking the following -steps: +Preview the updated name of your cloud: 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. -2. Select the organization you want to use from the dropdown menu in +1. Select the organization you want to use from the dropdown menu in the top right corner. -3. From the top navigation bar, select **Admin**. -4. From the left sidebar, select **Bring your own cloud**. -5. In the **Bring your own cloud** view, see the list of the available +1. From the top navigation bar, select **Admin**. +1. From the left sidebar, select **Bring your own cloud**. +1. In the **Bring your own cloud** view, see the list of the available clouds and identify the cloud with the name you updated. ## Related pages