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

Commit

Permalink
Fix relative links (#2280)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurFlag authored Nov 22, 2023
1 parent c46b9d3 commit b4b775a
Show file tree
Hide file tree
Showing 95 changed files with 147 additions and 149 deletions.
2 changes: 1 addition & 1 deletion docs/integrations/prometheus-system-metrics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ About the Prometheus integration

The Prometheus integration allows you to monitor your Aiven services and understand the resource usage. Using this integration, you can also track some non-service-specific metrics that may be worth monitoring.

To start using Prometheus for monitoring the metrics, you need to :doc:`configure the Prometheus integration and set up the Prometheus server <../platform/howto/integrations/prometheus-metrics>`.
To start using Prometheus for monitoring the metrics, you need to :doc:`configure the Prometheus integration and set up the Prometheus server </docs/platform/howto/integrations/prometheus-metrics>`.

Get a list of available service metrics
---------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/authentication-tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@ It is also good practice to rotate your authorization tokens on a regular basis,

.. note::

Follow :doc:`Create an authentication token <../howto/create_authentication_token>` to create an authentication token from `Aiven Console <https://console.aiven.io/>`_ or the Aiven CLI.
Follow :doc:`Create an authentication token </docs/platform/howto/create_authentication_token>` to create an authentication token from `Aiven Console <https://console.aiven.io/>`_ or the Aiven CLI.
4 changes: 2 additions & 2 deletions docs/platform/concepts/dynamic-disk-sizing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Using DDS provides the following benefits:

How does DDS work?
-------------------
You can add disk storage to your service plan when you :doc:`create a new service <../howto/create_new_service>` or on demand when you need more storage while :doc:`running your service<../howto/add-storage-space>`. Adding storage will not affect or interrupt the operations of your service.
You can add disk storage to your service plan when you :doc:`create a new service </docs/platform/howto/create_new_service>` or on demand when you need more storage while :doc:`running your service </docs/platform/howto/add-storage-space>`. Adding storage will not affect or interrupt the operations of your service.

When you add storage to your service, the Aiven platform provisions the extra disk space and dynamically adds it to your running instances. The total amount of storage you can add to your service is based on your service plan and the cloud provider.

Expand All @@ -51,4 +51,4 @@ It is unlikely that any performance degradation from additional disk storage wou

Next steps
----------
For instructions on how to add or remove disk storage in `Aiven Console <https://console.aiven.io/>`_, see :doc:`Add or remove storage <../howto/add-storage-space>`.
For instructions on how to add or remove disk storage in `Aiven Console <https://console.aiven.io/>`_, see :doc:`Add or remove storage </docs/platform/howto/add-storage-space>`.
2 changes: 1 addition & 1 deletion docs/platform/concepts/hourly-billing-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ The prices shown in the Aiven console are all-inclusive, meaning that all of the

The minimum hourly charge unit is one hour. For example, when you launch an Aiven service and terminate it after 40 minutes, you will be charged for one full hour. Likewise, if you terminate a service after 40.5 hours, you will be charged for 41 hours.

:doc:`Terminating or pausing a service <../howto/pause-from-cli>` will stop the accumulation of new charges immediately. However, please note that the minimum hourly charge unit still applies prior to terminating or pausing a service.
:doc:`Terminating or pausing a service </docs/platform/howto/pause-from-cli>` will stop the accumulation of new charges immediately. However, please note that the minimum hourly charge unit still applies prior to terminating or pausing a service.

Migrating a service to another cloud region or to a different cloud provider does not incur any additional costs.
4 changes: 2 additions & 2 deletions docs/platform/concepts/out-of-memory-conditions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Left unchecked, the ``OOM Killer`` may opt to kill the primary service. This is

Further, if Aiven's management platform detects that the primary service is unavailable for |failover_primary| , the service will be marked as down and a failover will occur.

To mitigate this scenario, namespaces are used, :doc:`some with additional memory limits <service-memory-limits>`, in combination with an ``oom_score_adjust`` on the primary process, to coax the ``OOM Killer`` into selection of less critical processes.
To mitigate this scenario, namespaces are used, :doc:`some with additional memory limits </docs/platform/concepts/service-memory-limits>`, in combination with an ``oom_score_adjust`` on the primary process, to coax the ``OOM Killer`` into selection of less critical processes.

This will still result in a service restart, but in a more controlled process, where the database is shut down, rather than killed; exposure to data loss is limited and recovery is faster when the service restarts, often avoiding failover.

Expand All @@ -54,7 +54,7 @@ For most databases, the service memory footprint can often be reduced by:
- Tuning indexes for query load
- Dropping unused objects from storage

In cases where the working set no longer fits into memory, consider :doc:`scaling your service <../howto/scale-services>`.
In cases where the working set no longer fits into memory, consider :doc:`scaling your service </docs/platform/howto/scale-services>`.


.. include:: /includes/platform-variables.rst
4 changes: 2 additions & 2 deletions docs/platform/concepts/service-integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@ Yes. The PostgreSQL service is a normal PostgreSQL database service that can be
Can I add alerts in Grafana for the telemetry data?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Yes. You can add alert thresholds for individual graphs and attach different alerting mechanisms to them for sending out alerts. Please refer to the :doc:`Grafana documentation <../../products/grafana>` for more information.
Yes. You can add alert thresholds for individual graphs and attach different alerting mechanisms to them for sending out alerts. Please refer to the :doc:`Grafana documentation </docs/products/grafana>` for more information.

Create a service integration
-----------------------------

Follow :doc:`this guide <../howto/create-service-integration>` to create service integration between multiple Aiven services.
Follow :doc:`this guide </docs/platform/howto/create-service-integration>` to create service integration between multiple Aiven services.

6 changes: 3 additions & 3 deletions docs/platform/concepts/service_backups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Service power-off/on backup policy

Whenever a service is powered on from a powered-off state, the latest available backup is restored.

Services that have been powered off for more than 180 days are reviewed. A notification email will be sent to you to provide time for taking action before the service and backup are deleted as part of the :doc:`periodic cleanup of powered-off services <../howto/cleanup-powered-off-services>`.
Services that have been powered off for more than 180 days are reviewed. A notification email will be sent to you to provide time for taking action before the service and backup are deleted as part of the :doc:`periodic cleanup of powered-off services </docs/platform/howto/cleanup-powered-off-services>`.

If you wish to keep the powered-off service for more than 180 days, power on the service and then power it off again to avoid the routine cleanup.

Expand Down Expand Up @@ -68,7 +68,7 @@ If the Apache Kafka® service is powered off/on or if any incidents lead to the

To back up data passing through Apache Kafka, we recommend using one of the following tools:

* :doc:`MirrorMaker 2<../../products/kafka/kafka-mirrormaker>` to replicate the data to another cluster, which could be an Aiven service or a Apache Kafka cluster on your own infrastructure. With MirrorMaker 2, the backup cluster operates as an independent Apache Kafka service. You can freely choose a zone for your backup service since it operates independently from the primary service.
* :doc:`MirrorMaker 2 </docs/products/kafka/kafka-mirrormaker>` to replicate the data to another cluster, which could be an Aiven service or a Apache Kafka cluster on your own infrastructure. With MirrorMaker 2, the backup cluster operates as an independent Apache Kafka service. You can freely choose a zone for your backup service since it operates independently from the primary service.

.. note::

Expand Down Expand Up @@ -189,7 +189,7 @@ Recommended backup tools per service are as follows:

* `PostgreSQL <https://www.postgresql.org/docs/14/app-pgdump.html>`__: ``pgdump``
* `MySQL <https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html>`_: ``mysqldump``
* `Redis <https://redis.io/docs/ui/cli/#remote-backups-of-rdb-files>`_: ``redis-cli``
* `Redis <https://redis.io/docs/connect/cli/#remote-backups-of-rdb-files>`_: ``redis-cli``
* `Cassandra <https://docs.datastax.com/en/archived/cql/3.3/cql/cql_reference/cqlshCopy.html>`_: ``cqlsh``
* `OpenSearch <https://github.com/elasticsearch-dump/elasticsearch-dump>`_: ``elasticdump``
* `InfluxDB <https://docs.influxdata.com/influxdb/v1.8/tools/influx-cli/>`_: ``influxd``
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/static-ips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ To create, delete, associate or dissociate IP addresses, use the :doc:`/docs/too

.. note:: The ``static_ip`` configuration can only be enabled when enough static IP addresses have been created *and associated* with the service.

For more information, read the step-by-step process :doc:`../howto/static-ip-addresses`
For more information, read the step-by-step process :doc:`/docs/platform/howto/static-ip-addresses`
2 changes: 1 addition & 1 deletion docs/platform/concepts/tls-ssl-certificates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Most of our services use a browser-recognized CA certificate, but there are exce

- **Aiven for Apache Kafka®** requires the Aiven project CA certificate, and also the client key and certificate.

For these services you can :doc:`../howto/download-ca-cert` from the service overview page.
For these services you can :doc:`/docs/platform/howto/download-ca-cert` from the service overview page.

.. note::
Older/existing services may be using the Aiven project's CA, you can request switching to a browser-recognized certificate by opening support ticket and letting us know.
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/add-authentication-method.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ To add an authentication method for your user account in the `Aiven Console <htt
After authorizing access, the new method is shown in the list.

.. note::
You can also add and update authentication methods :doc:`using the Aiven CLI <../../tools/cli/account/account-authentication-method>`.
You can also add and update authentication methods :doc:`using the Aiven CLI </docs/tools/cli/account/account-authentication-method>`.
4 changes: 2 additions & 2 deletions docs/platform/howto/add-storage-space.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Add or remove storage
=======================

With :doc:`dynamic disk sizing <../concepts/dynamic-disk-sizing>`, you can add or remove disk storage (by factor of 10 GiB) both when you create a service and later for a running service.
With :doc:`dynamic disk sizing </docs/platform/concepts/dynamic-disk-sizing>`, you can add or remove disk storage (by factor of 10 GiB) both when you create a service and later for a running service.

.. note::
- You cannot add or remove storage when service nodes are in the rebalancing state, for example, during a maintenance update or a service upgrade.
Expand All @@ -13,7 +13,7 @@ Use Aiven Console
Add storage during new service creation
'''''''''''''''''''''''''''''''''''''''

You can add disk storage when :doc:`creating a new service <../howto/create_new_service>`.
You can add disk storage when :doc:`creating a new service </docs/platform/howto/create_new_service>`.


Add storage to a running service
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/console-fork-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Fork your service

Fork your Aiven service in order to make a copy of the service. You can use it to create a development copy of your production environment, set up a snapshot to analyze an issue or test an upgrade, or create an instance in a different cloud/geographical location/under a different plan.

Learn more :doc:`about service forking <../concepts/service-forking>`.
Learn more :doc:`about service forking </docs/platform/concepts/service-forking>`.

Fork a service using the console
--------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/create-billing-groups.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Create billing groups

With billing groups you can set up billing profiles to be used across all the projects in an organization. A consolidated :doc:`invoice</docs/platform/howto/use-billing-groups>` is created for each billing group.

More information about billing groups is available in the :doc:`Billing groups article <../concepts/billing-groups>`.
More information about billing groups is available in the :doc:`Billing groups article </docs/platform/concepts/billing-groups>`.

Create a billing group
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/create-service-integration.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Create service integrations
============================

If you're not sure what a service integration is, see :doc:`Service integration <../concepts/service-integration>` for an overview. This article will guide you on how to create service integrations between different Aiven services and move telemetry data using these integrations.
If you're not sure what a service integration is, see :doc:`Service integration </docs/platform/concepts/service-integration>` for an overview. This article will guide you on how to create service integrations between different Aiven services and move telemetry data using these integrations.

Prerequisites
-------------
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/create_authentication_token.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Create authentication tokens
==============================

Create an authentication token in the Aiven Console for use with the Aiven CLI or API. To learn more about using authentication tokens, refer to :doc:`../concepts/authentication-tokens`.
Create an authentication token in the Aiven Console for use with the Aiven CLI or API. To learn more about using authentication tokens, refer to :doc:`/docs/platform/concepts/authentication-tokens`.

To create an authentication token on the `Aiven Console <https://console.aiven.io/>`_:

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/create_new_service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Follow these steps to create a new service in `Aiven Console <https://console.ai

This determines the number of servers and what kind of memory, CPU, and disk resources are allocated to your service. Check out `Plans & Pricing <https://aiven.io/pricing?product=pg>`_ for details.

3. Add :doc:`disk storage <../concepts/dynamic-disk-sizing>` for your service by using the slider, if needed. The cost for the additional storage is in the service summary section.
3. Add :doc:`disk storage </docs/platform/concepts/dynamic-disk-sizing>` for your service by using the slider, if needed. The cost for the additional storage is in the service summary section.

.. note::

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/download-ca-cert.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Or, you can use the ``avn`` :doc:`command-line tool </docs/tools/cli>` with the
avn service user-creds-download --username <username> <service-name>
Read more: :doc:`../concepts/tls-ssl-certificates`
Read more: :doc:`/docs/platform/concepts/tls-ssl-certificates`
2 changes: 1 addition & 1 deletion docs/platform/howto/rename-a-service.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ If you need to have your service running under a different name, the best option

.. seealso::

Learn more :doc:`about service forking <../concepts/service-forking>`.
Learn more :doc:`about service forking </docs/platform/concepts/service-forking>`.
2 changes: 1 addition & 1 deletion docs/products/clickhouse/howto/integrate-kafka.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ For each table, you need to define the following:
* ``name`` - name of the connector table
* ``columns`` - array of columns, with names and types
* ``topics`` - array of topics, where you want to bring the data from
* ``data_format`` - your preferred format for data input, see :doc:`../reference/supported-input-output-formats`
* ``data_format`` - your preferred format for data input, see :doc:`/docs/products/clickhouse/reference/supported-input-output-formats`
* ``group_name`` - consumer group name, that will be created on your behalf

.. topic:: JSON format
Expand Down
2 changes: 1 addition & 1 deletion docs/products/clickhouse/howto/manage-databases-tables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Tables can be added with an SQL query, either with the help of the web query edi
Select a table engine
^^^^^^^^^^^^^^^^^^^^^

Part of the table definition includes a targeted table engine. The full list of supported table engines in Aiven for ClickHouse can be found :doc:`in this article <../reference/supported-table-engines>`. Aiven for ClickHouse uses ``replicated`` variants of table engines to ensure high availability. Even if you select ``MergeTree`` engine, we will automatically use the replicated variant on our side.
Part of the table definition includes a targeted table engine. The full list of supported table engines in Aiven for ClickHouse can be found :doc:`in this article </docs/products/clickhouse/reference/supported-table-engines>`. Aiven for ClickHouse uses ``replicated`` variants of table engines to ensure high availability. Even if you select ``MergeTree`` engine, we will automatically use the replicated variant on our side.

With this knowledge, try out an example dataset described :doc:`over here </docs/products/clickhouse/howto/load-dataset>`.

Expand Down
2 changes: 1 addition & 1 deletion docs/products/clickhouse/howto/monitor-performance.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Monitor Aiven for ClickHouse® metrics with Grafana®
===================================================

As well as offering ClickHouse®-as-a-service, the Aiven platform gives you access to monitor the database. The metrics/dashboard integration in the Aiven console allows you to create an integration and monitoring dashboards in Aiven for Grafana®. For more information on the metrics, see :doc:`Aiven for ClickHouse® metrics exposed in Aiven for Grafana® <../reference/metrics-list>`.
As well as offering ClickHouse®-as-a-service, the Aiven platform gives you access to monitor the database. The metrics/dashboard integration in the Aiven console allows you to create an integration and monitoring dashboards in Aiven for Grafana®. For more information on the metrics, see :doc:`Aiven for ClickHouse® metrics exposed in Aiven for Grafana® </docs/products/clickhouse/reference/metrics-list>`.

Push ClickHouse® metrics to InfluxDB®, M3DB, or PostgreSQL®
-----------------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/products/flink/concepts/flink-applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ Aiven for Apache Flink® applications

An Aiven for Apache Flink® Application is an abstraction layer on top of Apache Flink SQL that includes all the elements related to a Flink job to help build your data processing pipeline. An application contains the definition of source and sink tables, data processing logic, deployment parameters, and other necessary metadata.

:doc:`Applications <../howto/create-flink-applications>` are the starting point for running an Apache Flink job within the Aiven managed service. The `Aiven Console <https://console.aiven.io/>`_ provides a user-friendly, guided wizard to help you build and deploy applications, create source and sink tables, write transformation statements, and validate and ingest data using the interactive query feature.
:doc:`Applications </docs/products/flink/howto/create-flink-applications>` are the starting point for running an Apache Flink job within the Aiven managed service. The `Aiven Console <https://console.aiven.io/>`_ provides a user-friendly, guided wizard to help you build and deploy applications, create source and sink tables, write transformation statements, and validate and ingest data using the interactive query feature.

Each application created and deployed in the Aiven for Apache Flink service performs a specific data transformation task allowing you to map and manage different workflows separately within the Aiven for Apache Flink service. For example, you can create an application to get user IDs from one topic and publish them on another topic. You can run multiple applications within the Aiven for Apache Flink service.

Applications significantly improve the developer experience and simplify the development and deployment of Flink applications. Applications are **automatically versioned** on every edit of the underline definition (tables, or transformation SQL), allowing you to experiment with new transformations and revert to a previously stored definition if the result of the edits doesn't meet expectations.

.. seealso::
For infromation on how to create applications, see :doc:`Create an Aiven for Apache Flink® application <../howto/create-flink-applications>`
For infromation on how to create applications, see :doc:`Create an Aiven for Apache Flink® application </docs/products/flink/howto/create-flink-applications>`


Features of Aiven for Apache Flink applications
Expand Down
Loading

0 comments on commit b4b775a

Please sign in to comment.