diff --git a/.github/workflow-config/labeling-rules.yaml b/.github/workflow-config/labeling-rules.yaml index 7fef61f82..fb91ada0c 100644 --- a/.github/workflow-config/labeling-rules.yaml +++ b/.github/workflow-config/labeling-rules.yaml @@ -5,10 +5,6 @@ platform: - changed-files: - any-glob-to-any-file: 'docs/platform/**' -service/alloydbomni: - - changed-files: - - any-glob-to-any-file: 'docs/products/alloydbomni/**' - service/cassandra: - changed-files: - any-glob-to-any-file: 'docs/products/cassandra/**' diff --git a/.github/workflows/update-adv-params-all.yaml b/.github/workflows/update-adv-params-all.yaml index 5373ba3e5..7e7cdeb4c 100644 --- a/.github/workflows/update-adv-params-all.yaml +++ b/.github/workflows/update-adv-params-all.yaml @@ -83,9 +83,3 @@ jobs: uses: ./.github/workflows/update-adv-params.yaml with: service-name: valkey - - update-adv-params-alloydbomni: - name: Update parameters - AlloyDB Omni - uses: ./.github/workflows/update-adv-params.yaml - with: - service-name: alloydbomni diff --git a/Makefile b/Makefile index 302a511fd..df698201c 100644 --- a/Makefile +++ b/Makefile @@ -2,7 +2,7 @@ SCRIPTS = ./scripts INCLUDESDIR = ./static/includes # Generate config listing for a service type -all-service-type-configs: service-type-config-cassandra service-type-config-clickhouse service-type-config-flink service-type-config-grafana service-type-config-kafka_mirrormaker service-type-config-kafka_connect service-type-config-kafka service-type-config-mysql service-type-config-opensearch service-type-config-caching service-type-config-pg service-type-config-dragonfly service-type-config-valkey service-type-config-alloydbomni +all-service-type-configs: service-type-config-cassandra service-type-config-clickhouse service-type-config-flink service-type-config-grafana service-type-config-kafka_mirrormaker service-type-config-kafka_connect service-type-config-kafka service-type-config-mysql service-type-config-opensearch service-type-config-caching service-type-config-pg service-type-config-dragonfly service-type-config-valkey service-type-config-cassandra: node "$(SCRIPTS)/service_type_parser.js" "cassandra" "$(INCLUDESDIR)/config-cassandra.md" @@ -43,9 +43,6 @@ service-type-config-caching: service-type-config-valkey: node "$(SCRIPTS)/service_type_parser.js" "valkey" "$(INCLUDESDIR)/config-valkey.md" -service-type-config-alloydbomni: - node "$(SCRIPTS)/service_type_parser.js" "alloydbomni" "$(INCLUDESDIR)/config-alloydbomni.md" - cloud-list: node "$(SCRIPTS)/clouds_parser.js" "$(INCLUDESDIR)/clouds-list.md" diff --git a/docs/platform/concepts/permissions.md b/docs/platform/concepts/permissions.md index 367735a7c..b1fe629e8 100644 --- a/docs/platform/concepts/permissions.md +++ b/docs/platform/concepts/permissions.md @@ -92,7 +92,7 @@ These permissions apply to the | View services | `project:services:read` | | | Manage services | `project:services:write` | | | Manage service configuration | `service:configuration:write` | | -| Access data | `service:data:write` | | +| Access data | `service:data:write` | | | View service logs | `service:logs:read` | **Service logs may contain sensitive information.** | | View configuration secrets | `service:secrets:read` | | | Manage service users | `service:users:write` | | diff --git a/docs/platform/howto/create_new_service_user.md b/docs/platform/howto/create_new_service_user.md index 2e35aefac..2368f4ece 100644 --- a/docs/platform/howto/create_new_service_user.md +++ b/docs/platform/howto/create_new_service_user.md @@ -19,7 +19,6 @@ and Aiven for Grafana®. By default, Aiven-managed services allow up to 50 users. This limit does not apply to the following services: -- Aiven for AlloyDB Omni - Aiven for Apache Cassandra® - Aiven for Caching - Aiven for Dragonfly @@ -50,7 +49,6 @@ To increase the maximum number of users allowed for a service, Use the service user resource for your Aiven service: -- Aiven for AlloyDB Omni: [`aiven_alloydbomni_user`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni_user) - Aiven for ClickHouse®: [`aiven_clickhouse_user`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/clickhouse_user) - Aiven for Apache Kafka®: [`aiven_kafka_user`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/kafka_user) - Aiven for MySQL®: [`aiven_mysql_user`](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/mysql_user) diff --git a/docs/platform/howto/list-service.md b/docs/platform/howto/list-service.md index bfc03c781..825c4a92f 100644 --- a/docs/platform/howto/list-service.md +++ b/docs/platform/howto/list-service.md @@ -30,9 +30,6 @@ product portfolio. - Aiven for PostgreSQL® with the TimescaleDB extension is your best choice if you already use PostgreSQL, require **SQL compatibility** and have a limited time series use case. -- Aiven for AlloyDB Omni is a solid option for **PostgreSQL compatible** - workloads with a need for columnar analytical data and seamless AI - integration across any cloud. - Aiven for Clickhouse® is your best choice when you need a high-prformance columnar time series database for OLAP workloads or a data analytics warehouse. diff --git a/docs/platform/howto/use-aws-privatelinks.md b/docs/platform/howto/use-aws-privatelinks.md index 39585e0d7..188835fa2 100644 --- a/docs/platform/howto/use-aws-privatelinks.md +++ b/docs/platform/howto/use-aws-privatelinks.md @@ -33,7 +33,6 @@ need [AWS Management Console](https://aws.amazon.com/console) or :::note AWS PrivateLink is not supported for: -- Aiven for AlloyDB Omni - Aiven for Apache Cassandra® - Aiven for Apache Flink® - Aiven for Apache Kafka® MirrorMaker 2 diff --git a/docs/platform/reference/end-of-life.md b/docs/platform/reference/end-of-life.md index 2b041dc00..61accfbf4 100644 --- a/docs/platform/reference/end-of-life.md +++ b/docs/platform/reference/end-of-life.md @@ -55,18 +55,8 @@ before January 7, 2026. For further assistance, contact your account team. **EOL date**: December 5, 2025 -### Service impact - -- **End of availability (EOA)**: September 5, 2025 - - After this date, you can no longer create new Aiven for AlloyDB Omni services. Existing - services continue to operate until the end of life (EOL) date but you cannot change - plans for these services. - -- **End of life (EOL)**: December 5, 2025 - - On this date, all active Aiven for AlloyDB Omni services are powered off and deleted, - making data from these services inaccessible. +Since December 5, 2025, Aiven for AlloyDB Omni services are no longer available, +and data they hosted is inaccessible. ### Migration options diff --git a/docs/products/alloydbomni.md b/docs/products/alloydbomni.md deleted file mode 100644 index 64cd98211..000000000 --- a/docs/products/alloydbomni.md +++ /dev/null @@ -1,155 +0,0 @@ ---- -title: Aiven for AlloyDB Omni ---- - -import EoaNotice from "@site/static/includes/service-end-of-availability-notice.md" - - - -Harness the speed and scalability of Google AlloyDB Omni on any cloud, managed by Aiven. - -Aiven for AlloyDB Omni is a managed version of Google AlloyDB Omni purpose-built for -mission-critical PostgreSQL® workloads. It combines the power of Google's advanced -database technology, new columnar engine, and AI capabilities with the ease of use and -multi-cloud flexibility of the Aiven Platform for Google Cloud, Amazon Web Services (AWS), -and Microsoft Azure. - -## Features and benefits - -- Full PostgreSQL compatibility - - Aiven for AlloyDB Omni is designed to be fully compatible with PostgreSQL, ensuring that - existing applications and tools work seamlessly without requiring any code changes. It - utilizes standard PostgreSQL drivers and supports a wide range of PostgreSQL extensions - and flags. - - :::note - Aiven for AlloyDB Omni version 15 is compatible with PostgreSQL version 15. - ::: - -- High performance - - Experience fast transactional, analytical, and vector search workloads for real-time - insights, high-throughput applications, and efficient AI-powered solutions. - -- Managed service simplicity - - Aiven handles the provisioning of Aiven for AlloyDB Omni on any major cloud and takes - care of routine tasks like backups, scaling, upgrades, and high availability. This gives - you the freedom to focus on innovation and building applications, not database - management. - -- Built-in generative AI - - Build and deploy powerful generative AI applications directly on your operational data. - Leverage vector embeddings, perform lightning-fast vector similarity searches, and - access cutting-edge AI models within your database, all with the familiarity of SQL. - -- Multi-cloud and hybrid flexibility - - Deploy and manage Aiven for AlloyDB Omni seamlessly across AWS, Google Cloud, or Azure. - Achieve maximum flexibility and agility anywhere you use PostgreSQL. - -- Enterprise-grade security - - Securely access your operational data and your AI models stored remotely. Leverage - end-to-end encryption, private networking, and role-based access control for peace of - mind. - -- Seamless scalability - - Scale your database, upgrade versions, or perform other management tasks without - interrupting your applications. - -- Cost-efficiency - - Benefit from predictable and transparent, pay-as-you-go pricing with no hidden fees or - charges. - -## Key use cases - -Aiven for AlloyDB Omni is ideal for a variety of data-intensive applications and use cases, -including: - -- Data-intensive applications with complex workloads - - Reduce response times for - applications that require a combination of high transactional throughput and complex - analytical queries, such as those in healthcare or gaming. - -- High-performance transactional workloads - - Increase the throughput for applications that - require high transaction rates, low latency, and consistent performance, such as - e-commerce platforms or financial systems. - -- Multi-cloud deployments - - Adopt Aiven for AlloyDB Omni advanced features and performance - on the cloud or clouds of your choice with centralized management through the Aiven - platform. - -- High-traffic web applications - - Handle large volumes of concurrent users and transactions - with ease, ensuring a smooth user experience. - -- Real-time analytics and dashboards - - Process and analyze massive datasets in real time to - generate actionable insights, track key performance indicators, and drive faster - decision-making. - -- Machine learning and AI applications - - Build and deploy generative AI applications - directly on your operational data, using the familiarity of SQL. - -## How it works - -### Setting up Aiven for AlloyDB Omni - -- In the Aiven Console, create an Aiven for AlloyDB Omni service. Select a cloud - provider (AWS, Google Cloud, Azure) and a pricing plan. -- Aiven handles the infrastructure provisioning and deployment of Aiven for AlloyDB Omni. -- Once the cluster is up and running, find connection details (host, port, credentials) - to access your Aiven for AlloyDB Omni database. - -### Connecting to Aiven for AlloyDB Omni - -- Securely connect Aiven for AlloyDB Omni to your applications and tools. -- Efficiently manage client application connections with built-in connection pooling. -- Extend database functionality with your favorite PostgreSQL extensions. - -### Managing Aiven for AlloyDB Omni - -- Manage your Aiven for AlloyDB Omni cluster using the Aiven Console. -- Scale up or down, fork clusters, upgrade versions, and create read replicas with a few - clicks. -- Use your favorite PostgreSQL tools and extensions compatible with Aiven for AlloyDB Omni. -- Deploy read replicas across clouds or regions for disaster recovery and improved - performance. -- Integrate with your preferred monitoring tools or use Aiven's built-in observability - features for deep insights. - -### Data protection and security - -Scale your database, upgrade versions, or perform other management tasks without -interrupting your applications. - -Aiven for AlloyDB Omni offers the following: - -- Automatic backups with Point-In-Time-Recovery -- Aiven's self-healing platform automatically detecting and recovering from failures, - minimizing downtime and disruptions -- Adherence to strict security standards (ISO 27001, SOC2) and compliance with - GDPR, HIPAA, and PCI/DSS -- Email communication with best-effort responses on the same or next business day from a - 100% human support team - -## Learn more - -- [Get started with Aiven for AlloyDB Omni](/docs/products/alloydbomni/get-started) -- [Access and use generative AI models with Aiven for AlloyDB Omni](/docs/products/alloydbomni/access-ai-models) -- [Use the Aiven for AlloyDB Omni columnar engine](/docs/products/alloydbomni/use-columnar-engine) -- [AlloyDB Omni documentation by Google](https://cloud.google.com/alloydb/docs/omni) diff --git a/docs/products/alloydbomni/access-ai-models.md b/docs/products/alloydbomni/access-ai-models.md deleted file mode 100644 index d5a598997..000000000 --- a/docs/products/alloydbomni/access-ai-models.md +++ /dev/null @@ -1,283 +0,0 @@ ---- -title: Access and use AI models with Aiven for AlloyDB Omni -sidebar_label: Use AI models -keywords: [Vertex AI, VertexAI] ---- - -Enable and use AI models in Aiven for AlloyDB Omni to build and deploy generative AI applications directly on your operational data. - -Aiven for AlloyDB Omni allows you to integrate and use many AI models including -[OpenAI](/docs/products/alloydbomni/access-ai-models#use-openai), -[Gemini](/docs/products/alloydbomni/access-ai-models#use-gemini), or -[Hugging Face](/docs/products/alloydbomni/access-ai-models#use-hugging-face). You can also -integrate an AI model you built yourself using the -[bring your own model (BYOM)](/docs/products/alloydbomni/access-ai-models#bring-your-own-model-byom) -capability. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- [`psql` CLI client installed](https://www.postgresql.org/download/) -- [`gcloud` CLI client installed](https://cloud.google.com/sdk/docs/install) -- [Google service account credentials uploaded into Aiven for AlloyDB Omni](/docs/products/alloydbomni/manage-credentials) -- `google_ml_integration` extension installed using the `psql` CLI: - - ```sql - CREATE EXTENSION google_ml_integration; - ``` - -## Use OpenAI - -1. Record your OpenAI user API key as a secret in Google Secret Manager. - -1. Grant your Google service account access to the created secret using the `gcloud` CLI: - - ```bash - gcloud secrets add-iam-policy-binding SECRET_ID - --member="serviceAccount:GOOGLE_SERVICE_ACCOUNT_PRINCIPAL" - --role="roles/secretmanager.secretAccessor" - ``` - - where: - - `SECRET_ID` is the ID of you newly created secret recorded in the Google Secret - Manager - - `GOOGLE_SERVICE_ACCOUNT_PRINCIPAL` is your Google service account principal, - for example `abc-vertex-ai-sa@sample-project-name.iam.gserviceaccount.com` - -1. Declare the secret for the integration using the `psql` CLI: - - ```sql - CALL google_ml.create_sm_secret( - secret_id=>'DECLARED_SECRET_ID', - secret_path=>'projects/GOOGLE_CLOUD_PROJECT_NAME/secrets/SECRET_ID/versions/1'); - ``` - - where: - - `DECLARED_SECRET_ID` is the local identifier for your secret - - `GOOGLE_CLOUD_PROJECT_NAME` is the name of your Google Cloud project where the - secret in stored - - `SECRET_ID` is the ID of the secret created in Google Secret Manager - -1. Define the AI model using the `psql` CLI: - - ```sql - CALL google_ml.create_model( - model_id => 'gpt-4o', - model_provider => 'open_ai', - model_request_url =>'https://api.openai.com/v1/chat/completions', - model_type => 'generic', - model_auth_type => 'secret_manager', - model_auth_id => 'DECLARED_SECRET_ID', - model_qualified_name => 'gpt-4o'); - ``` - - where `DECLARED_SECRET_ID` is the local identifier for the secret declared for the - integration. - -1. Use the model by running: - - ```sql - SELECT google_ml.predict_row('gpt-4o','{"model" : "gpt-4o", "messages" : [{"role": "user", "content": "What is Aiven?"}]}')->'choices'->0->'message'->'content'; - ``` - -## Use Gemini - -:::note -[Gemini](https://cloud.google.com/gemini/docs/overview) models are integrated into Google -Cloud’s [Vertex AI](https://cloud.google.com/vertex-ai/docs?hl=en) platform. To enable -other Vertex-AI-supported models in Aiven, use -[the instructions for integrating Gemini](/docs/products/alloydbomni/access-ai-models#use-gemini), -adjusting as needed. -::: - -1. Grant the service user access to utilize Vertex AI using the `gcloud` CLI: - - ```bash - gcloud projects add-iam-policy-binding GOOGLE_CLOUD_PROJECT_NAME - --member="serviceAccount:GOOGLE_SERVICE_ACCOUNT_PRINCIPAL" - --role="roles/aiplatform.user" - ``` - - where: - - `GOOGLE_CLOUD_PROJECT_NAME` is the name of your Google Cloud project - - `GOOGLE_SERVICE_ACCOUNT_PRINCIPAL` is your Google service account principal, - for example `abc-vertex-ai-sa@sample-project-name.iam.gserviceaccount.com`. - -1. Define the AI model on your Aiven for AlloyDB Omni service using the `psql` CLI: - - ```sql - CALL google_ml.create_model( - model_id => 'gemini-1.0-pro', - model_request_url => 'https://us-central1-aiplatform.googleapis.com/v1/projects/GOOGLE_CLOUD_PROJECT_NAME/locations/us-central1/publishers/google/models/gemini-1.0-pro:streamGenerateContent', - model_provider => 'google', - model_auth_type => 'alloydb_service_agent_iam'); - ``` - - where `GOOGLE_CLOUD_PROJECT_NAME` is the name of your Google Cloud project. - -1. Use the model by running: - - ```sql - SELECT google_ml.predict_row( - model_id =>'gemini-1.0-pro', - request_body =>'{ "contents": { "role": "user", "parts": { "text": "What is Aiven?" } }}'); - ``` - -## Use Hugging Face - -1. Record your [Hugging Face access token](https://huggingface.co/docs/hub/en/security-tokens) - as a secret in Google Secret Manager. - -1. Grant your Google service account access to the created secret using the `gcloud` CLI: - - ```bash - gcloud secrets add-iam-policy-binding SECRET_ID - --member="serviceAccount:GOOGLE_SERVICE_ACCOUNT_PRINCIPAL" - --role="roles/secretmanager.secretAccessor" - ``` - - where: - - `SECRET_ID` is the ID of you newly created secret recorded in the Google Secret - Manager - - `GOOGLE_SERVICE_ACCOUNT_PRINCIPAL` is your Google service account principal, - for example `abc-vertex-ai-sa@sample-project-name.iam.gserviceaccount.com` - -1. Declare the secret for the integration using the `psql` CLI: - - ```sql - CALL google_ml.create_sm_secret( - secret_id=>'DECLARED_SECRET_ID', - secret_path=>'projects/GOOGLE_CLOUD_PROJECT_NAME/secrets/SECRET_ID/versions/1'); - ``` - - where: - - `DECLARED_SECRET_ID` is the local identifier for your secret - - `GOOGLE_CLOUD_PROJECT_NAME` is the name of your Google Cloud project where the - secret in stored - - `SECRET_ID` with the ID of the secret created in Google Secret Manager - -1. Define the AI model using the `psql` CLI: - - ```sql - CALL google_ml.create_model( - model_id => 'Mistral-7B-Instruct-v0.3', - model_provider => 'custom', - model_request_url =>'https://api-inference.huggingface.co/models/mistralai/Mistral-7B-Instruct-v0.3', - model_type => 'generic', - model_auth_type => 'secret_manager', - model_auth_id => 'DECLARED_SECRET_ID', - model_qualified_name => 'Mistral-7B-Instruct-v0.3'); - ``` - - where `DECLARED_SECRET_ID` is the local identifier for the secret declared for the - integration. - -1. Use the model by running: - - ```sql - SELECT google_ml.predict_row('Mistral-7B-Instruct-v0.3','{"inputs" : "What is Aiven?"}')->0->'generated_text'; - ``` - -## Bring your own model (BYOM) - -Aiven for AlloyDB Omni can connect to custom or 3rd party models remotely. Such remote -models can be used to: - -- Generate embeddings by translating text prompts into numerical vectors (`embedding()`) -- Invoke predictions using SQL within transactions (`predict_row()`) - -### BYOM prerequisites - -- Model endpoint can be called using the HTTP/HTTPS REST protocol. -- Input and output of model endpoint calls support the JSON format. - -### Enable BYOM for text embeddings - -1. Declare transformation functions to move from text input to a JSON request by encode - the `input_text` parameter into a JSON field `prompt` for the outgoing request: - - ```bash - CREATE OR REPLACE FUNCTION mymodel_text_input_transform(model_id VARCHAR(100), input_text TEXT) - RETURNS JSON - LANGUAGE plpgsql - AS $$ - DECLARE - transformed_input JSON; - BEGIN - SELECT json_build_object( - ‘prompt’, - json_build_array(input_text))::JSON - INTO transformed_input; - RETURN transformed_inpput; - END; - $$; - ``` - -1. Parse the returned response from JSON into a array of real vectors by translating the - list of vector array into a single list of expected vectors: - - ```bash - CREATE OR REPLACE FUNCTION mymodel_text_output_transform(model_id VARCHAR(100), response_json JSON) - RETURNS REAL[] - LANGUAGE plpgsql - AS $$ - DECLARE - transformed_output REAL[]; - BEGIN - SELECT ARRAY(SELECT json_array_elements_text(response_json->0)) INTO transformed_output; - RETURN transformed_output; - END; - $$; - ``` - -1. Declare the secret for the integration using the `psql` CLI: - - ```sql - CALL google_ml.create_sm_secret( - secret_id=>'DECLARED_SECRET_ID', - secret_path=>'projects/GOOGLE_CLOUD_PROJECT_NAME/secrets/SECRET_ID/versions/1'); - ``` - - where: - - `DECLARED_SECRET_ID` is the local identifier for your secret - - `GOOGLE_CLOUD_PROJECT_NAME` is the name of your Google Cloud project where the - secret in stored - - `SECRET_ID` is the ID of the secret created in Google Secret Manager - -1. Define the AI model using the `psql` CLI: - - ```sql - CALL google_ml.create_model( - model_id => 'LOCAL_MODEL_ID', - model_provider => 'custom', - model_request_url =>'MODEL_URL_ENDPOINT', - model_type => 'MODEL_TYPE', - model_auth_type => 'secret_manager', - model_auth_id => 'DECLARED_SECRET_ID', - model_in_transform_fn => ‘mymodel_text_input_transform’, - model_out_transform_fn => ‘mymodel_text_output_transform’); - ``` - - where: - - `LOCAL_MODEL_ID` is the name of the registered model - - `M̀ODEL_URL_ENDPOINT` is a pointer to your remote model - - `MODEL_TYPE` is either `text-embedding` or `generic` depending on whether to use - an `embedding()` call or a `predict_row()` call - - `DECLARED_SECRET_ID` is the local identifier for the secret declared for the - integration - - `model_in_transform_fn` and `model_out_transform_fn` are the transformation - functions declared earlier - -1. Use your model by running: - - ```sql - SELECT - google_ml.embedding( - model_id => 'LOCAL_MODEL_ID', - content => 'Aiven for AlloyDB Omni is a managed cloud-hosted SQL database service with AI integrations'); - ``` - -## Next step - -With an AI model integrated, you can -[build generative AI applications using AlloyDB AI](https://cloud.google.com/alloydb/docs/ai). diff --git a/docs/products/alloydbomni/connect/connect-datagrip.md b/docs/products/alloydbomni/connect/connect-datagrip.md deleted file mode 100644 index a964cbbd2..000000000 --- a/docs/products/alloydbomni/connect/connect-datagrip.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: Connect with DataGrip ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using [JetBrains DataGrip](https://www.jetbrains.com/datagrip/). - -## Prerequisites - -- Access to the [Aiven Console](https://console.aiven.io/) -- Aiven for AlloyDB Omni service running -- [DataGrip](https://www.jetbrains.com/datagrip/download/) installed on your machine - -## Get JDBC URI from Aiven Console - -1. Log in to [Aiven Console](https://console.aiven.io/) and go to your - organization > project > Aiven for AlloyDB Omni service. -1. On the service's page, select **Quick connect**. -1. Choose to connect with DataGrip. -1. Copy the generated JDBC URI and click **Done**. - -## Connect to JDBC URI from DataGrip - -1. Open DataGrip on your machine, and select **File** > **New** > **Data Source** > - **PostgreSQL** from the top navigation menu. -1. In the **Data Sources and Drivers** window > **General** tab, paste the copied URI from - the [Aiven Console](https://console.aiven.io/). -1. Click **OK** to create and save the connection. - -The connection to your service has been established and is visible in -DataGrip > **Database Explorer**. diff --git a/docs/products/alloydbomni/connect/connect-dbeaver.md b/docs/products/alloydbomni/connect/connect-dbeaver.md deleted file mode 100644 index 8824a21c1..000000000 --- a/docs/products/alloydbomni/connect/connect-dbeaver.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Connect with DBeaver ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using [DBeaver](https://dbeaver.com/). - -## Prerequisites - -- Access to the [Aiven Console](https://console.aiven.io/) -- Aiven for AlloyDB Omni service running -- [DBeaver](https://dbeaver.io/download/) installed on your machine - -## Get JDBC URI from Aiven Console - -1. Log in to [Aiven Console](https://console.aiven.io/) and go -1. On the service's page, select **Quick connect**. -1. Choose to connect with DBeaver. -1. Copy the generated JDBC URI and click **Done**. - -## Connect to JDBC URI from DBeaver - -1. Open DBeaver on your machine, and select **Database** > **New Database Connection** - from the top navigation menu. -1. In the **Connect to database** window, select PostgreSQL and click **Next**. -1. In the **Connection Settings** window > **Main** tab > **Server** section, - choose to connect with URL and paste the copied URI from the - [Aiven Console](https://console.aiven.io/). -1. Click **Finish** to create and save the connection. - -The connection to your service has been established and is visible in -DBeaver > **Database Navigator**. diff --git a/docs/products/alloydbomni/connect/connect-go.md b/docs/products/alloydbomni/connect/connect-go.md deleted file mode 100644 index af93ec3e7..000000000 --- a/docs/products/alloydbomni/connect/connect-go.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Connect with Go ---- - -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.go'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database from Go, making use of the `pg` library. - -## Prerequisites - -- Aiven for AlloyDB Omni service running - -- Go `pq` library, which you can get by running: - - ```bash - go get github.com/lib/pq - ``` - -- [CA certificate (a file named `ca.pem`) downloaded](/docs/platform/concepts/tls-ssl-certificates#download-ca-certificates) - from the service's page - -## Connect to a service - -1. Create a file named `main.go` with the following content: - - {MyComponentSource1} - - Replace `SERVICE_URI` with the service URI available on the - page in the Aiven Console. - - This code opens a connection to the database, runs a query checking the database version, - and prints the response. - - :::note - To verify the SSL certificate, this code specifies `sslmode` as `verify-ca` and adds - the location of the certificate. - ::: - -1. Run the code: - - ```bash - go run main.go - ``` - -Expect output like: - -```text -PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -``` diff --git a/docs/products/alloydbomni/connect/connect-java.md b/docs/products/alloydbomni/connect/connect-java.md deleted file mode 100644 index 86267fc01..000000000 --- a/docs/products/alloydbomni/connect/connect-java.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: Connect with Java ---- - -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.java'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database from Java, using JDBC Driver. - -## Prerequisites - -- Aiven for AlloyDB Omni service running - -- If you have an Apache Maven version >= 2+, run: - - ```bash - mvn org.apache.maven.plugins:maven-dependency-plugin:2.8:get -Dartifact=org.postgresql:postgresql:42.3.2:jar -Ddest=postgresql-42.3.2.jar - ``` - -- [Binary JAR file of the JDBC driver downloaded](https://jdbc.postgresql.org/download/) - -## Connect to a service - -1. Create a file named `AlloyDBOmniExample.java` with the following content: - - {MyComponentSource1} - - This code opens a connection to the database, runs a query checking the database version, - and prints the response. - -1. Run the code using the following command, replacing the placeholders for connection - parameters with the values available on the - page of your service in the Aiven Console: - - ```bash - javac AlloyDBOmniExample.java && java -cp postgresql-42.2.24.jar:. AlloyDBOmniExample -host HOST -port PORT -database DATABASE -username avnadmin -password PASSWORD - ``` - - The connection parameters to be replaced in the command: - - | Variable | Description | - | ---------- | ----------------------------------------------------------- | - | `HOST` | Hostname for Aiven for AlloyDB Omni service connection | - | `PORT` | Port for Aiven for AlloyDB Omni service connection | - | `DATABASE` | Database name for Aiven for AlloyDB Omni service connection | - | `PASSWORD` | `avnadmin` password | - -Expect output like: - -```text -Version: PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -``` diff --git a/docs/products/alloydbomni/connect/connect-node.md b/docs/products/alloydbomni/connect/connect-node.md deleted file mode 100644 index f81950211..000000000 --- a/docs/products/alloydbomni/connect/connect-node.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Connect with NodeJS ---- - -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.js'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database from NodeJS, using the `pg` package. - -## Prerequisites - -- Aiven for AlloyDB Omni service running - -- npm `pg` package, which you can get by running: - - ```bash - npm install pg --save - ``` - -- [CA certificate (a file named `ca.pem`) downloaded](/docs/platform/concepts/tls-ssl-certificates#download-ca-certificates) - from the service's page - -## Connect to a service - -1. Create a file named `index.js` with the following content: - - {MyComponentSource1} - - Replace the connection parameters with the values available on the - page in the Aiven Console: - - | Variable | Description | - | ---------- | ----------------------------------------------------------- | - | `USER` | Aiven for AlloyDB Omni service username | - | `PASSWORD` | Aiven for AlloyDB Omni service password | - | `HOST` | Hostname for Aiven for AlloyDB Omni service connection | - | `PORT` | Port for Aiven for AlloyDB Omni service connection | - | `DATABASE` | Database name for Aiven for AlloyDB Omni service connection | - - This code opens a connection to the database, runs a query checking the database version, - and prints the response. - -1. Run the code: - - ```bash - node index.js - ``` - -Expect output like: - -```text -PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -``` diff --git a/docs/products/alloydbomni/connect/connect-pgadmin.md b/docs/products/alloydbomni/connect/connect-pgadmin.md deleted file mode 100644 index 02d08c37f..000000000 --- a/docs/products/alloydbomni/connect/connect-pgadmin.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Connect with pgAdmin ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using [pgAdmin](https://www.pgadmin.org/), which is a PostgreSQL® client useful for managing and querying databases. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- Connection details for your service available in the - [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**: - - - Database name - - Host - - Port - - User - - Password - -- [pgAdmin installed on your computer](https://www.pgadmin.org/download/) - -## Connect to a service - -1. Open pgAdmin, go to a server group, and select **Register** to add a server connection. -1. In the **General** tab, give the connection a name, for example `MyDatabase`. -1. In the **Connection** tab, set the connection parameters using the values available in - the Aiven Console > the service's page > - **Connection information**. -1. In the **Parameters** tab, set **SSL mode** to `require`. -1. Click **Save**. - -The connection to your Aiven for AlloyDB Omni service should now be opened, with the -pgAdmin **Dashboard** page showing activity metrics on your database. diff --git a/docs/products/alloydbomni/connect/connect-php.md b/docs/products/alloydbomni/connect/connect-php.md deleted file mode 100644 index 8d75bd4bd..000000000 --- a/docs/products/alloydbomni/connect/connect-php.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: Connect with PHP ---- - -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.php'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database from PHP, using the built-in PDO module. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- [CA certificate (a file named `ca.pem`) downloaded](/docs/platform/concepts/tls-ssl-certificates#download-ca-certificates) - from the service's page -- [PostgreSQL functions](https://www.php.net/manual/en/ref.pdo-pgsql.php) included in your - PHP installation (most installations include them) - -## Connect to a service - -1. Create a file named `index.php` with the following content: - - {MyComponentSource1} - - Replace `SERVICE_URI` with the service URI available on the - page in the Aiven Console. - - This code opens a connection to the database, runs a query checking the database version, - and prints the response. - - :::note - To verify the SSL certificate, this code specifies `sslmode` as `verify-ca` and adds - the location of the certificate. - ::: - -1. Run the code: - - ```bash - php index.php - ``` - -Expect output like: - -```text -PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -``` diff --git a/docs/products/alloydbomni/connect/connect-psql.md b/docs/products/alloydbomni/connect/connect-psql.md deleted file mode 100644 index d05bc2d80..000000000 --- a/docs/products/alloydbomni/connect/connect-psql.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: Connect with psql ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using `psql`, which is a command line tool useful for managing and querying your database. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- `psql` CLI client installed on your computer - -## Connect to a service - -Run: - -```sql -psql 'SERVICE_URI' -``` - -Replace `SERVICE_URI` with the service URI available on the - page in the Aiven Console. - -Expect output like: - -```sql -psql (13.2, server 13.3) -SSL connection (protocol: TLSv1.3, cipher: TLS_AES_256_GCM_SHA384, bits: 256, compression: off) -Type "help" for help. -``` - -## Verify the connection - -To confirm that the connection is working, run: - -```sql -select version(); -``` - -Expect output like: - -```text -version --------------------------------------------------------------------------------------------- -PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -(1 row) -``` diff --git a/docs/products/alloydbomni/connect/connect-python.md b/docs/products/alloydbomni/connect/connect-python.md deleted file mode 100644 index 28118f292..000000000 --- a/docs/products/alloydbomni/connect/connect-python.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Connect with Python ---- - -import CodeBlock from '@theme/CodeBlock'; -import MyComponentSource1 from '!!raw-loader!/code/products/postgresql/connect.py'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using Python 3 and the [psycopg2](https://pypi.org/project/psycopg2/) library. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- Python 3.6 or later -- Python `psycopg2` library, which you can install with the following commands: - - ```bash - pip install psycopg2 - ``` - - or - - ```bash - python3 -m pip install psycopg2 - ``` - -## Connect to a service - -1. Create a file named `main.py` with the following content: - - {MyComponentSource1} - - Replace `SERVICE_URI` with the service URI available on the - page in the Aiven Console. - - This code opens a connection to the database, runs a query checking the database version, - and prints the response. - - :::note - By default, the connection string (`SERVICE_URI`) specifies `sslmode=require`, which - doesn't verify the CA certificate. For production environments, it's recommended to - change it to `sslmode=verify-ca` and include the certificate. - ::: - -1. Run the code: - - ```bash - python3 main.py - ``` - -Expect output like: - -```text -PostgreSQL 15.5 on x86_64-pc-linux-gnu, compiled by [...] -``` diff --git a/docs/products/alloydbomni/connect/connect-rivery.md b/docs/products/alloydbomni/connect/connect-rivery.md deleted file mode 100644 index ec6b39e24..000000000 --- a/docs/products/alloydbomni/connect/connect-rivery.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: Connect with Rivery ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using [Rivery](https://rivery.io/), a platform for data ingestion, transformation, orchestration, reverse ETL, and more. - -## Prerequisites - -- Active Rivery account and workspace -- Aiven for AlloyDB Omni service running -- Connection details for your service available in the - [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**: - - Database name - - Host (server) - - Port - - User - - Password - -## Connect to a service - -1. Log in to your Rivery workspace, and click **Connections** > **New connection**. -1. Select **PostgreSQL** for your new connection. -1. Give the connection a name, for example `MyDatabase`. -1. Set the `MyDatabase` connection parameters using the connection details from the - [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**. -1. Expand **SSL Options**, and set **SSL Mode** to `Require`. -1. Click **Save**. diff --git a/docs/products/alloydbomni/connect/connect-services.md b/docs/products/alloydbomni/connect/connect-services.md deleted file mode 100644 index 0ba39ee01..000000000 --- a/docs/products/alloydbomni/connect/connect-services.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Connect to Aiven for AlloyDB Omni ---- - -import DocCardList from '@theme/DocCardList'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to the Aiven for AlloyDB Omni service using various programming languages or tools. - -:::tip -Preview connection instructions in the [Aiven Console](https://console.aiven.io/): - -1. Log in to the [Aiven Console](https://console.aiven.io/), and go to your - organization > project > Aiven for AlloyDB Omni service. -1. On the page of your service, click - **Quick connect**. -1. In the **Connect** window, select a tool or language to connect with to your service. -1. Follow the connection instructions for a selected language or tool. - - Click **Done** to return to the page. - -::: - - diff --git a/docs/products/alloydbomni/connect/connect-skyvia.md b/docs/products/alloydbomni/connect/connect-skyvia.md deleted file mode 100644 index 69e6eb407..000000000 --- a/docs/products/alloydbomni/connect/connect-skyvia.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Connect with Skyvia ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using the [Skyvia](https://skyvia.com/) cloud data platform. - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- Active Skyvia account and workspace -- Values of your service's connection parameters identified in the - [Aiven Console](https://console.aiven.io) > - the service's page > **Connection information** - - - Database name - - Host (server) - - Port - - User - - Password - -## Connect to a service - -1. Log in to your Skyvia workspace, and click **Create new** > **Connection**. -1. Select **AlloyDB** as a connector. -1. Give the connection a name, for example `MyDatabase`. -1. Set the `MyDatabase` connection parameters using the connection details from the - [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**. -1. Expand **Advanced Settings** and configure the following: - - Set **Protocol** to `SSL` and **SSL Mode** to `Require`. - - For **SSL CA Cert**, paste **CA certificate** from the - [Aiven Console](https://console.aiven.io/) > the service's - page > **Connection information**. - - Leave **SSL Cert** and **SSL Key** empty. - - Set **SSL TLS Protocol** to `1.2`. -1. Click **Create Connection**. diff --git a/docs/products/alloydbomni/connect/connect-zapier.md b/docs/products/alloydbomni/connect/connect-zapier.md deleted file mode 100644 index 15d092ce9..000000000 --- a/docs/products/alloydbomni/connect/connect-zapier.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: Connect with Zapier ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; - -Connect to an Aiven for AlloyDB Omni database using the [Zapier](https://zapier.com/) automation platform. - -## Prerequisites - -- Active Zapier account -- Aiven for AlloyDB Omni service running -- Connection details for your service available in the - [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**: - - Database name - - Host (server) - - Port - - User - - Password - -## Connect to a service - -1. Log in to your Zapier account, and click **Apps** > **Add connection**. -1. Select **PostgreSQL** as an app. -1. Set the app connection details using the connection information available for your Aiven - for AlloyDB Omni service in the [Aiven Console](https://console.aiven.io) > the service's - page > **Connection information**. -1. Click **Yes, Continue to PostgreSQL**. diff --git a/docs/products/alloydbomni/get-started.md b/docs/products/alloydbomni/get-started.md deleted file mode 100644 index 5a6b32893..000000000 --- a/docs/products/alloydbomni/get-started.md +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: Get started with Aiven for AlloyDB Omni -sidebar_label: Get started -keywords: [quick start] ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import ConsoleLabel from "@site/src/components/ConsoleIcons"; -import CreateServiceDBLegacy from "@site/static/includes/create-service-console-db-legacy.md"; -import Help from "@site/static/includes/cli-help.md"; -import TerraformPrereqs from "@site/static/includes/terraform-get-started-prerequisites.md"; -import TerraformApply from "@site/static/includes/terraform-apply-changes.md"; -import TerraformSample from '@site/src/components/CodeSamples/TerraformSample'; - -import EoaNotice from "@site/static/includes/service-end-of-availability-notice.md" - - - -Start using Aiven for AlloyDB Omni by setting up a service and connecting to your new default database with a programming language of your choice. - -## Prerequisites - - - - -- Access to the [Aiven Console](https://console.aiven.io) -- [psql](https://www.postgresql.org/download/) command line tool installed - - - - -- [Aiven CLI](https://github.com/aiven/aiven-client) installed -- [psql](https://www.postgresql.org/download/) command line tool installed - - - - -- [Terraform installed](https://www.terraform.io/downloads) -- A [personal token](https://docs.aiven.io/docs/platform/howto/create_authentication_token.html) -- [psql](https://www.postgresql.org/download/) command line tool installed - - - - -- [Aiven Operator for Kubernetes®](https://aiven.github.io/aiven-operator/installation/helm.html) - installed -- Admin access to a Kubernetes cluster where you can run the operator -- A [personal token](/docs/platform/howto/create_authentication_token) -- [A Kubernetes Secret](https://aiven.github.io/aiven-operator/authentication.html) - - - - - -## Create an Aiven for AlloyDB Omni service - - - - - - - - - -1. Determine the service specifications, including plan, cloud provider, region, - and project name. - -1. Run the following command to create an Aiven for AlloyDB Omni service named - `demo-alloydbomni`: - - ```bash - avn service create demo-alloydbomni \ - --service-type alloydbomni \ - --cloud CLOUD_AND_REGION \ - --plan PLAN \ - --project PROJECT_NAME - ``` - - Parameters: - - - `avn service create demo-alloydbomni`: Command to create new Aiven service - named `demo-alloydbomni`. - - `--service-type alloydbomni`: Specifies the service type as Aiven for AlloyDB Omni. - - `--cloud CLOUD_AND_REGION`: Specifies the cloud provider and region for deployment. - - `--plan PLAN`: Specifies the service plan or tier. - - `--project PROJECT_NAME`: Specifies the project where the service will be created. - - - - - - -The following example files are also available in the -[Aiven Terraform Provider repository](https://github.com/aiven/terraform-provider-aiven/tree/main/examples/alloydbomni) on GitHub. - -1. Create a file named `provider.tf` and add the following: - - - -1. Create a file named `service.tf` and add the following: - - - -1. To output connection details, create a file named `output.tf` and add the following: - - - -1. Create a file named `variables.tf` and add the following: - - - -1. Create the `terraform.tfvars` file and add the values for your token and project name. - - - - - - -Use the [AlloyDBOmni](https://aiven.github.io/aiven-operator/resources/alloydbomni.html) -resource. - - - - -## Configure the service - -You can change your service settings by updating the service configuration. - -:::tip -See configuration options in -[Advanced parameters for Aiven for AlloyDB Omni](/docs/products/alloydbomni/reference/advanced-params). -::: - - - -1. Select the new service from the list of services on - the page. -1. On the page, select - from the sidebar. -1. In the **Advanced configuration** section, make changes to the service configuration. - - -Use the [avn service update](/docs/tools/cli/service-cli#avn-cli-service-update) command -to change basic service settings, such as service version, IP filtering, cloud region, -termination protection, or service plan. - -:::tip -Use [other avn service commands](/docs/tools/cli/service-cli) for advanced settings and -operations on your service. -::: - - - - -See -[the `aiven_alloydbomni` resource documentation](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni) -for the full schema. - - - - -Update your [AlloyDBOmni](https://aiven.github.io/aiven-operator/resources/alloydbomni.html) -resource. - - - - -## Connect to the service - - - -1. Log in to the [Aiven Console](https://console.aiven.io/), and go to your - organization > project > Aiven for AlloyDB Omni service. -1. On the page of your service, click - **Quick connect**. -1. In the **Connect** window, select a tool or language to connect to your service, follow - the connection instructions, and click **Done**. - - - - -[Connect to your new service](/docs/products/alloydbomni/connect/connect-psql) with -[psql](https://www.postgresql.org/download/) CLI tool. - - - - -Access your service with [the psql client](/docs/products/postgresql/howto/connect-psql) -using the `alloydb_service_uri` Terraform output. - -```bash -psql "$(terraform output -raw alloydb_service_uri)" -``` - - - - -:::tip -Discover more tools for connecting to Aiven for AlloyDB Omni in -[Connect to Aiven for AlloyDB Omni](/docs/products/alloydbomni/connect/connect-services). -::: - -## Connect a Google service account - -[Upload your Google service account key](/docs/products/alloydbomni/manage-credentials) -to the Aiven for AlloyDB Omni service so that you can use generative AI capabilities to -build applications. - -## Build AI applications - -[Access and use AI models](/docs/products/alloydbomni/access-ai-models) to -[build generative AI applications using AlloyDB AI](https://cloud.google.com/alloydb/docs/ai). diff --git a/docs/products/alloydbomni/manage-credentials.md b/docs/products/alloydbomni/manage-credentials.md deleted file mode 100644 index c4f87900d..000000000 --- a/docs/products/alloydbomni/manage-credentials.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Manage Google service account credentials in Aiven for AlloyDB Omni -sidebar_label: Manage Google credentials ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Store and manage Google service account credentials in Aiven for AlloyDB Omni to use them for AI integration purposes. - -Add, update, or delete your Google service account credentials in Aiven for AlloyDB Omni -using either the [Aiven Console](https://console.aiven.io) or the -[Aiven CLI client](/docs/tools/cli). - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- [Service account created with Google Cloud](https://cloud.google.com/iam/docs/service-accounts-create) -- [Google service account key created and downloaded](https://cloud.google.com/iam/docs/keys-create-delete#creating) -- Access to one of the following tools: - - [Aiven Console](https://console.aiven.io) - - [Aiven CLI](/docs/tools/cli) - - [Aiven API](/docs/tools/api) - -## Manage Google credentials in Aiven - -### Add a key - - - -1. Go to the [Aiven Console](https://console.aiven.io) and your Aiven for AlloyDB Omni service. -1. Go to > **Goolge service account key**. -1. Click **Upload file** > **Choose file**, select the JSON file including your Google - service account key, and click **Upload**. - - -Run: - -```bash -avn service alloydbomni google-cloud-private-key set --service SERVICE_NAME --private-key-file PRIVATE_KEY_FILE -``` - -where: - -- `SERVICE_NAME` is the name of your service -- `PRIVATE_KEY_FILE` is the path to your key file - - - -Make a request to the -[AlloyDbOmniGoogleCloudPrivateKeySet](https://api.aiven.io/doc/#tag/Service:_AlloyDB_Omni/operation/AlloyDbOmniGoogleCloudPrivateKeySet) -endpoint. - - - -### Update a key - - - -1. Go to the [Aiven Console](https://console.aiven.io) and your Aiven for AlloyDB Omni service. -1. Go to > **Goolge service account key**. -1. Click > **Replace file** > **Choose file**, select the - JSON file including your new Google service account key, and click **Upload**. - - -Run: - -```bash -avn service alloydbomni google-cloud-private-key set --service SERVICE_NAME --private-key-file PRIVATE_KEY_FILE -``` - -where: - -- `SERVICE_NAME` is the name of your service -- `PRIVATE_KEY_FILE` is the path to your new key file - - - -Make a request to the -[AlloyDbOmniGoogleCloudPrivateKeySet](https://api.aiven.io/doc/#tag/Service:_AlloyDB_Omni/operation/AlloyDbOmniGoogleCloudPrivateKeySet) -endpoint. - - - -### Delete a key - - - -1. Go to the [Aiven Console](https://console.aiven.io) and your Aiven for AlloyDB Omni service. -1. Go to > **Goolge service account key**. -1. Click > **Delete file** > **Delete**. - - -Run: - -```bash -avn service alloydbomni google-cloud-private-key delete --service SERVICE_NAME -``` - - - -Make a request to the -[AlloyDbOmniGoogleCloudPrivateKeyRemove](https://api.aiven.io/doc/#tag/Service:_AlloyDB_Omni/operation/AlloyDbOmniGoogleCloudPrivateKeyRemove) -endpoint. - - - -## Get key details - -Display the key ID and the client email associated with your key. - - - -1. Go to the [Aiven Console](https://console.aiven.io) and your Aiven for AlloyDB Omni service. -1. Go to > **Google service account key**. - - -Run: - -```bash -avn service alloydbomni google-cloud-private-key show --service SERVICE_NAME -``` - - - -Make a request to the -[AlloyDbOmniGoogleCloudPrivateKeyIdentify](https://api.aiven.io/doc/#tag/Service:_AlloyDB_Omni/operation/AlloyDbOmniGoogleCloudPrivateKeyIdentify) -endpoint. - - diff --git a/docs/products/alloydbomni/reference/advanced-params.md b/docs/products/alloydbomni/reference/advanced-params.md deleted file mode 100644 index 8be4af979..000000000 --- a/docs/products/alloydbomni/reference/advanced-params.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Advanced parameters for Aiven for AlloyDB Omni -sidebar_label: Advanced parameters ---- - -See the configuration options available for Aiven for AlloyDB Omni: - -import Reference from '@site/static/includes/config-alloydbomni.md'; - - diff --git a/docs/products/alloydbomni/reference/list-of-extensions.md b/docs/products/alloydbomni/reference/list-of-extensions.md deleted file mode 100644 index 8b1fdaf16..000000000 --- a/docs/products/alloydbomni/reference/list-of-extensions.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: Extensions for Aiven for AlloyDB Omni -sidebar_label: Extensions ---- - -Aiven for AlloyDB Omni extensions enhance capabilities of your service by adding advanced -functionalities such as performance optimizations or additional data types. - -## List supported extensions - -To list the extensions and their details, such as extension version numbers, -connect to your service and run: - -```sql -SELECT * -FROM pg_available_extensions; -``` - -## Limitations - -- Some extensions have dependencies and need to be created in a predetermined order. -- Some extensions require resetting the client connection before they are fully available. - -## Supported extensions - -Aiven for AlloyDB Omni supports -[AlloyDB for PostgreSQL extensions](https://cloud.google.com/alloydb/docs/reference/extensions) -with [a few exceptions](/docs/products/alloydbomni/reference/list-of-extensions#exceptions-unsupported-extensions). - -## Exceptions: unsupported extensions - -Aiven for AlloyDB Omni **does NOT support** the following extensions: - -- `address_standardizer_data_us` -- `address_standardizer` -- `anon` -- `pageinspect` -- `pg_bigm` -- `pg_cron` -- `pg_proctab` -- `pg_squeeze` -- `pg_wait_sampling` -- `pgaudit` -- `pgfincore` -- `pglogical` -- `postgis_raster` -- `postgis_sfcgal` -- `postgis_tiger_geocoder` -- `postgis_topology` -- `postgis` diff --git a/docs/products/alloydbomni/use-columnar-engine.md b/docs/products/alloydbomni/use-columnar-engine.md deleted file mode 100644 index 9901fff9e..000000000 --- a/docs/products/alloydbomni/use-columnar-engine.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -title: Manage the Aiven for AlloyDB Omni columnar engine -sidebar_label: Use columnar engine ---- - -import ConsoleLabel from "@site/src/components/ConsoleIcons"; -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -Enable or disable the Aiven for AlloyDB Omni columnar engine, and control how much RAM it can use to leverage AI and analytics capabilities of your service. - -The Aiven for AlloyDB Omni columnar engine accelerates SQL query processing of scans, -joins, and aggregates using Google's -[AlloyDB Omni columnar engine](https://cloud.google.com/alloydb/docs/columnar-engine/about). - -:::important -Any change to columnar engine settings results in restarting the service. -::: - -## Prerequisites - -- Aiven for AlloyDB Omni service running -- Access to one of the following tools: - - [Aiven Console](https://console.aiven.io/) - - [Aiven Provider for Terraform](/docs/tools/terraform) - - [Aiven Operator for Kubernetes®](/docs/tools/kubernetes) - -## Enable the columnar engine - -:::note -The columnar engine is enabled by default. -::: - - - -1. Log in to the [Aiven Console](https://console.aiven.io/). -1. On the page, select a service. -1. Click , and go to **Columnar engine**. -1. Click **Configure**. -1. Set **google_columnar_engine_enabled** to `Enabled`. -1. Click **Save configuration**. - - -Update the -[aiven_alloydbomni](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni) -resource: in the `alloydbomni_user_config` block, set attribute -[google_columnar_engine_enabled](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni#google_columnar_engine_enabled-1) -to `true`. - - -Update the [AlloyDBOmni](https://aiven.github.io/aiven-operator/resources/alloydbomni.html) -resource: in the -[userConfig](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig) -block nested in -[spec](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec), -set option -[google_columnar_engine_enabled](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig.google_columnar_engine_enabled-property) -to `true`. - - - -## Configure the size of the columnar data store - -By default, the columnar engine is set to use up to 10% of your service's RAM. You can -modify the size of the columnar engine memory to a maximum of 50% of the service's -memory. - - - -1. Log in to the [Aiven Console](https://console.aiven.io/). -1. On the page, select a service. -1. Click , and go to **Columnar engine**. -1. Click **Configure**. -1. Set **google_columnar_engine_memory_size_percentage** to a value between `0` and `50`. -1. Click **Save configuration**. - - -Update the -[aiven_alloydbomni](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni) -resource: in the `alloydbomni_user_config` block, set attribute -[google_columnar_engine_memory_size_percentage](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni#google_columnar_engine_memory_size_percentage-1) -to a value between `0` and `50`. - - -Update the [AlloyDBOmni](https://aiven.github.io/aiven-operator/resources/alloydbomni.html) -resource: in the -[userConfig](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig) -block nested in -[spec](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec), -set option -[google_columnar_engine_memory_size_percentage](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig.google_columnar_engine_memory_size_percentage-property) -to a value between `0` and `50`. - - - -## Disable the columnar engine - -Disable the columnar engine if its design doesn't align well with your workloads or system -requirements. Disabling the columnar engine releases resources allocated for the columnar -engine. - - - -1. Log in to the [Aiven Console](https://console.aiven.io/). -1. On the page, select a service. -1. Click , and go to **Columnar engine**. -1. Click **Configure**. -1. Set **google_columnar_engine_enabled** to `Disabled`. -1. Click **Save configuration**. - - -Update the -[aiven_alloydbomni](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni) -resource: in the `alloydbomni_user_config` block, set attribute -[google_columnar_engine_enabled](https://registry.terraform.io/providers/aiven/aiven/latest/docs/resources/alloydbomni#google_columnar_engine_enabled-1) -to `false`. - - -Update the [AlloyDBOmni](https://aiven.github.io/aiven-operator/resources/alloydbomni.html) -resource: in the -[userConfig](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig) -block nested in -[spec](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec), -set option -[google_columnar_engine_enabled](https://aiven.github.io/aiven-operator/resources/alloydbomni.html#spec.userConfig.google_columnar_engine_enabled-property) -to `false`. - - diff --git a/docs/tools/cli/service/alloydbomni.md b/docs/tools/cli/service/alloydbomni.md deleted file mode 100644 index f745a08ec..000000000 --- a/docs/tools/cli/service/alloydbomni.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -title: avn service alloydbomni ---- - -List of commands for `avn service alloydbomni` - -## Manage Google service account credentials - -Manage a Google service account private key in Aiven for AlloyDB Omni. - -### `avn service alloydbomni google-cloud-private-key set` - -Add or update a Google service account private key for your Aiven for AlloyDB Omni service. - -```bash -avn service alloydbomni google-cloud-private-key set SERVICE_NAME \ - --private-key-file PRIVATE_KEY_FILE -``` - -| Parameter | Information | -| ------------------------ | --------------------------------------------------------------------- | -| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service | -| `PRIVATE_KEY_FILE` | Path to a JSON file including your Google service account private key | - -**Example** - -```bash -avn service alloydbomni google-cloud-private-key set alloydbomni-test \ - --private-key-file /Users/john.doe/documents/private-key.json -``` - -**Output** - -This command outputs a Google service account email and a key ID, for example: - -```txt -CLIENT_EMAIL PRIVATE_KEY_ID -============================================================ ======================================== -test-svc-account@test-project-123456.iam.gserviceaccount.com 1a2b3c4d5e6f7g8h9i0j1a2b3c4d5e6f7g8h9i0j -``` - -### `avn service alloydbomni google-cloud-private-key delete` - -Delete a Google service account private key uploaded to your Aiven for AlloyDB Omni service. - -```bash -avn service alloydbomni google-cloud-private-key delete SERVICE_NAME -``` - -| Parameter | Information | -| ------------------------ | --------------------------------------------------------------------- | -| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service | - -**Example** - -```bash -avn service alloydbomni google-cloud-private-key delete alloydbomni-test -``` - -**Output** - -This command outputs: - -```txt -Service account key has been removed -``` - -### `avn service alloydbomni google-cloud-private-key show` - -Display the key ID and the client email associated with your Google service account private -key. - -```bash -avn service alloydbomni google-cloud-private-key show SERVICE_NAME -``` - -| Parameter | Information | -| ------------------------ | --------------------------------------------------------------------- | -| `SERVICE_NAME` | Name of an Aiven for AlloyDB Omni service | - -**Example** - -```bash -avn service alloydbomni google-cloud-private-key show alloydbomni-test -``` - -**Output** - -This command outputs a Google service account email and a key ID, for example: - -```txt -CLIENT_EMAIL PRIVATE_KEY_ID -============================================================ ======================================== -test-svc-account@test-project-123456.iam.gserviceaccount.com 1a2b3c4d5e6f7g8h9i0j1a2b3c4d5e6f7g8h9i0j -``` diff --git a/sidebars.ts b/sidebars.ts index bf98e5435..6cdb269e0 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -492,7 +492,6 @@ const sidebars: SidebarsConfig = { }, items: [ 'tools/cli/service/acl', - 'tools/cli/service/alloydbomni', 'tools/cli/service/connection-info', 'tools/cli/service/connection-pool', 'tools/cli/service/connector', @@ -524,50 +523,6 @@ const sidebars: SidebarsConfig = { className: 'expandedSection', items: [ 'products/services', - { - type: 'category', - label: 'Aiven for AlloyDB Omni', - link: { - id: 'products/alloydbomni', - type: 'doc', - }, - items: [ - 'products/alloydbomni/get-started', - { - type: 'category', - label: 'Connect to service', - link: { - type: 'doc', - id: 'products/alloydbomni/connect/connect-services', - }, - items: [ - 'products/alloydbomni/connect/connect-go', - 'products/alloydbomni/connect/connect-node', - 'products/alloydbomni/connect/connect-php', - 'products/alloydbomni/connect/connect-python', - 'products/alloydbomni/connect/connect-java', - 'products/alloydbomni/connect/connect-psql', - 'products/alloydbomni/connect/connect-pgadmin', - 'products/alloydbomni/connect/connect-datagrip', - 'products/alloydbomni/connect/connect-dbeaver', - 'products/alloydbomni/connect/connect-rivery', - 'products/alloydbomni/connect/connect-skyvia', - 'products/alloydbomni/connect/connect-zapier', - ], - }, - 'products/alloydbomni/use-columnar-engine', - 'products/alloydbomni/manage-credentials', - 'products/alloydbomni/access-ai-models', - { - type: 'category', - label: 'Reference', - items: [ - 'products/alloydbomni/reference/advanced-params', - 'products/alloydbomni/reference/list-of-extensions', - ], - }, - ], - }, { type: 'category', label: 'Aiven for Apache Cassandra®', diff --git a/static/_redirects b/static/_redirects index 0d717387f..e32697a10 100644 --- a/static/_redirects +++ b/static/_redirects @@ -99,7 +99,8 @@ /platform/privatelink /docs/platform/howto/use-aws-privatelinks /platform/reference/project-member-privileges /docs/platform/concepts/permissions /platform/vpc /docs/platform/howto/manage-vpc-peering -/products/alloydbomni/advanced-params /docs/products/alloydbomni/reference/advanced-params +# Aiven for AlloyDB Omni → Aiven for PostgreSQL redirects +/products/alloydbomni /docs/products/postgresql # Aiven for Caching → Aiven for Valkey redirects /products/caching /docs/products/valkey /products/caching/concepts /docs/products/valkey @@ -282,6 +283,7 @@ /tools/cli/project /docs/tools/cli /tools/cli/service /docs/tools/cli/service-cli /tools/cli/service/m3 /docs/tools/cli/service-cli#avn-service-metrics +/tools/cli/service/alloydbomni /docs/tools/cli/service-cli /tools/cli/ticket /docs/platform/howto/support /tools/cli/user/user-access-token /docs/tools/cli/user /tools/terraform/concepts/data-sources /docs/tools/terraform @@ -329,3 +331,4 @@ /products/m3db/* /docs/products/metrics /products/redis/* /docs/products/valkey/:splat /products/caching/* /docs/products/valkey/:splat +/products/alloydbomni/* /docs/products/postgresql diff --git a/static/includes/config-alloydbomni.md b/static/includes/config-alloydbomni.md deleted file mode 100644 index 45912ea6e..000000000 --- a/static/includes/config-alloydbomni.md +++ /dev/null @@ -1,928 +0,0 @@ - - -import Link from '@docusaurus/Link' - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Parameter
-

additional_backup_regions

array

-

Additional Cloud Regions for Backup Replication

- - - - -
-
-

ip_filter

array

  • default: 0.0.0.0/0,::/0
-

IP filter

-

Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'

- - - -
-
-

static_ips

boolean

-

Static IP addresses

-

Use static public IP addresses

- - - -
-
-

service_log

boolean,null

-

Service logging

-

Store logs for the service so that they are available in the HTTP API and console.

- - - -
-
-

enable_ipv6

boolean

-

Enable IPv6

-

Register AAAA DNS records for the service, and allow IPv6 packets to service ports

- - - -
-
-

admin_username

string,null

-

Custom username for admin user. This must be set only when a new service is being created.

- - - - -
-
-

admin_password

string,null

-

Custom password for admin user. Defaults to random string. This must be set only when a new service is being created.

- - - - -
-
-

backup_hour

integer,null

  • max: 23
-

The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.

- - - - -
-
-

backup_minute

integer,null

  • max: 59
-

The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.

- - - - -
-
-

node_count

integer

  • min: 1
  • max: 100
-

Number of nodes for the service

- - - - -
-
-

pgaudit

object

-

PGAudit settings

-

System-wide settings for the pgaudit extension.

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

pgaudit.feature_enabled

boolean

-

Enable pgaudit extension.

-

Enable pgaudit extension. When enabled, pgaudit extension will be automatically installed.Otherwise, extension will be uninstalled but auditing configurations will be preserved.

-
-

pgaudit.log

array

-

Log

-

Specifies which classes of statements will be logged by session audit logging.

-
-

pgaudit.log_catalog

boolean

  • default: true
-

Log Catalog

-

Specifies that session logging should be enabled in the case where all relations -in a statement are in pg_catalog.

-
-

pgaudit.log_client

boolean

-

Log Client

-

Specifies whether log messages will be visible to a client process such as psql.

-
-

pgaudit.log_level

string

  • default: log
-

Log level

-

Specifies the log level that will be used for log entries.

-
-

pgaudit.log_max_string_length

integer

  • min: -1
  • max: 102400
  • default: -1
-

Log Max String Length

-

Crop parameters representation and whole statements if they exceed this threshold. -A (default) value of -1 disable the truncation.

-
-

pgaudit.log_nested_statements

boolean

  • default: true
-

Log Nested Statements

-

This GUC allows to turn off logging nested statements, that is, statements that are -executed as part of another ExecutorRun.

-
-

pgaudit.log_parameter

boolean

-

Log Parameter

-

Specifies that audit logging should include the parameters that were passed with the statement.

-
-

pgaudit.log_parameter_max_size

integer

-

Log Parameter Max Size

-

Specifies that parameter values longer than this setting (in bytes) should not be logged, -but replaced with <long param suppressed>.

-
-

pgaudit.log_relation

boolean

-

Log Relation

-

Specifies whether session audit logging should create a separate log entry -for each relation (TABLE, VIEW, etc.) referenced in a SELECT or DML statement.

-
-

pgaudit.log_rows

boolean

-

Log Rows

- -
-

pgaudit.log_statement

boolean

  • default: true
-

Log Statement

-

Specifies whether logging will include the statement text and parameters (if enabled).

-
-

pgaudit.log_statement_once

boolean

-

Log Statement Once

-

Specifies whether logging will include the statement text and parameters with -the first log entry for a statement/substatement combination or with every entry.

-
-

pgaudit.role

string

-

Role

-

Specifies the master role to use for object audit logging.

-
-
-

pglookout

object

  • default: [object Object]
-

PGLookout settings

-

System-wide settings for pglookout.

- - - - - - -
-

pglookout.max_failover_replication_time_lag

integer

  • min: 10
  • max: 9223372036854776000
  • default: 60
-

Max Failover Replication Time Lag

-

Number of seconds of master unavailability before triggering database failover to standby

-
-
-

pg_service_to_fork_from

string,null

-

Name of the PG Service from which to fork (deprecated, use service_to_fork_from). This has effect only when a new service is being created.

- - - - -
-
-

service_to_fork_from

string,null

-

Name of another service to fork from. This has effect only when a new service is being created.

- - - - -
-
-

project_to_fork_from

string,null

-

Name of another project to fork a service from. This has effect only when a new service is being created.

- - - - -
-
-

synchronous_replication

string

-

Synchronous replication type. Note that the service plan also needs to support synchronous replication.

- - - - -
-
-

pg_read_replica

boolean,null

-

Should the service which is being forked be a read replica (deprecated, use read_replica service integration instead).

-

This setting is deprecated. Use read_replica service integration instead.

- - - -
-
-

alloydbomni_version

string,null

-

PostgreSQL major version

- - - - -
-
-

pg_version

string,null

-

PostgreSQL major version

- - - - -
-
-

pgbouncer

object

-

PGBouncer connection pooling settings

-

System-wide settings for pgbouncer.

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

pgbouncer.autodb_idle_timeout

integer

  • max: 86400
  • default: 3600
-

If the automatically created database pools have been unused this many seconds, they are freed. If 0 then timeout is disabled. [seconds]

- -
-

pgbouncer.autodb_max_db_connections

integer

  • max: 2147483647
-

Do not allow more than this many server connections per database (regardless of user). Setting it to 0 means unlimited.

- -
-

pgbouncer.autodb_pool_mode

string

  • default: transaction
-

PGBouncer pool mode

- -
-

pgbouncer.autodb_pool_size

integer

  • max: 10000
-

If non-zero then create automatically a pool of that size per user when a pool doesn't exist.

- -
-

pgbouncer.ignore_startup_parameters

array

-

List of parameters to ignore when given in startup packet

- -
-

pgbouncer.max_prepared_statements

integer

  • max: 3000
  • default: 100
-

PgBouncer tracks protocol-level named prepared statements related commands sent by the client in transaction and statement pooling modes when max_prepared_statements is set to a non-zero value. Setting it to 0 disables prepared statements. max_prepared_statements defaults to 100, and its maximum is 3000.

- -
-

pgbouncer.min_pool_size

integer

  • max: 10000
-

Add more server connections to pool if below this number. Improves behavior when usual load comes suddenly back after period of total inactivity. The value is effectively capped at the pool size.

- -
-

pgbouncer.server_idle_timeout

integer

  • max: 86400
  • default: 600
-

If a server connection has been idle more than this many seconds it will be dropped. If 0 then timeout is disabled. [seconds]

- -
-

pgbouncer.server_lifetime

integer

  • min: 60
  • max: 86400
  • default: 3600
-

The pooler will close an unused server connection that has been connected longer than this. [seconds]

- -
-

pgbouncer.server_reset_query_always

boolean

-

Run server_reset_query (DISCARD ALL) in all pooling modes

- -
-
-

recovery_target_time

string,null

-

Recovery target time when forking a service. This has effect only when a new service is being created.

- - - - -
-
-

variant

string,null

-

Variant of the PostgreSQL service, may affect the features that are exposed by default

- - - - -
-
-

private_access

object

-

Allow access to selected service ports from private networks

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

private_access.pg

boolean

-

Allow clients to connect to pg with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations

- -
-

private_access.pgbouncer

boolean

-

Allow clients to connect to pgbouncer with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations

- -
-

private_access.prometheus

boolean

-

Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations

- -
-
-

privatelink_access

object

-

Allow access to selected service components through Privatelink

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

privatelink_access.pg

boolean

-

Enable pg

- -
-

privatelink_access.pgbouncer

boolean

-

Enable pgbouncer

- -
-

privatelink_access.prometheus

boolean

-

Enable prometheus

- -
-
-

public_access

object

-

Allow access to selected service ports from the public Internet

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

public_access.pg

boolean

-

Allow clients to connect to pg from the public internet for service nodes that are in a project VPC or another type of private network

- -
-

public_access.pgbouncer

boolean

-

Allow clients to connect to pgbouncer from the public internet for service nodes that are in a project VPC or another type of private network

- -
-

public_access.prometheus

boolean

-

Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network

- -
-
-

pg

object

-

postgresql.conf configuration values

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

pg.autovacuum_freeze_max_age

integer

  • min: 200000000
  • max: 1500000000
  • Service restart
-

autovacuum_freeze_max_age

-

Specifies the maximum age (in transactions) that a table's pg_class.relfrozenxid field can attain before a VACUUM operation is forced to prevent transaction ID wraparound within the table. The system launches autovacuum processes to prevent wraparound even when autovacuum is otherwise disabled. Changing this parameter causes a service restart.

-
-

pg.autovacuum_max_workers

integer

  • min: 1
  • max: 20
  • Service restart
-

autovacuum_max_workers

-

Specifies the maximum number of autovacuum processes (other than the autovacuum launcher) that may be running at any one time. The default is `3`. Changing this parameter causes a service restart.

-
-

pg.autovacuum_naptime

integer

  • min: 1
  • max: 86400
-

autovacuum_naptime

-

Specifies the minimum delay between autovacuum runs on any given database. The delay is measured in seconds. The default is `60`.

-
-

pg.autovacuum_vacuum_threshold

integer

  • max: 2147483647
-

autovacuum_vacuum_threshold

-

Specifies the minimum number of updated or deleted tuples needed to trigger a VACUUM in any one table. The default is `50`.

-
-

pg.autovacuum_analyze_threshold

integer

  • max: 2147483647
-

autovacuum_analyze_threshold

-

Specifies the minimum number of inserted, updated or deleted tuples needed to trigger an ANALYZE in any one table. The default is `50`.

-
-

pg.autovacuum_vacuum_scale_factor

number

  • max: 1
-

autovacuum_vacuum_scale_factor

-

Specifies a fraction of the table size to add to autovacuum_vacuum_threshold when deciding whether to trigger a VACUUM (e.g. `0.2` for 20% of the table size). The default is `0.2`.

-
-

pg.autovacuum_analyze_scale_factor

number

  • max: 1
-

autovacuum_analyze_scale_factor

-

Specifies a fraction of the table size to add to autovacuum_analyze_threshold when deciding whether to trigger an ANALYZE (e.g. `0.2` for 20% of the table size). The default is `0.2`.

-
-

pg.autovacuum_vacuum_cost_delay

integer

  • min: -1
  • max: 100
-

autovacuum_vacuum_cost_delay

-

Specifies the cost delay value that will be used in automatic VACUUM operations. If `-1` is specified, the regular vacuum_cost_delay value will be used. The default is `2` (upstream default).

-
-

pg.autovacuum_vacuum_cost_limit

integer

  • min: -1
  • max: 10000
-

autovacuum_vacuum_cost_limit

-

Specifies the cost limit value that will be used in automatic VACUUM operations. If `-1` is specified, the regular vacuum_cost_limit value will be used. The default is `-1` (upstream default).

-
-

pg.bgwriter_delay

integer

  • min: 10
  • max: 10000
-

bgwriter_delay

-

Specifies the delay between activity rounds for the background writer in milliseconds. The default is `200`.

-
-

pg.bgwriter_flush_after

integer

  • max: 2048
-

bgwriter_flush_after

-

Whenever more than bgwriter_flush_after bytes have been written by the background writer, attempt to force the OS to issue these writes to the underlying storage. Specified in kilobytes. Setting of 0 disables forced writeback. The default is `512`.

-
-

pg.bgwriter_lru_maxpages

integer

  • max: 1073741823
-

bgwriter_lru_maxpages

-

In each round, no more than this many buffers will be written by the background writer. Setting this to zero disables background writing. The default is `100`.

-
-

pg.bgwriter_lru_multiplier

number

  • max: 10
-

bgwriter_lru_multiplier

-

The average recent need for new buffers is multiplied by bgwriter_lru_multiplier to arrive at an estimate of the number that will be needed during the next round, (up to bgwriter_lru_maxpages). 1.0 represents a “just in time” policy of writing exactly the number of buffers predicted to be needed. Larger values provide some cushion against spikes in demand, while smaller values intentionally leave writes to be done by server processes. The default is `2.0`.

-
-

pg.deadlock_timeout

integer

  • min: 500
  • max: 1800000
-

deadlock_timeout

-

This is the amount of time, in milliseconds, to wait on a lock before checking to see if there is a deadlock condition. The default is `1000` (upstream default).

-
-

pg.password_encryption

string,null

-

password_encryption

-

Chooses the algorithm for encrypting passwords.

-
-

pg.default_toast_compression

string

-

default_toast_compression

-

Specifies the default TOAST compression method for values of compressible columns. The default is `lz4`.

-
-

pg.idle_in_transaction_session_timeout

integer

  • max: 604800000
-

idle_in_transaction_session_timeout

-

Time out sessions with open transactions after this number of milliseconds

-
-

pg.jit

boolean

-

jit

-

Controls system-wide use of Just-in-Time Compilation (JIT).

-
-

pg.log_autovacuum_min_duration

integer

  • min: -1
  • max: 2147483647
-

log_autovacuum_min_duration

-

Causes each action executed by autovacuum to be logged if it ran for at least the specified number of milliseconds. Setting this to zero logs all autovacuum actions. Minus-one disables logging autovacuum actions. The default is `1000`.

-
-

pg.log_error_verbosity

string

-

log_error_verbosity

-

Controls the amount of detail written in the server log for each message that is logged.

-
-

pg.log_line_prefix

string

-

log_line_prefix

-

Choose from one of the available log formats.

-
-

pg.log_min_duration_statement

integer

  • min: -1
  • max: 86400000
-

log_min_duration_statement

-

Log statements that take more than this number of milliseconds to run, -1 disables

-
-

pg.log_temp_files

integer

  • min: -1
  • max: 2147483647
-

log_temp_files

-

Log statements for each temporary file created larger than this number of kilobytes, -1 disables

-
-

pg.max_files_per_process

integer

  • min: 1000
  • max: 4096
  • Service restart
-

max_files_per_process

-

PostgreSQL maximum number of files that can be open per process. The default is `1000` (upstream default). Changing this parameter causes a service restart.

-
-

pg.max_prepared_transactions

integer

  • max: 10000
  • Service restart
-

max_prepared_transactions

-

PostgreSQL maximum prepared transactions. The default is `0`. Changing this parameter causes a service restart.

-
-

pg.max_pred_locks_per_transaction

integer

  • min: 64
  • max: 5120
  • Service restart
-

max_pred_locks_per_transaction

-

PostgreSQL maximum predicate locks per transaction. The default is `64` (upstream default). Changing this parameter causes a service restart.

-
-

pg.max_locks_per_transaction

integer

  • min: 64
  • max: 6400
  • Service restart
-

max_locks_per_transaction

-

PostgreSQL maximum locks per transaction. Changing this parameter causes a service restart.

-
-

pg.max_slot_wal_keep_size

integer

  • min: -1
  • max: 2147483647
-

max_slot_wal_keep_size

-

PostgreSQL maximum WAL size (MB) reserved for replication slots. If `-1` is specified, replication slots may retain an unlimited amount of WAL files. The default is `-1` (upstream default). wal_keep_size minimum WAL size setting takes precedence over this.

-
-

pg.max_stack_depth

integer

  • min: 2097152
  • max: 6291456
-

max_stack_depth

-

Maximum depth of the stack in bytes. The default is `2097152` (upstream default).

-
-

pg.max_standby_archive_delay

integer

  • min: 1
  • max: 43200000
-

max_standby_archive_delay

-

Max standby archive delay in milliseconds. The default is `30000` (upstream default).

-
-

pg.max_standby_streaming_delay

integer

  • min: 1
  • max: 43200000
-

max_standby_streaming_delay

-

Max standby streaming delay in milliseconds. The default is `30000` (upstream default).

-
-

pg.max_replication_slots

integer

  • min: 8
  • max: 256
  • Service restart
-

max_replication_slots

-

PostgreSQL maximum replication slots. The default is `20`. Changing this parameter causes a service restart.

-
-

pg.max_logical_replication_workers

integer

  • min: 4
  • max: 256
  • Service restart
-

max_logical_replication_workers

-

PostgreSQL maximum logical replication workers (taken from the pool of max_parallel_workers). The default is `4` (upstream default). Changing this parameter causes a service restart.

-
-

pg.max_parallel_workers

integer

  • max: 96
-

max_parallel_workers

-

Sets the maximum number of workers that the system can support for parallel queries. The default is `8` (upstream default).

-
-

pg.max_parallel_workers_per_gather

integer

  • max: 96
-

max_parallel_workers_per_gather

-

Sets the maximum number of workers that can be started by a single Gather or Gather Merge node. The default is `2` (upstream default).

-
-

pg.max_sync_workers_per_subscription

integer

  • min: 2
  • max: 8
-

max_sync_workers_per_subscription

-

Maximum number of synchronization workers per subscription. The default is `2`.

-
-

pg.max_worker_processes

integer

  • min: 8
  • max: 288
  • Service restart
-

max_worker_processes

-

Sets the maximum number of background processes that the system can support. The default is `8`. Changing this parameter causes a service restart.

-
-

pg.pg_partman_bgw.role

string

-

pg_partman_bgw.role

-

Controls which role to use for pg_partman's scheduled background tasks.

-
-

pg.pg_partman_bgw.interval

integer

  • min: 3600
  • max: 604800
-

pg_partman_bgw.interval

-

Sets the time interval in seconds to run pg_partman's scheduled tasks. The default is `3600`.

-
-

pg.pg_stat_statements.track

string

-

pg_stat_statements.track

-

Controls which statements are counted. Specify top to track top-level statements (those issued directly by clients), all to also track nested statements (such as statements invoked within functions), or none to disable statement statistics collection. The default is `top`.

-
-

pg.temp_file_limit

integer

  • min: -1
  • max: 2147483647
-

temp_file_limit

-

PostgreSQL temporary file limit in KiB, -1 for unlimited

-
-

pg.timezone

string

-

timezone

-

PostgreSQL service timezone

-
-

pg.track_activity_query_size

integer

  • min: 1024
  • max: 10240
  • Service restart
-

track_activity_query_size

-

Specifies the number of bytes reserved to track the currently executing command for each active session. Changing this parameter causes a service restart.

-
-

pg.track_commit_timestamp

string

  • Service restart
-

track_commit_timestamp

-

Record commit time of transactions. Changing this parameter causes a service restart.

-
-

pg.track_functions

string

-

track_functions

-

Enables tracking of function call counts and time used.

-
-

pg.track_io_timing

string

-

track_io_timing

-

Enables timing of database I/O calls. The default is `off`. When on, it will repeatedly query the operating system for the current time, which may cause significant overhead on some platforms.

-
-

pg.max_wal_senders

integer

  • min: 20
  • max: 256
  • Service restart
-

max_wal_senders

-

PostgreSQL maximum WAL senders. The default is `20`. Changing this parameter causes a service restart.

-
-

pg.wal_sender_timeout

integer

-

wal_sender_timeout

-

Terminate replication connections that are inactive for longer than this amount of time, in milliseconds. Setting this value to zero disables the timeout.

-
-

pg.wal_writer_delay

integer

  • min: 10
  • max: 200
-

wal_writer_delay

-

WAL flush interval in milliseconds. The default is `200`. Setting this parameter to a lower value may negatively impact performance.

-
-
-

shared_buffers_percentage

number

  • min: 20
  • max: 60
  • Service restart
-

shared_buffers_percentage

-

Percentage of total RAM that the database server uses for shared memory buffers. Valid range is 20-60 (float), which corresponds to 20% - 60%. This setting adjusts the shared_buffers configuration value. Changing this parameter causes a service restart.

- - - -
-
-

work_mem

integer

  • min: 1
  • max: 1024
-

work_mem

-

Sets the maximum amount of memory to be used by a query operation (such as a sort or hash table) before writing to temporary disk files, in MB. The default is 1MB + 0.075% of total RAM (up to 32MB).

- - - -
-
-

google_columnar_engine_memory_size_percentage

integer

  • max: 50
  • default: 10
-

Columnar data store size

-

Allocate the amount of RAM to store columnar data.

- - - -
-
-

google_columnar_engine_enabled

boolean

  • default: true
-

Columnar engine control

-

Enables or disables the columnar engine. When enabled, it accelerates SQL query processing.

- - - -
-
- \ No newline at end of file diff --git a/static/includes/service-end-of-availability-notice.md b/static/includes/service-end-of-availability-notice.md deleted file mode 100644 index 2ae80a734..000000000 --- a/static/includes/service-end-of-availability-notice.md +++ /dev/null @@ -1,8 +0,0 @@ -:::warning[End of availability] - -You can no longer create Aiven for AlloyDB Omni services. -Existing services continue to run until the end-of-life date. - -[**Learn more**](/docs/platform/reference/end-of-life#aiven-for-alloydb-omni) - -:::