This repository has been archived by the owner on Jan 29, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 51
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
82d3021
commit 1381d92
Showing
3 changed files
with
97 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| Enable bring your own cloud (BYOC) with Aiven | ||
| ============================================= | ||
|
|
||
| Enabling :doc:`the bring your own cloud (BYOC) feature </docs/platform/concepts/byoc>` allows you to create custom clouds in your Aiven organization. A :doc:`custom cloud </docs/platform/concepts/byoc>` 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 <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 <byoc-limitations>` and meet all the :ref:`prerequisites <byoc-prerequisites>`. | ||
|
|
||
| To be able to create custom clouds on the Aiven platform, first you need to enable the BYOC feature using `Aiven Console <https://console.aiven.io/>`_. 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 <https://console.aiven.io/>`_. | ||
|
|
||
| .. topic:: BYOC self-service in Aiven Console | ||
|
|
||
| You configure your custom cloud setup in `Aiven Console <https://console.aiven.io/>`_ and prepare your own AWS account so that Aiven can access it. In `Aiven Console <https://console.aiven.io/>`_, 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 <https://console.aiven.io/>`_ for this purpose. Aiven creates your custom cloud for you in that case. | ||
| * BYOC is supported with the :ref:`standard deployment <byoc-deployment>` model only. | ||
| * Only organization's administrators can create custom clouds. | ||
|
|
||
| .. _byoc-prerequisites: | ||
|
|
||
| Prerequisites | ||
| ------------- | ||
|
|
||
| * Access to `Aiven Console <https://console.aiven.io/>`_ | ||
| * 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 <https://console.aiven.io/>`_ 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 <create-cloud>` 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 </docs/platform/howto/byoc/create-custom-cloud>` | ||
| * :doc:`About bring your own cloud (BYOC) </docs/platform/concepts/byoc>` | ||
| * :doc:`Assign a project to your custom cloud </docs/platform/howto/byoc/assign-project-custom-cloud>` | ||
| * :doc:`Add customer's contact information for your custom cloud </docs/platform/howto/byoc/add-customer-info-custom-cloud>` | ||
| * :doc:`Rename your custom cloud </docs/platform/howto/byoc/rename-custom-cloud>` |