Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

platform: byoc mvp docs updates #2173

Merged
merged 8 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/vale/dicts/aiven.dic
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ downsampling
DSBulk
DZone
Elasticsearch
enablement
Epicurious
etcd
event_type
Expand Down
9 changes: 7 additions & 2 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,17 +139,22 @@ entries:
- file: docs/platform/reference/list_of_clouds
- file: docs/platform/concepts/availability-zones
- file: docs/platform/howto/list-byoc
title: BYOC
title: Bring your own cloud (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
title: Assign projects
title: Attach projects
- file: docs/platform/howto/byoc/add-customer-info-custom-cloud
title: Add customer contacts
- file: docs/platform/howto/byoc/rename-custom-cloud
title: Rename custom cloud
- file: docs/platform/howto/byoc/delete-custom-cloud
title: Delete custom cloud
- file: docs/platform/concepts/enhanced-compliance-env
- file: docs/platform/concepts/aiven-node-firewall-configuration
- file: docs/platform/concepts/cloud-security
Expand Down
10 changes: 6 additions & 4 deletions docs/platform/concepts/byoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ About BYOC

Aiven services are usually deployed on Aiven-managed infrastructure, using Aiven-managed security protocols, and backed by Aiven-managed storage and backups. This provides the most seamless straightforward de-risked approach to deploying Aiven services. However, you might need a different configuration if your business, project, or organization has specific requirements for strict regulatory compliance, fine-grained network access control, or cloud purchase commitments in place, for instance.

This is where the bring your own cloud (BYOC) feature comes in enabling you to use your own cloud infrastructure instead of using the Aiven-managed infrastructure. With BYOC, your Aiven organization gets connected with your cloud provider account by creating custom clouds in your Aiven organization. This allows you to manage your infrastructure on the Aiven platform while keeping your data in your own cloud.
This is where the bring your own cloud (BYOC) feature comes in enabling you to use your own cloud infrastructure instead of using the Aiven-managed infrastructure. With BYOC, your Aiven organization gets connected with your cloud provider account by creating custom clouds in your Aiven organization. A custom cloud is a secure environment within your cloud provider account to run Aiven-managed data services. By enabling BYOC, creating custom clouds, and setting up Aiven services within the custom clouds, you can manage your infrastructure on the Aiven platform while keeping your data in your own cloud.

Why use BYOC
------------
Expand All @@ -15,17 +15,19 @@ There a few major reasons to utilize BYOC:

1. **Compliance**: Aiven offers managed environments for several standard compliance regulations, such as HIPAA, PCI DSS, and GDPR. However, if you have strict regulatory requirements or special compliance requirements, BYOC may be the best option for you.
2. **Network auditing**: If you require the visibility of all traffic within any VPC you operate in or need frequent auditing capabilities, BYOC is potentially a good fit. BYOC gives you the ability to audit network metadata but not the actual contents.
3. **Fine-grained network control**: BYOC requires only some specific network access (for example, service management and troubleshooting), otherwise allowing you to customize your network to meet any internal requirements or requirements of your customers.
3. **Fine-grained network control**: BYOC only requires specific network access for Aiven (for example, service management or troubleshooting) to deploy and manage open source data services, otherwise allowing you to customize your network to meet any internal requirements or requirements of your customers.
4. **Cost optimization**: Depending on your cloud provider, with BYOC you can use cost savings plans, committed use discounts, or other strategies to save on compute and storage infrastructure costs related to Aiven services.

.. _eligible-for-byoc:

Who is eligible for BYOC
------------------------

The BYOC setup is a bespoke service offered on a case-by-case basis, and not all cloud providers support it yet. You need to meet a few requirements to be eligible for BYOC:

- 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 greater than $5,000.
- You have an active enterprise support contract.
- Your total monthly spend is at least $5,000.00 for at least 12 months.
- You use at least the `Priority tier of Aiven support services <https://aiven.io/support-services>`_.

When to use the regular Aiven deployment
----------------------------------------
Expand Down
32 changes: 20 additions & 12 deletions docs/platform/howto/byoc/add-customer-info-custom-cloud.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
Add or remove customer contacts for your custom cloud
=====================================================
Add or remove customer contacts for your AWS custom cloud in Aiven
==================================================================

.. topic:: Custom clouds

A :doc:`custom cloud </docs/platform/concepts/byoc>` 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 </docs/platform/concepts/byoc>`. Check the availability of the feature in :ref:`Who is eligible for BYOC <eligible-for-byoc>`. To activate BYOC in your Aiven organization, follow the steps in :doc:`Enable bring your own cloud (BYOC) with Aiven </docs/platform/howto/byoc/enable-byoc>`.

.. important::

Creating custom clouds in your Aiven organization requires enabling :doc:`the bring your own cloud (BYOC) feature </docs/platform/concepts/byoc>`, which is a :doc:`limited availability feature </docs/platform/concepts/beta_services>`. If you're interested in trying it out, contact the sales team at `sales@Aiven.io <mailto:sales@Aiven.io>`_.
Custom cloud configuration in Aiven is an :doc:`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.

This article details how to update the list of customer contacts for your custom cloud using `Aiven Console <https://console.aiven.io/>`_.

Expand All @@ -23,16 +27,18 @@ Update the contacts list
------------------------

1. Log in to `Aiven Console <https://console.aiven.io/>`_ as an administrator.
2. From the left sidebar, select **Bring your own cloud**.
3. In the **Bring you own cloud** view, select one of the clouds available on the list.
4. In the selected cloud's page, use the ellipsis (**...**) menu in the top right corner to select **Customer contact**.
5. 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.
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.

6. When you're done adding all the contacts, select **Save changes**.
8. When you're done adding all the contacts, select **Save changes**.

.. topic:: Result

Expand All @@ -44,10 +50,12 @@ Check it out
You can preview the updated list of contacts by taking the following steps:

1. Log in to `Aiven Console <https://console.aiven.io/>`_ as an administrator.
2. From the left sidebar, select **Bring your own cloud**.
3. In the **Bring you own cloud** view, select one of the clouds available on the list.
4. In the selected cloud's page, use the ellipsis (**...**) menu in the top right corner.
5. Select **Customer contact** from the options available on the the ellipsis (**...**) menu.
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.
7. Select **Customer contact** from the options available on the the ellipsis (**...**) menu.

Related reading
---------------
Expand Down
66 changes: 47 additions & 19 deletions docs/platform/howto/byoc/assign-project-custom-cloud.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,33 @@
Assign a project to your custom cloud
=====================================
Enable your AWS custom cloud in Aiven organizations, units, or projects
=======================================================================

.. topic:: Custom clouds

A :doc:`custom cloud </docs/platform/concepts/byoc>` 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 </docs/platform/concepts/byoc>`. Check the availability of the feature in :ref:`Who is eligible for BYOC <eligible-for-byoc>`. To activate BYOC in your Aiven organization, follow the steps in :doc:`Enable bring your own cloud (BYOC) with Aiven </docs/platform/howto/byoc/enable-byoc>`.

.. important::

Creating custom clouds in your Aiven organization requires enabling :doc:`the bring your own cloud (BYOC) feature </docs/platform/concepts/byoc>`, which is a :doc:`limited availability feature </docs/platform/concepts/beta_services>`. If you're interested in trying it out, contact the sales team at `sales@Aiven.io <mailto:sales@Aiven.io>`_.
Custom cloud configuration in Aiven is an :doc:`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.

This article details how to allow your projects in Aiven to use your custom cloud, for example, to create services.

About making custom clouds available from your projects
-------------------------------------------------------

With the BYOC feature enabled, you can :doc:`create custom clouds </docs/platform/howto/byoc/create-custom-cloud>` in your Aiven organization. As a part of the :doc:`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. 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 <https://console.aiven.io/>`_ and update the settings you configured during the :doc:`initial custom cloud's setup </docs/platform/howto/byoc/create-custom-cloud>`.


This article details how to update the list of projects assigned to your custom cloud using `Aiven Console <https://console.aiven.io/>`_.
1. In the **Custom cloud's availability in your organization** section, select either

About assigning projects to your custom cloud
---------------------------------------------
* **By default for all projects** to make your custom cloud available in all existing and future projects in the organization

With the BYOC feature enabled, you can :doc:`create custom clouds </docs/platform/howto/byoc/create-custom-cloud>` in your Aiven organizations. While :doc:`setting up a custom cloud in Aiven </docs/platform/howto/byoc/create-custom-cloud>`, you add projects for this cloud, which is a part of the initial custom cloud's configuration. Later, you can come back to the **Projects availability** tab in your cloud's page in `Aiven Console <https://console.aiven.io/>`_ and update the projects list you initially created for your cloud.
or

* **By selection** to pick specific projects or organizational units where you want your custom cloud to be available.

2. 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 which you want to be able to use your custom cloud.

Prerequisites
-------------
Expand All @@ -19,34 +36,45 @@ Prerequisites
* At least one :doc:`custom cloud created </docs/platform/howto/byoc/create-custom-cloud>` in your Aiven organization
* Access to `Aiven Console <https://console.aiven.io/>`_

Assign projects
---------------
Enable projects to use your custom cloud
----------------------------------------

1. Log in to `Aiven Console <https://console.aiven.io/>`_ as an administrator.
2. From the left sidebar, select **Bring your own cloud**.
3. In the **Bring you own cloud** view, select one of the clouds available on the list.
4. In the selected cloud's page, navigate to the **Projects availability** tab and select **Assign projects**.
5. In the **Assign projects** window, use the dropdown menu to select a project you want to assign to your cloud.
6. Confirm your choice by selecting **Assign projects**.
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, navigate to the **Available projects** tab and modify the settings provided as needed:

* Select **Set availability** to decide if your custom cloud is available in all the projects in your organization or in selected projects only. In the **Custom cloud's availability in your organization** window, select either **By default for all projects** or **By selection**. If you go for the **By selection** option, dropdown menus **Assign organizational units** and **Assign projects** show up. Use them to select desired organizational units and/ or projects and confirm your choice by selecting **Save**.

.. note::

By selecting an organizational unit, you make your custom cloud available from all the projects in this unit.

* 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

Another project has been added to your custom cloud.
In the projects and/ or organizational units you assigned, you can create services using your custom cloud.

Check it out
------------

You can preview the updated list of assigned projects by taking the following steps:
You can verify if the cloud availability changes you made are live by taking the following steps:

1. Log in to `Aiven Console <https://console.aiven.io/>`_ as an administrator.
2. From the left sidebar, select **Bring your own cloud**.
3. In the **Bring you own cloud** view, select one of the clouds available on the list.
4. In the selected cloud's page, navigate to the **Projects availability** tab.
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, navigate to the **Available projects** tab and check the available projects and organizational units list for the updates you made.

Related reading
---------------

* :doc:`Bring your own cloud </docs/platform/concepts/byoc>`
* :doc:`Enable the bring your own cloud (BYOC) feature </docs/platform/howto/byoc/enable-byoc>`
* :doc:`Create a custom cloud in Aiven </docs/platform/howto/byoc/create-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>`
Loading
Loading