From bdb531fdda6171b69442451dc75744542dd5949b Mon Sep 17 00:00:00 2001 From: Dorota Wojcik Date: Thu, 25 Jan 2024 15:09:25 +0100 Subject: [PATCH] update byoc docs for aws ga --- .../byoc/add-customer-info-custom-cloud.rst | 21 +++------ .../byoc/assign-project-custom-cloud.rst | 11 ++--- .../howto/byoc/create-custom-cloud.rst | 47 ++++++++++++------- .../howto/byoc/delete-custom-cloud.rst | 4 -- docs/platform/howto/byoc/enable-byoc.rst | 5 +- .../howto/byoc/rename-custom-cloud.rst | 4 -- 6 files changed, 42 insertions(+), 50 deletions(-) diff --git a/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst b/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst index 1ab0fcc93..b47006ead 100644 --- a/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst +++ b/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst @@ -3,14 +3,14 @@ Add or remove customer contacts for your AWS custom cloud in Aiven Update the list of customer contacts for your :doc:`custom cloud `. -.. important:: - - Custom cloud configuration in Aiven is an :doc:`early availability feature `. 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 updating customer contacts -------------------------------- -With the BYOC feature enabled, you can :doc:`create custom clouds ` 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 `_ and update the contacts list you initially created for your cloud. +With the BYOC feature enabled, you can :doc:`create custom clouds ` in your Aiven organizations. While creating a custom cloud in Aiven, you need to add at least **Admin** customer contact, which is a mandatory role required as a primary support contact. Later, you can come back to the the **Customer contact** setting in your cloud's page in `Aiven Console `_ 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 ------------- @@ -22,23 +22,16 @@ Prerequisites Update the contacts list ------------------------ -1. Log in to `Aiven Console `_ as an administrator. +1. Log in to the `Aiven Console `_ as an administrator. 2. 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 available on the list. 6. In the selected cloud's page, use the ellipsis (**...**) menu in the top right corner to select **Customer contact**. 7. In the **Customer contact** window, select a new contact's role 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**. -.. topic:: Result - - The list of contacts for your cloud has been updated. +The list of contacts for your cloud has been updated. Check it out ------------ diff --git a/docs/platform/howto/byoc/assign-project-custom-cloud.rst b/docs/platform/howto/byoc/assign-project-custom-cloud.rst index d04b9240c..c8313f565 100644 --- a/docs/platform/howto/byoc/assign-project-custom-cloud.rst +++ b/docs/platform/howto/byoc/assign-project-custom-cloud.rst @@ -3,14 +3,10 @@ Enable your AWS custom cloud in Aiven organizations, units, or projects To be able to use a :doc:`custom cloud ` in your Aiven organizations, units, or projects, you need to configure its availability. -.. important:: - - Custom cloud configuration in Aiven is an :doc:`early availability feature `. 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 making custom clouds available from your projects ------------------------------------------------------- -With the BYOC feature enabled, you can :doc:`create custom clouds ` in your Aiven organization. As a part of the :doc:`initial custom cloud's setup in Aiven Console `, you select in what projects you'll be able to use your new custom cloud to create services. You decide if you want to make your cloud available for all the projects in your organization, selected organizational units, or specific projects only. +With the BYOC feature enabled, you can :doc:`create custom clouds ` in your Aiven organization. As a part of the :doc:`initial custom cloud's setup in Aiven Console `, you select in what projects you'll be able to use your new custom cloud to host Aiven services. You decide if you want to 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 cloud's page in `Aiven Console `_ and update the settings you configured during the :doc:`initial custom cloud's setup `. @@ -48,9 +44,10 @@ Enable projects to use your custom cloud * Select **Assign projects** to enable your custom cloud in specific organizational units and/ or projects. In the **Assign projects** window, use the available dropdown menus to select desired units and/ or projects as needed. Confirm your choice by selecting **Assign projects**. -.. topic:: Result +In the projects and/ or organizational units for which you enable your custom cloud, you can perform the following operations: - In the projects and/ or organizational units you assigned, you can create services using your custom cloud. +* Create new services in the custom cloud +* Migrate existing services to the custom cloud Check it out ------------ diff --git a/docs/platform/howto/byoc/create-custom-cloud.rst b/docs/platform/howto/byoc/create-custom-cloud.rst index 0160e6322..cecb45a16 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.rst +++ b/docs/platform/howto/byoc/create-custom-cloud.rst @@ -9,10 +9,6 @@ Create a :doc:`custom cloud ` in your Aiven organi * Enabling :doc:`the BYOC feature ` 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 :doc:`early availability feature `. 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 ----------------------------- @@ -520,7 +516,13 @@ Use the Terraform template generated in step :ref:`Generate an infrastructure te 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. + +.. note:: + + In the projects where you enable your custom cloud, you'll be able to create new services in the custom cloud and migrate your existing services to the custom cloud. + +You can make your cloud available for all the projects in your organization, selected organizational units, or specific projects only. Continue working in the **Create custom cloud** wizard by taking the following steps: @@ -541,15 +543,19 @@ Continue working in the **Create custom cloud** wizard by taking the following s 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 by taking the following steps: +Select at least one person whom Aiven can contact in case any technical issues with your need to be fixed. -1. In the **Customer contacts** section, select a contact person's role using the **Job title** dropdown menu, and provide their email address in the **Email** field. -2. Use **+ Add another contact** to add as many customer contacts as needed for your custom cloud. -3. Select **Create**. +.. note:: -.. topic:: Result + **Admin** is a mandatory role, which is required as a primary support contact. - The custom cloud process has been initiated for you, which is communicated in the the **Create custom cloud** wizard as **Creating your custom cloud**. +Continue working in the **Create custom cloud** wizard by taking the following steps: + +1. In the **Customer contacts** section, set up the mandatory **Admin** contact by providing an email address in the **Email** field. +2. Use **+ Add another contact** to add as many customer contacts as needed for your custom cloud: select a contact person's role using the **Job title** dropdown menu, and provide an email address in the **Email** field. +3. Select **Create**. + +The custom cloud process has been initiated for you, which is communicated in the the **Create custom cloud** wizard as **Creating your custom cloud**. Complete the cloud setup '''''''''''''''''''''''' @@ -575,9 +581,7 @@ You can check the status of your custom cloud by taking the following steps: 4. From the left sidebar, select **Bring your own cloud**. 5. In the **Bring your own cloud** view, identify your new cloud on the list of available clouds and check its status in the **Status** column. -.. topic:: Result - - 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. +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 new services in the custom cloud and migrate your existing services to the custom cloud. Next steps ---------- @@ -587,12 +591,19 @@ 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 `_. -Create a service using the new cloud -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Create new services in the custom cloud +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To create a service in `Aiven Console `_ in your new custom cloud, follow the guidelines in :doc:`Create a new service `. + +When creating a service in the `Aiven Console `_, at the **Select service region** step, select **Custom clouds** from among available regions. + +Migrate existing services to the custom cloud +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To create a service in `Aiven Console `_ using your new custom cloud, follow the guidelines in :doc:`Create a new service `. +To migrate an existing Aiven service to your new custom cloud using the `Aiven Console `_, follow the guidelines in :doc:`Migrate service to another cloud or region `. -When you get to the **Select service region** step while setting up your service in `Aiven Console `_, you'll be able to select **Custom clouds** from among available regions. +When migration your service in the `Aiven Console `_ > the **Migrate service to another cloud** window, select **Custom clouds** from among available regions. Related pages ------------- diff --git a/docs/platform/howto/byoc/delete-custom-cloud.rst b/docs/platform/howto/byoc/delete-custom-cloud.rst index c53cd4610..8cc5d3519 100644 --- a/docs/platform/howto/byoc/delete-custom-cloud.rst +++ b/docs/platform/howto/byoc/delete-custom-cloud.rst @@ -3,10 +3,6 @@ Delete your AWS custom cloud in Aiven Delete a :doc:`custom cloud ` so that it's no longer available in your Aiven organizations, units, or projects. -.. important:: - - Custom cloud configuration in Aiven is an :doc:`early availability feature `. 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 deleting custom clouds ---------------------------- diff --git a/docs/platform/howto/byoc/enable-byoc.rst b/docs/platform/howto/byoc/enable-byoc.rst index 9b76ebd70..a7ee673cd 100644 --- a/docs/platform/howto/byoc/enable-byoc.rst +++ b/docs/platform/howto/byoc/enable-byoc.rst @@ -1,8 +1,7 @@ Enable bring your own cloud (BYOC) ================================== -Enabling :doc:`the bring your own cloud (BYOC) feature ` allows you to :doc:`create custom clouds ` in your Aiven organization. For more information on BYOC and custom clouds, check -:doc:`Bring your own cloud (BYOC) `. +Enabling :doc:`the bring your own cloud (BYOC) feature ` allows you to :doc:`create custom clouds ` in your Aiven organization. For more information on BYOC and custom clouds, check :doc:`Bring your own cloud (BYOC) `. .. note:: @@ -14,7 +13,7 @@ About enabling BYOC To be able to create custom clouds on the Aiven platform, first you need to enable the BYOC feature. `Aiven Console `_ offers a quick and easy way to set up a short call with the Aiven sales team to identify your use cases and confirm the requirements. In the call, we make sure BYOC can address them, and we check your environment eligibility for the feature. .. important:: - + Before getting down to enabling BYOC, check the availability of the feature in :ref:`Who is eligible for BYOC `, make sure you understand all the :ref:`limitations `, and meet all the :ref:`prerequisites `. .. _byoc-enable-limitations: diff --git a/docs/platform/howto/byoc/rename-custom-cloud.rst b/docs/platform/howto/byoc/rename-custom-cloud.rst index b39cb8cd8..e4eb76301 100644 --- a/docs/platform/howto/byoc/rename-custom-cloud.rst +++ b/docs/platform/howto/byoc/rename-custom-cloud.rst @@ -3,10 +3,6 @@ Rename your AWS custom cloud in Aiven Change the name of your :doc:`custom cloud `. -.. important:: - - Custom cloud configuration in Aiven is an :doc:`early availability feature `. 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 renaming custom clouds ----------------------------