### Install valkey-go Library

Source: https://aiven.io/docs/products/valkey/howto/connect-go

Install the valkey-go library using the go get command. This is a prerequisite for using the Valkey protocol in Go.

```bash
go get github.com/valkey-io/valkey-go
```

--------------------------------

### Install Go PostgreSQL Driver

Source: https://aiven.io/docs/products/postgresql/howto/connect-go

Installs the 'pq' library, a PostgreSQL driver for Go. Ensure you have Go installed and configured.

```bash
go get github.com/lib/pq
```

--------------------------------

### Install valkey-py library

Source: https://aiven.io/docs/products/valkey/howto/connect-python

Install the valkey-py library, with optional performance enhancements from hiredis.

```bash
pip install valkey
```

```bash
pip install "valkey[hiredis]"
```

--------------------------------

### Valkey Server Info Output Example

Source: https://aiven.io/docs/products/valkey/howto/connect-valkey-cli

This is an example output of the `INFO` command, showing server parameters and confirming the connection is active.

```text
# Server
redis_version:7.2.4
server_name:valkey
valkey_version:7.2.7
redis_git_sha1:c0b10003
redis_git_dirty:0
redis_build_id:e63142036e093656
redis_mode:standalone
...
```

--------------------------------

### Example connection calculation

Source: https://aiven.io/docs/products/valkey/howto/estimate-max-number-of-connections

An example calculation for a server with 4 GB of memory.

```text
4 * 4096 = 16384 connections
```

--------------------------------

### Compile and Run Java Valkey Example

Source: https://aiven.io/docs/products/valkey/howto/connect-java

Compile and run the Java Valkey example using the provided service URI. Ensure all dependencies are in the lib folder and the classpath is set correctly.

```bash
javac -cp "lib/*:." ValkeyExample.java && java -cp "lib/*:." ValkeyExample SERVICE_URI
```

--------------------------------

### Install go-redis library

Source: https://aiven.io/docs/products/dragonfly/howto/connect-go

Install the required dependency for Dragonfly connectivity.

```bash
go get github.com/go-redis/redis/v8
```

--------------------------------

### Clone repository and install dependencies

Source: https://aiven.io/docs/products/opensearch/howto/opensearch-search-and-python

Clone the demo repository and install the required Python packages using pip.

```bash
git clone https://github.com/aiven/demo-opensearch-python
cd demo-opensearch-python
pip install -r requirements.txt
```

--------------------------------

### Install Aiven CLI

Source: https://aiven.io/docs/tools/cli

Install the aiven-client package using either pip or Homebrew.

```shell
pip install aiven-client
```

```shell
brew install aiven-client
```

--------------------------------

### Install pg package

Source: https://aiven.io/docs/products/postgresql/howto/connect-node

Install the required PostgreSQL client library for NodeJS.

```bash
npm install pg --save
```

--------------------------------

### Install MySQL Connector

Source: https://aiven.io/docs/products/mysql/howto/connect-using-mysqlx-with-python

Install the required Python library for MySQLx support.

```bash
pip install mysql-connector-python
```

--------------------------------

### Example PostgreSQL connection string

Source: https://aiven.io/docs/tools/cli/service/connection-info

This is an example output of the `avn service connection-info pg string` command, providing the host, port, user, and database name for connecting to an Aiven for PostgreSQL service.

```bash
host='demo-pg-dev-project.aivencloud.com' port='13039' user=avnadmin dbname='defaultdb'
```

--------------------------------

### Example Kafka Topics

Source: https://aiven.io/docs/products/kafka/kafka-connect/howto/debezium-source-connector-oracle

Resulting Kafka topics generated by the example connector configuration.

```text
oracle.cdc.SALES.ORDERS
oracle.cdc.SALES.CUSTOMERS
```

--------------------------------

### Install the Grafana string replacer tool

Source: https://aiven.io/docs/products/grafana/howto/replace-expression-string

Requires a Go environment to build and install the tool from the source repository.

```bash
go install github.com/aiven/aiven-string-replacer-for-grafana
```

--------------------------------

### Create Example S3 Sink Connector

Source: https://aiven.io/docs/products/kafka/kafka-connect/howto/s3-sink-connector-confluent

Command to create the example S3 sink connector using the Aiven CLI. This command uses a demo service name and the previously defined configuration file.

```bash
avn service connector create demo-kafka @s3_sink_confluent.json
```

--------------------------------

### Example kcat connection command

Source: https://aiven.io/docs/tools/cli/service/connection-info

This is an example output of the `avn service connection-info kafkacat` command, showing the parameters for connecting to a Kafka service using `kcat`. Note that the command output uses the older `kafkacat` naming; replace it with `kcat` to execute.

```bash
kafkacat -b demo-kafka-dev-advocates.aivencloud.com:13041 -X security.protocol=SSL -X ssl.ca.location=ca.pem -X ssl.key.location=service.key -X ssl.certificate.location=service.crt
```

--------------------------------

### Clone Kafka Streams Example Repository

Source: https://aiven.io/docs/products/kafka/howto/kafka-streams-with-aiven-for-kafka

Clone the Kafka Streams example repository from GitHub to get the application code. This is the first step to setting up the example.

```bash
git clone https://github.com/Aiven-Labs/kafka-streams-example.git
```

```bash
cd kafka-streams-example
```

--------------------------------

### Initialize OpenTofu

Source: https://aiven.io/docs/tools/terraform/howto/use-opentofu

Prepare the working directory by downloading provider plugins.

```bash
tofu init
```

--------------------------------

### Aiven API get snapshot details response

Source: https://aiven.io/docs/products/opensearch/howto/manage-snapshots

Example JSON response structure for a get snapshot details request via Aiven API.

```json
{
  "snapshots": [
    {
      "snapshot": "first-snapshot",
      "state": "SUCCESS",
      "indices": ["test"],
      "uuid": "7cdWedW7RC6FMSktlZTCDw"
    }
  ]
}
```

--------------------------------

### Example Output for Get Replication Flow

Source: https://aiven.io/docs/tools/cli/mirrormaker

An example JSON output showing the configuration of a MirrorMaker 2 replication flow, including enabled status, replication policy, and topic configurations.

```json
{
    "emit_heartbeats_enabled": true,
    "enabled": true,
    "replication_policy_class": "org.apache.kafka.connect.mirror.DefaultReplicationPolicy",
    "source_cluster": "kafka-source-alias",
    "sync_group_offsets_enabled": true,
    "sync_group_offsets_interval_seconds": 60,
    "target_cluster": "kafka-target-alias",
    "topics": [
        "my-src-topic.*"
    ],
    "topics.blacklist": [
        ".*not-include"
    ]
}
```

--------------------------------

### Install ClickHouse Go Module

Source: https://aiven.io/docs/products/clickhouse/howto/connect-with-go

Install the ClickHouse Go module using the go get command. For Go versions lower than 1.18.4, use a specific older version of the module.

```bash
go get github.com/ClickHouse/clickhouse-go/v2
```

```bash
go get github.com/ClickHouse/clickhouse-go/v2@v2.2
```

--------------------------------

### Plan OpenTofu Configuration

Source: https://aiven.io/docs/tools/terraform/howto/use-opentofu

Preview infrastructure changes before applying them.

```bash
tofu plan
```

--------------------------------

### Connect to Dragonfly with Go

Source: https://aiven.io/docs/products/dragonfly/howto/connect-go

A complete example demonstrating how to parse a connection URI, initialize a client, and perform basic set/get operations.

```go
package main

import (
    "context"
    "fmt"
    "github.com/go-redis/redis/v8"
)

var ctx = context.Background()

func main() {
    dragonflyURI := "DRAGONFLY_URI"

    opts, err := redis.ParseURL(dragonflyURI)
    if err != nil {
        panic(err)
    }

    rdb := redis.NewClient(opts)

    err = rdb.Set(ctx, "key", "hello world", 0).Err()
    if err != nil {
        panic(err)
    }

    val, err := rdb.Get(ctx, "key").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println("The value of key is:", val)
}
```

--------------------------------

### Get Connector Class Name Example

Source: https://aiven.io/docs/products/kafka/kafka-connect/howto/manage-logging-level

This JSON snippet shows the 'connector.class' field, which represents the logger name for a specific connector. This is usually the first field when configuring a connector.

```json
{
    "connector.class": "io.debezium.connector.postgresql"
}
```

--------------------------------

### Apply OpenTofu Configuration

Source: https://aiven.io/docs/tools/terraform/howto/use-opentofu

Create the defined resources.

```bash
tofu apply --auto-approve
```

--------------------------------

### Overcommit Memory Warning Example

Source: https://aiven.io/docs/products/valkey/troubleshooting/warning-overcommit_memory

This is a warning message that may appear in the logs when starting an Aiven for Valkey service. It suggests setting `vm.overcommit_memory` to 1. This warning can be safely ignored.

```text
# WARNING overcommit_memory is set to 0! Background save may fail under
low memory condition. To fix this issue add
'vm.overcommit_memory = 1' to /etc/sysctl.conf and reboot or run the command 'sysctl vm.overcommit_memory=1'
for this to take effect.
```

--------------------------------

### Get Current User Information

Source: https://aiven.io/docs/tools/cli/user

Retrieves details about the currently logged-in user, including username, state, token validity, and associated projects. No setup is required if already logged in.

```bash
avn user info
```

--------------------------------

### Create and connect to the dellstore database

Source: https://aiven.io/docs/products/postgresql/get-started

Initializes the database environment for the sample dataset.

```sql
CREATE DATABASE dellstore;
\c dellstore
```

--------------------------------

### Install Node.js client for ClickHouse

Source: https://aiven.io/docs/products/clickhouse/howto/connect-with-nodejs

Install the Node.js client for connecting to ClickHouse using npm. Ensure Node.js is installed in your environment.

```bash
npm i @clickhouse/client
```

--------------------------------

### Connect to Aiven for Valkey and Perform Operations

Source: https://aiven.io/docs/products/valkey/howto/connect-go

Connect to Aiven for Valkey using the provided SERVICE_URI. This example sets a key, retrieves it, and prints the value. Ensure you replace SERVICE_URI with your actual service connection URI.

```go
package main

import (
	"context"
	"fmt"

	"github.com/valkey-io/valkey-go"
)

var ctx = context.Background()

func main() {
	valkeyURI := "SERVICE_URI"

	opts, err = valkey.ParseURL(valkeyURI)
	if err != nil {
		return panic(err)
	}

	client, err := valkey.NewClient(opts)
	if err != nil {
		panic(err)
	}
	defer client.Close()

	err = client.Do(ctx, client.B().Set().Key("key").Value("hello world").Nx().Build()).Error()
	if err != nil {
		panic(err)
	}

	value, err := client.Do(ctx, client.B().Get().Key("key").Build()).ToString()
	if err != nil {
		panic(err)
	}
	fmt.Println("The value of key is:", value)
}
```

--------------------------------

### Install an Extension in PostgreSQL

Source: https://aiven.io/docs/products/postgresql/howto/manage-extensions

Use this command to install a new extension. Ensure the extension is on the approved list. The CASCADE option installs any dependencies.

```sql
CREATE EXTENSION EXTENSION_NAME CASCADE;
```

--------------------------------

### Run Go application

Source: https://aiven.io/docs/products/dragonfly/howto/connect-go

Execute the main.go file to verify the connection.

```bash
go run main.go
```

--------------------------------

### Install cryptography dependency

Source: https://aiven.io/docs/products/mysql/howto/connect-with-python

Install the required cryptography package.

```bash
pip install cryptography
```

--------------------------------

### View static IP creation output

Source: https://aiven.io/docs/platform/concepts/static-ips

Example output returned after initiating the creation of a static IP.

```text
CLOUD_NAME        IP_ADDRESS  SERVICE_NAME  STATE     STATIC_IP_ADDRESS_ID
================  ==========  ============  ========  ====================
azure-westeurope  null        null          creating  ip359373e5e56
```

--------------------------------

### Verify Aiven CLI Installation

Source: https://aiven.io/docs/tools/cli

Check the installed version of the Aiven CLI.

```shell
avn --version
```

--------------------------------

### Get aiven-db-migrate Help

Source: https://aiven.io/docs/products/postgresql/howto/run-aiven-db-migrate-python

Display the full list of parameters and their descriptions for the `aiven-db-migrate` command by running this command.

```bash
python3 -m aiven_db_migrate.migrate pg -h
```

--------------------------------

### Copy Sample Configuration File

Source: https://aiven.io/docs/products/kafka/howto/generate-sample-data-manually

Copy the sample environment configuration file to create your own version for customization.

```bash
cp conf/env.conf.sample conf/env.conf
```

--------------------------------

### Install predis library

Source: https://aiven.io/docs/products/valkey/howto/connect-php

Use Composer to install the required predis dependency.

```bash
composer require predis/predis
```

--------------------------------

### Example response for custom repositories

Source: https://aiven.io/docs/products/opensearch/howto/custom-repositories

Sample JSON output showing the structure of configured repositories returned by the API.

```json
{
  "repositories": [
    {
      "name": "aws-repo",
      "settings": {
        "base_path": "test/path",
        "bucket": "testbucket",
        "endpoint": "http://s3.eu-north-1.amazonaws.com",
        "region": "eu-north-1",
        "server_side_encryption": true,
        "readonly": false
      },
      "type": "s3"
    },
    {
      "name": "azure-repo",
      "settings": {
        "base_path": "test/path",
        "container": "testcontainer",
        "readonly": false
      },
      "type": "azure"
    }
  ]
}
```

--------------------------------

### Run Kafbat UI container

Source: https://aiven.io/docs/products/kafka/howto/kafbat-ui

Command to start the Kafbat UI container with the required environment variables and volume mounts for SSL authentication.

```bash
docker run -p 8080:8080 \
    -v SSL_STORE_FOLDER/SSL_TRUSTSTORE_FILE_NAME:/client.truststore.jks:ro \
    -v SSL_STORE_FOLDER/SSL_KEYSTORE_FILE_NAME:/client.keystore.p12:ro \
    -e KAFKA_CLUSTERS_0_BOOTSTRAPSERVERS=APACHE_KAFKA_HOST:APACHE_KAFKA_PORT \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SECURITY_PROTOCOL=SSL \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SSL_TRUSTSTORE_LOCATION=/client.truststore.jks \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SSL_TRUSTSTORE_PASSWORD=SSL_TRUSTSTORE_PASSWORD \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SSL_KEYSTORE_LOCATION=/client.keystore.p12 \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SSL_KEYSTORE_PASSWORD=SSL_KEYSTORE_PASSWORD \
    -e KAFKA_CLUSTERS_0_PROPERTIES_SSL_KEYSTORE_TYPE=PKCS12 \
    -d ghcr.io/kafbat/kafka-ui:latest
```

--------------------------------

### Install PyMySQL dependency

Source: https://aiven.io/docs/products/mysql/howto/connect-with-python

Install the required PyMySQL library using pip.

```bash
pip install pymysql
```

--------------------------------

### Install JDBC and Avro connectors

Source: https://aiven.io/docs/products/kafka/kafka-connect/howto/bring-your-own-kafka-connect-cluster

Unzip the connector archives and move the JAR files into the plugin library folder.

```bash
# extract aiven connect jdbc
unzip jdbc-connector-for-apache-kafka-6.7.0.zip
# extract confluent kafka connect avro converter
unzip confluentinc-kafka-connect-avro-converter-7.1.0.zip
# copying plugins in the plugins/lib folder
cp jdbc-connector-for-apache-kafka-6.7.0/*.jar plugins/lib/
cp confluentinc-kafka-connect-avro-converter-7.1.0/*.jar plugins/lib/
```

--------------------------------

### Install kafka-python library

Source: https://aiven.io/docs/products/kafka/howto/connect-with-python

Install the required Python library for Kafka interaction.

```bash
pip install kafka-python
```

--------------------------------

### Install ioredis dependency

Source: https://aiven.io/docs/products/dragonfly/howto/connect-node

Install the required ioredis library via npm.

```bash
npm install --save ioredis
```

--------------------------------

### Prepare SSL directory for Kafbat UI

Source: https://aiven.io/docs/products/kafka/howto/kafbat-ui

Commands to create a secure directory and set appropriate permissions for storing Kafka SSL certificates.

```bash
mkdir SSL_STORE_FOLDER
```

```bash
chmod 700 SSL_STORE_FOLDER
```

```bash
cp SSL_KEYSTORE_FILE_NAME SSL_TRUSTSTORE_FILE_NAME SSL_STORE_FOLDER
```

```bash
chmod +r SSL_STORE_FOLDER/*
```

--------------------------------

### Log output for %m [%p] %q[user=%u,db=%d,app=%a]

Source: https://aiven.io/docs/products/postgresql/reference/log-formats-supported

Example log output when using the millisecond timestamp, process ID, and user/database/application format.

```text
[pg-user-test-1]2023-01-12T00:00:57.839867[postgresql-14][18-1] 2023-01-12 00:00:57.839 GMT [1323] [user=postgres,db=defaultdb,app=[unknown]] LOG: connection authorized: user=postgres database=defaultdb application_name=aiven-pruned
[pg-user-test-1]2023-01-12T00:00:57.849223[postgresql-14][19-1] 2023-01-12 00:00:57.849 GMT [1323] [user=postgres,db=defaultdb,app=aiven-pruned] LOG: disconnection: session time: 0:00:00.010 user=postgres database=defaultdb host=[local]
```

--------------------------------

### Log output for pid=%p,user=%u,db=%d,app=%a,client=%h

Source: https://aiven.io/docs/products/postgresql/reference/log-formats-supported

Example log output when using the pid, user, database, application, and client format.

```text
[pg-user-test-1]2023-01-11T23:58:46.010530[postgresql-14][14-1] pid=625,user=postgres,db=defaultdb,app=[unknown],client=[local] LOG: connection authorized: user=postgres database=defaultdb application_name=aiven-pruned
[pg-user-test-1]2023-01-11T23:58:46.019705[postgresql-14][15-1] pid=625,user=postgres,db=defaultdb,app=aiven-pruned,client=[local] LOG: disconnection: session time: 0:00:00.010 user=postgres database=defaultdb host=[local]
```

--------------------------------

### GET avn service get

Source: https://aiven.io/docs/tools/cli/service-cli

Retrieves details for a specific Aiven service.

```APIDOC
## GET avn service get

### Description
Retrieves the details of a single Aiven service.

### Parameters
#### Path Parameters
- **service_name** (string) - Required - The name of the service to retrieve.

#### Query Parameters
- **--format** (string) - Optional - Format of the output string.
- **--json** (flag) - Optional - Output the service details in JSON format.

### Request Example
```
avn service get pg-demo --format '{service_name} {service_uri}'
```
```

--------------------------------

### Example switchover window configuration

Source: https://aiven.io/docs/products/postgresql/howto/pg-controlled-switchover

A sample JSON structure showing both maintenance and switchover window definitions.

```json
{
  "maintenance": {
    "dow": "monday",
    "time": "08:00:00"
  },
  "user_config": {
    "switchover_windows": [
      {
        "dow": "monday",
        "start_time": "22:00:00",
        "end_time": "22:15:00"
      },
      {
        "dow": "tuesday",
        "start_time": "23:30:00",
        "end_time": "23:59:59"
      },
      {
        "dow": "wednesday",
        "start_time": "00:00:00",
        "end_time": "00:30:00"
      }
      ...
    ]
  }
}
```

--------------------------------

### Install PHP ClickHouse library

Source: https://aiven.io/docs/products/clickhouse/howto/connect-with-php

Use Composer to install the required smi2/phpclickhouse dependency.

```bash
composer require smi2/phpclickhouse
```

```bash
php composer.phar require smi2/phpclickhouse
```

--------------------------------

### Build and Run Locally

Source: https://aiven.io/docs/products/kafka/howto/kafka-streams-with-aiven-for-kafka

Compile the application into a fat JAR and execute it using the provided run script.

```bash
gradle GenericFilterAppUberJar
```

```bash
cp app/build/libs/GenericFilterApp-uber.jar .
```

```bash
APP_NAME=GenericFilterApp ./run.sh
```

--------------------------------

### Example output of user roles

Source: https://aiven.io/docs/products/postgresql/howto/pg-long-running-queries

Sample output showing users and their associated roles.

```text
username |        role
----------+---------------------
avnadmin | pg_read_all_stats
avnadmin | pg_stat_scan_tables
(3 rows)
```

--------------------------------

### Install psycopg2 library

Source: https://aiven.io/docs/products/postgresql/howto/connect-python

Install the Python psycopg2 library using pip. This is a prerequisite for connecting to PostgreSQL.

```bash
pip install psycopg2
```

--------------------------------

### Create a Valkey service with Aiven CLI

Source: https://aiven.io/docs/products/valkey/get-started

Use the avn service create command to provision a new Valkey instance. Ensure you replace placeholders with your specific cloud, plan, and project details.

```bash
 avn service create demo-valkey     \
    --service-type valkey              \
    --cloud CLOUD_AND_REGION           \
    --plan PLAN                        \
    --project PROJECT_NAME
```

--------------------------------

### Install redis-py library

Source: https://aiven.io/docs/products/dragonfly/howto/connect-python

Install the redis-py library using pip. This is a prerequisite for connecting to Dragonfly with Python.

```bash
pip install redis
```

--------------------------------

### Example Output of MySQL Version

Source: https://aiven.io/docs/products/mysql/howto/connect-with-java

This is an example of the output you can expect if the Java connection to Aiven for MySQL is successful.

```text
Version: 8.0.26
```

--------------------------------

### Run ksqlDB by copying SSL certificates

Source: https://aiven.io/docs/products/kafka/howto/ksql-docker

Deploys a ksqlDB container by creating it first and then copying the required SSL files into the container filesystem.

```bash
docker container create --name ksql  \
    -p 127.0.0.1:8088:8088 \
    -e KSQL_BOOTSTRAP_SERVERS=APACHE_KAFKA_HOST:APACHE_KAFKA_PORT \
    -e KSQL_LISTENERS=http://0.0.0.0:8088/ \
    -e KSQL_KSQL_SERVICE_ID=ksql_service_1_ \
    -e KSQL_OPTS="-Dsecurity.protocol=SSL
        -Dssl.keystore.type=PKCS12
        -Dssl.keystore.location=/home/appuser/KEYSTORE_FILE_NAME
        -Dssl.keystore.password=SSL_KEYSTORE_PASSWORD
        -Dssl.key.password=SSL_KEY_PASSWORD
        -Dssl.truststore.type=JKS
        -Dssl.truststore.location=/home/appuser/TRUSTSTORE_FILE_NAME
        -Dssl.truststore.password=SSL_TRUSTSTORE_PASSWORD
        -Dksql.schema.registry.url=APACHE_KAFKA_HOST:SCHEMA_REGISTRY_PORT
        -Dksql.schema.registry.basic.auth.credentials.source=USER_INFO
        -Dksql.schema.registry.basic.auth.user.info=avnadmin:SCHEMA_REGISTRY_PASSWORD
        -Dksql.schema.registry.ssl.truststore.location=/home/appuser/TRUSTSTORE_SCHEMA_REGISTRY_FILE_NAME
        -Dksql.schema.registry.ssl.truststore.password=TRUSTSTORE_SCHEMA_REGISTRY_PASSWORD" \
    confluentinc/ksqldb-server:0.23.1
docker cp KEYSTORE_FILE_NAME ksql:/home/appuser/
docker cp TRUSTSTORE_FILE_NAME ksql:/home/appuser/
docker cp TRUSTSTORE_SCHEMA_REGISTRY_FILE_NAME ksql:/home/appuser/
docker start ksql
```

--------------------------------

### Configure runtime Docker image

Source: https://aiven.io/docs/products/apps/manifest-files/containerfiles

Sets up a Debian-based runtime environment, installs necessary libraries, and configures the application entrypoint.

```dockerfile
FROM debian:bookworm-slim

WORKDIR /app

# Install openssl (for run.sh) and RocksDB library (for Kafka Streams)
RUN apt-get update \
    && apt-get install -y librocksdb7.8

RUN apt-get autoremove -y \
    && apt-get clean -y \
    && apt-get autoclean -y \
    && rm -rf /var/lib/apt/lists/*

# Get the ARG value to make it available in this stage
ARG APP_NAME
# Set an ENV value to that value
ENV APP_NAME=$APP_NAME

# Copy the custom JRE and application artifacts from the builder stage
COPY --from=builder /app/custom-jre /usr/lib/jvm/custom-jre
COPY --from=builder /app/$APP_NAME-uber.jar ./
COPY --from=builder /app/setup_auth.sh ./
COPY --from=builder /app/run.sh ./

ENV JAVA_HOME="/usr/lib/jvm/custom-jre"
ENV PATH="$JAVA_HOME/bin:$PATH"

# Copy the entrypoint script and make it executable
COPY run.sh ./
RUN chmod +x ./run.sh
RUN chmod +x ./setup_auth.sh

# Set the custom entrypoint
CMD [ "./run.sh" ]
```

--------------------------------

### Build and Run with Docker

Source: https://aiven.io/docs/products/kafka/howto/kafka-streams-with-aiven-for-kafka

Build the container image and execute the application with necessary environment variables.

```bash
docker build --build-arg APP_NAME=GenericFilterApp -t appimage .
```

```bash
docker run -d --name kafka-streams-container -p 3000:3000 \
        -e KAFKA_BOOTSTRAP_SERVERS=$KAFKA_BOOTSTRAP_SERVERS \
        -e KAFKA_CA_CERT="$KAFKA_CA_CERT" \
        -e SERVICE_CERT_CONTENTS="$SERVICE_CERT_CONTENTS" \
        -e KAFKA_ACCESS_KEY="$KAFKA_ACCESS_KEY" \
        -e SCHEMA_REGISTRY_URL=$SCHEMA_REGISTRY_URL \
        -e SCHEMA_REGISTRY_USERNAME=$SCHEMA_REGISTRY_USERNAME \
        -e SCHEMA_REGISTRY_PASSWORD=$SCHEMA_REGISTRY_PASSWORD \
        appimage
```

--------------------------------

### Connect and interact with Aiven for Valkey

Source: https://aiven.io/docs/products/valkey/howto/connect-php

Create a client instance using the service URI and perform basic set and get operations.

```php
<?php

require 'vendor/autoload.php';
Predis\Autoloader::register();

$service_uri = 'SERVICE_URI';

$client = new Predis\Client($service_uri);

$client->set('key', 'hello world');
$value = $client->get('key');

echo "The value of key is: {$value}";
```

--------------------------------

### Example Search Results

Source: https://aiven.io/docs/products/opensearch/howto/opensearch-search-and-python

This is an example output of search results, likely from a query targeting recipe titles or ingredients.

```json
[
  'Garlic-Lemon Potatoes ',
  'Lemon Garlic Mayonnaise ',
  'Lemon Garlic Mayonnaise ',
  'Garlic-Lemon Croutons ',
  'Lemon-Garlic Vinaigrette ',
  'Lemon-Garlic Lamb Chops ',
  'Lemon Pepper Garlic Vinaigrette ',
  'Lemon-Garlic Baked Shrimp ',
  'Lemon-Herb Turkey with Lemon-Garlic Gravy ',
  'Garlic, Oregano, and Lemon Vinaigrette '
]
```

--------------------------------

### GET avn service ca get

Source: https://aiven.io/docs/tools/cli/service-cli

Retrieves the project CA certificate for the project that the selected service belongs to.

```APIDOC
## GET avn service ca get

### Description
Retrieves the project CA that the selected service belongs to.

### Parameters
#### Path Parameters
- **service_name** (string) - Required - The name of the service

#### Query Parameters
- **--target-filepath** (string) - Optional - The file path used to store the CA certificate locally

### Request Example
avn service ca get kafka-doc --target-filepath /tmp/ca.pem
```