From 1381d928f1a490a7131101bc0f750ebef89fc3e1 Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 12 Oct 2023 15:41:41 +0200 Subject: [PATCH] fixes --- _toc.yml | 3 + .../howto/byoc/create-custom-cloud.rst | 44 ++++------- docs/platform/howto/byoc/enable-byoc.rst | 78 +++++++++++++++++++ 3 files changed, 97 insertions(+), 28 deletions(-) create mode 100644 docs/platform/howto/byoc/enable-byoc.rst diff --git a/_toc.yml b/_toc.yml index 7c16985543..7fc9183a79 100644 --- a/_toc.yml +++ b/_toc.yml @@ -142,6 +142,9 @@ entries: title: BYOC entries: - file: docs/platform/concepts/byoc + title: About BYOC + - file: docs/platform/howto/byoc/enable-byoc + title: Enable BYOC - file: docs/platform/howto/byoc/create-custom-cloud title: Create custom cloud - file: docs/platform/howto/byoc/assign-project-custom-cloud diff --git a/docs/platform/howto/byoc/create-custom-cloud.rst b/docs/platform/howto/byoc/create-custom-cloud.rst index 46d0f5898d..009ba75b1d 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.rst +++ b/docs/platform/howto/byoc/create-custom-cloud.rst @@ -5,18 +5,18 @@ A :doc:`custom cloud ` is your own cloud infrastru .. important:: - Creating custom clouds in your Aiven organization requires enabling :doc:`the bring your own cloud (BYOC) feature `. Check the availability of the feature in :ref:`Who is eligible for BYOC `. + Creating custom clouds in your Aiven organization requires enabling :doc:`the bring your own cloud (BYOC) feature `. Check the availability of the feature in :ref:`Who is eligible for BYOC `. To activate BYOC in your Aiven organization, follow the steps in :doc:`Enable bring your own cloud (BYOC) with Aiven `. -This article provides you with instructions on how to enable BYOC and :ref:`add a custom cloud ` to your Aiven organization. +This article provides you with instructions on how to :ref:`create a custom cloud ` for your Aiven organization. About creating a custom cloud ----------------------------- .. important:: - Before getting down to enabling BYOC and, next, creating a custom cloud, make sure you understand all the :ref:`limitations ` and meet all the :ref:`prerequisites `. + Before getting down to creating a custom cloud, make sure you understand all the :ref:`limitations ` and meet all the :ref:`prerequisites `. -To be able to create custom clouds on the Aiven platform, first you need to enable the BYOC feature using `Aiven Console `_. As soon as BYOC is activated, you can have custom clouds created in your organization. Depending on what cloud provider you want to use for that purpose, the process of creating custom clouds differs. +The process of creating a custom cloud in Aiven differs depending on what cloud provider you want to integrate with: * If you want to use the AWS cloud provider, you create your custom cloud yourself in `Aiven Console `_. @@ -24,7 +24,7 @@ To be able to create custom clouds on the Aiven platform, first you need to enab You configure your custom cloud setup in `Aiven Console `_ and prepare your own AWS account so that Aiven can access it. In `Aiven Console `_, you follow the **Create custom cloud** workflow to generate a Terraform infrastructure-as-code (IaC) template. Next, you deploy this template in your AWS account to acquire Role ARN (Amazon Resource Name). You supply your Role ARN into the **Create custom cloud** wizard, which gives Aiven the permissions to securely access your AWS account, create resources, and manage them onward. Finally, you select projects that can use your new custom clouds for creating services, and you add customer contacts for your custom cloud. -* If you want to use the GCP or Azure cloud providers, you have your custom cloud created by Aiven, not via Aiven Console. +* If you want to use the GCP or Azure cloud providers, you have your custom cloud created by the Aiven team, not via Aiven Console. .. _byoc-limitations: @@ -41,27 +41,12 @@ Limitations Prerequisites ------------- -* Access to `Aiven Console `_ -* Administrator's role for your Aiven organization -* Active account with your cloud provider -* Terraform installed (if using the AWS cloud provider) -* Terraform permissions - -Enable BYOC ------------ - -Creating custom clouds requires enabling the BYOC feature first. - -1. Log in to `Aiven Console `_ as an administrator. -2. From the top navigation bar, select **Admin**. -3. From the left sidebar, select **Bring you own cloud**. -4. In the **Bring you own cloud** view, select **Contact us**. -5. In the **Enable BYOC** window, select the cloud provider and the cloud region you want to use, add any other information you think might be relevant, and select **Send**. - -.. topic:: Result - - * If you selected the AWS cloud provider, you'll be able to :ref:`create your custom cloud in Aiven Console ` soon. - * If you selected Azure or GCP, we'll set up a custom cloud for you shortly. We might also reach out to you for more details if needed. +* You have :doc:`enabled the BYOC feature `. +* You have an active account with your cloud provider. +* You have access to `Aiven Console `_ (:ref:`to integrate with AWS `). +* You have administrator's role in your Aiven organization (:ref:`to integrate with AWS `). +* You have Terraform installed (:ref:`to integrate with AWS `). +* You have Terraform permissions (:ref:`to integrate with AWS `). .. _create-cloud: @@ -71,7 +56,9 @@ Create a custom cloud Create a custom cloud with GCP or Azure ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you want to use the GCP or Azure cloud providers, you have your custom cloud created by Aiven. You cannot use `Aiven Console `_ for this purpose. +If you want to use the GCP or Azure cloud providers, you have your custom cloud created by the Aiven team (not via `Aiven Console `_). Therefore, after :doc:`enabling the BYOC feature ` in `Aiven Console `_, there are no further actions required from you to create your custom cloud. We'll build your custom cloud for you according to the specifications you provided while enabling BYOC in `Aiven Console `_. We might reach out to you for more details if needed. We'll follow up with you to keep you informed on the progress. + +.. _create-cloud-aws: Create a custom cloud with AWS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -174,7 +161,8 @@ You're all set. Select **Close** to close the **Create custom cloud** wizard. Related reading --------------- -* :doc:`Bring your own cloud ` +* :doc:`About bring your own cloud (BYOC) ` +* :doc:`Enable bring your own cloud (BYOC) ` * :doc:`Assign a project to your custom cloud ` * :doc:`Add customer's contact information for your custom cloud ` * :doc:`Rename your custom cloud ` diff --git a/docs/platform/howto/byoc/enable-byoc.rst b/docs/platform/howto/byoc/enable-byoc.rst new file mode 100644 index 0000000000..80108e0006 --- /dev/null +++ b/docs/platform/howto/byoc/enable-byoc.rst @@ -0,0 +1,78 @@ +Enable bring your own cloud (BYOC) with Aiven +============================================= + +Enabling :doc:`the bring your own cloud (BYOC) feature ` allows you to create custom clouds in your Aiven organization. A :doc:`custom cloud ` is your own cloud infrastructure integrated with your Aiven organization. Using a custom cloud in Aiven may be the optimal solution if you have specific business needs or project requirements, such as a strict regulatory compliance. + +.. important:: + + Check the availability of the BYOC feature in :ref:`Who is eligible for BYOC `. + +This article provides you with instructions on how to enable BYOC in your Aiven organization. + +About creating a custom cloud +----------------------------- + +.. important:: + + Before getting down to enabling BYOC and, next, creating a custom cloud, make sure you understand all the :ref:`limitations ` and meet all the :ref:`prerequisites `. + +To be able to create custom clouds on the Aiven platform, first you need to enable the BYOC feature using `Aiven Console `_. As soon as BYOC is activated, you can have custom clouds created in your organization. Depending on what cloud provider you want to use for that purpose, the process of creating custom clouds differs. + +* If you want to use the AWS cloud provider, you create your custom cloud yourself in `Aiven Console `_. + +.. topic:: BYOC self-service in Aiven Console + + You configure your custom cloud setup in `Aiven Console `_ and prepare your own AWS account so that Aiven can access it. In `Aiven Console `_, you follow the **Create custom cloud** workflow to generate a Terraform infrastructure-as-code (IaC) template. Next, you deploy this template in your AWS account to acquire Role ARN (Amazon Resource Name). You supply your Role ARN into the **Create custom cloud** wizard, which gives Aiven the permissions to securely access your AWS account, create resources, and manage them onward. Finally, you select projects that can use your new custom clouds for creating services, and you add customer contacts for your custom cloud. + +* If you want to use the GCP or Azure cloud providers, you have your custom cloud created by Aiven, not via Aiven Console. + +.. _byoc-limitations: + +Limitations +----------- + +* You need at least the Priority tier of Aiven support services to be eligible for activating BYOC. +* If you want to build your custom cloud with a cloud provider other than AWS, you cannot use `Aiven Console `_ for this purpose. Aiven creates your custom cloud for you in that case. +* BYOC is supported with the :ref:`standard deployment ` model only. +* Only organization's administrators can create custom clouds. + +.. _byoc-prerequisites: + +Prerequisites +------------- + +* Access to `Aiven Console `_ +* Administrator's role for your Aiven organization +* Active account with your cloud provider +* Terraform installed (if using the AWS cloud provider) +* Terraform permissions + +Enable BYOC +----------- + +Creating custom clouds requires enabling the BYOC feature first. + +1. Log in to `Aiven Console `_ as an administrator. +2. From the top navigation bar, select **Admin**. +3. From the left sidebar, select **Bring you own cloud**. +4. In the **Bring you own cloud** view, select **Contact us**. +5. In the **Enable BYOC** window, select the cloud provider and the cloud region you want to use, add any other information you think might be relevant, and select **Send**. + +.. topic:: Result + + * If you selected the AWS cloud provider, you'll be able to :ref:`create your custom cloud in Aiven Console ` soon. + * If you selected Azure or GCP, we'll set up a custom cloud for you shortly. We might also reach out to you for more details if needed. + +Next steps +---------- + + + +Related reading +--------------- + +* :doc:`Create a custom cloud ` +* :doc:`About bring your own cloud (BYOC) ` +* :doc:`Assign a project to your custom cloud ` +* :doc:`Add customer's contact information for your custom cloud ` +* :doc:`Rename your custom cloud `