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

Commit

Permalink
Turn :: into .. code:: (#2260)
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurFlag authored Nov 20, 2023
1 parent c837850 commit 5e2763a
Show file tree
Hide file tree
Showing 174 changed files with 1,218 additions and 927 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ Howto article template

Title template: Start with a verb (e.g. *Connect with Go*, *Install or upgrade an extension*).

::
.. code::
Article title
#############
Expand Down Expand Up @@ -227,7 +227,7 @@ Concept article template
Title template: *About [subject]* (if this is a background information for a task, e.g. *About migrating to Aiven*) / *Subject* (use noun or noun phrase, e.g. *Authentication*, *High availability*)


::
.. code::
Article title
#############
Expand Down Expand Up @@ -255,7 +255,7 @@ Limited availability note template

For features that are in the limited availability stage, add the following admonition directly undert the article title:

::
.. code::
.. important::
{feature name} is a :doc:`limited availability feature </docs/platform/concepts/beta_services>`. If you're interested in trying out this feature, contact the sales team at sales@Aiven.io.
Expand All @@ -266,7 +266,7 @@ Early availability note template

For features that are in the early availability stage and can be enabled in the Console, add the following admonition directly under the article title:

::
.. code::
.. important::
{feature name} is an :doc:`early availability feature </docs/platform/concepts/beta_services>`. To use it, :doc:`enable the feature preview </docs/platform/howto/feature-preview.html>` in your user profile.
4 changes: 2 additions & 2 deletions docs/community/challenge/the-rolling-challenge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ The goal is to make sense of the incoming stream of data.

7. Build the Docker image

::
.. code::
docker build -t fake-data-producer-for-apache-kafka-docker .
8. Run the Docker image

::
.. code::
docker run fake-data-producer-for-apache-kafka-docker
Expand Down
8 changes: 5 additions & 3 deletions docs/integrations/cloudwatch/cloudwatch-logs-cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,13 @@ This is what you'll need to send your logs from the AWS CloudWatch using the :do
Configure the integration
-------------------------

1. Open the Aiven client, and log in::
1. Open the Aiven client, and log in:

avn user login <you@example.com> --token
.. code::
avn user login <you@example.com> --token
.. seealso:: Learn more about :doc:`/docs/tools/cli/user/user-access-token`
.. seealso:: Learn more about :doc:`/docs/tools/cli/user/user-access-token`

2. Collect the following information for the creation of the endpoint between your Aiven account and AWS CloudWatch. These are the placeholders you will need to replace in the code sample:

Expand Down
13 changes: 9 additions & 4 deletions docs/integrations/datadog/datadog-logs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,20 @@ Start by configuring the link between Aiven and Datadog for logs. This setup onl
* - ``AIVEN_PROJECT_NAME``
- Found in the web console

This is the format to use, replacing the variables listed. Don't edit the values surrounded by ``%`` signs, such as ``%msg%`` as these are used in constructing the log line::
This is the format to use, replacing the variables listed. Don't edit the values surrounded by ``%`` signs, such as ``%msg%`` as these are used in constructing the log line:

.. code::
DATADOG_API_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.AIVEN_PROJECT_NAME %app-name% - - - %msg%
An example of the correct format, using an example API key and ``my_project`` as the project name:

``01234567890123456789abcdefabcdef <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.my_project %app-name% - - - %msg%``

.. note:: Metrics and logs are correlated in Datadog by hostname. The metrics integration is currently configured to append the project name to the hostname in order to disambiguate between services that have the same name in different projects. Adding the project name to the hostname in the syslog integration to Datadog assures that they can be correlated again in the Datadog dashboard. Not doing so will not result in missing logs, but the logs that appear in Datadog will miss tags that come from this correlation with the metrics. See https://docs.datadoghq.com/integrations/rsyslog.
.. note::

Metrics and logs are correlated in Datadog by hostname. The metrics integration is currently configured to append the project name to the hostname in order to disambiguate between services that have the same name in different projects. Adding the project name to the hostname in the syslog integration to Datadog assures that they can be correlated again in the Datadog dashboard. Not doing so will not result in missing logs, but the logs that appear in Datadog will miss tags that come from this correlation with the metrics.
See the `Datadog documentation <https://docs.datadoghq.com/integrations/rsyslog>`_.


4. Select **Create** to save the endpoint.
Expand All @@ -63,8 +68,8 @@ Follow the steps in this section for each of the services whose logs should be s

1. From the **Service Overview** page, select **Manage integrations** and choose the **Rsyslog** option.

.. image:: /images/integrations/rsyslog-service-integration.png
:alt: Screenshot of system integrations including rsyslog
.. image:: /images/integrations/rsyslog-service-integration.png
:alt: Screenshot of system integrations including rsyslog

2. Pick the log integration you created earlier from the dropdown and choose **Enable**.

Expand Down
8 changes: 4 additions & 4 deletions docs/integrations/google-bigquery.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Step 1: Create integration endpoints
* **GCP Project ID**: The identifier associated with your Google Cloud Project where BigQuery is set up. For example, ``my-gcp-project-12345``.
* **Google Service Account Credentials**: The JSON formatted credentials obtained from your Google Cloud Console for service account authentication. For example:

::
.. code::
{
"type": "service_account",
Expand All @@ -51,7 +51,7 @@ Step 1. Create integration endpoints
``````````````````````````````````````
To create a new integration endpoint that can be used to connect to a BigQuery service, use the :ref:`avn service integration-endpoint-create <avn_service_integration_endpoint_create>` command with the required parameters.

::
.. code::
avn service integration-endpoint-create \
--project <project_name> \
Expand Down Expand Up @@ -100,13 +100,13 @@ Step 2: Add your service to the integration endpoint
``````````````````````````````````````````````````````
1. Retrieve the endpoint identifier using the following command:

::
.. code::
avn service integration-endpoint-list --project your-project-name
2. Using this ``endpoint_id``, connect your Aiven service to the endpoint with the following command:

::
.. code::
avn service integration-create --project your-project-name \
-t external_google_bigquery -s your-service-name \
Expand Down
18 changes: 9 additions & 9 deletions docs/integrations/rsyslog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Console.
Another option is to use the `Aiven
Client <https://github.com/aiven/aiven-client>`__ .

::
.. code::
avn service integration-endpoint-create --project your-project \
    -d example-syslog -t rsyslog \
Expand Down Expand Up @@ -97,7 +97,7 @@ integration by clicking **Use integration** in the modal window.
Alternately, with the Aiven Client, first you need the id of the
endpoint previously created

::
.. code::
avn service integration-endpoint-list --project your-project
ENDPOINT_ID                           ENDPOINT_NAME   ENDPOINT_TYPE
Expand All @@ -106,7 +106,7 @@ endpoint previously created
Then you can link the service to the endpoint

::
.. code::
avn service integration-create --project your-project \
    -t rsyslog -s your-service \
Expand Down Expand Up @@ -143,7 +143,7 @@ The Syslog Endpoint to use for ``server`` depends on your account:

See the Coralogix `Rsyslog <https://coralogix.com/docs/>`_ documentation for more information.

::
.. code::
avn service integration-endpoint-create --project your-project \
-d coralogix -t rsyslog \
Expand All @@ -162,7 +162,7 @@ For
`Loggly <https://www.loggly.com/>`_
integration, you need to use a custom ``logline`` format with your token.

::
.. code::
avn service integration-endpoint-create --project your-project \
-d loggly -t rsyslog \
Expand All @@ -177,7 +177,7 @@ Mezmo (LogDNA)

For `Mezmo <https://www.mezmo.com/>`_ syslog integration you need to use a custom ``logline`` format with your key.

::
.. code::
avn service integration-endpoint-create --project your-project \
-d logdna -t rsyslog \
Expand All @@ -202,7 +202,7 @@ The value to use for ``server`` depends on the account location:

For more information see `Use TCP endpoint to forward logs to New Relic <https://docs.newrelic.com/docs/logs/log-api/use-tcp-endpoint-forward-logs-new-relic/>`_

::
.. code::
avn service integration-endpoint-create --project your-project \
-d newrelic -t rsyslog \
Expand All @@ -222,7 +222,7 @@ respectively. You **do not need** the ca-bundle as the Papertrail servers use
certificates signed by a known CA. You also need to set the format to
``rfc3164`` .

::
.. code::
avn service integration-endpoint-create --project your-project \
-d papertrail -t rsyslog \
Expand All @@ -238,7 +238,7 @@ For `Sumo Logic <https://www.sumologic.com/>`_
you need to use a custom ``logline`` format with your collector token, use the server and port of the collector,
and replace ``YOUR_DEPLOYMENT`` with one of ``au``, ``ca``, ``de``, ``eu``, ``fed``, ``in``, ``jp``, ``us1`` or ``us2``. See `Cloud Syslog Source <https://help.sumologic.com/03Send-Data/Sources/02Sources-for-Hosted-Collectors/Cloud-Syslog-Source>`_ for more information.

::
.. code::
avn service integration-endpoint-create --project your-project \
-d sumologic -t rsyslog \
Expand Down
4 changes: 2 additions & 2 deletions docs/integrations/rsyslog/loggly.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ systems that support rsyslog protocol, including `Loggly <https://www.loggly.com

To integrate your service with Loggly, a new endpoint needs to be added
into the project that contains the service you want to integrate. This
can be done using through Aiven console or command line using :doc:`Aiven
CLI </docs/tools/cli>`.
can be done using through Aiven console or command line using
`Aiven CLI </docs/tools/cli>_`.

Prerequisites
-------------
Expand Down
20 changes: 12 additions & 8 deletions docs/integrations/rsyslog/logtail.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,11 @@ Send Aiven logs to Logtail
* **Server**: ``in.logtail.com``
* **Port**: ``6514``
* **Format**: ``custom``
* Now replace ``YOUR_LOGTAIL_SOURCE_TOKEN`` in the log template below with the token you copied in step 2, and paste into the **Log template** field::
* Now replace ``YOUR_LOGTAIL_SOURCE_TOKEN`` in the log template below with the token you copied in step 2, and paste into the **Log template** field:

<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [logtail@11993 source_token="YOUR_LOGTAIL_SOURCE_TOKEN"] %msg%
.. code::
<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [logtail@11993 source_token="YOUR_LOGTAIL_SOURCE_TOKEN"] %msg%
5. Add your new logs integration to any of your Aiven services (more information :ref:`in the Rsyslog article<add_rsyslog_integration>`)

Expand All @@ -26,13 +28,15 @@ Send Aiven logs to Logtail
Create the Logtail service integration endpoint with Aiven client
-----------------------------------------------------------------

If you would rather use the CLI, you can use the following command to create the service integration endpoint. Replace the placeholder with your token::
If you would rather use the CLI, you can use the following command to create the service integration endpoint. Replace the placeholder with your token:

avn service integration-endpoint-create --project your-project \
-d logtail -t rsyslog \
-c server=in.logtail.com -c port=6514 \
-c tls=true -c format=custom \
-c logline='<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [logtail@11993 source_token="TOKEN-FROM-LOGTAIL"] %msg%'
.. code::
avn service integration-endpoint-create --project your-project \
-d logtail -t rsyslog \
-c server=in.logtail.com -c port=6514 \
-c tls=true -c format=custom \
-c logline='<%pri%>%protocol-version% %timestamp:::date-rfc3339% %HOSTNAME% %app-name% %procid% %msgid% [logtail@11993 source_token="TOKEN-FROM-LOGTAIL"] %msg%'
This replaces steps 3 and 4 above.

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/beta_services.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Before general availability, the lifecycle of new services and features includes
Limited availability (private beta)
-----------------------------------

The limited availability (private beta) stage is an initial release of a new functionality that you can try out by invitation only. If you are interested in trying a service or feature in this stage, contact the sales team at sales@Aiven.io.
The limited availability (private beta) stage is an initial release of a new functionality that you can try out by invitation only. If you are interested in trying a service or feature in this stage, contact the `sales team <sales@aiven.io>`_ .

Early availability (public beta)
--------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/concepts/disaster-recovery-test-scenarios.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ These situations are uncommon but can have a huge impact, so they need to be pre
What is a Disaster Recovery scenario?
-----------------------------------------------------------

This is a preset scenario where an Aiven specialist will simulate an issue with your service and `sabotage` one (or more) of your Virtual Machines. For example, with an Aiven for PostgreSQL® service, we can `sabotage` the Primary instance and test the failover functionality or we can sabotage both nodes to test recovery time for a complete outage.
This is a preset scenario where an Aiven specialist will simulate an issue with your service and ``sabotage`` one (or more) of your Virtual Machines. For example, with an Aiven for PostgreSQL® service, we can ``sabotage`` the Primary instance and test the failover functionality or we can sabotage both nodes to test recovery time for a complete outage.

What is needed?
-----------------------------------------------------------

1. At least 7 working days notice and the time (plus timezone) that you would like this carried out.
2. A `throwaway` service (i.e. one that is created specifically for this scenario and not a service used in Production).
2. A ``throwaway`` service (i.e. one that is created specifically for this scenario and not a service used in Production).
3. The virtual machine and/or the availability zone that you would like to target.
4. An Enterprise Support contract.

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/service-level-agreement.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Service level agreement
=======================

The Aiven service level agreement (SLA) details can be found at `https://aiven.io/sla <https://aiven.io/sla>`_.
The Aiven service level agreement (SLA) details can be found at `aiven.io/sla <https://aiven.io/sla>`_.

Custom SLAs are available for premium plans. Contact us at sales@Aiven.io for more details.
6 changes: 4 additions & 2 deletions docs/platform/howto/download-ca-cert.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@ Download CA certificates

If your service needs a CA certificate, download it through the `Aiven Console <https://console.aiven.io>`_ by accessing the **Overview** page for the specific service. In the **Connection information** section, find **CA Certificate**, and select the download icon in the same line.

Or, you can use the ``avn`` :doc:`command-line tool </docs/tools/cli>` with the following command::
Or, you can use the ``avn`` :doc:`command-line tool </docs/tools/cli>` with the following command:

avn service user-creds-download --username <username> <service-name>
.. code::
avn service user-creds-download --username <username> <service-name>
Read more: :doc:`../concepts/tls-ssl-certificates`
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Identify that metrics have been dropped
----------------------------------------
The following is an example log of a large Apache Kafka® service cluster where some metrics are missing and cannot be found in the Datadog dashboards after service integration. These metrics have been dropped by user Telegraf.

::
.. code::
2022-02-15T22:47:30.601220+0000 scoober-kafka-3c1132a3-82 user-telegraf: 2022-02-15T22:47:30Z W! [outputs.prometheus_client] Metric buffer overflow; 3378 metrics have been dropped
2022-02-15T22:47:30.625696+0000 scoober-kafka-3c1132a3-86 user-telegraf: 2022-02-15T22:47:30Z W! [outputs.prometheus_client] Metric buffer overflow; 1197 metrics have been dropped
Expand All @@ -27,13 +27,13 @@ The ``max_jmx_metrics`` is not exposed in the Aiven Console yet, but you can cha

1. Find the ``SERVICE_INTEGRATION_ID`` for your Datadog integration with

::
.. code::
avn service integration-list --project=PROJECT_NAME SERVICE_NAME
2. Change the value of ``max_jmx_metrics`` to the new LIMIT:

::
.. code::
avn service integration-update SERVICE_INTEGRATION_ID --project PROJECT_NAME -c max_jmx_metrics=LIMIT
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/howto/pause-from-cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@ One option is to power the service off temporarily. This way you can come back a

You can update the state of your service either through the service overview page in `Aiven Console <https://console.aiven.io>`_ or by using Aiven command line interface:

::
.. code::
avn service update demo-open-search --power-off
When you're ready to continue using the service run the command to power it on. Use ``wait`` command to easily see when the service is up and running.

::
.. code::
avn service update demo-open-search --power-on
avn service wait demo-open-search
If you have finished exploring your OpenSearch® service, you can destroy or "terminate" the service. To terminate the service completely use the following command:

::
.. code::
avn service terminate demo-open-search
Expand Down
4 changes: 2 additions & 2 deletions docs/platform/howto/private-ip-resolution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ 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::
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::
dig +short myservice-myproject.aivencloud.com
Expand Down
Loading

0 comments on commit 5e2763a

Please sign in to comment.