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

Commit

Permalink
Merge branch 'main' into dorota-update-pg-docs-for-the-new-settings-page
Browse files Browse the repository at this point in the history
  • Loading branch information
wojcik-dorota authored Dec 8, 2023
2 parents d7b491e + e73c10b commit 36b83ac
Show file tree
Hide file tree
Showing 72 changed files with 935 additions and 904 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cloud-list.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Cloud - Create PR to update available list

on:
schedule:
- cron: "0 6 * * 2"
- cron: "0 6 * * *"
workflow_dispatch:

jobs:
Expand Down
3 changes: 3 additions & 0 deletions _templates/base.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@

<meta name="description" content="{{ body|striptags|replace("\u00B6", '')|truncate(160) }}">

<!-- Zendesk -->
<meta name="zd-site-verification" content="ocz0liuu2tgqzafi4d9mp">

<!-- Twitter Cards -->
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@aiven_io">
Expand Down
3 changes: 3 additions & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ entries:
title: User and access management
entries:
- file: docs/platform/howto/manage-org-users
title: Invite and remove organization users
- file: docs/platform/howto/delete-user
- file: docs/platform/howto/make-super-admin
- file: docs/platform/howto/list-user-profile
Expand All @@ -79,6 +80,8 @@ entries:
- file: docs/platform/howto/add-authentication-method
- file: docs/platform/reference/password-policy
- file: docs/platform/howto/user-2fa
- file: docs/platform/howto/set-authentication-policies
title: Set authentication policies
- file: docs/platform/concepts/authentication-tokens
- file: docs/platform/howto/create_authentication_token
- file: docs/platform/howto/list-saml
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/datadog.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Datadog and Aiven
=================

`Datadog <https://datadoghq.com/>`_ is a monitoring platform, allowing you to keep an eye on all aspects of your cloud estate. Aiven has integrations that make it easy to include an Aiven service in your Datadog dashboards.
`Datadog <https://www.datadoghq.com/>`_ is a monitoring platform, allowing you to keep an eye on all aspects of your cloud estate. Aiven has integrations that make it easy to include an Aiven service in your Datadog dashboards.

Datadog for metrics
-------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/rsyslog/logtail.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Send Aiven logs to Logtail
==========================

`Logtail <https://betterstack.com/logtail>`_ is a logging service with solid database backing and a cool SQL query interface. You can use the Aiven :doc:`/docs/integrations/rsyslog` to send your logs to Logtail. This article will show you how to set this up.
`Logtail <https://betterstack.com/logs>`_ is a logging service with solid database backing and a cool SQL query interface. You can use the Aiven :doc:`/docs/integrations/rsyslog` to send your logs to Logtail. This article will show you how to set this up.

1. Set up an Rsyslog source on Logtail. Choose **Connect source**, give your source a **Name**, and select "Rsyslog" as the **Platform**.

Expand Down
31 changes: 19 additions & 12 deletions docs/platform/concepts/enhanced-compliance-env.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,24 +50,31 @@ Environment:

The necessary peering information to enable the peer from our end. This differs between clouds:

AWS:
* AWS account ID
* VPC ID
GCP:
* GCP Project ID
* VPC Network Name
Azure:
* Azure Tenant ID
* Azure App ID
* Azure VNet ID
**AWS:**

* AWS account ID
* VPC ID

**GCP:**

* GCP Project ID
* VPC Network Name

**Azure:**

* Azure Tenant ID
* Azure App ID
* Azure VNet ID

What compliances are covered?
--------------------------------
Although not exhaustive, Aiven is capable of supporting both the Health Insurance Portability and
Accountability Act (HIPAA) and the Payment Card Industry Data Security Standard (PCI DSS)
compliances. If you require compliance beyond these please contact our sales department so we
compliances.

If you require compliance beyond these please contact our sales department so we
can better understand your specific needs. Additionally, we also offer an alternative deployment
option -- :doc:`Bring Your Own Cloud (BYOC) </docs/platform/concepts/byoc>`.
option. See :doc:`Bring Your Own Cloud (BYOC) </docs/platform/concepts/byoc>`.

Migrating
----------------
Expand Down
11 changes: 6 additions & 5 deletions docs/platform/concepts/free-plan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,11 @@ Free plans include:
* Monitoring for metrics and logs
* Backups
* Integrations between different Aiven services including free, paid, and trial services
* AWS hosting in a limited number of regions:
* EMEA: aws-eu-north-1, aws-eu-west-1, aws-eu-west-2, aws-eu-west-3
* Americas: aws-us-east-1, aws-us-east-2, aws-us-west-2, aws-ca-central-1
* APAC: aws-ap-south-1
* DigitalOcean hosting in a limited number of regions:

* EMEA: do-ams (Amsterdam), do-ldn (London), do-fra (Frankfurt)
* Americas: do-nyc (New York), do-sfo (San Francisco), do-tor (Toronto)
* APAC: do-blr (Bangalore)

There are some limitations of the free plan services:

Expand All @@ -35,7 +36,7 @@ There are some limitations of the free plan services:
* No forking
* For PostgreSQL: no connection pooling
* Support only through the `Aiven Community Forum <https://aiven.io/community/forum/>`_
* Only a limited number of AWS regions, no other cloud providers
* Only a limited number of DigitalOcean regions, no other cloud providers
* Only one service per service type per user and :doc:`organization </docs/platform/concepts/projects_accounts_access>`
* Not covered under Aiven's 99.99% SLA

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/service_backups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ Aiven for ClickHouse backups contain database lists, table schemas, table conten

.. seealso::

For more information on Aiven for ClickHouse backups, see :ref:`Backup and restore <backup-and-restore>`.
For more information on Aiven for ClickHouse backups, see :doc:`Backup and restore </docs/products/clickhouse/concepts/disaster-recovery>`.

Access to backups
-----------------
Expand Down
3 changes: 2 additions & 1 deletion docs/platform/howto/add-storage-space.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can add storage to your running service in `Aiven Console <https://console.a

4. In the **Upgrade service storage** window, use the slider to add disk storage.

.. note::
.. note::

The price shown for the additional storage includes backup costs.

Expand Down Expand Up @@ -87,4 +87,5 @@ For example, if you use a ``Startup-4`` plan with a 80-GiB disk by default and y
.. note::

- When you perform a service upgrade or downgrade horizontally, remember to include all additional disks the service uses. For example, when switching from ``Startup-4`` to ``Business-4`` or from ``Business-4`` to ``Startup-4``, include all the additional disks available for this service.

- Similarly, when you fork an existing service, include all additional disks the service uses.
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ First, there are some steps that need to be completed on the Google Cloud Market
Google Cloud Marketplace setup
------------------------------

1. Navigate to `Aiven Managed Database Services on the Google Cloud Marketplace <https://console.cloud.google.com/marketplace/product/aiven-public/aiven>`_. This page contains information about all of Aiven's services and how the marketplace subscription works. Click the **Subscribe** button on this page.
#. Navigate to `Aiven Managed Database Services on the Google Cloud Marketplace <https://console.cloud.google.com/marketplace/product/aiven-public/aiven>`_. This page contains information about all of Aiven's services and how the marketplace subscription works. Click the **Subscribe** button on this page.

2. Select your desired billing account, then read and agree to the terms and conditions.
#. Select your desired billing account, then read and agree to the terms and conditions.

3. When you are ready, click the **Subscribe** button at the bottom of the page. You will NOT be charged by clicking this button; this only sets up a billing subscription between GCP and Aiven. You will only be charged after deploying Aiven services.
#. When you are ready, click the **Subscribe** button at the bottom of the page. You will NOT be charged by clicking this button; this only sets up a billing subscription between GCP and Aiven. You will only be charged after deploying Aiven services.

4. You should now see a message that says "Your order request has been sent to Aiven". Click on the **Go to product page** button.
#. You should now see a message that says "Your order request has been sent to Aiven". Click on the **Go to product page** button.

5. Everything is now complete in your GCP account, but you still need to setup the Aiven account. Click on the **Manage on provider** button to go to the Aiven console to complete the process.
#. Everything is now complete in your GCP account, but you still need to setup the Aiven account. Click on the **Manage on provider** button to go to the Aiven console to complete the process.

.. image:: /images/platform/howto/gcp-manage-on-provider.png
:alt: Google Cloud Marketplace page after subscribing, showing the "Manage on provider" button
Expand All @@ -25,14 +25,15 @@ Google Cloud Marketplace setup
Aiven account setup
-------------------

6. You should now be on a signup page at Aiven, asking you for your email address to create a new account.
#. You should now be on a signup page at Aiven, asking you for your email address to create a new account.

7. After entering your email address, you will be sent an email to confirm your registration. Click on the link.
#. After entering your email address, you will be sent an email to confirm your registration. Click on the link.

8. You can now proceed to the `Aiven console for GCP <https://console.gcp.aiven.io/>`_, where you can manage your Aiven services as normal.
#. You can now proceed to the `Aiven console for GCP <https://console.gcp.aiven.io/>`_, where you can manage your Aiven services as normal.

.. image:: /images/platform/howto/gcp-console.png
:alt: The GCP version of the Aiven web console

.. note::
Note the URL is https://console.gcp.aiven.io - this uses a different account system than https://console.aiven.io. If you have an existing Aiven account you will need to create a new Aiven GCP account using the Aiven GCP console, and when coming back to Aiven in the future, you will need to use https://console.gcp.aiven.io to login.

Expand Down
8 changes: 3 additions & 5 deletions docs/platform/howto/byoc/assign-project-custom-cloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,11 @@ With the BYOC feature enabled, you can :doc:`create custom clouds </docs/platfor
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>`.


1. In the **Custom cloud's availability in your organization** section, select either
1. In the **Custom cloud's availability in your organization** section, select either:

* **By default for all projects** to make your custom cloud available in all existing and future projects in the organization
* **By default for all projects** to make your custom cloud available in all existing and future projects in the organization, or;

or

* **By selection** to pick specific projects or organizational units where you want your custom cloud to be available.
* **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.

Expand Down
2 changes: 2 additions & 0 deletions docs/platform/howto/cleanup-powered-off-services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ The Aiven platform receive regular maintenance updates to keep the services upda
Keeping services in powered-off state for a long time lowers the feasibility of a smooth upgrade path, making it harder for Aiven to continue supporting your needs.

.. note::

* It is recommended that you regularly review your services and delete those that are no longer needed. This allows Aiven to focus on supporting the services that you actively use and better utilize platform resources.

* If a service has been powered off for 90 days, you will receive email notifications reminding you that the service has been inactive for a prolonged period. If the service remains powered off for 180 consecutive days, it is subject to automatic deletion.


Expand Down
12 changes: 8 additions & 4 deletions docs/platform/howto/console-fork-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,17 @@ Fork a service using the Aiven client (CLI)
1. Prepare the command to create a new service, this will contain the new copy of your data store.

2. Add the ``service_to_fork_from`` parameter to specify the service to use as the source.
Change service type accordingly with ``-t``, run the following command to see available options::
Change service type accordingly with ``-t``, run the following command to see available options:

avn service types
.. code::
avn service types
For example, if you want to create a fork of your ``forker`` PostgreSQL® service, and name it ``forked``, the command would be something like::
For example, if you want to create a fork of your ``forker`` PostgreSQL® service, and name it ``forked``, the command would be something like:

avn service create forked -t pg --plan business-4 -c service_to_fork_from=forker
.. code::
avn service create forked -t pg --plan business-4 -c service_to_fork_from=forker
.. topic:: Result

Expand Down
8 changes: 4 additions & 4 deletions docs/platform/howto/private-ip-resolution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ DNS-rebinding protection on your network. To verify this assumption:
``8.8.8.8``. This has no rebinding protection so serves as a good test. You can
use the ``dig`` command:

.. code::
.. code::
dig +short myservice-myproject.aivencloud.com @8.8.8.8
dig +short myservice-myproject.aivencloud.com @8.8.8.8
3. Compare the output of the above command with the response from your default DNS resolver:

.. code::
.. code::
dig +short myservice-myproject.aivencloud.com
dig +short myservice-myproject.aivencloud.com
4. If the response from your default DNS resolver does not return the same IP
address as the earlier test, then your default DNS resolver is blocking the
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/saml-authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ SAML Authentication methods are configured at the organization level:

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click on **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
29 changes: 15 additions & 14 deletions docs/platform/howto/saml/setup-saml-auth0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down Expand Up @@ -42,15 +42,15 @@ Configure SAML on Auth0

10. In the **Settings** section for the Application Callback URL, remove the existing configuration and add the following field mapping configuration:

.. code-block:: shell
{
"email": "email",
"first_name": "first_name",
"identity": "email",
"last_name": "last_name",
"mapUnknownClaimsAsIs": true
}
.. code-block:: shell
{
"email": "email",
"first_name": "first_name",
"identity": "email",
"last_name": "last_name",
"mapUnknownClaimsAsIs": true
}
11. Click **Enable** and **Save**.

Expand Down Expand Up @@ -81,10 +81,11 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.
* **Signup URL**: For users that don't have an Aiven user account and need to create a new Aiven user linked to this IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

.. note::
If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.
.. note::

If you set up a SAML authentication method before and are now switching to a new IdP, existing users need to log in with the new account link URL to finish the setup.

Troubleshooting
---------------

If you have issues, you can use the `SAML Tracer browser extension <https://addons.mozilla.org/firefox/addon/saml-tracer/>`_ to check the process step by step.
If you have issues, you can use the `SAML Tracer browser extension <https://addons.mozilla.org/en-US/firefox/addon/saml-tracer>`_ to check the process step by step.
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-fusionauth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-google.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-jumpcloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-okta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/saml/setup-saml-onelogin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Prerequisite steps in Aiven Console

#. In the organization, click **Admin**.

#. Select **Authentication**.
#. Select **Identity providers**.

#. Click **Add authentication method**.
#. Click **Add identity provider**.

#. Enter a name and select SAML. You can also select the groups that users will be added to when they sign up or log in through this authentication method.

Expand Down
Loading

0 comments on commit 36b83ac

Please sign in to comment.