From 5a7142e29dfaf836ef0e54676d7d0442542672df Mon Sep 17 00:00:00 2001 From: ArthurFlageul Date: Wed, 10 Jan 2024 12:11:43 +0100 Subject: [PATCH] fix markup --- .../byoc/add-customer-info-custom-cloud.rst | 4 +--- .../howto/byoc/assign-project-custom-cloud.rst | 4 +--- docs/platform/howto/byoc/create-custom-cloud.rst | 16 +++++----------- docs/platform/howto/byoc/delete-custom-cloud.rst | 4 +--- docs/platform/howto/byoc/enable-byoc.rst | 10 +++------- docs/platform/howto/byoc/rename-custom-cloud.rst | 3 +-- .../howto/saml/setup-saml-fusionauth.rst | 3 +-- 7 files changed, 13 insertions(+), 31 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 1efa780b12..c8cd2d2708 100644 --- a/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst +++ b/docs/platform/howto/byoc/add-customer-info-custom-cloud.rst @@ -1,9 +1,7 @@ Add or remove customer contacts for your AWS custom cloud in Aiven ================================================================== -.. topic:: Custom clouds - - A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. +A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. .. important:: diff --git a/docs/platform/howto/byoc/assign-project-custom-cloud.rst b/docs/platform/howto/byoc/assign-project-custom-cloud.rst index 726d2757cf..06b2c188b2 100644 --- a/docs/platform/howto/byoc/assign-project-custom-cloud.rst +++ b/docs/platform/howto/byoc/assign-project-custom-cloud.rst @@ -1,9 +1,7 @@ Enable your AWS custom cloud in Aiven organizations, units, or projects ======================================================================= -.. topic:: Custom clouds - - A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. +A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. .. important:: diff --git a/docs/platform/howto/byoc/create-custom-cloud.rst b/docs/platform/howto/byoc/create-custom-cloud.rst index 01755db7a6..df41fe5bed 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.rst +++ b/docs/platform/howto/byoc/create-custom-cloud.rst @@ -1,9 +1,7 @@ Create an AWS custom cloud in Aiven =================================== -.. topic:: Custom clouds - - A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. +A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. .. important:: @@ -13,24 +11,20 @@ Create an AWS custom cloud in Aiven 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. -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 creating a custom cloud, make sure you understand all the :ref:`limitations ` and meet all the :ref:`prerequisites `. +Before creating a custom cloud, make sure you understand all the :ref:`limitations ` and meet all the :ref:`prerequisites `. -The process of creating a custom cloud in Aiven differs depending on what cloud provider you want to integrate with: +The process of creating a custom cloud in Aiven differs depending on the 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 `_. +* If you want to use the AWS cloud provider, 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 IAM Role ARN (Amazon Resource Name). You supply your IAM 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 the Aiven team, not via Aiven Console. +* If you want to use the GCP or Azure cloud providers, request the Aiven team to create the cloud. .. _byoc-limitations: diff --git a/docs/platform/howto/byoc/delete-custom-cloud.rst b/docs/platform/howto/byoc/delete-custom-cloud.rst index da67f63b88..c41340c4ec 100644 --- a/docs/platform/howto/byoc/delete-custom-cloud.rst +++ b/docs/platform/howto/byoc/delete-custom-cloud.rst @@ -1,9 +1,7 @@ Delete your AWS custom cloud in Aiven ===================================== -.. topic:: Custom clouds - - A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. +A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. .. important:: diff --git a/docs/platform/howto/byoc/enable-byoc.rst b/docs/platform/howto/byoc/enable-byoc.rst index e49d73a956..08c849431e 100644 --- a/docs/platform/howto/byoc/enable-byoc.rst +++ b/docs/platform/howto/byoc/enable-byoc.rst @@ -46,24 +46,20 @@ Enable BYOC 5. In the **Bring your own cloud** view, select **Contact us**. 6. 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**. -.. topic:: Result - The scheduling assistant shows up so that you can schedule a short 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 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 on enabling BYOC in your environment. -.. topic:: Result - If the call reveals BYOC addresses your needs and your environment is eligible for BYOC, the feature will be enabled for your Aiven organization. Next steps ---------- -With BYOC activated in your Aiven organization, it's possible for you to have custom clouds created: +With BYOC activated in your Aiven organization, you can use custom clouds: -* Either :ref:`by yourself using Aiven Console if the cloud provider you selected was AWS ` -* Or :ref:`by the Aiven team if the cloud provider you selected was GCP or Azure `. +* :ref:`Create them yourself using Aiven Console if the cloud provider you selected was AWS ` +* :ref:`Request the Aiven team to create one if the cloud provider you selected was GCP or Azure `. Related reading --------------- diff --git a/docs/platform/howto/byoc/rename-custom-cloud.rst b/docs/platform/howto/byoc/rename-custom-cloud.rst index 481244c3ff..f7b54fedac 100644 --- a/docs/platform/howto/byoc/rename-custom-cloud.rst +++ b/docs/platform/howto/byoc/rename-custom-cloud.rst @@ -1,9 +1,8 @@ Rename your AWS custom cloud in Aiven ===================================== -.. topic:: Custom clouds - A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. +A :doc:`custom cloud ` is a secure environment within your cloud provider account to run Aiven-managed data services. 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. Creating and using 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 `. .. important:: diff --git a/docs/platform/howto/saml/setup-saml-fusionauth.rst b/docs/platform/howto/saml/setup-saml-fusionauth.rst index 9747b36cad..68c69bae0f 100644 --- a/docs/platform/howto/saml/setup-saml-fusionauth.rst +++ b/docs/platform/howto/saml/setup-saml-fusionauth.rst @@ -79,8 +79,7 @@ Next, create an application in your FusionAuth instance: #. On the **SAML** tab, and toggle on the **Enabled** switch. -#. Paste the **Metadata URL** and **ACS URL** you copied from the Aiven Console to the **Issuer** and -**Authorized redirect URLs** fields in your FusionAuth application, respectively. +#. Paste the **Metadata URL** and **ACS URL** you copied from the Aiven Console to the **Issuer** and **Authorized redirect URLs** fields in your FusionAuth application, respectively. .. list-table:: :header-rows: 1