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

Commit

Permalink
Change developer.aiven.io to docs.aiven.io
Browse files Browse the repository at this point in the history
  • Loading branch information
TibsAtWork committed Nov 10, 2022
1 parent 3582957 commit e4eb23b
Show file tree
Hide file tree
Showing 33 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion SEARCH.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ In addition to these `url` field should be provided with every document but it i

## Search function

The OpenSearch® index is used through the Netlify function in [netlify/functions/search/search.js](netlify/functions/search/search.js). To call the function, make a GET request to the function URL and append your search term to the `query` parameter, like this: [https://developer.aiven.io/.netlify/functions/search?query=redis](https://developer.aiven.io/.netlify/functions/search?query=redis).
The OpenSearch® index is used through the Netlify function in [netlify/functions/search/search.js](netlify/functions/search/search.js). To call the function, make a GET request to the function URL and append your search term to the `query` parameter, like this: [https://docs.aiven.io/.netlify/functions/search?query=redis](https://docs.aiven.io/.netlify/functions/search?query=redis).

The query uses this overall approach:

Expand Down
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
html_baseurl = 'https://docs.aiven.io'
# Since we have `language='en'` set (further down) the URLs in the sitemap will
# default to "{version}{lang}{link}", producing things like
# <url><loc>https://developer.aiven.io/en/docs/platform/howto/create_authentication_token.html</loc></url>
# <url><loc>https://docs.aiven.io/en/docs/platform/howto/create_authentication_token.html</loc></url>
# That doesn't work because we do not produce pages with the `/en` in the URL.
# We need to be explicit that we don't want {version} or {language} in the URLs
sitemap_url_scheme = "{link}"
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Learn about some of the key concepts for working with Aiven platform:

.. We would like to use a :doc: role for this, but at 2022-08, vale will
spell-check the URL if we do so, and complain about 'timeseries'
.. _`Choosing a time series database`: https://developer.aiven.io/docs/platform/concepts/choosing-timeseries-database
.. _`Choosing a time series database`: https://docs.aiven.io/docs/platform/concepts/choosing-timeseries-database



Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Rotating Grafana® service credentials
In the interests of security, it is best practice to rotate credentials from time-to-time.

For Grafana®, a few steps need to be performed manually to do this. You will need to have access to a web browser,
and to have installed ``avn``, the `Aiven CLI tool <https://developer.aiven.io/docs/tools/cli.html>`_.
and to have installed ``avn``, the `Aiven CLI tool <https://docs.aiven.io/docs/tools/cli.html>`_.

1. In the web browser, go to the `Aiven Console <https://console.aiven.io/>`_ page for your Grafana service.

Expand Down
4 changes: 2 additions & 2 deletions docs/products/kafka/howto/connect-with-command-line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Variable Description

.. _`the guide to set up properties to use the Apache Kafka toolbox`: toolbox_
.. _`for Apache Kafka toolbox`: toolbox_
.. _toolbox: https://developer.aiven.io/docs/products/kafka/howto/kafka-tools-config-file.html
.. _toolbox: https://docs.aiven.io/docs/products/kafka/howto/kafka-tools-config-file.html

In the command lines below, values in ``{`` and ``}`` are to be replaced - so ``{PORT}`` would be replaced by the appropriate port number, for instance ``12345``.

Expand Down Expand Up @@ -65,7 +65,7 @@ With ``kafka-avro-console-producer`` you can include the schema by connecting to

1. The ``schema.registry.url`` value must be a full URL, typically starting with ``https://``
2. Aiven's `Karapace <https://karapace.io/>`_ is an acceptable schema registry for this purpose.
See `Use Karapace with Aiven for Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/enable-karapace.html>`_ for how to enable it for your Aiven for Kafka service. The ``SCHEMA_REGISTRY_`` values for the command line can be found on the service Overview page, on the **Schema registry** tab.
See `Use Karapace with Aiven for Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/enable-karapace.html>`_ for how to enable it for your Aiven for Kafka service. The ``SCHEMA_REGISTRY_`` values for the command line can be found on the service Overview page, on the **Schema registry** tab.

.. code::
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-go.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-java.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/connect-with-nodejs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand Down
6 changes: 3 additions & 3 deletions docs/products/kafka/howto/connect-with-python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ These examples show how to connect to an Aiven for Apache Kafka® service using

.. note:: The examples given here provide different options for the different authentication
methods. For more information on the supported methods, see `our article on Kafka
authentication types <https://developer.aiven.io/docs/products/kafka/concepts/auth-types>`_.
authentication types <https://docs.aiven.io/docs/products/kafka/concepts/auth-types>`_.

Pre-requisites
--------------
Expand All @@ -35,7 +35,7 @@ Go to the *Overview* page of your Aiven for Apache Kafka service.

* If you are going to connect using SASL authentication:

#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://developer.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.
#. Follow the instructions at `Use SASL Authentication with Apache Kafka® <https://docs.aiven.io/docs/products/kafka/howto/kafka-sasl-auth.html>`_ to enable SASL.

#. In the *Connection Information* section

Expand All @@ -48,7 +48,7 @@ Note that the *CA Certificate* ``ca.pem`` file has the same contents by either r

In the below examples, we just pass the name of the certificate files, but in actual use, the full path should be used.

You can also use the `Aiven command line tool <https://developer.aiven.io/docs/tools/cli.html>`_ to download the files. See the documentation for `avn service user-creds-download <https://developer.aiven.io/docs/tools/cli/service/user.html#avn-service-user-creds-download>`_
You can also use the `Aiven command line tool <https://docs.aiven.io/docs/tools/cli.html>`_ to download the files. See the documentation for `avn service user-creds-download <https://docs.aiven.io/docs/tools/cli/service/user.html#avn-service-user-creds-download>`_


Variables
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/flink-with-aiven-for-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The example in this article shows you how to create a simple Java Flink job that
Prerequisites
-------------

You need an Aiven for Apache Kafka service up and running with two topics, named ``test-flink-input`` and ``test-flink-output``, already `created <https://developer.aiven.io/docs/products/kafka/howto/create-topic.html>`_.
You need an Aiven for Apache Kafka service up and running with two topics, named ``test-flink-input`` and ``test-flink-output``, already `created <https://docs.aiven.io/docs/products/kafka/howto/create-topic.html>`_.
Furthermore, for the example, you need to collect the following information about the Aiven for Apache Kafka service:

* ``APACHE_KAFKA_HOST``: The hostname of the Apache Kafka service
Expand Down
2 changes: 1 addition & 1 deletion docs/products/kafka/howto/ksql-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Use ksqlDB with Aiven for Apache Kafka®

Aiven provides a managed Apache Kafka® solution together with a number of auxiliary services like Apache Kafka Connect, Kafka REST and Schema Registry via `Karapace <https://github.com/aiven/karapace>`_. A managed `ksqlDB <https://ksqldb.io/>`_ service in Aiven is, however, not supported. If you want to define streaming data pipelines with SQL, you have two options:

* Use `Aiven for Apache Flink® <https://developer.aiven.io/docs/products/flink.html>`_
* Use `Aiven for Apache Flink® <https://docs.aiven.io/docs/products/flink.html>`_
* Run a self-hosted ksqlDB cluster.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Sink connectors enable the integration of data from an existing Apache Kafka top

* :doc:`Aiven for Apache Kafka® S3 Sink Connector <../howto/s3-sink-connector-aiven>`

* `Confluent Amazon S3 Sink <https://developer.aiven.io/docs/products/kafka/kafka-connect/howto/s3-sink-connector-confluent>`__
* `Confluent Amazon S3 Sink <https://docs.aiven.io/docs/products/kafka/kafka-connect/howto/s3-sink-connector-confluent>`__

* `Couchbase® <https://github.com/couchbase/kafka-connect-couchbase>`__

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Furthermore you need to collect the following information about the source Postg
* ``PLUGIN_NAME``: The `logical decoding plugin <https://debezium.io/documentation/reference/stable/connectors/postgresql.html>`_, possible values are ``decoderbufs``, ``wal2json`` and ``pgoutput``
* ``PG_TABLES``: The list of database tables to be included in Apache Kafka; the list must be in the form of ``schema_name1.table_name1,schema_name2.table_name2``
* ``PG_PUBLICATION_NAME``: The name of the `PostgreSQL logical replication publication <https://www.postgresql.org/docs/current/logical-replication-publication.html>`_, if left empty, ``debezium`` is used as default
* ``PG_SLOT_NAME``: name of the `PostgreSQL replication slot <https://developer.aiven.io/docs/products/postgresql/howto/setup-logical-replication>`_, if left empty, ``debezium`` is be used as default
* ``PG_SLOT_NAME``: name of the `PostgreSQL replication slot <https://docs.aiven.io/docs/products/postgresql/howto/setup-logical-replication>`_, if left empty, ``debezium`` is be used as default
* ``APACHE_KAFKA_HOST``: The hostname of the Apache Kafka service, only needed when using Avro as data format
* ``SCHEMA_REGISTRY_PORT``: The Apache Kafka's schema registry port, only needed when using Avro as data format
* ``SCHEMA_REGISTRY_USER``: The Apache Kafka's schema registry username, only needed when using Avro as data format
Expand Down
2 changes: 1 addition & 1 deletion docs/products/mysql/concepts/mysql-backups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ More resources
--------------

- Our blog post: `MyHoard, your solution to MySQL backups and restoration <https://aiven.io/blog/introducing-myhoard-your-single-solution-to-mysql-backups-and-restoration>`_
- Read about `Aiven cloud security and data encryption <https://developer.aiven.io/docs/platform/concepts/cloud-security#data-encryption>`_
- Read about `Aiven cloud security and data encryption <https://docs.aiven.io/docs/platform/concepts/cloud-security#data-encryption>`_
2 changes: 1 addition & 1 deletion docs/products/opensearch/howto/connect-with-nodejs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Connect to OpenSearch® cluster with NodeJS

The most convenient way to work with the cluster when using NodeJS is to rely on `OpenSearch® JavaScript client <https://github.com/opensearch-project/opensearch-js>`_. Follow its ``README`` file for installation instructions.

To connect to the cluster, you'll need ``service_uri``, which you can find either in the service overview in the `Aiven console <https://console.aiven.io>`_ or get through the Aiven command line interface `service command <https://developer.aiven.io/docs/tools/cli/service.html#avn-service-get>`_. ``service_uri`` contains credentials, therefore should be treated with care.
To connect to the cluster, you'll need ``service_uri``, which you can find either in the service overview in the `Aiven console <https://console.aiven.io>`_ or get through the Aiven command line interface `service command <https://docs.aiven.io/docs/tools/cli/service.html#avn-service-get>`_. ``service_uri`` contains credentials, therefore should be treated with care.

We strongly recommend using environment variables for credential information. A good way to do this is to use ``dotenv``. You will find installation and usage instructions `on its library's project page <https://github.com/motdotla/dotenv>`_, but in short, you need to create ``.env`` file in the project and assign ``SERVICE_URI`` inside of this file.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ Calculate percentiles for `calories`:
}
}

From the returned result you can see that 50% of recipes have less than 331 calories. Interestingly, only one percent of the meals is more than 3256 calories. You must be curious what falls within that last percentile ;) Now that we know the value to look for, we can use `a range query <https://developer.aiven.io/docs/products/opensearch/howto/opensearch-and-nodejs.html#find-fields-with-a-value-within-a-range>`_ to find the recipes. Set the minimum value, but keep the maximum empty to allow no bounds:
From the returned result you can see that 50% of recipes have less than 331 calories. Interestingly, only one percent of the meals is more than 3256 calories. You must be curious what falls within that last percentile ;) Now that we know the value to look for, we can use `a range query <https://docs.aiven.io/docs/products/opensearch/howto/opensearch-and-nodejs.html#find-fields-with-a-value-within-a-range>`_ to find the recipes. Set the minimum value, but keep the maximum empty to allow no bounds:

::

Expand Down
2 changes: 1 addition & 1 deletion docs/products/postgresql/howto/migrate-using-bucardo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ To migrate your data using Bucardo:
instructions <https://bucardo.org/Bucardo/installation/>`__ on the
Bucardo site.

#. | Install the ``aiven_extras`` `extension <https://developer.aiven.io/docs/products/postgresql/concepts/dba-tasks-pg.html#aiven-extras-extension>`_ to your current database.
#. | Install the ``aiven_extras`` `extension <https://docs.aiven.io/docs/products/postgresql/concepts/dba-tasks-pg.html#aiven-extras-extension>`_ to your current database.
| Bucardo requires the superuser role to set the
``session_replication_role`` parameter. Aiven uses the open source
``aiven_extras`` extension to allow you to run ``superuser``
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
High CPU load when using PgBouncer
==================================

PgBouncer is a lightweight connection pooler for PostgreSQL®. For the setup and configurations of PgBouncer please refer to this `help article. <https://developer.aiven.io/docs/products/postgresql/concepts/pg-connection-pooling.html>`_
PgBouncer is a lightweight connection pooler for PostgreSQL®. For the setup and configurations of PgBouncer please refer to this `help article. <https://docs.aiven.io/docs/products/postgresql/concepts/pg-connection-pooling.html>`_

During the usage of PgBouncer pooling, you may see a high percentage of CPU load by PgBouncer, which indicates a problem with the usage pattern.
Historically, the reason for the high CPU usage in PgBouncer is most likely the high incoming SSL connection rate. SSL handshakes cost quite a bit when the user run the query and then disconnect/reconnect again for the next query.
Expand Down
4 changes: 2 additions & 2 deletions docs/tools/terraform/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Prepare the dependencies
''''''''''''''''''''''''
- `Download and install Terraform <https://www.terraform.io/downloads.html>`_
- `Sign up <https://console.aiven.io/signup?utm_source=github&utm_medium=organic&utm_campaign=devportal&utm_content=repo>`_ for Aiven if you haven't already
- `Generate an authentication token <https://developer.aiven.io/docs/platform/howto/create_authentication_token.html>`_
- `Generate an authentication token <https://docs.aiven.io/docs/platform/howto/create_authentication_token.html>`_

.. Tip::

Make sure that you have either the *Administrator* or *Operator* role when creating the API token. When you create a project, you automatically receive the *Administrator* access.

For more details, refer to the `Project members and roles page <https://developer.aiven.io/docs/platform/concepts/projects_accounts_access.html#project-members-and-roles>`_.
For more details, refer to the `Project members and roles page <https://docs.aiven.io/docs/platform/concepts/projects_accounts_access.html#project-members-and-roles>`_.

Configure your project and services
'''''''''''''''''''''''''''''''''''
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,8 @@ More resources

You might find these related resources useful too:

- `Configuration options for Aiven for Grafana <https://developer.aiven.io/docs/products/grafana/reference/advanced-params.html>`_
- `Configuration options for Aiven for PostgreSQL <https://developer.aiven.io/docs/products/postgresql/reference/list-of-advanced-params.html>`_
- `Configuration options for Aiven for M3DB <https://developer.aiven.io/docs/products/m3db/reference/advanced-params.html>`_
- `Set up your first Aiven Terraform project <https://developer.aiven.io/docs/tools/terraform/get-started.html>`_
- `Configuration options for Aiven for Grafana <https://docs.aiven.io/docs/products/grafana/reference/advanced-params.html>`_
- `Configuration options for Aiven for PostgreSQL <https://docs.aiven.io/docs/products/postgresql/reference/list-of-advanced-params.html>`_
- `Configuration options for Aiven for M3DB <https://docs.aiven.io/docs/products/m3db/reference/advanced-params.html>`_
- `Set up your first Aiven Terraform project <https://docs.aiven.io/docs/tools/terraform/get-started.html>`_
- `Metrics and graphs with M3 and Grafana <https://aiven.io/blog/metrics-and-graphs-with-m3-and-grafana>`_
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,6 @@ More resources

You might find these related resources useful too:

- `Configuration options for Kafka <https://developer.aiven.io/docs/products/kafka/reference/advanced-params.html>`_
- `Configuration options for OpenSearch <https://developer.aiven.io/docs/products/opensearch/reference/advanced-params.html>`_
- `Configuration options for Kafka <https://docs.aiven.io/docs/products/kafka/reference/advanced-params.html>`_
- `Configuration options for OpenSearch <https://docs.aiven.io/docs/products/opensearch/reference/advanced-params.html>`_

Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ More resources

Keep in mind that some parameters and configurations will vary for your case. Some related resources are provided below:

- `Configuration options for Aiven for Apache Kafka <https://developer.aiven.io/docs/products/kafka/reference/advanced-params.html>`_
- `Aiven for Apache Kafka access control lists permission mapping <https://developer.aiven.io/docs/products/kafka/concepts/acl.html>`_
- `Configuration options for Aiven for Apache Kafka <https://docs.aiven.io/docs/products/kafka/reference/advanced-params.html>`_
- `Aiven for Apache Kafka access control lists permission mapping <https://docs.aiven.io/docs/products/kafka/concepts/acl.html>`_
- `How to Manage Aiven for Apache Kafka Parameters <https://www.youtube.com/watch?v=pXQZWI0ddLg>`_
- `Set up your first Aiven Terraform project <https://developer.aiven.io/docs/tools/terraform/get-started.html>`_
- `Set up your first Aiven Terraform project <https://docs.aiven.io/docs/tools/terraform/get-started.html>`_
Loading

0 comments on commit e4eb23b

Please sign in to comment.