From 2c399ba2aa59a3857541e08db5001844c3c4abaa Mon Sep 17 00:00:00 2001 From: ArthurFlageul Date: Mon, 2 Dec 2024 12:12:14 +0100 Subject: [PATCH] fix: metadescriptions --- docs/platform/howto/manage-organizations.md | 22 ++++++++++-------- docs/platform/howto/manage-project.md | 8 ++++--- docs/platform/reference/service-ip-address.md | 9 +++++--- docs/products/caching/howto/connect-node.md | 1 - .../clickhouse/howto/connect-with-php.md | 3 +-- .../howto/list-connect-to-service.md | 2 ++ .../products/kafka/concepts/kafka-rest-api.md | 4 +--- docs/products/kafka/howto/fake-sample-data.md | 16 ++++++------- .../kafka/kafka-connect/howto/http-sink.md | 7 +++--- .../kafka-connect/howto/opensearch-sink.md | 4 +--- .../disaster-recovery/active-passive-setup.md | 7 ++---- .../concepts/mirrormaker2-tuning.md | 15 ++++++------ .../kafka/karapace/concepts/acl-definition.md | 4 +--- .../concepts/max-number-of-connections.md | 8 ++----- docs/products/mysql/concepts/mysql-backups.md | 4 ++-- docs/products/mysql/howto/connect-from-cli.md | 3 ++- docs/products/mysql/howto/connect-with-php.md | 3 +-- .../products/mysql/howto/list-code-samples.md | 2 ++ .../concepts/opensearch-vs-elasticsearch.md | 7 +++--- .../postgresql/concepts/dba-tasks-pg.md | 6 ++--- .../postgresql/concepts/timescaledb.md | 8 +++---- .../products/postgresql/howto/connect-node.md | 23 +++++++++---------- .../postgresql/howto/connect-pgadmin.md | 11 ++++----- .../postgresql/howto/list-code-samples.md | 4 +--- .../valkey/howto/connect-valkey-cli.md | 1 - docs/tools.md | 2 +- docs/tools/cli/cloud.md | 2 +- 27 files changed, 84 insertions(+), 102 deletions(-) diff --git a/docs/platform/howto/manage-organizations.md b/docs/platform/howto/manage-organizations.md index ab427d1d9..4b795afd4 100644 --- a/docs/platform/howto/manage-organizations.md +++ b/docs/platform/howto/manage-organizations.md @@ -2,24 +2,26 @@ title: Manage organizations --- +Learn how to manage your organizations via the Aiven Console. + ## Delete an organization 1. Delete all [projects](/docs/platform/howto/manage-project) in the organization and in the organizational units. -2. Click **Admin**. -3. Click **Organization**. -4. Open each organizational unit by clicking its name then click +1. Click **Admin**. +1. Click **Organization**. +1. Open each organizational unit by clicking its name then click **Delete** to delete it. -5. After all the organizational units have been deleted, on the +1. After all the organizational units have been deleted, on the **Organization** page click **Delete**. -6. Confirm to delete the organization by clicking +1. Confirm to delete the organization by clicking **Delete**. ## Rename an organization 1. In the organization, click **Admin**. -2. Click **Organization**. -3. Click **Rename**. -4. Select **Rename**. -5. Enter the new name. -6. Click **Rename**. +1. Click **Organization**. +1. Click **Rename**. +1. Select **Rename**. +1. Enter the new name. +1. Click **Rename**. diff --git a/docs/platform/howto/manage-project.md b/docs/platform/howto/manage-project.md index 48dce4f52..e1a5b0904 100644 --- a/docs/platform/howto/manage-project.md +++ b/docs/platform/howto/manage-project.md @@ -5,12 +5,14 @@ title: Manage projects import ConsoleLabel from "@site/src/components/ConsoleIcons" import {ConsoleIcon} from "@site/src/components/ConsoleIcons" +Learn how to manage your projects with the Aiven Console. + ## Create a project 1. Click and select **Create project**. -2. Enter a name for the project. -3. Select an organization or organizational unit to add the project to. -4. Select a [billing group](/docs/platform/concepts/billing-groups-overview). +1. Enter a name for the project. +1. Select an organization or organizational unit to add the project to. +1. Select a [billing group](/docs/platform/concepts/billing-groups-overview). The costs from all services in this project are charged to the payment method for this billing group. diff --git a/docs/platform/reference/service-ip-address.md b/docs/platform/reference/service-ip-address.md index 1cb0acfa2..c68222c7b 100644 --- a/docs/platform/reference/service-ip-address.md +++ b/docs/platform/reference/service-ip-address.md @@ -2,11 +2,14 @@ title: Default service IP address and hostname --- +When a new Aiven service is created, it automatically gets a hostname and one or more public IP addresses. + ## Default service IP address -When a new Aiven service is created, the chosen cloud service provider -will dynamically assign one or more public IP address from their -connection pool. This IP address is not permanent, and with every +The chosen cloud service provider will dynamically assign one or more public IP +address from their connection pool. + +This IP address is not permanent, and with every service maintenance (in case of failover, maintenance upgrade or cloud migration) the IP address changes since Aiven creates a new node, migrates the existing data to it and retire the old node. diff --git a/docs/products/caching/howto/connect-node.md b/docs/products/caching/howto/connect-node.md index b7deb2b1a..6530387d9 100644 --- a/docs/products/caching/howto/connect-node.md +++ b/docs/products/caching/howto/connect-node.md @@ -7,7 +7,6 @@ import MyComponentSource1 from '!!raw-loader!/code/products/redis/connect.js'; Learn how to connect to an Aiven for Caching service using NodeJS with the `ioredis` library. - ## Variables Replace the following placeholders in the code sample with actual values diff --git a/docs/products/clickhouse/howto/connect-with-php.md b/docs/products/clickhouse/howto/connect-with-php.md index 04ef2397d..20e345d3d 100644 --- a/docs/products/clickhouse/howto/connect-with-php.md +++ b/docs/products/clickhouse/howto/connect-with-php.md @@ -2,8 +2,7 @@ title: Connect to the Aiven for ClickHouse® service with PHP --- -Learn how to connect to your Aiven for ClickHouse® service with PHP -using the PHP ClickHouse client and the HTTPS port. +Learn how to connect to your Aiven for ClickHouse® service with PHP using the PHP ClickHouse client and the HTTPS port. ## Prerequisites diff --git a/docs/products/clickhouse/howto/list-connect-to-service.md b/docs/products/clickhouse/howto/list-connect-to-service.md index af98c196c..de7ca44b9 100644 --- a/docs/products/clickhouse/howto/list-connect-to-service.md +++ b/docs/products/clickhouse/howto/list-connect-to-service.md @@ -4,4 +4,6 @@ title: Connect to your Aiven for ClickHouse® service import DocCardList from '@theme/DocCardList'; +Discover the various ways to connect to your Aiven for ClickHouse® service. + diff --git a/docs/products/kafka/concepts/kafka-rest-api.md b/docs/products/kafka/concepts/kafka-rest-api.md index 83e4357fb..2e549d80d 100644 --- a/docs/products/kafka/concepts/kafka-rest-api.md +++ b/docs/products/kafka/concepts/kafka-rest-api.md @@ -2,9 +2,7 @@ title: Apache Kafka® REST API --- -[Karapace](https://github.com/aiven/karapace) provides a RESTful -interface to your Apache Kafka® cluster, allowing you to produce and -consume messages and perform administrative cluster work. +[Karapace](https://github.com/aiven/karapace) provides a RESTful interface to your Apache Kafka® cluster, allowing you to produce and consume messages and perform administrative cluster work. Authorization can be enabled for Apache Kafka® REST APIs using Apache Kafka® REST proxy authorization. The authorization rules are based on diff --git a/docs/products/kafka/howto/fake-sample-data.md b/docs/products/kafka/howto/fake-sample-data.md index 7f6a578b6..e25eaf0a5 100644 --- a/docs/products/kafka/howto/fake-sample-data.md +++ b/docs/products/kafka/howto/fake-sample-data.md @@ -3,9 +3,7 @@ title: Sample dataset generator for Aiven for Apache Kafka® sidebar_label: Sample data --- -Learning to work with streaming data is much more fun with data, so to -get you started on your Apache Kafka® journey we help you create fake -streaming data to a topic. +Learn to work with streaming data with sample data to get you started on your Apache Kafka® journey. :::note The following example is based on [Docker](https://www.docker.com/) @@ -30,9 +28,9 @@ To start using the generator: git clone https://github.com/aiven/fake-data-producer-for-apache-kafka-docker ``` -2. Copy the file `conf/env.conf.sample` to `conf/env.conf` +1. Copy the file `conf/env.conf.sample` to `conf/env.conf` -3. Create a [token](/docs/platform/howto/create_authentication_token) in the Aiven +1. Create a [token](/docs/platform/howto/create_authentication_token) in the Aiven Console or using the following command in the [Aiven CLI](/docs/tools/cli), changing the `max-age-seconds` appropriately for the duration of @@ -53,7 +51,7 @@ To start using the generator: the token. ::: -4. Edit the `conf/env.conf` file filling the following placeholders: +1. Edit the `conf/env.conf` file filling the following placeholders: - `my_project_name`: the name of your Aiven project - `my_kafka_service_name`: the name of your Aiven for Apache Kafka @@ -64,7 +62,7 @@ To start using the generator: - `my_aiven_token`: the personal token generated during the previous step -5. Build the Docker image with: +1. Build the Docker image with: ``` docker build -t fake-data-producer-for-apache-kafka-docker . @@ -75,13 +73,13 @@ To start using the generator: rebuild the Docker image to start using them. ::: -6. Start the streaming data flow with: +1. Start the streaming data flow with: ``` docker run fake-data-producer-for-apache-kafka-docker ``` -7. Once the Docker image is running, check in the target Aiven for +1. Once the Docker image is running, check in the target Aiven for Apache Kafka® service that the topic is populated. This can be done with the [Aiven Console](https://console.aiven.io/), if the Kafka REST option is enabled, in the *Topics* tab. Alternatively you can diff --git a/docs/products/kafka/kafka-connect/howto/http-sink.md b/docs/products/kafka/kafka-connect/howto/http-sink.md index 7533ea939..d0cb1115d 100644 --- a/docs/products/kafka/kafka-connect/howto/http-sink.md +++ b/docs/products/kafka/kafka-connect/howto/http-sink.md @@ -2,10 +2,9 @@ title: Create a sink connector from Apache Kafka® via HTTP --- -The HTTP sink connector enables you to move data from an Aiven for -Apache Kafka® cluster to a remote server via HTTP. The full list of -parameters and setup details is available in the [dedicated GitHub -repository](https://github.com/aiven/http-connector-for-apache-kafka/). +The HTTP sink connector enables you to move data from an Aiven for Apache Kafka® cluster to a remote server via HTTP. + +The full list of parameters and setup details is available in the [dedicated GitHub repository](https://github.com/aiven/http-connector-for-apache-kafka/). :::note See the full set of available parameters and configuration diff --git a/docs/products/kafka/kafka-connect/howto/opensearch-sink.md b/docs/products/kafka/kafka-connect/howto/opensearch-sink.md index d01b840a6..96087dc8f 100644 --- a/docs/products/kafka/kafka-connect/howto/opensearch-sink.md +++ b/docs/products/kafka/kafka-connect/howto/opensearch-sink.md @@ -2,9 +2,7 @@ title: Create a sink connector from Apache Kafka® to OpenSearch® --- -The OpenSearch sink connector enables you to move data from an Aiven for -Apache Kafka® cluster to an OpenSearch® instance for further processing -and analysis. +The OpenSearch sink connector enables you to move data from an Aiven for Apache Kafka® cluster to an OpenSearch® instance for further processing and analysis. :::warning diff --git a/docs/products/kafka/kafka-mirrormaker/concepts/disaster-recovery/active-passive-setup.md b/docs/products/kafka/kafka-mirrormaker/concepts/disaster-recovery/active-passive-setup.md index 10201b47f..a34f7bdf6 100644 --- a/docs/products/kafka/kafka-mirrormaker/concepts/disaster-recovery/active-passive-setup.md +++ b/docs/products/kafka/kafka-mirrormaker/concepts/disaster-recovery/active-passive-setup.md @@ -2,11 +2,8 @@ title: Active-passive setup --- -In this setup, there are two Apache Kafka® clusters, the primary and secondary clusters. -The primary cluster contains the *topic* topic. The -"active" cluster serves all produce and consume requests, while the -"passive" cluster serves as a replica of the "active" cluster -without running any applications against it. +In this setup, there are two Apache Kafka® clusters, the primary and secondary clusters. The primary cluster contains the *topic* topic. +The "active" cluster serves all produce and consume requests, while the "passive" cluster serves as a replica of the "active" cluster without running any applications against it. ![MirrorMaker 2 Active-Passive Setup](/images/content/products/kafka/kafka-mirrormaker/Mirrormaker-Active-Passive.png) diff --git a/docs/products/kafka/kafka-mirrormaker/concepts/mirrormaker2-tuning.md b/docs/products/kafka/kafka-mirrormaker/concepts/mirrormaker2-tuning.md index 46188447b..19c7a339c 100644 --- a/docs/products/kafka/kafka-mirrormaker/concepts/mirrormaker2-tuning.md +++ b/docs/products/kafka/kafka-mirrormaker/concepts/mirrormaker2-tuning.md @@ -2,25 +2,24 @@ title: MirrorMaker 2 common parameters --- -MirrorMaker 2 (MM2) offers a suite of parameters to help with data -replication and monitoring within Apache Kafka® ecosystems. This topic -outlines common parameters you can adjust, along with tips for +MirrorMaker 2 (MM2) offers a suite of parameters to help with data replication and monitoring within Apache Kafka® ecosystems. +This topic outlines common parameters you can adjust, along with tips for validating MM2's performance. 1. Increase the value of `kafka_mirrormaker.tasks_max_per_cpu` in the advanced options. Setting this to match the number of partitions can enhance performance. -2. Ensure the interval seconds for the following settings match. You +1. Ensure the interval seconds for the following settings match. You can reduce these intervals for more frequent data synchronization: - Advanced options: - `kafka_mirrormaker.emit_checkpoints_interval_seconds` - `kafka_mirrormaker.sync_group_offsets_interval_seconds` - Replication flow: - `Sync interval in seconds`. -3. To exclude internal topics, add these patterns to your topic +1. To exclude internal topics, add these patterns to your topic blacklist: - `.*[\-\.]internal` `.*\.replica` `__.*` `connect.*` -4. Depending on your use case, consider adjusting these parameters: +1. Depending on your use case, consider adjusting these parameters: - `kafka_mirrormaker.consumer_fetch_min_bytes` - `kafka_mirrormaker.producer_batch_size` - `kafka_mirrormaker.producer_buffer_memory` @@ -34,11 +33,11 @@ these: 1. **Consumer lag metric**: Monitor the `kafka.consumer_lag` metric. -2. **Dashboard metrics**: If MirrorMaker 2 stops adding records to a +1. **Dashboard metrics**: If MirrorMaker 2 stops adding records to a topic, the `jmx.kafka.connect.mirror.record_count` metric stops increasing, showing a flat line on the dashboard. -3. **Retrieve latest messages with \`kt\`**: Use +1. **Retrieve latest messages with \`kt\`**: Use [kt](https://github.com/fgeller/kt) to retrieve the latest messages from all partitions with the following command: diff --git a/docs/products/kafka/karapace/concepts/acl-definition.md b/docs/products/kafka/karapace/concepts/acl-definition.md index 98312099c..3e48594f6 100644 --- a/docs/products/kafka/karapace/concepts/acl-definition.md +++ b/docs/products/kafka/karapace/concepts/acl-definition.md @@ -2,9 +2,7 @@ title: ACLs definition --- -An ACL for Karapace schema registry authorization consists of zero or -more entries that specify a **username**, an **operation**, and a -**resource**. +An ACL for Karapace schema registry authorization consists of zero or more entries that specify a **username**, an **operation**, and a **resource**. - **Username** is the name of a service user in the Aiven for Apache Kafka® service. diff --git a/docs/products/mysql/concepts/max-number-of-connections.md b/docs/products/mysql/concepts/max-number-of-connections.md index fba764cca..c0a95fa61 100644 --- a/docs/products/mysql/concepts/max-number-of-connections.md +++ b/docs/products/mysql/concepts/max-number-of-connections.md @@ -1,13 +1,9 @@ --- title: MySQL max_connections +service_label: max_connections --- -## `max_connections` vs RAM - -The maximum number of simultaneous connections in Aiven for MySQL® -depends on how much RAM your service plan offers and is fixed for each -service plan (**Hobbyist**, **Startup**, **Business**, **Premium**, or -any other plan available under a specific cloud provider.) +The maximum number of simultaneous connections in Aiven for MySQL® depends on how much RAM your [service plan](/docs/platform/howto/scale-services) offers and is fixed for each service plan. :::note Independent of the plan, an `extra_connection` with a value of `1` is diff --git a/docs/products/mysql/concepts/mysql-backups.md b/docs/products/mysql/concepts/mysql-backups.md index 223d6ae2f..b52628ed9 100644 --- a/docs/products/mysql/concepts/mysql-backups.md +++ b/docs/products/mysql/concepts/mysql-backups.md @@ -3,8 +3,8 @@ title: Understand MySQL backups sidebar_label: Backups --- -Aiven for MySQL databases are automatically backed-up, with full backups -daily, and binary logs recorded continuously. The number of stored +Aiven for MySQL databases are automatically backed-up, with full backups daily, and binary logs recorded continuously. +The number of stored backups and backup retention time depends on your [Aiven service plan](https://aiven.io/pricing?product=mysql&tab=plan-comparison). Full backups are version-specific binary backups, which when combined with diff --git a/docs/products/mysql/howto/connect-from-cli.md b/docs/products/mysql/howto/connect-from-cli.md index a84b19963..3e8ce000f 100644 --- a/docs/products/mysql/howto/connect-from-cli.md +++ b/docs/products/mysql/howto/connect-from-cli.md @@ -1,8 +1,9 @@ --- title: Connect to Aiven for MySQL® from the command line +sidebar_label: Connect with the CLI --- -Connect to your MySQL via the command line with the following tools: +Connect to your Aiven for MySQL® service via the command line with the following tools: - [mysqlsh shell](/docs/products/mysql/howto/connect-from-cli#connect-mysqlsh) - [mysql client](/docs/products/mysql/howto/connect-from-cli#connect-mysql) diff --git a/docs/products/mysql/howto/connect-with-php.md b/docs/products/mysql/howto/connect-with-php.md index 32d3d7296..ac9dd958b 100644 --- a/docs/products/mysql/howto/connect-with-php.md +++ b/docs/products/mysql/howto/connect-with-php.md @@ -5,8 +5,7 @@ title: Connect to Aiven for MySQL® with PHP import CodeBlock from '@theme/CodeBlock'; import MyComponentSource1 from '!!raw-loader!/code/products/mysql/connect.php'; -This example connects to an Aiven for MySQL® service from PHP, making -use of the built-in PDO module. +This example connects to an Aiven for MySQL® service from PHP, making use of the built-in PDO module. ## Variables diff --git a/docs/products/mysql/howto/list-code-samples.md b/docs/products/mysql/howto/list-code-samples.md index 1b348c87a..cd1fcf1e8 100644 --- a/docs/products/mysql/howto/list-code-samples.md +++ b/docs/products/mysql/howto/list-code-samples.md @@ -4,4 +4,6 @@ title: Connect to your Aiven for MySQL® service import DocCardList from '@theme/DocCardList'; +Discover the various ways to connect to your Aiven for MySQL® service. + diff --git a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.md b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.md index fba16782a..e0ad3c04c 100644 --- a/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.md +++ b/docs/products/opensearch/concepts/opensearch-vs-elasticsearch.md @@ -2,10 +2,9 @@ title: OpenSearch® vs Elasticsearch --- -OpenSearch® is the open source continuation of the original Elasticsearch project. -When [Elastic moved to a restrictive license](https://www.elastic.co/blog/licensing-change), the changes -meant that third parties were not able to continue to offer -Elasticsearch as a service. The community (including Aiven) joined +OpenSearch® is the open-source version of the Elasticsearch project, which has [a restrictive license](https://www.elastic.co/blog/licensing-change). Third parties cannot offer Elasticsearch as a service. + +The community (including Aiven) joined forces to create and maintain OpenSearch based on the last open source licensed releases of both Elasticsearch and Kibana (v7.10.2). diff --git a/docs/products/postgresql/concepts/dba-tasks-pg.md b/docs/products/postgresql/concepts/dba-tasks-pg.md index 696d50b1d..a60c71552 100644 --- a/docs/products/postgresql/concepts/dba-tasks-pg.md +++ b/docs/products/postgresql/concepts/dba-tasks-pg.md @@ -3,9 +3,7 @@ title: Perform DBA-type tasks in Aiven for PostgreSQL® sidebar_label: DBA-type tasks --- -Aiven doesn't allow superuser access to Aiven for PostgreSQL® services. -However, most DBA-type actions are still available through other -methods. +Aiven doesn't allow superuser access to Aiven for PostgreSQL® services. However, most DBA-type actions are still available through other methods. ## `avnadmin` user privileges @@ -41,7 +39,7 @@ the `avnadmin` to perform superuser-like functionalities like: You can install the `aiven_extras` extension executing the following command with the `avnadmin` user: -``` +```sql CREATE EXTENSION aiven_extras CASCADE; ``` diff --git a/docs/products/postgresql/concepts/timescaledb.md b/docs/products/postgresql/concepts/timescaledb.md index 9ac9949ec..8331ea984 100644 --- a/docs/products/postgresql/concepts/timescaledb.md +++ b/docs/products/postgresql/concepts/timescaledb.md @@ -2,10 +2,8 @@ title: About TimescaleDB --- -[TimescaleDB](https://github.com/timescale/timescaledb) is an -open-source database designed to make your existing relational database -scalable for time series data. TimescaleDB is available as a PostgreSQL® -extension on Aiven. +[TimescaleDB](https://github.com/timescale/timescaledb) is an open-source database designed to make your existing relational database scalable for time series data. +TimescaleDB is available as a PostgreSQL® extension on Aiven. A time series indexes a series of data points in chronological order, usually as a sequence over regular intervals. Examples of a time series @@ -22,7 +20,7 @@ took place. TimescaleDB is available as an extension; you can enable it by running: -``` +```sql CREATE EXTENSION timescaledb CASCADE; ``` diff --git a/docs/products/postgresql/howto/connect-node.md b/docs/products/postgresql/howto/connect-node.md index cbec480f8..25eadb60d 100644 --- a/docs/products/postgresql/howto/connect-node.md +++ b/docs/products/postgresql/howto/connect-node.md @@ -5,20 +5,19 @@ title: Connect with NodeJS import CodeBlock from '@theme/CodeBlock'; import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.js'; -This example connects to PostgreSQL® service from NodeJS, making use of -the `pg` package. +This example connects to PostgreSQL® service from NodeJS, making use of the `pg` package. ## Variables These are the placeholders you will need to replace in the code sample: - | Variable | Description | - | ---------- | ----------------------------------------------------------------------- | - | `USER` | PostgreSQL username, from the service overview page | - | `PASSWORD` | PostgreSQL password, from the service overview page | - | `HOST` | Hostname for PostgreSQL connection, from the service overview page | - | `PORT` | Port for PostgreSQL connection, from the service overview page | - | `DATABASE` | Database Name for PostgreSQL connection, from the service overview page | +| Variable | Description | +| ---------- | ----------------------------------------------------------------------- | +| `USER` | PostgreSQL username, from the service overview page | +| `PASSWORD` | PostgreSQL password, from the service overview page | +| `HOST` | Hostname for PostgreSQL connection, from the service overview page | +| `PORT` | Port for PostgreSQL connection, from the service overview page | +| `DATABASE` | Database Name for PostgreSQL connection, from the service overview page | ## Prerequisites @@ -26,7 +25,7 @@ For this example you will need: - The npm `pg` package: - ``` + ```bash npm install pg --save ``` @@ -46,13 +45,13 @@ response. To run the code: -``` +```bash node index.js ``` If the script runs successfully, the outputs should be the PostgreSQL version running in your service like: -``` +```text PostgreSQL 13.3 on x86_64-pc-linux-gnu, compiled by gcc, a 68c5366192 p 6520304dc1, 64-bit ``` diff --git a/docs/products/postgresql/howto/connect-pgadmin.md b/docs/products/postgresql/howto/connect-pgadmin.md index 3266b5100..97c659717 100644 --- a/docs/products/postgresql/howto/connect-pgadmin.md +++ b/docs/products/postgresql/howto/connect-pgadmin.md @@ -2,8 +2,7 @@ title: Connect with pgAdmin --- -[pgAdmin](https://www.pgadmin.org/) is one of the most popular -PostgreSQL® clients, useful to manage and query your database. +[pgAdmin](https://www.pgadmin.org/) is one of the most popular PostgreSQL® clients. Use it to manage and query your database. ## Variables @@ -26,10 +25,10 @@ website](https://www.pgadmin.org/download/) 1. Open pgAdmin and click **Create New Server**. -2. In the **General** Tab give the connection a name, for example +1. In the **General** Tab give the connection a name, for example `MyDatabase`. -3. In the **Connection** tab, set: +1. In the **Connection** tab, set: - **Host name/address** to `HOSTNAME` - **Port**: to `PORT` @@ -37,9 +36,9 @@ website](https://www.pgadmin.org/download/) - **Username** to `avnadmin` - **Password** to `PASSWORD` -4. In the **SSL** tab, set **SSL mode** to `Require` +1. In the **SSL** tab, set **SSL mode** to `Require` -5. Click **Save** +1. Click **Save** :::tip If you experience a SSL error while connecting, add the service CA diff --git a/docs/products/postgresql/howto/list-code-samples.md b/docs/products/postgresql/howto/list-code-samples.md index 9de5f92cf..b320d41b2 100644 --- a/docs/products/postgresql/howto/list-code-samples.md +++ b/docs/products/postgresql/howto/list-code-samples.md @@ -4,9 +4,7 @@ title: Connect to your Aiven for PostgreSQL® service import DocCardList from '@theme/DocCardList'; -Connect to Aiven for PostgreSQL® with a tool or programming language of your choice. - -All connections to Aiven for PostgreSQL are encrypted and protected with TLS. +Connect to Aiven for PostgreSQL® with a tool or programming language of your choice. All connections to PostgreSQL are encrypted and protected with TLS. For a connection to be established, `sslmode` can be set as follows: diff --git a/docs/products/valkey/howto/connect-valkey-cli.md b/docs/products/valkey/howto/connect-valkey-cli.md index 7adb3c2ed..492e1cb7f 100644 --- a/docs/products/valkey/howto/connect-valkey-cli.md +++ b/docs/products/valkey/howto/connect-valkey-cli.md @@ -4,7 +4,6 @@ title: Connect with valkey-cli Learn how to establish a connection to an Aiven for Valkey™ service using the `valkey-cli`. - ## Variables Replace the following placeholders in the code sample with actual values diff --git a/docs/tools.md b/docs/tools.md index 2c95348c8..35c457c79 100644 --- a/docs/tools.md +++ b/docs/tools.md @@ -8,7 +8,7 @@ import GridContainer from "@site/src/components/GridContainer"; import K8sIcon from "@site/static/images/logos/kubernetes.svg"; import AI from "@site/static/images/logos/star-ai.svg"; -Interact with the Aiven platform with the following tools: +You can interact with the Aiven platform with various interfaces and tools that best suit your workflow.