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 read-replicas-slow-query-log-warning
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-martin-aiven authored Aug 25, 2023
2 parents 9dd6734 + e37c77d commit 609c5d7
Show file tree
Hide file tree
Showing 27 changed files with 160 additions and 100 deletions.
2 changes: 2 additions & 0 deletions .github/vale/styles/Aiven/capitalization_headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ exceptions:
- APIs
- Aiven
- Aiven Console
- Aiven Provider
- Aiven Provider for Terraform
- Apache
- AWS Transit Gateway
- AWS Marketplace
Expand Down
122 changes: 66 additions & 56 deletions _toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,8 @@ entries:
# -------- TOOLS --------
- file: docs/tools
entries:

# -------- CLI --------
- file: docs/tools/cli
entries:
- file: docs/tools/cli/account
Expand All @@ -242,79 +244,87 @@ entries:
entries:
- glob: docs/tools/cli/user/*
- file: docs/tools/cli/vpc

# -------- API --------
- file: docs/tools/api
title: Aiven API
entries:
- file: docs/tools/api/examples

# -------- TERRAFORM --------
- file: docs/tools/terraform
title: Aiven Terraform provider
title: Aiven Provider for Terraform
entries:
- file: docs/tools/terraform/get-started
title: Get started
- file: docs/tools/terraform/howto
title: HowTo
- file: docs/tools/terraform/concepts/data-sources
- file: docs/tools/terraform/howto/terraform-logging
title: Enable debug logging
- file: docs/tools/terraform/howto/promote-to-master-pg-rr
title: Promote PostgreSQL read-only replica to primary
- file: docs/tools/terraform/howto/config-postgresql-provider
title: Use PostgreSQL Provider with Aiven Provider
- file: docs/tools/terraform/list-upgrade-terraform
title: Upgrade Aiven Provider
entries:
- file: docs/tools/terraform/howto/terraform-logging
title: Enable debug logging
- file: docs/tools/terraform/howto/upgrade-provider-v1-v2
title: Upgrade the Aiven Terraform Provider from v1 to v2
title: Upgrade from v1 to v2
- file: docs/tools/terraform/howto/upgrade-provider-v2-v3
title: Upgrade the Aiven Terraform Provider from v2 to v3
title: Upgrade from v2 to v3
- file: docs/tools/terraform/howto/upgrade-provider-v3-v4
title: Upgrade the Aiven Terraform Provider from v3 to v4
- file: docs/tools/terraform/howto/update-deprecated-resources
- file: docs/tools/terraform/howto/config-postgresql-provider
title: Use PostgreSQL provider alongside Aiven Terraform Provider
- file: docs/tools/terraform/howto/promote-to-master-pg-rr
title: Promote PostgreSQL read-only replica to master
title: Upgrade from v3 to v4
- file: docs/tools/terraform/howto/upgrade-to-opensearch
- file: docs/tools/terraform/howto/update-deprecated-resources
- file: docs/tools/terraform/list-vpc-terraform
title: Virtual network peering
entries:
- file: docs/tools/terraform/howto/vpc-peering-aws
title: Set up AWS virtual network peering
- file: docs/tools/terraform/howto/vnet-peering-azure
title: Set up Azure virtual network peering
- file: docs/tools/terraform/howto/vpc-peering-gcp
- file: docs/tools/terraform/howto/vpc-peering-aws
- file: docs/tools/terraform/concepts
title: Concepts
title: Set up Google Cloud Platform virtual network peering
- file: docs/tools/terraform/reference/cookbook
title: Terraform Cookbook
entries:
- glob: docs/tools/terraform/concepts/*
- file: docs/tools/terraform/reference
- file: docs/tools/terraform/reference/cookbook/kafka-connect-terraform-recipe
title: Apache Kafka and OpenSearch
- file: docs/tools/terraform/reference/cookbook/multicloud-postgresql-recipe
title: Multicloud PostgreSQL
- file: docs/tools/terraform/reference/cookbook/kafka-flink-integration-recipe
title: Apache Kafka and Apache Flink
- file: docs/tools/terraform/reference/cookbook/kafka-mirrormaker-recipe
title: Apache Kafka and Apache MirrorMaker
- file: docs/tools/terraform/reference/cookbook/kafka-karapace-recipe
title: Apache Kafka with Karapace
- file: docs/tools/terraform/reference/cookbook/grafana-m3db-postgresql-recipe
title: Visualize PostgreSQL metrics with Grafana
- file: docs/tools/terraform/reference/cookbook/postgresql-custom-configs-recipe
title: PostgreSQL with custom configs
- file: docs/tools/terraform/reference/cookbook/kafka-mongodb-recipe
title: Apache Kafka MongoDB Source Connector
- file: docs/tools/terraform/reference/cookbook/kafka-debezium-postgres-source
title: Debezium Source Connector across clouds
- file: docs/tools/terraform/reference/cookbook/kafka-topics-http-connector-recipe.rst
title: Apache Kafka with topics and HTTP sink connector
- file: docs/tools/terraform/reference/cookbook/kafka-custom-conf-recipe.rst
title: Apache Kafka with custom configurations
- file: docs/tools/terraform/reference/cookbook/m3db-m3agg-recipe
title: M3 and M3 Aggregator
- file: docs/tools/terraform/reference/cookbook/postgresql-read-replica-recipe
title: PostgreSQL® read-only replica
- file: docs/tools/terraform/reference/cookbook/clickhouse-access-setup-recipe
title: Configure ClickHouse user's access
- file: docs/tools/terraform/reference/cookbook/kafka-clickhouse-integration-recipe
title: Apache Kafka and ClickHouse
- file: docs/tools/terraform/reference/cookbook/postgres-clickhouse-integration-recipe
title: ClickHouse and PostgreSQL
- file: docs/tools/terraform/reference/troubleshooting
entries:
- file: docs/tools/terraform/reference/cookbook
entries:
- file: docs/tools/terraform/reference/cookbook/kafka-connect-terraform-recipe
title: Apache Kafka and OpenSearch
- file: docs/tools/terraform/reference/cookbook/multicloud-postgresql-recipe
title: Multicloud PostgreSQL
- file: docs/tools/terraform/reference/cookbook/kafka-flink-integration-recipe
title: Apache Kafka and Apache Flink
- file: docs/tools/terraform/reference/cookbook/kafka-mirrormaker-recipe
title: Apache Kafka and Apache MirrorMaker
- file: docs/tools/terraform/reference/cookbook/kafka-karapace-recipe
title: Apache Kafka with Karapace
- file: docs/tools/terraform/reference/cookbook/grafana-m3db-postgresql-recipe
title: Visualize PostgreSQL metrics with Grafana
- file: docs/tools/terraform/reference/cookbook/postgresql-custom-configs-recipe
title: PostgreSQL with custom configs
- file: docs/tools/terraform/reference/cookbook/kafka-mongodb-recipe
title: Apache Kafka MongoDB Source Connector
- file: docs/tools/terraform/reference/cookbook/kafka-debezium-postgres-source
title: Debezium Source Connector across clouds
- file: docs/tools/terraform/reference/cookbook/kafka-topics-http-connector-recipe.rst
title: Apache Kafka with topics and HTTP sink connector
- file: docs/tools/terraform/reference/cookbook/kafka-custom-conf-recipe.rst
title: Apache Kafka with custom configurations
- file: docs/tools/terraform/reference/cookbook/m3db-m3agg-recipe
title: M3 and M3 Aggregator
- file: docs/tools/terraform/reference/cookbook/postgresql-read-replica-recipe
title: PostgreSQL® read-only replica
- file: docs/tools/terraform/reference/cookbook/clickhouse-access-setup-recipe
title: Configure ClickHouse user's access
- file: docs/tools/terraform/reference/cookbook/kafka-clickhouse-integration-recipe
title: Apache Kafka and ClickHouse
- file: docs/tools/terraform/reference/cookbook/postgres-clickhouse-integration-recipe
title: ClickHouse and PostgreSQL
- file: docs/tools/terraform/reference/troubleshooting
entries:
- file: docs/tools/terraform/reference/troubleshooting/private-access-error
title: Private access error when using VPC
- file: docs/tools/terraform/reference/troubleshooting/private-access-error
title: Private access error when using VPC

# -------- KUBERNETES --------
- file: docs/tools/kubernetes
title: Aiven Operator for Kubernetes

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/byoc/create-custom-cloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ In the **Create custom cloud** workflow, proceed as follows:

**BYOC standard** is the only option supported currently.

1. Select **Next**.
2. Select **Next**.

.. topic:: Result

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/saml/saml-authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ After the authentication method is enabled, there are two URLs in the **Signup a
* **Signup URL**: For users that don't have an Aiven user account to create a new Aiven user linked to the configured IdP.
* **Account link URL**: For users that already have an Aiven user account to link their existing Aiven user with the configured IdP.

Send the appropriate URL to link the authentication method to a new or existing Aiven user.
Send the appropriate URL to link the authentication method to a new or existing Aiven user. 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.

When a user clicks on the link, they will be redirected to a page to link their Aiven user account with the SAML account:

Expand Down
8 changes: 7 additions & 1 deletion docs/platform/howto/saml/setup-saml-auth0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,13 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

5. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.
6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

Troubleshooting
---------------
Expand Down
8 changes: 7 additions & 1 deletion docs/platform/howto/saml/setup-saml-azure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,13 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

5. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.
6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

Troubleshooting
---------------
Expand Down
11 changes: 6 additions & 5 deletions docs/platform/howto/saml/setup-saml-fusionauth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,13 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

6. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.


.. image:: /images/platform/howto/saml/fusionauth/login-sso.png
:alt: Logging in to Aiven.
7. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

Troubleshooting
---------------
Expand Down
8 changes: 7 additions & 1 deletion docs/platform/howto/saml/setup-saml-google.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,13 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

5. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.
6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

Troubleshooting
---------------
Expand Down
8 changes: 7 additions & 1 deletion docs/platform/howto/saml/setup-saml-jumpcloud.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,13 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

6. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.
7. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

Troubleshooting
---------------
Expand Down
10 changes: 8 additions & 2 deletions docs/platform/howto/saml/setup-saml-okta.rst
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,14 @@ Go back to the **Authentication** page in the `Aiven Console <https://console.ai

5. Click ``Edit Method`` to save the settings.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.

6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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.

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

Expand Down
12 changes: 8 additions & 4 deletions docs/platform/howto/saml/setup-saml-onelogin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Configure SAML on OneLogin

#. Click **Save**

#. Assign users to this application.
#. Assign users to this application.


Finish the configuration in Aiven
Expand All @@ -84,10 +84,14 @@ Go back to the **Authentication** page in `Aiven Console <https://console.aiven.

5. Toggle on **Enable authentication method** at the top of the page.

You can use the **Signup URL** to invite new users, or the **Account link URL** for those that already have an Aiven user account.
6. In the **Signup and link accounts URLs** section, copy the appropriate link and send it to your users to switch them to the new IdP:

* **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::
You need to assign users in OneLogin for the connection to work.

Troubleshooting
----------------
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Create a source connector from Apache Kafka® to MQTT
=======================================================
Create a source connector from MQTT to Apache Kafka®
====================================================

The `MQTT source connector <https://docs.lenses.io/5.0/integrations/connectors/stream-reactor/sources/mqttsourceconnector/>`_ copies messages from the MQTT topic into Apache Kafka® where they can be transformed and read by multiple consumers. Then, the Stream Reactor MQTT source connector creates a queue and binds it to the ``amq.topic`` defined in the KCQL statement, then messages are copied to the Apache Kafka® service.

Expand Down
6 changes: 3 additions & 3 deletions docs/tools/terraform.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Aiven Terraform provider
========================
Aiven Provider for Terraform
=============================

With Aiven's `Terraform <https://www.terraform.io>`_ provider, you can use an open-source infrastructure as code software tool to declare and manage your cloud services.

Expand All @@ -16,7 +16,7 @@ See the `Aiven Terraform provider documentation <https://registry.terraform.io/p
Getting started
---------------

Check out the :doc:`getting started guide </docs/tools/terraform/get-started>` for your first Terraform project.
Check out the :doc:`get started guide </docs/tools/terraform/get-started>` for your first Terraform project.

.. grid:: 1 2 2 2

Expand Down
6 changes: 3 additions & 3 deletions docs/tools/terraform/concepts.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:orphan:

Understanding the Aiven Terraform provider
==========================================

In this section you can learn more about the concepts used with the Aiven Terraform provider.

.. tableofcontents::
:doc:`Data sources in Terraform </docs/tools/terraform/concepts/data-sources>`
4 changes: 2 additions & 2 deletions docs/tools/terraform/concepts/data-sources.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Data sources in Terraform
=========================
Data sources
=============

It is common to want your Terraform configuration to refer to information beyond the current Terraform definition, either because it is defined in a separate Terraform project, or because the item is not under the control of Terraform. This is supported in Terraform by a concept called `data sources <https://www.terraform.io/language/data-sources>`_. Providers offer data sources alongside their data types, and in the Aiven Terraform provider, you will find that there are many situations where the same item appears as both a managed resource and a read-only data source.

Expand Down
6 changes: 3 additions & 3 deletions docs/tools/terraform/howto.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:orphan:

HowTo
=====

A collection of helpful guides for performing tasks with Aiven Terraform Provider.

.. tableofcontents::
:doc:`Get started with Aiven Provider for Terraform </docs/tools/terraform/get-started>`
2 changes: 1 addition & 1 deletion docs/tools/terraform/howto/upgrade-provider-v1-v2.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Upgrade the Aiven Terraform Provider from v1 to v2
Upgrade Aiven Provider for Terraform from v1 to v2
==================================================

Version 2 of the Aiven Terraform Provider was released in `October of
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/terraform/howto/upgrade-provider-v2-v3.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Upgrade the Aiven Terraform Provider from v2 to v3
Upgrade Aiven Provider for Terraform from v2 to v3
==================================================

This article will walk you through upgrading the Aiven Terraform Provider from v2 to v3.
Expand Down
2 changes: 1 addition & 1 deletion docs/tools/terraform/howto/upgrade-provider-v3-v4.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Upgrade the Aiven Terraform Provider from v3 to v4
Upgrade Aiven Provider for Terraform from v3 to v4
===================================================

The Aiven Terraform Provider version 4.0.0 was released in February 2023. If you previously upgraded the Terraform provider from version 2 to version 3, then no other actions are needed. Otherwise, this article has information on how to upgrade to version 4.
Expand Down
Loading

0 comments on commit 609c5d7

Please sign in to comment.