diff --git a/.github/vale/styles/Aiven/Generic.yml b/.github/vale/styles/Aiven/Generic.yml index 776d7795..a322987a 100644 --- a/.github/vale/styles/Aiven/Generic.yml +++ b/.github/vale/styles/Aiven/Generic.yml @@ -5,7 +5,6 @@ ignorecase: true tokens: - click here - follow the steps - - if you want to - this article - this guide - this help article diff --git a/.github/vale/styles/Aiven/WeaselWords.yml b/.github/vale/styles/Aiven/WeaselWords.yml index e96f9791..ed753230 100644 --- a/.github/vale/styles/Aiven/WeaselWords.yml +++ b/.github/vale/styles/Aiven/WeaselWords.yml @@ -7,6 +7,7 @@ tokens: - quickly - merely - simply + # - best - hardly - shortly - slowly diff --git a/.github/vale/styles/Aiven/Wordiness-error.yml b/.github/vale/styles/Aiven/Wordiness-error.yml new file mode 100644 index 00000000..00ceb8e1 --- /dev/null +++ b/.github/vale/styles/Aiven/Wordiness-error.yml @@ -0,0 +1,15 @@ +extends: substitution +message: "Using '%s' instead of '%s'." +ignorecase: true +level: error +action: + name: replace +swap: + spin up: start + if you want to: to + you need to: imperative + pre-requisites: prerequisite + (?:take|apply)? ?(?:the )?following steps: nothing + and then: and + to see a list: to list + proceed as follows: nothing diff --git a/.github/vale/styles/Aiven/Wordiness.yml b/.github/vale/styles/Aiven/Wordiness.yml index 228c8335..6964017b 100644 --- a/.github/vale/styles/Aiven/Wordiness.yml +++ b/.github/vale/styles/Aiven/Wordiness.yml @@ -123,5 +123,4 @@ swap: these instructions: use the title of the page in case: if in the case of: if - pre-requisites: prerequisites - (?:take|apply)? ?(?:the )?following steps: nothing + check that: ensure diff --git a/.github/vale/styles/config/vocabularies/Aiven/accept.txt b/.github/vale/styles/config/vocabularies/Aiven/accept.txt index a5e9bb59..fc6ce056 100644 --- a/.github/vale/styles/config/vocabularies/Aiven/accept.txt +++ b/.github/vale/styles/config/vocabularies/Aiven/accept.txt @@ -33,6 +33,7 @@ Centrify checkpointing CIDRs ClickHouse +Cloudera CloudWatch codecs compliances @@ -294,12 +295,14 @@ Unschedule untrusted UpCloud upsert +URIs? UUID UUIDs vectorizing virtualized VM VMs +ECEs? VNet VPC/MS VPCs? diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc index 104ed47d..aa71c193 100644 --- a/.markdownlint.jsonc +++ b/.markdownlint.jsonc @@ -20,6 +20,15 @@ "MD050": {"style": "asterisk"}, "MD013": {"line_length": 90}, "MD033": { - "allowed_elements": ["table", "DocCardList", "Clouds", "details", "summary"] + "allowed_elements": [ + "table", + "DocCardList", + "Clouds", + "details", + "summary", + "EarlyBadge", + "LimitedBadge", + "ProBadge" + ] } } diff --git a/.vscode/aiven.code-snippets b/.vscode/aiven.code-snippets index e8acb531..18fe32ed 100644 --- a/.vscode/aiven.code-snippets +++ b/.vscode/aiven.code-snippets @@ -132,5 +132,10 @@ "scope": "markdown", "prefix": ["contact", "sales"], "body": ["contact the [sales team](mailto:sales@aiven.io)"] + }, + "Contact support": { + "scope": "markdown", + "prefix": ["contact", "support"], + "body": ["contact the [support team](mailto:support@aiven.io)"] } } diff --git a/docs/integrations/datadog/datadog-logs.md b/docs/integrations/datadog/datadog-logs.md index 0a8c3410..fb9b8f1b 100644 --- a/docs/integrations/datadog/datadog-logs.md +++ b/docs/integrations/datadog/datadog-logs.md @@ -4,14 +4,14 @@ title: Send logs to Datadog Use the Aiven Rsyslog integration to send the logs from your Aiven services to Datadog. -You will need: +Before you begin, ensure you know: -- A Datadog account, and which region it is in. -- A Datadog API key. Generate an API key by visiting **Organization - settings** under your account menu, and then choose **API Keys**. - The **New Key** button will give you an API key. Make a note of it. -- An Aiven account with a project set up. You\'ll need the name of the - project. +- The region of your Datadog account. +- Your Datadog API key. Generate an API key for your Datadog account + in the **Organization settings**, and click **API Keys** > **New Key**. Make sure to + copy this key. +- An Aiven account with a project set up. You'll need the name of the + project. ## Configure the integration @@ -20,16 +20,16 @@ setup only needs to be done once. 1. Log in to the [Aiven Console](https://console.aiven.io/), and select **Integration endpoints** from the left sidebar in the project page. -2. Select **Syslog** from the list in the **Integration endpoints** - screen, and then select **Add new endpoint**. -3. Configure the settings for the new endpoint: +1. Select **Syslog** from the list in the **Integration endpoints** + screen, and select **Add new endpoint**. +1. Configure the settings for the new endpoint: - **Endpoint name** is how you will refer to this logs integration when linking it to other Aiven services - **Server** and **Port** (leave TLS enabled): - For region USA use `intake.logs.datadoghq.com` and `10516` - For region EU use `tcp-intake.logs.datadoghq.eu` and `443` - - **Format** set to \"custom\" -4. Configure the **Log Template** field. You will need to replace the + - **Format** set to `custom`. +1. Configure the **Log Template** field. You will need to replace the following values: | Variable | Description | @@ -37,11 +37,11 @@ setup only needs to be done once. | `DATADOG_API_KEY` | From your Datadog account settings | | `AIVEN_PROJECT_NAME` | Found in the web console | -This is the format to use, replacing the variables listed. Don\'t edit +This is the format to use, replacing the variables listed. Don't edit the values surrounded by `%` signs, such as `%msg%` as these are used in constructing the log line: -``` +```text DATADOG_API_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.AIVEN_PROJECT_NAME %app-name% - - - %msg% ``` @@ -62,7 +62,7 @@ this correlation with the metrics. See the [Datadog documentation](https://docs.datadoghq.com/integrations/rsyslog). ::: -4. Select **Create** to save the endpoint. +1. Select **Create** to save the endpoint. ## Send logs from an Aiven service to Datadog @@ -73,12 +73,12 @@ To send logs to Datadog: ![Screenshot of system integrations including rsyslog](/images/integrations/rsyslog-service-integration.png) -2. Pick the log integration you created earlier from the dropdown and +1. Pick the log integration you created earlier from the dropdown and choose **Enable**. -3. Visit Datadog and look under \"Logs\" to see the data flowing within +1. Visit Datadog and look under \"Logs\" to see the data flowing within a few minutes. ## Related pages -Learn more about [Datadog and Aiven](/docs/integrations/datadog). +- [Datadog and Aiven](/docs/integrations/datadog) diff --git a/docs/integrations/datadog/datadog-metrics.md b/docs/integrations/datadog/datadog-metrics.md index 7ed85e77..839d6e7d 100644 --- a/docs/integrations/datadog/datadog-metrics.md +++ b/docs/integrations/datadog/datadog-metrics.md @@ -6,14 +6,12 @@ Send metrics from your Aiven service to your Datadog account. ## Prepare your Datadog account -Before you begin, ensure that you have the following details ready: +Before you begin, ensure you know: -- Determine whether your Datadog account is located in the US or EU - region. -- A Datadog API key. Generate an API key for your Datadog account by - visiting the **Organization settings** in your account menu. Select - **API Keys** and then select **New Key** to obtain the API key. Make - sure to copy this key. +- The region of your Datadog account. +- Your Datadog API key. Generate an API key for your Datadog account + in the **Organization settings**, and click **API Keys** > **New Key**. Make sure to + copy this key. ## Configure the service integration endpoint @@ -22,21 +20,20 @@ you intend to use. Afterward, multiple services can use this service integration endpoint. 1. Log in to the [Aiven Console](https://console.aiven.io/). -2. In the **Services** screen, select **Integration endpoints** on the +1. In the **Services** screen, select **Integration endpoints** on the left sidebar. -3. Select **Datadog** and then select **Add new endpoint** or **Create - new**. -4. Configure the endpoint by providing a name for this integration and +1. Select **Datadog** > **Add new endpoint** or **Create new**. +1. Configure the endpoint by providing a name for this integration and entering the API key you copied earlier. Ensure that the correct region is selected. ![Screenshot of the Datadog configuration screen](/images/integrations/configure-datadog-service-integration.png) -5. Optionally, include additional tags that will be used when sending +1. Optionally, include additional tags that will be used when sending metrics to Datadog. Refer to [Add custom tags Datadog integration](/docs/integrations/datadog/add-custom-tags-to-datadog) to learn more about adding tags to the Datadog integration. You can always add or edit tags later. -6. Select **Add endpoint** to save this configuration. +1. Select **Add endpoint** to save this configuration. ## Add Datadog metrics integration to your Aiven service @@ -45,18 +42,18 @@ metric tracking in Datadog, follow these steps: 1. In the [Aiven Console](https://console.aiven.io/), select your service. -2. From the **Overview** page of your service, scroll to **Service +1. From the **Overview** page of your service, scroll to **Service integrations** and select **Manage integrations**. -3. In the **Integrations** screen, select **Datadog Metrics**. -4. Select the Datadog endpoint you want to use from the drop-down list +1. In the **Integrations** screen, select **Datadog Metrics**. +1. Select the Datadog endpoint you want to use from the drop-down list and select **Enable**. -:::tip -If you're using Aiven for Apache Kafka® you can also -[customise the metrics sent to Datadog](/docs/products/kafka/howto/datadog-customised-metrics). -::: + :::tip + If you're using Aiven for Apache Kafka® you can also + [customise the metrics sent to Datadog](/docs/products/kafka/howto/datadog-customised-metrics). + ::: -5. Return to your Datadog dashboard and after a few minutes, you should +1. Return to your Datadog dashboard and after a few minutes, you should see the data start to arrive from your Aiven services. ## Related pages diff --git a/docs/integrations/prometheus-system-metrics.md b/docs/integrations/prometheus-system-metrics.md index 8e78ee3d..445798fb 100644 --- a/docs/integrations/prometheus-system-metrics.md +++ b/docs/integrations/prometheus-system-metrics.md @@ -2,9 +2,7 @@ title: Prometheus system metrics --- -Learn how to check what metrics are available for monitoring your -service using Prometheus, and find out which of the available metrics -are particularly worth monitoring and why. +Learn how to check what metrics are available for monitoring your service using Prometheus, and find out which of the available metrics are particularly worth monitoring and why. ## About the Prometheus integration @@ -12,7 +10,7 @@ The Prometheus integration allows you to monitor your Aiven services and understand the resource usage. Using this integration, you can also track some non-service-specific metrics that may be worth monitoring. -To start using Prometheus for monitoring the metrics, you need to +To start using Prometheus for monitoring the metrics, [configure the Prometheus integration and set up the Prometheus server](/docs/platform/howto/integrations/prometheus-metrics). ## Get a list of available service metrics @@ -30,7 +28,7 @@ request to your Prometheus service endpoint. - Username - Password -2. Make a request to get a snapshot of your metrics, replacing the +1. Make a request to get a snapshot of your metrics, replacing the placeholders in the following code with the values for your service: ```bash @@ -98,7 +96,7 @@ collect and monitor: | Metrics | Description | | ------------------- | --------------------------------------------------------------------------------------------------------------------- | | `disk_free` | Free space on the service disk | -| `disk_used` | Used space on the disk, for example, `8.0e+9` (8,000,000,000 bytes) | +| `disk_used` | Used space on the disk, for example, `1.0e+9` (8,000,000,000 bytes) | | `disk_total` | Total space on the disk (free and used) | | `disk_used_percent` | Percentage of the disk space used equal to `disk_used / disk_total * 100`, for example, `80` (80% service disk usage) | | `disk_inodes_free` | Number of index nodes available on the service disk | diff --git a/docs/integrations/rsyslog.md b/docs/integrations/rsyslog.md index ede54f4e..29609866 100644 --- a/docs/integrations/rsyslog.md +++ b/docs/integrations/rsyslog.md @@ -2,22 +2,20 @@ title: Remote syslog integration --- -In addition to using Aiven for OpenSearch® to store the logs from your -Aiven services, you can also integrate with an external monitoring -system that supports the rsyslog protocol. +In addition to using Aiven for OpenSearch® to store the logs from your Aiven services, you can also integrate with an external monitoring system that supports the rsyslog protocol. ## Creating rsyslog integration ### Add rsyslog integration endpoint -As the first step, you need to add the remote syslog you want to send +Add the remote syslog you want to send the log to into the project that contains the service you want to integrate. This can be configured from the **Integration endpoints** page in the Aiven Console. -![\"Create new Syslog endpoint\" dialog](/images/integrations/remote-syslog-endpoint.png) +!["Create new Syslog endpoint" dialog](/images/integrations/remote-syslog-endpoint.png) Another option is to use the [Aiven Client](https://github.com/aiven/aiven-client) . @@ -102,14 +100,14 @@ CLI though the examples are easier to copy and paste in the CLI form. ### Coralogix {#rsyslog_coralogix} -For [Coralogix](https://coralogix.com/) integration you need to use a +For a [Coralogix](https://coralogix.com/) integration, use a custom `logline` format with your key and company ID. The Syslog Endpoint to use for `server` depends on your account: -- if it ends with `.com` use `syslogserver.coralogix.com` -- if it ends with `.us` use `syslogserver.coralogix.us` -- if it ends with `.in` use `syslogserver.app.coralogix.in` +- If it ends with `.com`, use `syslogserver.coralogix.com`. +- If it ends with `.us`, use `syslogserver.coralogix.us`. +- If it ends with `.in`, use `syslogserver.app.coralogix.in`. See the Coralogix [Rsyslog](https://coralogix.com/docs/) documentation for more information. @@ -128,7 +126,7 @@ avn service integration-endpoint-create --project your-project \ ### Loggly® {#rsyslog_loggly} -For [Loggly](hthtps://www.loggly.com/) integration, you need to use a +For [Loggly](hthtps://www.loggly.com/) integration, use a custom `logline` format with your token. ```bas @@ -141,7 +139,7 @@ avn service integration-endpoint-create --project your-project \ ### Mezmo (LogDNA) {#rsyslog_mezmo} -For [Mezmo](https://www.mezmo.com/) syslog integration you need to use a +For [Mezmo](https://www.mezmo.com/) syslog integration, use a custom `logline` format with your key. ```bash @@ -154,7 +152,7 @@ avn service integration-endpoint-create --project your-project \ ### New Relic {#rsyslog_new_relic} -For [New Relic](https://newrelic.com/) Syslog integration you need to +For [New Relic](https://newrelic.com/) Syslog integration, use a custom `logline` format with your license key. This is so you can prepend your [New Relic License Key](https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#license-key) @@ -167,7 +165,7 @@ The value to use for `server` depends on the account location: endpoint will not work for an EU account) - `newrelic.syslog.nr-data.net` for other regions -For more information see [Use TCP endpoint to forward logs to New +For more information, see [Use TCP endpoint to forward logs to New Relic](https://docs.newrelic.com/docs/logs/log-api/use-tcp-endpoint-forward-logs-new-relic/) ```bash @@ -182,7 +180,7 @@ avn service integration-endpoint-create --project your-project \ As [Papertrail](https://www.papertrail.com/) identifies the client based on the server and port you only need to copy the appropriate values from -the \"Log Destinations\" page and use those as the values for `server` +the "Log Destinations" page and use those as the values for `server` and `port` respectively. You **do not need** the ca-bundle as the Papertrail servers use certificates signed by a known CA. You also need to set the format to `rfc3164` . @@ -196,7 +194,7 @@ avn service integration-endpoint-create --project your-project \ ### Sumo Logic® {#rsyslog_sumo_logic} -For [Sumo Logic](https://www.sumologic.com/) you need to use a custom +For [Sumo Logic](https://www.sumologic.com/), use a custom `logline` format with your collector token, use the server and port of the collector, and replace `YOUR_DEPLOYMENT` with one of `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1` or `us2`. See [Cloud Syslog diff --git a/docs/platform/concepts/authentication-tokens.md b/docs/platform/concepts/authentication-tokens.md index 4cdc1b02..12a961dc 100644 --- a/docs/platform/concepts/authentication-tokens.md +++ b/docs/platform/concepts/authentication-tokens.md @@ -56,17 +56,17 @@ sign out command (`avn user logout`). Think about how long the token needs to be valid for; this varies depending on what the token is used for. - + - If you're doing a video recording for a demo, you can set the token to expire in an hour. This means that even if you have exposed the token during your work, it will no longer work by the time the video is published. -- For server side use within the build process, such as on the CI +- For server-side use within the build process, such as on the CI server, a token with long-term validity and/or refresh interval is appropriate. - For a situation where the token could ever be accessible, keep the expiry time short, and generate a new token for each operation. - + The longer a token lives, the higher the risk of exposure. Follow the IT security best practises established by your company and refrain from allowing human users to share the same token. @@ -84,11 +84,12 @@ account to automation services that may only need read access. It is also good practice to rotate your authorization tokens on a regular basis, for example each month. You can have as many tokens active at one time as you need, so you can create a new token, replace -it as needed, check everything works, and then remove the old token once +it as needed, check everything works, and remove the old token once you are confident that all changes have completed successfully. :::note Follow -[Create an authentication token](/docs/platform/howto/create_authentication_token) to create an authentication token from [Aiven +[Create an authentication token](/docs/platform/howto/create_authentication_token) to +create an authentication token from [Aiven Console](https://console.aiven.io/) or the Aiven CLI. ::: diff --git a/docs/platform/concepts/availability-zones.md b/docs/platform/concepts/availability-zones.md index 17b94cd4..3865ce67 100644 --- a/docs/platform/concepts/availability-zones.md +++ b/docs/platform/concepts/availability-zones.md @@ -28,9 +28,11 @@ availability zones (AZs). All Aiven's multi-node service plans are automatically spread among AZs of a region as long as the underlying cloud provider supports it. + The virtual machines (VMs) are distributed evenly across zones to provide the best possible service availability in cases an entire AZ (which may include one or more datacenters) goes down. + Cloud providers with AZs available to support your Aiven services are the following: diff --git a/docs/platform/concepts/beta_services.md b/docs/platform/concepts/beta_services.md index 177dc2ff..b7c2bf35 100644 --- a/docs/platform/concepts/beta_services.md +++ b/docs/platform/concepts/beta_services.md @@ -2,53 +2,64 @@ title: Service and feature releases --- -Before general availability, the lifecycle of new services and features -includes a limited availability (private beta) stage and an early -availability (public beta) stage. +import ProBadge from "@site/src/components/Badges/ProBadge"; +import LimitedBadge from "@site/src/components/Badges/LimitedBadge"; +import EarlyBadge from "@site/src/components/Badges/EarlyBadge"; -## Limited availability (private beta) +New services and features follow a release lifecycles that promotes feature quality. + +The release workflow is: + +1. **Limited availability** (private beta) +1. **Early availability** (public beta) +1. **General availability** + +## Limited availability (private beta) The limited availability (private beta) stage is an initial release of a -new functionality that you can try out by invitation only. If you are -interested in trying a service or feature in this stage, contact the +new functionality that you can try out by invitation only. + +If you are interested in trying a service or feature in this stage, contact the [sales team](mailto:sales@aiven.io). -## Early availability (public beta) +## Early availability (public beta) Features and services in the early availability (public beta) stage are released to all users with some restrictions on the functionality and -[service level agreement](https://aiven.io/sla). They are intended for -use in non-production environments, but you can test them with -production-like workloads to gauge their behavior under heavy loads. -Issues raised for these services and features are considered [low -severity](https://aiven.io/support-services). +[service level agreement](https://aiven.io/sla). -You can enable most early availability (public beta) features yourself -on the -[feature preview page](/docs/platform/howto/feature-preview) in the user profile. This is also where you can provide -feedback about the feature after trying it out. +They are intended for use in non-production environments, but you can test them with +production-like workloads to gauge their behavior under heavy load. -Using a service in this stage means that you consent to us contacting -you to request qualitative feedback. The feedback we receive helps us -shape the products you use. +Issues raised for these services and features are considered +[low severity](https://aiven.io/support-services). You can provide feedback about the +feature. + +You can enable most early availability features yourself +on the [feature preview page](/docs/platform/howto/feature-preview) in the user profile. + +:::note +Using an early availability means that you consent to us contacting +you to request feedback. The feedback we receive helps us shape the products you use. +::: ## General availability New services and features become generally available once they are ready for production use at scale. The duration of the early and limited -availability stages depends on how quickly the service or feature has -been adopted by the users and what changes are required to address the -key issues that are discovered. +availability stages depends on the adoption of the service or feature by the users +and what changes are required to address the key issues that are discovered. ## Billing for limited and early availability services Aiven provides credits for you to try out limited and early availability -services. Once the credit code expires or you have used all of the -credits, you are charged for the service according to the normal rate. +services. After the credit code expires or after you have used the +credits, you are charged for the service at the usual rate. ## Feature roadmap -[Aiven Ideas](https://ideas.aiven.io/) is a portal for users to submit, -vote on, and discuss your ideas to shape the future of the product. -It's also where you can view the status and progress of each feature on -the roadmap. +Use [Aiven Ideas](https://ideas.aiven.io/) to: + +- View the status and progress of each feature on the roadmap +- Submit ideas +- Vote on and discuss your ideas to shape the future of the product. diff --git a/docs/platform/concepts/byoc.md b/docs/platform/concepts/byoc.md index 3821786b..76441734 100644 --- a/docs/platform/concepts/byoc.md +++ b/docs/platform/concepts/byoc.md @@ -50,13 +50,12 @@ BYOC: ## Who is eligible for BYOC {#eligible-for-byoc} The BYOC setup is a bespoke service offered on a case-by-case basis, and -not all cloud providers support it yet. You need to meet a few -requirements to be eligible for BYOC: +not all cloud providers support it yet. Meet a few requirements to be eligible for BYOC: - You use one of the following public clouds: Amazon Web Services (AWS), Google Cloud Platform (GCP), or Microsoft Azure (excluding Azure Germany). -- Your total monthly spend is at least \$5,000.00 for at least 12 +- Your total monthly spend is at least $5,000.00 for at least 12 months. - You use at least the [Priority tier of Aiven support services](https://aiven.io/support-services). @@ -90,7 +89,7 @@ may have and potentially leverage committed use discounts (CUDs) in certain cases. :::note -For a cost estimate and analysis, contact [sales@aiven.io](mailto:sales@aiven.io). +For a cost estimate and analysis, contact [the sales team](mailto:sales@aiven.io). ::: ## Standard BYOC architecture {#byoc-deployment} diff --git a/docs/platform/concepts/cloud-security.md b/docs/platform/concepts/cloud-security.md index 55bc5f0d..58bd0cd9 100644 --- a/docs/platform/concepts/cloud-security.md +++ b/docs/platform/concepts/cloud-security.md @@ -2,13 +2,14 @@ title: Cloud security --- -Learn about Aiven's access control, encryption, network security, data -privacy and operator access. +Learn about Aiven's access control, encryption, network security, data privacy and operator access. ## Cloud provider accounts -The regular Aiven services are hosted under cloud provider accounts -controlled by Aiven. These accounts are managed only by Aiven operations +Aiven services are hosted under cloud provider accounts +controlled by Aiven. + +These accounts are managed only by Aiven operations personnel, and customers cannot directly access the Aiven cloud provider account resources. @@ -16,19 +17,21 @@ account resources. Each Aiven service consists of one or more virtual machines, which are automatically launched to the target cloud region chosen by the -customer. In cloud regions that have multiple Availability Zones (or a -similar mechanism), the virtual machines are distributed evenly across -the zones in order to provide best possible service in cases when an +customer. + +In cloud regions that have multiple Availability Zones (or a +similar mechanism), virtual machines are distributed evenly across +the zones to provide the best possible service in cases when an entire availability zone (which can include one or more datacenters) -goes unavailable. +becomes unavailable. -Service-providing virtual machines (VMs) are dedicated for a single -customer, i.e. there is no multi-tenancy on a VM basis, and the customer +Service-providing virtual machines (VMs) are dedicated to a single +customer. This means there is no multi-tenancy on a VM basis, and the customer data never leaves the machine, except when uploaded to the offsite backup location. -Virtual machines are not reused and will be terminated, and wiped upon -service upgrade or termination. +Virtual machines are not reused and are terminated and wiped during service +upgrade or termination. ## Data encryption @@ -51,9 +54,10 @@ RSA key-pair is randomly generated for each service. The key lengths are 3072-bits for the RSA key. Aiven-encrypted backup files are stored in the object storage in the -same region where the service virtual machines are located. For those -cloud providers that do not provide object storage services (i.e. -DigitalOcean, UpCloud), the nearest region from another cloud provider +same region where the service virtual machines are located. + +For cloud providers that do not provide object storage services like +DigitalOcean or UpCloud, the nearest region from another cloud provider that provides an object storage is used. ## Networking security @@ -86,9 +90,8 @@ projects. When services are deployed in a VPC, the DNS names resolve to their Private IP. Some services allow both public and private access to be enabled while -inside a VPC (for testing, for example) and you can find instructions -for this in the -[Enable public access in a VPC](/docs/platform/howto/public-access-in-vpc) article. +inside a VPC and see +[Enable public access in a VPC](/docs/platform/howto/public-access-in-vpc). Connections to Aiven services are always established from your VPC to the peered Aiven VPC. So, you can use VPC firewall rules to prevent any diff --git a/docs/platform/concepts/disaster-recovery-test-scenarios.md b/docs/platform/concepts/disaster-recovery-test-scenarios.md index 83e59b31..6a2adf84 100644 --- a/docs/platform/concepts/disaster-recovery-test-scenarios.md +++ b/docs/platform/concepts/disaster-recovery-test-scenarios.md @@ -2,17 +2,12 @@ title: Disaster recovery testing scenarios --- -[Disaster Recovery](https://en.wikipedia.org/wiki/Disaster_recovery) -(DR) is the ability of software and/or services to handle extreme -scenarios; this could be the failure of the software itself or an outage -within a datacenter. +[Disaster Recovery](https://en.wikipedia.org/wiki/Disaster_recovery) (DR) is the ability of software and/or services to handle extreme scenarios. For example, the failure of the software itself or a datacenter outage. -These situations are uncommon but can have a huge impact, so they need -to be prepared for. Aiven provides this service to any Enterprise -Support customers and can run these scenarios at your request up to 4 -times per year. +Aiven provides this service to any Enterprise Support customers and can run +these scenarios at your request up to 4 times per year. -## What is a Disaster Recovery scenario? +## Disaster Recovery scenario This is a preset scenario where an Aiven specialist will simulate an issue with your service and `sabotage` one (or more) of your Virtual @@ -20,28 +15,25 @@ Machines. For example, with an Aiven for PostgreSQL® service, we can `sabotage` the Primary instance and test the failover functionality or we can sabotage both nodes to test recovery time for a complete outage. -## What is needed? +## Requirements -1. At least 7 working days notice and the time (plus timezone) that you - would like this carried out. -2. A `throwaway` service (i.e. one that is created specifically for - this scenario and not a service used in Production). -3. The virtual machine and/or the availability zone that you would like - to target. -4. An Enterprise Support contract. +1. At least 7 working days notice and the time (plus timezone) that you + would like this carried out. +1. A `throwaway` service created specifically for + this scenario and not a service used in Production. +1. The virtual machine and/or the availability zone that you would like + to target. +1. An Enterprise Support contract. -## How do we request this? +## Requesting a disaster recovery test -You can request this by opening a support ticket, emailing -[support@Aiven.io](mailto:support@aiven.io) or by contacting your -Customer Success Manager. +You can request a test by contacting the [support team](mailto:support@aiven.io) +or by contacting your Customer Success Manager. -## How is it run? +The process looks as follows: -- All communication during the exercise will occur in the support - ticket. -- We will contact you to confirm the start of the scenario, the - actions we will take and the service affected. The scenario will not - begin until it is confirmed by you. -- Actions taken on the service and/or virtual machines will be - communicated through the support ticket. +- All communication during the exercise will occur in the support ticket. +- Aiven contacts you to confirm the start date and content of the scenario. +- You confirm the scenario and its start date. +- Actions taken on the service and/or virtual machines will be communicated through + the support ticket. diff --git a/docs/platform/concepts/dynamic-disk-sizing.md b/docs/platform/concepts/dynamic-disk-sizing.md index 71bca01e..196f86a1 100644 --- a/docs/platform/concepts/dynamic-disk-sizing.md +++ b/docs/platform/concepts/dynamic-disk-sizing.md @@ -2,24 +2,22 @@ title: Dynamic Disk Sizing (DDS) --- -Dynamic Disk Sizing (DDS) allows you to add storage to or remove storage -from your services. You can add storage during service creation. You can -also add it later to a running service without interruption. +Dynamic Disk Sizing (DDS) allows you to add storage to or remove storage from your services. You can add storage during service creation. You can also add it later to a running service without interruption. DDS is available for the following services: -- Aiven for Apache Kafka® -- Aiven for PostgreSQL® -- Aiven for MySQL® -- Aiven for OpenSearch® -- Aiven for Apache Cassandra® -- Aiven for M3DB® +- Aiven for Apache Kafka® +- Aiven for PostgreSQL® +- Aiven for MySQL® +- Aiven for OpenSearch® +- Aiven for Apache Cassandra® +- Aiven for M3DB® :::note DDS is not supported on custom plans. ::: -## Why use DDS? +## Why use DDS When creating a service on Aiven, you have a fixed storage allocation based on the plan you choose. Predicting future growth and storage @@ -30,14 +28,14 @@ requirements without upgrading the plan. Using DDS provides the following benefits: -- Provides an easy way to increase the disk storage available with the - selected service plan. -- You can dynamically add or remove storage without disrupting your - running service. -- It is cost-effective as you pay only for the additional storage not - the compute resources that are part of an upgraded service plan. +- Provides an easy way to increase the disk storage available with the + selected service plan. +- You can dynamically add or remove storage without disrupting your + running service. +- It is cost-effective as you pay only for the additional storage not + the compute resources that are part of an upgraded service plan. -## How does DDS work? +## How DDS works You can add disk storage to your service plan when you [create a new service](/docs/platform/howto/create_new_service) or on demand when you need more storage while @@ -66,14 +64,14 @@ with it. You can also see these storage usage costs in your invoices. ### Limitations -- Maximum storage size depends on the plan and the service type. It - can go as high as five times the base storage size of the plan. -- Due to cloud provider restrictions, there is a limit on how many - times storage can be increased between two maintenance updates. If - this limit is reached, you need to perform a maintenance update for - performance optimization. -- If there is an ongoing maintenance update, you cannot add storage - until the update is completed. +- Maximum storage size depends on the plan and the service type. It + can go as high as five times the base storage size of the plan. +- Due to cloud provider restrictions, there is a limit on how many + times storage can be increased between two maintenance updates. If + this limit is reached, perform a maintenance update for + performance optimization. +- If there is an ongoing maintenance update, you cannot add storage + until the update is completed. It is unlikely that any performance degradation from additional disk storage would be noticeable in your clients, but it is possible. diff --git a/docs/platform/concepts/enhanced-compliance-env.md b/docs/platform/concepts/enhanced-compliance-env.md index c63f6d1a..08db29f2 100644 --- a/docs/platform/concepts/enhanced-compliance-env.md +++ b/docs/platform/concepts/enhanced-compliance-env.md @@ -2,13 +2,8 @@ title: Enhanced compliance environments (ECE) --- -As a business that collects, manages, and operates on sensitive data -that is protected by privacy and compliance rules and regulations - any -vendor that assists with this collection, management and operation is -subject to these same rules and regulations. Aiven meets the needs of -these businesses by providing specialized enhanced compliance -environments (ECE) that comply with many of the most common compliance -requirements. +Aiven collects, manages, and operates on sensitive data that is protected by privacy and compliance rules and regulations. Aiven meets the needs of its customers by providing specialized enhanced compliance environments (ECE) that comply with many of the most common compliance requirements. +The vendors that assist with this collection, management and operation are subject to the same rules and regulations. An enhanced compliance environment will run on Aiven managed infrastructure with the additional compliance requirement that no ECE @@ -43,70 +38,69 @@ accordingly. ## Similarities to a standard environment -In many ways, an ECE is the same as a standard Aiven deployment. All of -Aiven's tooling ([CLI](/docs/tools/cli), -[Terraform](/docs/tools/terraform), etc.) -interact with ECEs seamlessly, you will still be able to take advantage -of all of Aiven's service integrations, and access to the environment +In many ways, an ECE is the same as a standard Aiven deployment. +Aiven's tooling, such as [CLI](/docs/tools/cli) and [Terraform](/docs/tools/terraform), +interact with ECEs seamlessly, you will still be able to take advantage of Aiven's +service integrations, and access to the environment can be achieved through VPC peering or Privatelink (on AWS or Azure). + However, there are some key differences from standard environments as well: -- No internet access. Internet access cannot even be allow-listed as - would be the case in standard private VPCs -- VPCs cannot be automatically provisioned and must be manually - configured by our networking team. -- VPC peering or Privatelink connections must be manually approved on - the Aiven end +- No internet access. Internet access cannot even be allow-listed as + would be the case in standard private VPCs +- VPCs cannot be automatically provisioned and must be manually + configured by our networking team. +- VPC peering or Privatelink connections must be manually approved on + the Aiven end With these differences in mind, Aiven requires the following to provision an Enhanced Compliance Environment: -- A CIDR block for all region/environment combinations. For example, - if you have a development, QA and production environment and operate - in 3 regions in each of those, we will need 9 CIDR blocks. +- A CIDR block for all region/environment combinations. For example, + if you have a development, QA and production environment and operate + in 3 regions in each of those, we will need 9 CIDR blocks. The necessary peering information to enable the peer from our end. This differs between clouds: **AWS:** -- AWS account ID -- VPC ID +- AWS account ID +- VPC ID **GCP:** -- GCP Project ID -- VPC Network Name +- GCP Project ID +- VPC Network Name **Azure:** -- Azure Tenant ID -- Azure App ID -- Azure VNet ID +- Azure Tenant ID +- Azure App ID +- Azure VNet ID -## What compliances are covered? +## Compliances Although not exhaustive, Aiven is capable of supporting both the Health Insurance Portability and Accountability Act (HIPAA) and the Payment Card Industry Data Security Standard (PCI DSS) compliances. -If you require compliance beyond these please contact our sales -department so we can better understand your specific needs. -Additionally, we also offer an alternative deployment option. See +If you require compliance beyond these compliances, contact the [sales +team](mailto:sales@aiven.io) so we can better understand your specific needs. + +Additionally, we offer an alternative deployment option. See [Bring Your Own Cloud (BYOC)](/docs/platform/concepts/byoc). -## Migrating +## Migrate to an ECE + +Migrations to Aiven are a standard procedure, but migrating +to an ECE can add complexity. -Migrations to Aiven are fairly straightforward in general, but migrating -to an ECE can add a tiny bit of complexity. If the migration is for a -new service there are a few standard migration methods that will work - -please contact [sales](mailto:sales@aiven.io)and a Solution Architect will be -able to help. +To migrate a new service to an ECE, contact [the sales team](mailto:sales@aiven.io) +to request help. -If you need to migrate an existing Aiven service to an ECE the standard -automated migration methods will not work out of the box. To facilitate -the migration, the Aiven network team will create a VPN tunnel between -your non-compliant VPC and your ECE VPC to enable a one-click migration. -The migration will then be performed in an automated and zero-downtime -fashion. Once the migration is complete, we will remove the VPN tunnel. +To migrate an existing Aiven service to an ECE, the Aiven network team creates a VPN +tunnel between your non-compliant VPC and your ECE VPC to enable a one-click migration. +The migration is then performed in an automated and zero-downtime fashion. +Once the migration is complete, the VPN tunnel is removed. diff --git a/docs/platform/concepts/free-plan.md b/docs/platform/concepts/free-plan.md index 3b080c5f..285ee960 100644 --- a/docs/platform/concepts/free-plan.md +++ b/docs/platform/concepts/free-plan.md @@ -7,9 +7,9 @@ and Aiven for Redis®\* services. You don\'t need a credit card to sign up and you can create one free service for each type. This means you can create one free PostgreSQL, one free MySQL, and one free Redis service. -If you want to try a different service, you may want to consider a +To try a different service, you may want to consider a 30-day -[free trial](/docs/platform/concepts/free-trial), which gives you \$300 USD of free credits. +[free trial](/docs/platform/concepts/free-trial), which gives you $300 USD of free credits. You can run free plan services alongside a free 30-day trial without affecting your trial credits. Free plan services also continue running @@ -25,8 +25,8 @@ Free plans include: - A single node - 1 CPU per virtual machine -- 1GB RAM -- For PostgreSQL and MySQL: 5GB disk storage +- 1 GB RAM +- For PostgreSQL and MySQL: 5 GB disk storage - For Redis: `maxmemory` set to 50% - Management via our web console, CLI, API, Terraform provider, or Kubernetes® operator @@ -62,9 +62,10 @@ use policy](https://aiven.io/terms) or are unused for some time. You can upgrade your free plan to a paid plan at any time. -To upgrade, you need to add a payment method or start a full platform -trial. After adding a payment method, selecting upgrade lets you choose -a new plan size, cloud, and region. +To upgrade: + +1. Add a payment method or start a full platform trial. +1. Click upgrade and choose a new plan size, cloud, and region. :::important If you upgrade your free plan service to a paid plan using a free trial, diff --git a/docs/platform/concepts/free-trial.md b/docs/platform/concepts/free-trial.md index 34b2c52c..f39efbb6 100644 --- a/docs/platform/concepts/free-trial.md +++ b/docs/platform/concepts/free-trial.md @@ -2,13 +2,7 @@ title: 30-day trials --- -Aiven offers a free trial for 30 days to explore the platform - -including the [Aiven Console](https://console.aiven.io/), -[API](/docs/tools/api), -[CLI](/docs/tools/cli), -[Aiven Terraform provider](/docs/tools/terraform), and -[Aiven Operator for Kubernetes](/docs/tools/kubernetes) - and the [Aiven services](https://docs.aiven.io/). You -don\'t need a credit card to sign up. +Aiven offers a free trial for 30 days to explore the platform, including the [Aiven Console](https://console.aiven.io/), [API](/docs/tools/api), [CLI](/docs/tools/cli), [Aiven Terraform provider](/docs/tools/terraform), and [Aiven Operator for Kubernetes](/docs/tools/kubernetes), and the [Aiven services](https://docs.aiven.io/). You don't need a credit card to sign up. If you create services on the [free plan](/docs/platform/concepts/free-plan), they will continue to run alongside your free 30-day trial @@ -23,19 +17,22 @@ well functionality like virtual private cloud peering. Trials include: - Up to 10 VMs -- 1 - [Virtual Private Cloud (VPC)](/docs/platform/howto/manage-vpc-peering) +- 1 [Virtual Private Cloud (VPC)](/docs/platform/howto/manage-vpc-peering) - Up to 10 VPC peering connections There are some limitations: + + - You can only have one trial - Trials can only be started in your default project, which is created when you sign up - Trial credits cannot be transferred to another project -- You can\'t create new services if your remaining credits would be +- You can't create new services if your remaining credits would be spent too quickly + + ## Add a payment card To keep your services running after the trial period, diff --git a/docs/platform/concepts/hourly-billing-model.md b/docs/platform/concepts/hourly-billing-model.md index 3d39f28e..1a1b5256 100644 --- a/docs/platform/concepts/hourly-billing-model.md +++ b/docs/platform/concepts/hourly-billing-model.md @@ -13,8 +13,8 @@ You must be a [super admin](/docs/platform/howto/make-super-admin) to access thi ## Service charges -The prices shown in the Aiven console are all-inclusive, meaning that -all of the following are included in the hourly service price: +The prices shown in the Aiven console are all-inclusive. The following costs are +included in the hourly service price: - Virtual machine costs - Network costs @@ -35,9 +35,10 @@ an Aiven service and terminate it after 40 minutes, you will be charged for one full hour. Likewise, if you terminate a service after 40.5 hours, you will be charged for 41 hours. -[Terminating or pausing a service](/docs/platform/howto/pause-from-cli) will stop the accumulation of new charges immediately. -However, please note that the minimum hourly charge unit still applies -prior to terminating or pausing a service. +[Terminating or pausing a service](/docs/platform/howto/pause-from-cli) stops +the accumulation of new charges immediately. +However, the minimum hourly charge unit still applies prior to terminating or pausing +a service. -Migrating a service to another cloud region or to a different cloud -provider does not incur any additional costs. +Migrating a service to another cloud region or to a different cloud provider does not +incur any additional costs. diff --git a/docs/platform/concepts/logs-metrics-alerts.md b/docs/platform/concepts/logs-metrics-alerts.md index 8fe02002..42d6d8b8 100644 --- a/docs/platform/concepts/logs-metrics-alerts.md +++ b/docs/platform/concepts/logs-metrics-alerts.md @@ -2,8 +2,7 @@ title: About logging, metrics and alerting --- -Administrators can configure log and metrics integrations to Aiven -services so that you can monitor the health of your service. +Administrators can configure log and metrics integrations to Aiven services so that you can monitor the health of your service. ## Logs @@ -26,8 +25,9 @@ service. ## Alerts -The platform also has alert policies to notify you via email when a key -metric rises above or below a set threshold, such as low memory or high -CPU consumption. For information on setting the addresses for these -emails, see -[this article](/docs/platform/howto/technical-emails). +The platform has alert policies to notify you via email when a key metric +reaches or drifts from a threshold. For example, low memory or high CPU +consumption. + +For information on setting the addresses for these emails, see +[Manage project and service notifications](/docs/platform/howto/technical-emails). diff --git a/docs/platform/concepts/maintenance-window.md b/docs/platform/concepts/maintenance-window.md index 3de56ee2..31b88d5f 100644 --- a/docs/platform/concepts/maintenance-window.md +++ b/docs/platform/concepts/maintenance-window.md @@ -10,14 +10,12 @@ process is completed, the overall URI DNS name is pointed at the new location. The upgrade is done during the maintenance window that you can set from -the [Aiven Console](https://console.aiven.io/), in service details page. -During the maintenance window some services could have a minimal -downtime period. +the [Aiven Console](https://console.aiven.io/), in the service details page. +During the maintenance window, some services might have minimal downtime. :::note -For example, if there is a mandatory service updates for Apache Kafka®, -the following [upgrade -procedure](https://docs.aiven.io/docs/products/kafka/concepts/upgrade-procedure.html) +For example, when a mandatory service update for Apache Kafka® is released, +the [Kafka upgrade procedure](/docs/products/kafka/concepts/upgrade-procedure) is executed. ::: @@ -25,7 +23,7 @@ Aiven service upgrades are performed in rolling forward style, which means that new service nodes are first created alongside with the older nodes one at a time, after which the old nodes are retired. -In case of **MySQL®**, **PostgreSQL®** and **Redis®**\* the maintenance +For **MySQL®**, **PostgreSQL®** and **Redis®**\*, the maintenance window usually lasts around several seconds. The downtime comes from old master stopping itself in a controlled manner and new master executing promotion sequence after this. Once the promotion is complete the old @@ -34,7 +32,7 @@ service is accessible before DNS updates are propagated, though clients that end up reconnecting to the old master node will see additional disconnection once the old master is permanently retired. -In case of **Apache Kafka®** and **OpenSearch®** the service DNS address +For **Apache Kafka®** and **OpenSearch®**, the service DNS address resolves to all the available service nodes. During an upgrade the DNS address changes to reflect the added and removed nodes. For example, during an [Apache Kafka upgrade @@ -71,8 +69,8 @@ require any action from you. You can view maintenance updates pending for your service using the following: -- [Aiven Console](https://console.aiven.io/) \> **Service settings** - page \> **Service management** section +- [Aiven Console](https://console.aiven.io/) > **Service settings** + page > **Service management** section - `avn service get` command in [Aiven CLI](https://docs.aiven.io/docs/tools/cli/service-cli#avn-service-get) - `service` endpoint in [Aiven REST diff --git a/docs/platform/concepts/out-of-memory-conditions.md b/docs/platform/concepts/out-of-memory-conditions.md index 2cb28530..eb5bf538 100644 --- a/docs/platform/concepts/out-of-memory-conditions.md +++ b/docs/platform/concepts/out-of-memory-conditions.md @@ -32,7 +32,7 @@ long the process has been running. Processes that have been running for a long time are less likely to be killed. Subprocesses are summed with parent processes in terms of memory -usage, so a process which forks a large number of subprocesses, but +usage, so a process which forks many subprocesses, but itself does not use a lot of memory, may still be killed. *In most instances, the hosted data service, or a child process, will @@ -43,9 +43,9 @@ Aiven's cloud data platform leverages kernel namespaces (or containers) to isolate processes from each other. Isolation has several benefits, including: -- A smaller footprint for security‑related concerns -- A smaller blast radius for failure -- Greater control of system resources +- A smaller footprint for security‑related concerns +- A smaller blast radius for failure +- Greater control of system resources Left unchecked, the `OOM Killer` may opt to kill the primary service. This is undesirable as unclean termination of the primary service can @@ -72,17 +72,17 @@ including data unavailable or data loss conditions. ## How to avoid the OOM Killer -The OOM killer only runs when the system is critically low on memory, so -to avoid it running you need to either reduce your memory usage or +The OOM killer only runs when the system is critically low on memory. +To prevent it from running, either reduce your memory usage or increase the available memory. For most databases, the service memory footprint can often be reduced by: -- Reducing concurrency or implementing connection pooling -- Tuning queries to limit result sets -- Tuning indexes for query load -- Dropping unused objects from storage +- Reducing concurrency or implementing connection pooling +- Tuning queries to limit result sets +- Tuning indexes for query load +- Dropping unused objects from storage In cases where the working set no longer fits into memory, consider [scaling your service](/docs/platform/howto/scale-services). diff --git a/docs/platform/concepts/projects_accounts_access.md b/docs/platform/concepts/projects_accounts_access.md index 95cbf5d5..1909c372 100644 --- a/docs/platform/concepts/projects_accounts_access.md +++ b/docs/platform/concepts/projects_accounts_access.md @@ -2,10 +2,7 @@ title: Organization hierarchy and access --- -The Aiven platform uses organizations, organizational units, and -projects to organize services and access to those services. Learn how -you can use these effectively to accommodate your organization's -structure. +The Aiven platform uses organizations, organizational units, and projects to organize services and manage access to those services. ![Hierarchy showing two organizational units, each with two projects, nested within one organization.](/images/platform/concepts/organizations_hierarchy.png) @@ -18,23 +15,23 @@ You can use your organization to create a hierarchical structure that fits your needs. Organizational units can be nested within an organization, adding another level to group your projects. This gives you greater flexibility to organize your infrastructure based on your -specific use cases. For example, you can easily split production and +specific use cases. For example, you can split production and testing workloads into different organizational units. Grouping your projects in organizations and organizational units lets you centrally manage settings like: -- Authentication methods: Only available on the organization level -- Access control lists (ACLs): Can be set on all levels (organization, - organizational unit, and project) - - ACLs for service plans are inherited, meaning all projects - within an organization or organizational unit will have the same - service plan. -- Groups: Managed at the organization level and assigned to projects -- Support contracts: Specific to a single organization and cannot be - shared between them -- Billing groups: Specific to a single organization and cannot be - shared between them +- Authentication methods: Only available on the organization level +- Access control lists (ACLs): Can be set on all levels (organization, + organizational unit, and project) + - ACLs for service plans are inherited, meaning all projects + within an organization or organizational unit will have the same + service plan. +- Groups: Managed at the organization level and assigned to projects +- Support contracts: Specific to a single organization and cannot be + shared between them +- Billing groups: Specific to a single organization and cannot be + shared between them ### Super admin @@ -81,39 +78,38 @@ contractors. ### Groups -[Organization users](/docs/platform/howto/manage-org-users) can be -[added to groups](/docs/platform/howto/manage-groups), making it easy to control access to the services in a -project. When you -[add a group to a project](/docs/platform/howto/add-groups-projects), you also select the role for that group. This role gives -all users in that group the same level of access to all services in the -project. +[Organization users](/docs/platform/howto/manage-org-users) can be [added to +groups](/docs/platform/howto/manage-groups), making it easy to control access to +the services in a project. When you [add a group to a +project](/docs/platform/howto/add-groups-projects), you also select the role for +that group. This role gives users in that group the same level of access to +all services in the project. ## Best practices for organizations -**Small organizations** +### Small organizations For smaller organizations that have a limited number of projects we -recommend consolidating all of your projects within one organization. +recommend consolidating all your projects within one organization. This will make it easier for your teams to navigate between projects and services. Good naming conventions also help with finding projects and services. -For example, you can include the environment type - `dev`, `prod`, -etc. - at the beginning of project names. +For example, you can include the environment type, `dev`, `prod`, +etc., at the beginning of project names. -**Medium organizations** +### Medium organizations -For more complex cases, it's helpful to take advantage of the -organizational units. Organizational units let you collect together -related projects. +For more complex cases, take advantage of the +organizational units. Organizational units group related projects. -You could, for example, group projects into organizational units that -correspond to your internal departments. Alternatively, you could group +You can, for example, group projects into organizational units that +correspond to your internal departments. Alternatively, you can group them by categories like testing, staging, and production environments. -**Large organizations** +### Large organizations -For large organizations, it's best to keep all of your projects in -organizational units instead of organizations. By keeping all of your +For large organizations, keep your projects in +organizational units instead of organizations. By keeping your projects in organizational units you can centrally manage things like support contracts and billing groups for each group of projects. diff --git a/docs/platform/concepts/service-integration.md b/docs/platform/concepts/service-integration.md index b61bb4fc..6310ab03 100644 --- a/docs/platform/concepts/service-integration.md +++ b/docs/platform/concepts/service-integration.md @@ -46,12 +46,9 @@ so on. ### Can I add alerts in Grafana for the telemetry data? Yes. You can add alert thresholds for individual graphs and attach -different alerting mechanisms to them for sending out alerts. Please -refer to the -[Grafana documentation](/docs/products/grafana) for more information. +different alerting mechanisms to them for sending out alerts. +See the [Grafana documentation](/docs/products/grafana) for more information. ## Create a service integration -Follow -[this guide](/docs/platform/howto/create-service-integration) to create service integration between multiple Aiven -services. +See [Create service integrations](/docs/platform/howto/create-service-integration). diff --git a/docs/platform/concepts/service-power-cycle.md b/docs/platform/concepts/service-power-cycle.md index 69cb2195..22b139f5 100644 --- a/docs/platform/concepts/service-power-cycle.md +++ b/docs/platform/concepts/service-power-cycle.md @@ -2,11 +2,7 @@ title: Service power cycle --- -Aiven service power off and power on is more than stopping and starting -a service on nodes. For better utilisation of resources on Aiven -platform, idle resources will be released and only the necessary data -will be kept after power off. The impact on the service is different -depending on the service type and plan. +Aiven service power off and on is more than stopping and starting a service on nodes. For better utilisation of resources on Aiven platform, idle resources will be released and only the necessary data will be kept after power off. The impact on the service is different depending on the service type and plan. :::warning Depending on service type and plan, data loss may happen during a @@ -22,11 +18,11 @@ Console](https://console.aiven.io) or through Whenever an Aiven service is powered off: -- All virtual machine(s) of the service will be **removed** from the +- All virtual machines of the service will be **removed** from the public cloud. - The service information and configuration will be stored on Aiven Platform, while service data will be lost if there's no backup - available . + available. - If the service has **time-based** or **PITR (point in time recovery)** backups, they will be kept on Aiven Platform. The backups are listed on the **Backups** page of the service in [Aiven @@ -45,30 +41,30 @@ be sent before actions are taken. on the consequence of the power off. For example, powering off an Aiven service can erase data since the latest backup because the service only has time-based but not PITR backups. -- Moreover, on the `Backups` page, hovering the mouse over the help - icon (if it's available) can present some details on the content of - the backups. This information suggests what can be restored if the +- On the **Backups** page, hovering over the help + icon displays some details on the content of + the backups including what can be restored if the service is powered on later. :::warning For backup enabled Aiven for Apache Kafka® services, topic configuration, schemas and connectors are all backed up, but not the data in topics. Therefore all topic data will be lost on power off. For -Kafka services without backups, topic configurations together with all +Kafka services without backups, topic configurations including all topic data will be lost on power off. ::: ## Power on -When a service is powered on, the following things will happen: +When a service is powered on: -- New virtual machine(s) will be created on the specified public cloud +- New virtual machines will be created on the specified public cloud for the service. - Service will be started with the stored configuration parameters. - The latest time-based backup that is available will be restored. The restore time depends on the network bandwidth and disk IOPS allocated to the service plan as well as the size of the backup. It - could take from minutes to hours. Smaller plans with larger backups + takes from a few minutes to a few hours. Smaller plans with larger backups take longer time than bigger plans with smaller backups. Restore progress can be checked by Aiven support with Aiven Admin CLI. - If PITR backup is available, the database transaction log (for example, diff --git a/docs/platform/concepts/service_backups.md b/docs/platform/concepts/service_backups.md index 0f717b88..5d4cb889 100644 --- a/docs/platform/concepts/service_backups.md +++ b/docs/platform/concepts/service_backups.md @@ -2,11 +2,7 @@ title: Backups at Aiven --- -On top of general rules for handling service backups in Aiven, there are -service-specific backup details, such as backup frequency and retention -period per service. Backup policies for service power-off/on and service -deletion are common for all the services, similarly as the backup access -policy. +On top of general rules for handling service backups in Aiven, there are service-specific backup details, such as backup frequency and retention period per service. Backup policies for service power-off/on and service deletion are common for all the services, similarly as the backup access policy. ## About backups at Aiven @@ -15,8 +11,8 @@ Aggregator/Coordinator, have time-based backups that are encrypted and securely stored. Backups at Aiven are stored in the object storage of the cloud region where the service is first created (for example, S3 for AWS or GCS for GCP). You can check the location of your service's -backups in [Aiven Console](https://console.aiven.io/) \> your service's -homepage \> **Backups**. +backups in [Aiven Console](https://console.aiven.io/) > your service's +homepage > **Backups**. The backup retention times vary based on the service and the selected service plan. @@ -40,9 +36,10 @@ A notification email will be sent to you to provide time for taking action before the service and backup are deleted as part of the [periodic cleanup of powered-off services](/docs/platform/howto/cleanup-powered-off-services). -If you wish to keep the powered-off service for more than 180 days, -power on the service and then power it off again to avoid the routine -cleanup. +If you wish to keep the powered-off service for more than 180 days: + +1. Power on the service +1. Power it off again to avoid the routine cleanup. ## Service backup deletion policy @@ -184,7 +181,8 @@ durability is determined by data replication across the cluster. However, automatic backups for essential Apache Kafka® service configurations are offered through -[configuration backups](/docs/products/kafka/concepts/configuration-backup), and they come at no extra cost. If the Apache Kafka® +[configuration backups](/docs/products/kafka/concepts/configuration-backup), and +they come at no extra cost. If the Apache Kafka® service is powered off/on or if any incidents lead to the cluster's failure, the configuration backup facilitates restoring your Apache Kafka® service to its previous state. @@ -192,34 +190,33 @@ Kafka® service to its previous state. To back up data passing through Apache Kafka, we recommend using one of the following tools: -- [MirrorMaker 2](/docs/products/kafka/kafka-mirrormaker) to replicate the data to another cluster, which could be - an Aiven service or a Apache Kafka cluster on your own - infrastructure. With MirrorMaker 2, the backup cluster operates as - an independent Apache Kafka service. You can freely choose a zone - for your backup service since it operates independently from the - primary service. - - :::note - MirrorMaker 2 provides tools for mapping between the source and - target offset, so you don\'t need to make this calculation. For more - details, see section *Offset Mapping* in blog post [A look inside - Kafka MirrorMaker - 2](https://blog.cloudera.com/a-look-inside-kafka-mirrormaker-2/). - ::: - -- Kafka Connect to backup the cluster, for instance, sinking data from - Apache Kafka® to S3 via a - [dedicated Aiven connector](/docs/products/kafka/kafka-connect/howto/s3-sink-prereq). - -:::note[See also] -For more information, refer to - -- [Aiven for Apache Kafka® MirrorMaker 2](/docs/products/kafka/kafka-mirrormaker) -- Cloudera's [A look inside Kafka MirrorMaker - 2](https://blog.cloudera.com/a-look-inside-kafka-mirrormaker-2/) -- [Configure AWS for an S3 sink connector](/docs/products/kafka/kafka-connect/howto/s3-sink-prereq) -- [Configuration Backups](/docs/products/kafka/concepts/configuration-backup) -::: +- [MirrorMaker 2](/docs/products/kafka/kafka-mirrormaker) to replicate the data to + another cluster, which can be + an Aiven service or a Apache Kafka cluster on your own + infrastructure. + + With MirrorMaker 2, the backup cluster operates as + an independent Apache Kafka service. You can freely choose a zone + for your backup service since it operates independently from the + primary service. + + :::note + MirrorMaker 2 provides tools for mapping between the source and + target offset, so you don't need to make this calculation. For more + details, see section *Offset Mapping* in + [A look inside Kafka MirrorMaker 2](https://blog.cloudera.com/a-look-inside-kafka-mirrormaker-2/). + ::: + +- Kafka Connect to backup the cluster, for instance, sinking data from + Apache Kafka® to S3 via a + [dedicated Aiven connector](/docs/products/kafka/kafka-connect/howto/s3-sink-prereq). + +For more information, refer to: + +- [Aiven for Apache Kafka® MirrorMaker 2](/docs/products/kafka/kafka-mirrormaker) +- Cloudera's [A look inside Kafka MirrorMaker 2](https://blog.cloudera.com/a-look-inside-kafka-mirrormaker-2/) +- [Configure AWS for an S3 sink connector](/docs/products/kafka/kafka-connect/howto/s3-sink-prereq) +- [Configuration Backups](/docs/products/kafka/concepts/configuration-backup) ### Aiven for PostgreSQL® @@ -227,11 +224,11 @@ For Aiven for PostgreSQL, full daily backups are taken, and WAL segments are constantly archived to the cloud object storage. In case of node failure, -- For a business or premium plan, Aiven can reconstruct the latest - state from a replica -- For a startup plan, Aiven can reconstruct the latest state from the - latest base backup and replay the latest WAL segments on top of - that. +- For a business or premium plan, Aiven can reconstruct the latest + state from a replica +- For a startup plan, Aiven can reconstruct the latest state from the + latest base backup and replay the latest WAL segments on top of + that. You can supplement this with a remote read-only replica service, which you can run in a different cloud region or with another cloud provider @@ -243,13 +240,11 @@ Console](https://console.aiven.io/) (the service's **Service settings** page). If a recent backup has been taken, it may take another backup cycle before the new backup time takes effect. -:::note[See also] -For more information, refer to +For more information, refer to: -- [PostgreSQL® backups](/docs/products/postgresql/concepts/pg-backups) -- [High availability](/docs/products/postgresql/concepts/high-availability) -- [Create and use read-only replicas](/docs/products/postgresql/howto/create-read-replica) -::: +- [PostgreSQL® backups](/docs/products/postgresql/concepts/pg-backups) +- [High availability](/docs/products/postgresql/concepts/high-availability) +- [Create and use read-only replicas](/docs/products/postgresql/howto/create-read-replica) ### Aiven for MySQL® @@ -265,10 +260,8 @@ Console](https://console.aiven.io/) (the service's **Service settings** page). If a recent backup has been taken, it may take another backup cycle before the new backup time takes effect. -:::note[See also] -For more information, refer to -[MySQL Backups](/docs/products/mysql/concepts/mysql-backups). -::: +For more information, refer to [MySQL +Backups](/docs/products/mysql/concepts/mysql-backups). ### Aiven for OpenSearch® @@ -276,12 +269,10 @@ Aiven for OpenSearch databases are automatically backed up, encrypted, and stored securely in the object storage. The backups are taken every hour, and the retention period varies based on the service plan. -:::note[See also] -For more information, refer to +For more information, see: -- [OpenSearch backups](/docs/products/opensearch/concepts/backups) -- [How to restore an OpenSearch® backup](/docs/products/opensearch/howto/restore_opensearch_backup) -::: +- [OpenSearch backups](/docs/products/opensearch/concepts/backups) +- [How to restore an OpenSearch® backup](/docs/products/opensearch/howto/restore_opensearch_backup) ### Aiven for Apache Cassandra® @@ -289,8 +280,7 @@ Aiven for Apache Cassandra backups are taken every 24 hours. The point-in-time recovery (PITR) feature is currently not available. :::note -If you'd like to be notified once the PITR feature is available for -Cassandra, contact the Aiven support. +To be notified once the PITR feature is available for Cassandra, contact the Aiven support. ::: ### Aiven for Redis™\* @@ -303,13 +293,13 @@ You can control the persistence feature using `redis_persistence` under **Advanced configuration** in [Aiven Console](https://console.aiven.io/) (the service's **Service settings** page): -- When `redis_persistence` is set to `rdb`, Redis does RDB dumps every - 10 minutes if any key is changed. Also, RDB dumps are done according - to the backup schedule for backup purposes. -- When `redis_persistence` is `off`, no RDB dumps or backups are done, - so data can be lost at any moment if the service is restarted for - any reason or if the service is powered off. This also means the - service can\'t be forked. +- When `redis_persistence` is set to `rdb`, Redis does RDB dumps every + 10 minutes if any key is changed. Also, RDB dumps are done according + to the backup schedule for backup purposes. +- When `redis_persistence` is `off`, no RDB dumps or backups are done, + so data can be lost at any moment if the service is restarted for + any reason or if the service is powered off. This also means the + service can't be forked. :::note AOF persistence is currently not supported by Aiven for the managed @@ -332,14 +322,14 @@ backed up incrementally: files already present in the object storage are not re-uploaded and only changed parts are backed up. :::note -Aiven for ClickHouse doesn\'t support so-called streaming backups: when +Aiven for ClickHouse doesn't support so-called streaming backups: when a service is powered off, all data written after the last backup gets -lost. For more information about limitations on Aiven for ClickHouse +lost. + +For more information about limitations on Aiven for ClickHouse backups, see [Aiven for ClickHouse limitations](/docs/products/clickhouse/reference/limitations). ::: -:::note[See also] For more information on Aiven for ClickHouse backups, see [Backup and restore](/docs/products/clickhouse/concepts/disaster-recovery). -::: diff --git a/docs/platform/concepts/tax-information.md b/docs/platform/concepts/tax-information.md index b6895176..0c1e5758 100644 --- a/docs/platform/concepts/tax-information.md +++ b/docs/platform/concepts/tax-information.md @@ -2,15 +2,12 @@ title: Tax information for Aiven services --- -Aiven services are provided by Aiven Ltd, a private limited company -incorporated in Finland. This article describes our tax status in -different jurisdictions. None of our marketed prices include value-added -or other taxes. +Aiven services are provided by Aiven Ltd, a private limited company incorporated in Finland but operating in various countries. Aiven has the following tax status in the jurisdictions it operates in. None of our marketed prices include value-added or other taxes. ## European Union Finnish law requires Aiven to charge a value-added tax for services -provided within the European Union (EU). The value-added tax percentage +provided within the European Union. The value-added tax percentage depends on the domicile of the customer. For business customers in EU countries other than Finland, we can apply @@ -19,21 +16,22 @@ ID [is added to the billing information](/docs/platform/howto/update-tax-status) for a billing group. ## United States - -According to the tax treaty between Finland and the United States (US), -no direct tax needs to be withheld from payments by US entities to + +According to the tax treaty between Finland and the United States, +no direct tax needs to be withheld from payments by American entities to Aiven. Although a W-8 form is not required to confirm this status, -we\'re happy to provide a W-8BEN-E form describing Aiven's status. -Contact the sales team at [sales@aiven.io](mailto:sales@aiven.io) to request one. - -Aiven does charge US sales taxes in several states in the US. The +we're happy to provide a W-8BEN-E form describing Aiven's status. +Contact the [sales team](mailto:sales@aiven.io) to request one. + +Aiven charges American sales taxes in several states in the United-States. The applicability of these taxes depends on various factors, such as the taxability of Aiven services, tax thresholds, amongst others. ## Rest of the world - -No EU value-added tax is applied to services sold outside the EU as -described in the Value-Added Tax Act of Finland section 69h. Finland has -tax treaties with most countries in the world affirming this status. -Aiven reserves the right to charge any necessary taxes - similar to US -sales taxes - depending on the local tax legislation of the customer. + +No European Uninion value-added tax is applied to services sold outside the +European Union as described in the Value-Added Tax Act of Finland section 69h. +Finland has tax treaties with most countries in the world affirming this status. +Aiven reserves the right to charge any necessary taxes, similar to American +sales taxes, depending on the local tax legislation of the customer. + diff --git a/docs/platform/concepts/tls-ssl-certificates.md b/docs/platform/concepts/tls-ssl-certificates.md index 772c23ee..3067478e 100644 --- a/docs/platform/concepts/tls-ssl-certificates.md +++ b/docs/platform/concepts/tls-ssl-certificates.md @@ -2,17 +2,15 @@ title: TLS/SSL certificates --- -All traffic to Aiven services is always protected by TLS. It ensures -that third-parties can\'t eavesdrop or modify the data while in transit -between Aiven services and the clients accessing them. +All traffic to Aiven services is always protected by TLS. It ensures that third parties can't eavesdrop or modify the data while in transit between Aiven services and the clients accessing them. Every Aiven project has its own private Certificate Authority (CA) which is used to sign certificates that are used internally by the Aiven services to communicate between different cluster nodes and to Aiven management systems. -Some service types (listed below) uses the Aiven project's CA for -external connections. To access these services, you need to download the +Some service types uses the Aiven project's CA for +external connections. To access these services, download the CA certificate and configure it on your browser or client. For other services a browser-recognized CA is used, which is normally @@ -20,7 +18,7 @@ already marked as trusted in browsers and operating systems, so downloading the CA certificate is not normally required. :::note -All the services in a project share the same Certificate Authority(CA) +All the services in a project share the same Certificate Authority (CA) ::: ## Certificate requirements @@ -28,18 +26,18 @@ All the services in a project share the same Certificate Authority(CA) Most of our services use a browser-recognized CA certificate, but there are exceptions: -- **Aiven for PostgreSQL®** requires the Aiven project CA certificate - to connect when using `verify-ca` or - `verify-full` as `sslmode`. The first mode requires the - client to verify that the server certificate is actually emitted by - the Aiven CA, while the second provides maximum security by - performing HTTPS-like validation on the hostname as well. The - default `sslmode`, `require`, ensures TLS is used when connecting to - the database, but does not verify the server certificate. For more - information, see the [PostgreSQL - documentation](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS) -- **Aiven for Apache Kafka®** requires the Aiven project CA - certificate, and also the client key and certificate. +- **Aiven for PostgreSQL®** requires the Aiven project CA certificate + to connect when using `verify-ca` or + `verify-full` as `sslmode`. The first mode requires the + client to verify that the server certificate is actually emitted by + the Aiven CA, while the second provides maximum security by + performing HTTPS-like validation on the hostname as well. The + default `sslmode`, `require`, ensures TLS is used when connecting to + the database, but does not verify the server certificate. For more + information, see the [PostgreSQL + documentation](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-SSLMODE-STATEMENTS) +- **Aiven for Apache Kafka®** requires the Aiven project CA + certificate, and also the client key and certificate. For these services you can [Download CA certificates](/docs/platform/howto/download-ca-cert) diff --git a/docs/platform/howto/add-storage-space.md b/docs/platform/howto/add-storage-space.md index a42437fa..933c3179 100644 --- a/docs/platform/howto/add-storage-space.md +++ b/docs/platform/howto/add-storage-space.md @@ -5,10 +5,12 @@ title: Add or remove storage With [dynamic disk sizing](/docs/platform/concepts/dynamic-disk-sizing), you can add or remove disk storage, by a factor of 10 GiB, when you create a service or for a running service. :::note + - You cannot add or remove storage when service nodes are in the rebalancing state, for example, during a maintenance update or a service upgrade. - This feature is not available for all service plans. + ::: ## Use Aiven Console @@ -24,16 +26,16 @@ You can add storage to your running service in [Aiven Console](https://console.aiven.io/) without interrupting the service. 1. Log into the [Aiven Console](https://console.aiven.io/), select your - project and then select the service for which you want to add + project and select the service for which you want to add storage. -2. On the service page, click **Service settings** from the sidebar. +1. On the service page, click **Service settings** from the sidebar. -3. In the **Service plan** section, click **Actions (\...)**. +1. In the **Service plan** section, click **Actions (\...)**. -4. From the dropdown menu, select **Manage additional storage**. +1. From the dropdown menu, select **Manage additional storage**. -5. In the **Upgrade service storage** dialog, click **Change plan** +1. In the **Upgrade service storage** dialog, click **Change plan** choose the new service plan and tier or use the slider to add disk storage. @@ -41,7 +43,7 @@ Console](https://console.aiven.io/) without interrupting the service. The price shown for the additional storage includes backup costs. ::: -6. Click **Save changes**. +1. Click **Save changes**. The additional storage is available for immediate use. @@ -49,9 +51,8 @@ The additional storage is available for immediate use. Storage optimization is performed at the next maintenance update after a change to the storage size. Due to cloud provider limitations, there is a limit on how many times storage can be increased between two -maintenance updates. When this limit is reached, you need to perform a -maintenance update for performance optimization. It's best to carefully -plan increases to avoid reaching this limit. +maintenance updates. When this limit is reached, perform a +maintenance update for performance optimization. Plan increases to avoid reaching this limit. ::: ### Remove additional storage @@ -70,16 +71,16 @@ You can remove storage that you previously added to a service. #### Remove added storage 1. Log into the [Aiven Console](https://console.aiven.io/), select your - project and then select the service for which you want to add + project and select the service for which you want to add storage. -2. On the service page, click **Service settings** from the sidebar. +1. On the service page, click **Service settings** from the sidebar. -3. In the **Service plan** section, click **Actions (\...)**. +1. In the **Service plan** section, click **Actions (\...)**. -4. From the dropdown menu, select **Manage additional storage**. +1. From the dropdown menu, select **Manage additional storage**. -5. In the **Upgrade service storage** dialog, use the slider to remove +1. In the **Upgrade service storage** dialog, use the slider to remove disk storage. :::note @@ -88,7 +89,7 @@ You can remove storage that you previously added to a service. [change your service plan](/docs/platform/howto/scale-services). ::: -6. Click **Save changes**. +1. Click **Save changes**. Your additional disk space has been removed. The service is in the **Rebalancing** state while the nodes are being recycled. @@ -109,6 +110,7 @@ avn service update --disk-space-gib 90 --project PROJECT_NAME SERVICE_NAME ``` :::note + - When you perform a service upgrade or downgrade horizontally, remember to include all additional disks the service uses. For example, when switching from `Startup-4` to `Business-4` or from @@ -116,4 +118,5 @@ avn service update --disk-space-gib 90 --project PROJECT_NAME SERVICE_NAME available for this service. - Similarly, when you fork an existing service, include all additional disks the service uses. + ::: diff --git a/docs/platform/howto/billing-azure-marketplace-subscription.md b/docs/platform/howto/billing-azure-marketplace-subscription.md index 6b9a16d0..af40d66b 100644 --- a/docs/platform/howto/billing-azure-marketplace-subscription.md +++ b/docs/platform/howto/billing-azure-marketplace-subscription.md @@ -41,7 +41,7 @@ Aiven makes its services available through the Microsoft Azure Marketplace, you 1. After you are redirected to the [Azure signup page at Aiven](https://console.azure.aiven.io/login), enter your Azure console email address to log in to the account. 1. After entering your email address, you will be authenticated via Azure single sign-on - and then returned to the Aiven Console. + and redirected to the Aiven Console. 1. Check whether you have received an email to activate your new subscription. Click **Activate now** to join your Aiven account to your Azure account. diff --git a/docs/platform/howto/byoc/assign-project-custom-cloud.md b/docs/platform/howto/byoc/assign-project-custom-cloud.md index ba63677e..20940c7c 100644 --- a/docs/platform/howto/byoc/assign-project-custom-cloud.md +++ b/docs/platform/howto/byoc/assign-project-custom-cloud.md @@ -7,7 +7,7 @@ To use a [custom cloud](/docs/platform/concepts/byoc) in your Aiven organization :::important Custom cloud configuration in Aiven is an [early availability feature](/docs/platform/concepts/beta_services). You cover the costs associated with building and -maintaining your custom cloud: payments for your integrated AWS +maintaining your custom cloud payments for your integrated AWS infrastructure and Aiven services within the custom cloud. ::: @@ -88,8 +88,7 @@ create services using your custom cloud. ## Check it out -You can verify if the cloud availability changes you made are live by -taking the following steps: +To verify if the cloud availability changes you made are live: 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. diff --git a/docs/platform/howto/byoc/create-custom-cloud.md b/docs/platform/howto/byoc/create-custom-cloud.md index 1d55880e..296b464b 100644 --- a/docs/platform/howto/byoc/create-custom-cloud.md +++ b/docs/platform/howto/byoc/create-custom-cloud.md @@ -63,8 +63,8 @@ contacts for your custom cloud. - You need at least the Priority tier of Aiven support services to be eligible for activating BYOC. - To build your custom cloud with a cloud provider other - than AWS, you need to request it as detailed in - [Enable bring your own cloud (BYOC) with Aiven](/docs/platform/howto/byoc/enable-byoc) and follow up with the Aiven team. + than AWS, request it as detailed in + [Enable bring your own cloud (BYOC) with Aiven](/docs/platform/howto/byoc/enable-byoc). - BYOC is supported with the [standard deployment](/docs/platform/concepts/byoc#byoc-deployment) model only. - Only organization's administrators can create custom clouds. @@ -507,7 +507,7 @@ you\'ll deploy this template in your AWS account to acquire Role ARN (Amazon Resource Name), which Aiven needs for accessing your AWS account. -In the **Create custom cloud** wizard, proceed as follows: +In the **Create custom cloud** wizard: 1. Specify the following: - Custom cloud name @@ -568,8 +568,7 @@ account. Use the Terraform template generated in step [Generate an infrastructure template](/docs/platform/howto/byoc/create-custom-cloud#generate-infra-template) to create your Role ARN by deploying the template in your -AWS account. Continue working in the **Create custom cloud** wizard by -taking the following steps: +AWS account. Continue working in the **Create custom cloud** wizard: 1. Copy or download the template and the variables file from the **Create custom cloud** wizard. @@ -613,8 +612,7 @@ create services. You can make your cloud available for all the projects in your organization, selected organizational units, or specific projects only. -Continue working in the **Create custom cloud** wizard by taking the -following steps: +Continue working in the **Create custom cloud** wizard: 1. In the **Custom cloud's availability in your organization** section, select either: @@ -642,7 +640,7 @@ available from all the projects in this unit. Select at least one person whom Aiven can contact in case any technical issue with the custom cloud needs fixing. Continue working in the -**Create custom cloud** wizard by taking the following steps: +**Create custom cloud** wizard: 1. In the **Customer contacts** section, select a contact person's role using the **Job title** dropdown menu, and provide their email @@ -657,8 +655,7 @@ your custom cloud**. #### Complete the cloud setup -you're all set. Select **Close** to close the **Create custom cloud** -wizard. +Select **Close** to close the **Create custom cloud** wizard. The deployment of your new custom cloud might take a few minutes. As soon as it's over, and your custom cloud is ready to use, you\'ll be @@ -697,8 +694,7 @@ can create services using your new custom cloud. As soon as you new custom cloud gets the **Active** status, remove the Terraform resources your created in your AWS account while creating the cloud. See the guidelines on how to use the `destroy` command in -[Command: -destroy](https://developer.hashicorp.com/terraform/cli/commands/destroy). +[Command: destroy](https://developer.hashicorp.com/terraform/cli/commands/destroy). ### Create a service using the new cloud @@ -707,7 +703,7 @@ your new custom cloud, follow the guidelines in [Create a new service](/docs/platform/howto/create_new_service). When you get to the **Select service region** step while setting up your -service in [Aiven Console](https://console.aiven.io/), you\'ll be able +service in [Aiven Console](https://console.aiven.io/), you'll be able to select **Custom clouds** from among available regions. ## Related pages diff --git a/docs/platform/howto/byoc/delete-custom-cloud.md b/docs/platform/howto/byoc/delete-custom-cloud.md index d0d3d9d7..76ffd177 100644 --- a/docs/platform/howto/byoc/delete-custom-cloud.md +++ b/docs/platform/howto/byoc/delete-custom-cloud.md @@ -8,8 +8,7 @@ organizations, units, or projects. :::important Custom cloud configuration in Aiven is an [early availability feature](/docs/platform/concepts/beta_services). You cover the costs associated with building and -maintaining your custom cloud: payments for your integrated AWS -infrastructure and Aiven services within the custom cloud. +maintaining your custom cloud payments for your integrated AWS infrastructure and Aiven services within the custom cloud. ::: ## About deleting custom clouds @@ -43,15 +42,15 @@ them earlier, you're advised to do that if deleting your cloud. 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. -2. Select the organization you want to use from the dropdown menu in +1. Select the organization you want to use from the dropdown menu in the top right corner. -3. From the top navigation bar, select **Admin**. -4. From the left sidebar, select **Bring your own cloud**. -5. In the **Bring your own cloud** view, select one of the clouds +1. From the top navigation bar, select **Admin**. +1. From the left sidebar, select **Bring your own cloud**. +1. In the **Bring your own cloud** view, select one of the clouds available on the list. -6. In the selected cloud's page, use the ellipsis (**\...**) menu in +1. In the selected cloud's page, use the ellipsis (**\...**) menu in the top right corner to select **Delete**. -7. Make sure you understand the impact and, if so, confirm that you +1. Make sure you understand the impact and, if so, confirm that you want to delete the cloud by selecting **Delete** in the **Warning** window. @@ -68,16 +67,15 @@ destroy](https://developer.hashicorp.com/terraform/cli/commands/destroy). ## Check it out -You can verify if you deleted your cloud successfully by taking the -following steps: +To ensure a cloud was successfully deleted: 1. Log in to [Aiven Console](https://console.aiven.io/) as an administrator. -2. Select the organization you want to use from the dropdown menu in +1. Select the organization you want to use from the dropdown menu in the top right corner. -3. From the top navigation bar, select **Admin**. -4. From the left sidebar, select **Bring your own cloud**. -5. In the **Bring your own cloud** view, see the list of the available +1. From the top navigation bar, select **Admin**. +1. From the left sidebar, select **Bring your own cloud**. +1. In the **Bring your own cloud** view, see the list of the available clouds to make sure the cloud you intended to delete is actually gone. diff --git a/docs/platform/howto/change-your-email-address.md b/docs/platform/howto/change-your-email-address.md index 3516f21e..19821737 100644 --- a/docs/platform/howto/change-your-email-address.md +++ b/docs/platform/howto/change-your-email-address.md @@ -2,22 +2,21 @@ title: Change your email address --- -You can\'t change your login email address directly. Instead, you can -create a new user with the new email address and then remove the user -with the old email address. You must be an organization admin to do -this. +You can't change your login email address directly. Instead, you can create a new user with the new email address and remove the user with the old email address. + +You must be an organization admin to do this. :::important Aiven support cannot change your email address. ::: 1. In the organization, click **Admin**. -2. Click **Users**. -3. Click **Invite users**. -4. Enter the new email address. -5. Click **Invite users**. -6. Remove the old user from all groups and +1. Click **Users**. +1. Click **Invite users**. +1. Enter the new email address. +1. Click **Invite users**. +1. Remove the old user from all groups and [add the new user to those groups](/docs/platform/howto/manage-groups). -7. After the invite is accepted and you confirm that the new user has +1. After the invite is accepted and you confirm that the new user has the correct access, [remove the old user](/docs/platform/howto/manage-org-users) from the organization. diff --git a/docs/platform/howto/cleanup-powered-off-services.md b/docs/platform/howto/cleanup-powered-off-services.md index b5410d70..c2df11ec 100644 --- a/docs/platform/howto/cleanup-powered-off-services.md +++ b/docs/platform/howto/cleanup-powered-off-services.md @@ -16,6 +16,7 @@ feasibility of a smooth upgrade path, making it harder for Aiven to continue supporting your needs. :::note + - It is recommended that you regularly review your services and delete those that are no longer needed. This allows Aiven to focus on supporting the services that you actively use and better utilize @@ -24,17 +25,18 @@ continue supporting your needs. email notifications reminding you that the service has been inactive for a prolonged period. If the service remains powered off for 180 consecutive days, it is subject to automatic deletion. + ::: ## Delete a powered-off service 1. In [Aiven Console](https://console.aiven.io/), select **Services** in the left navigation bar to display a list of all services. -2. On the **Services** page, use the search bar to locate a specific +1. On the **Services** page, use the search bar to locate a specific powered off service or the filter to display a list of services with status **Powered off**. -3. Select the powered off service to access its **Overview** page, and +1. Select the powered off service to access its **Overview** page, and select **Delete service** from the actions menu in the top right corner. -4. In the **Delete confirmation** window, enter the name of the service +1. In the **Delete confirmation** window, enter the name of the service to delete and select **Delete** to confirm the action. diff --git a/docs/platform/howto/console-fork-service.md b/docs/platform/howto/console-fork-service.md index 6b956400..30a1c266 100644 --- a/docs/platform/howto/console-fork-service.md +++ b/docs/platform/howto/console-fork-service.md @@ -2,11 +2,7 @@ title: Fork your service --- -Fork your Aiven service in order to make a copy of the service. You can -use it to create a development copy of your production environment, set -up a snapshot to analyze an issue or test an upgrade, or create an -instance in a different cloud/geographical location/under a different -plan. +Fork your Aiven service to make a copy of the service. You can use it to create a development copy of your production environment, set up a snapshot to analyze an issue or test an upgrade, or create an instance in a different cloud/geographical location/under a different plan. Learn more [about service forking](/docs/platform/concepts/service-forking). @@ -16,7 +12,7 @@ Learn more 1. Log in to [Aiven Console](https://console.aiven.io/). 1. Go to your **Services**, and select the service you want to fork. 1. On the **Overview** page of your service, scroll down to **Fork - Database** \> **New database fork**. + Database** > **New database fork**. 1. In the **New Database Fork** window, select the new service region and plan. 1. Select **Create fork**. @@ -36,12 +32,12 @@ need for the copy. avn service types ``` -For example, if you want to create a fork of your `forker` PostgreSQL® +For example, to create a fork of your `forker` PostgreSQL® service, and name it `forked`, the command would be something like: ```bash avn service create forked --project PROJECT_NAME --cloud CLOUD_NAME -t pg --plan business-4 -c service_to_fork_from=forker ``` -You have now copied your Aiven service. You can now apply any integrations you +You have copied your Aiven service. You can now apply any integrations you need for the copy. diff --git a/docs/platform/howto/custom-plans.md b/docs/platform/howto/custom-plans.md index a1d3d728..1f14ff54 100644 --- a/docs/platform/howto/custom-plans.md +++ b/docs/platform/howto/custom-plans.md @@ -2,14 +2,11 @@ title: Request service custom plans --- -Aiven stock plans are designed to cover most common use cases. The plans -are tested and configurations optimized to work well across the -different clouds. +Aiven stock plans are designed to cover most common use cases. The plans are tested and configurations optimized to work well across the different clouds. Sometimes, for special use cases like very high throughput clusters, the stock plans might not be an optimal fit. In such cases we can create -custom plans where the default service configurations are modified to -best fit your needs. +custom plans where the default service configurations are modified to fit your needs. :::note Custom plans can be made available for all the Aiven services types (as diff --git a/docs/platform/howto/disk-autoscaler.md b/docs/platform/howto/disk-autoscaler.md index 14687a1b..be0d8bb2 100644 --- a/docs/platform/howto/disk-autoscaler.md +++ b/docs/platform/howto/disk-autoscaler.md @@ -19,7 +19,7 @@ Service disk autoscaler increases disk storage capacity automatically when the disk is running out of space. :::note -Currently, service disk autoscaler doesn\'t support scaling down. +Currently, service disk autoscaler doesn't support scaling down. ::: - Disk autoscaling allows you to improve the cost-efficiency of @@ -38,11 +38,11 @@ There are a few steps illustrating how disk autoscaler works: 1. You create a disk autoscaler integration endpoint in your Aiven project setting the maximum additional storage at the same time. -2. You enable a disk autoscaler integration for your service using the +1. You enable a disk autoscaler integration for your service using the new disk autoscaler integration endpoint. -3. From that point onward, the evaluation of disk space availability +1. From that point onward, the evaluation of disk space availability for your service is done every 30 seconds. -4. When disk storage consumption reaches the threshold for a specific +1. When disk storage consumption reaches the threshold for a specific service, disk autoscaler increases available storage space by 10% every time taking the used disk space as a baseline. @@ -75,7 +75,7 @@ the available disk storage capacity and depends on a service type: ## Enable disk autoscaler -To enable disk autoscaling on your Aiven service, you need to create an +To enable disk autoscaling on your Aiven service, create an autoscaler integration endpoint and enable autoscaler integration with your service using the new endpoint. You can set up disk autoscaling in [Aiven Console](https://console.aiven.io/), using Aiven API, or Aiven @@ -87,11 +87,11 @@ CLI client. 1. Log in to [Aiven Console](https://console.aiven.io/) and navigate to a desired organization and project. -2. On the **Services** page of your project, select **Integration +1. On the **Services** page of your project, select **Integration endpoints** from the sidebar. -3. On the **Integration endpoints** page, select **Disk autoscaler** \> +1. On the **Integration endpoints** page, select **Disk autoscaler** \> **Add new endpoint**. -4. In the **Create new autoscaler endpoint** window, enter an endpoint +1. In the **Create new autoscaler endpoint** window, enter an endpoint name, specify a maximum additional disk storage that you want to allow for disk autoscaling purposes, and select **Create**. @@ -99,11 +99,11 @@ CLI client. 1. Log in to [Aiven Console](https://console.aiven.io/) and navigate to a desired organization, project, and service. -2. On the **Overview** page of your service, select **Integrations** +1. On the **Overview** page of your service, select **Integrations** from the sidebar. -3. On the **Integrations** page, navigate to **External integrations** +1. On the **Integrations** page, navigate to **External integrations** and select **Disk autoscaler**. -4. In the **Autoscaler integration** window, select the newly created +1. In the **Autoscaler integration** window, select the newly created autoscaler integration endpoint from the dropdown menu and select **Enable**. @@ -141,7 +141,7 @@ endpoint to create an autoscaler integration on your service. }' ``` -2. Call the +1. Call the [ServiceIntegrationCreate](https://api.aiven.io/doc/#tag/Service_Integrations/operation/ServiceIntegrationCreate) endpoint on your service passing the following in the request body: @@ -188,14 +188,14 @@ autoscaler integration endpoint --user-config-json '{"max_additional_storage":"REPLACE_WITH_DESIRED_VALUE_IN_GB"}' ``` -2. Run the +1. Run the [avn service integration-endpoint-list](/docs/tools/cli/service/integration#avn_service_integration_endpoint_list) command to retrieve the identifier of the new endpoint: ```shell avn service integration-endpoint-list --project YOUR_PROJECT_NAME ``` -3. Run the following command to create an autoscaler integration on +1. Run the following command to create an autoscaler integration on your service using the new autoscaler integration endpoint: ```bash @@ -216,12 +216,12 @@ CLI to do that. 1. Log in to [Aiven Console](https://console.aiven.io/) and navigate to a desired organization and project. -2. On the **Services** page of your project, select **Integration +1. On the **Services** page of your project, select **Integration endpoints** from the sidebar. -3. On the **Integration endpoints** page, select **Disk autoscaler**, +1. On the **Integration endpoints** page, select **Disk autoscaler**, find your endpoint on the list of the existing autoscaler endpoints, select the **Edit endpoint** icon. -4. In the **Edit endpoint** window, specify a new value for the maximum +1. In the **Edit endpoint** window, specify a new value for the maximum additional disk storage to be allowed for autoscaling, and select **Update**. @@ -270,7 +270,7 @@ avn service integration-endpoint-update AUTOSCALER_ENDPOINT_ID ## Disable disk autoscaler -To disable disk autoscaling on your Aiven service, you need to +To disable disk autoscaling on your Aiven service, disconnect the service from the autoscaler integration endpoint. You can also delete the integration endpoint itself if you don\'t need it for future purposes. You can disable disk autoscaling in [Aiven @@ -283,21 +283,21 @@ client. 1. Log in to [Aiven Console](https://console.aiven.io/) and navigate to a desired organization, project, and service. -2. On the **Overview** page of your service, select **Integrations** +1. On the **Overview** page of your service, select **Integrations** from the sidebar. -3. On the **Integrations** page, find your autoscaler service +1. On the **Integrations** page, find your autoscaler service integration at the top, select the **Actions** (**\...**) menu \> **Disconnect**. -4. In the **Disconnect service integration** window, select +1. In the **Disconnect service integration** window, select **Disconnect**. #### Delete an autoscaler endpoint 1. Log in to [Aiven Console](https://console.aiven.io/) and navigate to a desired organization and project. -2. On the **Services** page of your project, select **Integration +1. On the **Services** page of your project, select **Integration endpoints** from the sidebar. -3. On the **Integration endpoints** page, select **Disk autoscaler**, +1. On the **Integration endpoints** page, select **Disk autoscaler**, find your endpoint on the list of the existing autoscaler endpoints, select the **Delete endpoint** icon and **Delete** in the **Confirmation** window. @@ -332,7 +332,7 @@ endpoint passing `{"service disk autoscaler": {"enabled": true}}` in the --header 'Authorization: Bearer REPLACE_WITH_YOUR_BEARER_TOKEN' ``` -2. Call the +1. Call the [ServiceIntegrationEndpointDelete](https://api.aiven.io/doc/#tag/Service_Integrations/operation/ServiceIntegrationEndpointDelete) endpoint on your project passing the following in the request body: @@ -365,21 +365,21 @@ run the commands to delete the following: avn service integration-list SERVICE_NAME ``` -2. Run the following command to delete an autoscaler integration on +1. Run the following command to delete an autoscaler integration on your service: ```bash avn service integration-delete INTEGRATION_ID ``` -3. Retrieve the ID of an autoscaler integration endpoint you want to +1. Retrieve the ID of an autoscaler integration endpoint you want to delete by running the following command: ```bash avn service integration-endpoint-list PROJECT_NAME ``` -4. Run the following command to delete an autoscaler integration +1. Run the following command to delete an autoscaler integration endpoint on your project: ```bash diff --git a/docs/platform/howto/google-cloud-functions.md b/docs/platform/howto/google-cloud-functions.md index 3e93b43b..170c6ff2 100644 --- a/docs/platform/howto/google-cloud-functions.md +++ b/docs/platform/howto/google-cloud-functions.md @@ -1,4 +1,6 @@ -# Access Aiven services from Google Cloud Functions via VPC peering +--- +title: Access Aiven services from Google Cloud Functions via VPC peering +--- You can access Aiven service by creating a **Serverless VPC access connector** and **Google Cloud Function**. @@ -38,7 +40,7 @@ You have: subnet that is not in use. 1. If you have **allowed IP addresses** configured on your Aiven - service, please ensure the subnet of **serverless VPC access + service, ensure the subnet of **serverless VPC access connector** is listed there ## Create a Cloud Function @@ -79,7 +81,7 @@ You have: ## Troubleshooting If you cannot access your VPC or Aiven VPC from the Cloud Function, -please consider using the following example for troubleshooting +consider using the following example for troubleshooting purposes. ```python diff --git a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.md b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.md index 597410a4..0c2df960 100644 --- a/docs/platform/howto/integrations/access-jmx-metrics-jolokia.md +++ b/docs/platform/howto/integrations/access-jmx-metrics-jolokia.md @@ -2,10 +2,7 @@ title: Access JMX metrics via Jolokia --- -[Jolokia](https://jolokia.org/) is one of the external metrics -integration supported on the Aiven platform besides -[Datadog metrics](/docs/integrations/datadog/datadog-metrics) and -[Prometheus metrics](/docs/platform/howto/integrations/prometheus-metrics). +[Jolokia](https://jolokia.org/) is one of the external metrics integration supported on the Aiven platform besides [Datadog metrics](/docs/integrations/datadog/datadog-metrics) and [Prometheus metrics](/docs/platform/howto/integrations/prometheus-metrics). :::note Only Aiven for Apache Kafka® has support for Jolokia integration. @@ -20,10 +17,10 @@ create a new Jolokia endpoint configuration: the **Services** page, select **Integration endpoints** on the left sidebar. -2. In the **Integrations** page, select **Jolokia**, and then select +1. In the **Integrations** page, select **Jolokia**, and select **Add new endpoint**. -3. Enter an **Endpoint name** for the new Jolokia endpoint and select +1. Enter an **Endpoint name** for the new Jolokia endpoint and select **Create**. The system will automatically generate a username and password for authentication. Usually, you can reuse the same Jolokia endpoint configuration for all services within a project. diff --git a/docs/platform/howto/integrations/prometheus-metrics.md b/docs/platform/howto/integrations/prometheus-metrics.md index e6594825..dd84b3ea 100644 --- a/docs/platform/howto/integrations/prometheus-metrics.md +++ b/docs/platform/howto/integrations/prometheus-metrics.md @@ -22,9 +22,8 @@ from the HTTP server running on Aiven nodes. Usually one Prometheus integration endpoint can be used for all services in the same project. To check if Prometheus is supported on your -service, you need to verify if the project for this service has a -Prometheus integration endpoint created. For this purpose, take the -following steps: +service, verify if the project for this service has a +Prometheus integration endpoint created: 1. Log in to [Aiven Console](https://console.aiven.io/), go to **Projects** in the top navigation bar, and select your project from @@ -42,7 +41,7 @@ Prometheus. If there's no Prometheus endpoint available, proceed to ## Enable Prometheus Aiven offers Prometheus endpoints for your services. To enable this -feature, take the following steps: +feature: 1. Log in to [Aiven Console](https://console.aiven.io/), go to **Projects** in the top navigation bar, and select your project from @@ -74,7 +73,7 @@ feature, take the following steps: integration listed and status `active`. ::: -1. Next, navigate to the service's **Overview** page, and then locate +1. Next, navigate to the service's **Overview** page, and locate the **Connection information** section. 1. Click on the **Prometheus** tab. diff --git a/docs/platform/howto/manage-groups.md b/docs/platform/howto/manage-groups.md index b863fd4b..7d1e8212 100644 --- a/docs/platform/howto/manage-groups.md +++ b/docs/platform/howto/manage-groups.md @@ -2,21 +2,19 @@ title: Create and manage groups in an organization --- -Create groups of users in your organization to make it easier to -[give users with similar roles access to projects](/docs/platform/howto/add-groups-projects). You need to -[invite users to your organization](/docs/platform/howto/manage-org-users) before adding them to a group. +Create groups of users in your organization to make it easier to [give users with similar roles access to projects](/docs/platform/howto/add-groups-projects). ## Create a group To create a group in an organization: 1. Click **Admin**. -2. Click **Groups**. -3. Click **Create group**. -4. Enter a unique name for the group. You can also enter a description. -5. Optional: To assign users to the group, click the toggle and choose +1. Click **Groups**. +1. Click **Create group**. +1. Enter a unique name for the group. You can also enter a description. +1. Optional: To assign users to the group, click the toggle and choose the users to add. -6. Click **Create group**. +1. Click **Create group**. ## Add users to a group @@ -26,21 +24,21 @@ You can only add users that are To add users to a group: 1. Click **Admin**. -2. Click **Groups**. -3. Select the group that you want to add users to. -4. Click **Add users**. -5. Choose the users to add. -6. Click **Add users**. +1. Click **Groups**. +1. Select the group that you want to add users to. +1. Click **Add users**. +1. Choose the users to add. +1. Click **Add users**. ## Rename a group 1. Click **Admin**. -2. Click **Groups**. -3. Find the group that you want to rename and click the **Actions** +1. Click **Groups**. +1. Find the group that you want to rename and click the **Actions** menu. -4. Select **Rename**. -5. Enter the new name. -6. Click **Save changes**. +1. Select **Rename**. +1. Enter the new name. +1. Click **Save changes**. ## Remove a group @@ -49,8 +47,8 @@ projects the group has permissions for unless they are part of another group with that access. 1. Click **Admin**. -2. Click **Groups**. -3. Find the group that you want to remove and click the **Actions** +1. Click **Groups**. +1. Find the group that you want to remove and click the **Actions** menu. -4. Select **Remove**. -5. Confirm you want to remove the group by clicking **Remove group**. +1. Select **Remove**. +1. Confirm you want to remove the group by clicking **Remove group**. diff --git a/docs/platform/howto/manage-org-users.md b/docs/platform/howto/manage-org-users.md index 78c0a9ea..7df10096 100644 --- a/docs/platform/howto/manage-org-users.md +++ b/docs/platform/howto/manage-org-users.md @@ -2,18 +2,17 @@ title: Manage users in an organization --- -Adding users to your organization lets you give them access to specific -organizational units, projects, and services within that organization. +Adding users to your organization lets you give them access to specific organizational units, projects, and services within that organization. ## Invite users to an organization To add users to your organization, send them an invite: 1. Click **Admin**. -2. Click **Users**. -3. Click **Invite users**. -4. Enter the email addresses of the people you want to invite. -5. Click **Invite users**. +1. Click **Users**. +1. Click **Invite users**. +1. Enter the email addresses of the people you want to invite. +1. Click **Invite users**. The users receive an email with instructions to sign up (for new users) and accept the invite. @@ -27,21 +26,21 @@ in the organization. To remove a user from an organization: 1. Click **Admin**. -2. Click **Users**. -3. Find the user that you want to remove and click the **Actions** +1. Click **Users**. +1. Find the user that you want to remove and click the **Actions** menu. -4. Select **Remove**. -5. Confirm you want to remove the user by clicking **Remove user**. +1. Select **Remove**. +1. Confirm you want to remove the user by clicking **Remove user**. ## Resend an invite -If you need to resend an invite to a user: +To resend an invite to a user: 1. Click **Admin**. -2. Click **Users**. -3. Find the email address that you want to resend an invite to and +1. Click **Users**. +1. Find the email address that you want to resend an invite to and click the **Actions** menu. -4. Select **Resend invite**. +1. Select **Resend invite**. -They get a new email with instructions for signing up or accepting the +They receive a new email with instructions for signing up or accepting the invite. diff --git a/docs/platform/howto/manage-unassigned-projects.md b/docs/platform/howto/manage-unassigned-projects.md index f6d3e853..b148944e 100644 --- a/docs/platform/howto/manage-unassigned-projects.md +++ b/docs/platform/howto/manage-unassigned-projects.md @@ -2,18 +2,7 @@ title: Manage unassigned projects --- -An unassigned project is a project that isn\'t assigned to an -organization or organizational unit. Projects that are part of an -organization or unit are easier to maintain as common settings like -authentication are centrally managed at the organization level. These -projects also get the latest feature updates. - -:::important -It's no longer possible to create unassigned projects and projects that -are not assigned to an organization or unit will not be updated with new -features. We recommend assigning all projects to an organization or unit -using the instructions on this page. -::: +An unassigned project is a project that isn't assigned to an organization or organizational unit. Projects that are part of an organization or unit are easier to maintain as common settings, like authentication, are centrally managed at the organization level. These projects also get the latest feature updates. Learn more about [organizations, organizational units, and projects](/docs/platform/concepts/projects_accounts_access). @@ -22,23 +11,25 @@ Learn more about ### Assign projects to an organization or unit -If you don\'t have an organization, you need to -[create one](/docs/platform/howto/manage-unassigned-projects#create-org) first. +:::note +If you don't have an organization, +[create one](/docs/platform/howto/manage-unassigned-projects#create-org). +::: To assign standalone projects to an organization or unit in the [Aiven Console](https://console.aiven.io/): -1. Click **Projects**. -2. Click **View unassigned projects** to see a list of all projects not - assigned to an organization or organizational unit. If you don\'t - see **View unassigned projects** in the dropdown menu, then you - don\'t have any unassigned projects. -3. On the **Unassigned projects** page, click **Assign project** for a - project you want to assign. -4. Add any other projects that you want to assign to the same - organization or unit. -5. Select the organization or organizational unit. -6. Click **Assign projects**. +1. Click **Projects**. +1. Click **View unassigned projects** to list all projects unassigned + to an organization or organizational unit. If you don't + see **View unassigned projects** in the dropdown menu, you + don't have any unassigned projects. +1. On the **Unassigned projects** page, click **Assign project** for a + project you want to assign. +1. Add any other projects that you want to assign to the same + organization or unit. +1. Select the organization or organizational unit. +1. Click **Assign projects**. ### Create an organization {#create-org} @@ -46,68 +37,77 @@ Projects must be assigned to organizations or units. We recommend using only one organization and creating organizational units to group your projects. -If you don\'t have any organization yet, you can create one: +To create an organization: -1. At the top right side, click **Create organization**. +1. At the top-right side, click **Create organization**. -2. Enter a name for the organization. +1. Enter a name for the organization. -3. Select the projects that you want to assign to this organization. - You can search for projects by name. +1. Select the projects to assign to this organization. + You can search for projects by name. -4. If you want to invite admin users to the organization, set the - toggle to **Yes** and enter their email addresses. They will receive - an email invitation with a confirmation link. +1. To invite admin users to the organization, set the + toggle to **Yes** and enter their email addresses. They will receive + an email to join the organization. - :::important - When admin users accept the invitation, they have full control over - the organization and the projects assigned to it. - ::: + :::important + When admin users accept the invitation, they have full control over + the organization and the projects assigned to it. + ::: -5. Click **Create organization**. +1. Click **Create organization**. The **Admin** page opens, where you can add organizational units, and manage users, groups, and other settings. ## Manage unassigned projects with the API -### Check for unassigned projects +### List unassigned projects -To see a list of names of all unassigned projects use the following: +To list the names of all unassigned projects use the following: -``` +```bash curl -sXGET \ https://api.aiven.io/v1/project \ -H "Authorization: Bearer TOKEN" | jq -r '.projects[] | select(.account_id==null) | .project_name' ``` -### Assign standalone projects to an organization or unit +### Assign standalone projects to an organization or unit programmatically {#assign-proj-api} -If you don\'t have an organization, you need to +:::note +If you don't have an organization, [create an organization](/docs/platform/howto/manage-unassigned-projects#create-org-api) -first and then assign your projects to it. +first and assign your projects to it. +::: To assign a standalone project to an organization or unit use the -following call. Replace `ACCOUNT_ID` with the ID of the organization or -unit and `PROJECT_NAME` with the name of the project to assign. +following call: -``` +```bash curl -sXPUT \ - https://api.aiven.io/v1/project/PROJECT_NAME \ - -H "Authorization: Bearer TOKEN" \ - -H 'content-type: application/json' \ - --data-raw '{"account_id":"ACCOUNT_ID","add_account_owners_admin_access":true}' | jq + https://api.aiven.io/v1/project/PROJECT_NAME \ + -H "Authorization: Bearer TOKEN" \ + -H 'content-type: application/json' \ + --data-raw '{"account_id":"ACCOUNT_ID","add_account_owners_admin_access":true}' ``` -### Create an organization {#create-org-api} +Where: -To create an organization use the following call. Replace `ORG_NAME` -with a name for your new organization. +- `ACCOUNT_ID` is the ID of the organization or unit. +- `PROJECT_NAME` is the name of the project to assign. -``` +### Create an organization programmatically {#create-org-api} + +To create an organization use the following call: + +```bash curl -sXPOST \ https://api.aiven.io/v1/account \ -H "Authorization: Bearer TOKEN" \ -H 'content-type: application/json' \ --data '{"account_name":"ORG_NAME"}' | jq ``` + +Where: + +- `ORG_NAME` is the name of your new organization. diff --git a/docs/platform/howto/migrate-services-cloud-region.md b/docs/platform/howto/migrate-services-cloud-region.md index c2a250d1..c513de4a 100644 --- a/docs/platform/howto/migrate-services-cloud-region.md +++ b/docs/platform/howto/migrate-services-cloud-region.md @@ -19,16 +19,16 @@ Services can be moved to another cloud provider, or another region within the same provider, or both. 1. Log into the [Aiven Console](https://console.aiven.io/), select your - project and then select the service you want migrate to another + project and select the service you want migrate to another cloud or region. -2. On the service page, click **Service settings** from the sidebar. -3. In the **Cloud and network** section, click **Actions (\...)**. -4. From the dropdown menu, click **Change cloud or region**. -5. In the **Migrate service to another cloud** window, select new cloud +1. On the service page, click **Service settings** from the sidebar. +1. In the **Cloud and network** section, click **Actions (\...)**. +1. From the dropdown menu, click **Change cloud or region**. +1. In the **Migrate service to another cloud** window, select new cloud provider and region. -6. Select **Migrate**. +1. Select **Migrate**. -Your service is in the *Rebuilding* state. Once the rebuilding is over, +Your service is in the **Rebuilding** state. Once the rebuilding is over, your new cloud provider and region will be in use. :::important diff --git a/docs/platform/howto/migrate-services-vpc.md b/docs/platform/howto/migrate-services-vpc.md index ec83092b..8f0229e7 100644 --- a/docs/platform/howto/migrate-services-vpc.md +++ b/docs/platform/howto/migrate-services-vpc.md @@ -16,7 +16,8 @@ resolution from public IP addresses to IP addresses within a VPC. To maintain uninterrupted access throughout this transition, Aiven provides a -[public access](/docs/platform/howto/public-access-in-vpc) advanced configuration. This ensures that your service +[public access](/docs/platform/howto/public-access-in-vpc) advanced configuration +This ensures that your service remains accessible over both the public Internet and within the VPC during migration. @@ -29,19 +30,19 @@ Follow these steps to migrate Aiven services to a VPC: 1. **VPC creation and peering**: [Create a VPC](/docs/platform/howto/manage-vpc-peering) and establish peering. -2. **Network peering validation**: Test the network peering with a +1. **Network peering validation**: Test the network peering with a non-critical service. -3. **Enable public access**: Activate public access for all services to +1. **Enable public access**: Activate public access for all services to be migrated. -4. **Application configuration update**: Modify your application to use +1. **Application configuration update**: Modify your application to use public access hostnames. -5. **Service migration**: Start the migration of the service into the +1. **Service migration**: Start the migration of the service into the VPC. -6. **Peering connections validation**: Confirm the functionality of +1. **Peering connections validation**: Confirm the functionality of peering connections with private hostnames and ports. -7. **Switch to private access hostnames**: Change application +1. **Switch to private access hostnames**: Change application configuration to use private access hostnames. -8. **Disable public access**: Turn off public access for all services. +1. **Disable public access**: Turn off public access for all services. :::note Steps 3, 4, 6, 7, 8 are optional but highly recommended. Following these @@ -85,8 +86,8 @@ be `public_access.kafka`. This action creates a new hostname and port, which remain publicly accessible even after the service is moved into the VPC. -You can find the new hostname and port under **Connection Information** -by selecting the `Public` \"Access Route\". Make sure you can connect to +See the new hostname and port under **Connection Information** +by selecting the **Public Access Route**. Make sure you can connect to each new host/port combination. ## Configure and redeploy application @@ -103,20 +104,19 @@ You can migrate your Aiven services into a VPC using the [Aiven Console](https://console.aiven.io/) . 1. Log in to the [Aiven Console](https://console.aiven.io/) select your - project and then select the service. -2. On the service page, select **Service settings** from the sidebar. -3. In the **Cloud and network** section, click **Actions (\...)**. -4. Choose **Change cloud or region** from the dropdown menu. -5. In the **Migrate service to another cloud** window, select the + project and select the service. +1. On the service page, select **Service settings** from the sidebar. +1. In the **Cloud and network** section, click **Actions (...)**. +1. Choose **Change cloud or region** from the dropdown menu. +1. In the **Migrate service to another cloud** window, select the **VPC** tab and choose the appropriate region for your project's dedicated VPC. Make sure the `Public Internet` tag is noted. -6. Start the migration process. Afterwards, monitor for the +1. Start the migration process. Afterwards, monitor for the `Project VPC` tag to appear on the service's page, which signifies the successful migration. -In [Aiven Console](https://console.aiven.io/), use the **Cloud and VPC** -\> **Migrate cloud** section on the service's **Overview** page to +In [Aiven Console](https://console.aiven.io/), use the **Cloud and VPC** > **Migrate cloud** section on the service's **Overview** page to migrate your Aiven services into a VPC. Note the `Public Internet` tag. Ensure that you select the region from the `VPC` tab. This is a diff --git a/docs/platform/howto/payment-issues-plan-upgrades.md b/docs/platform/howto/payment-issues-plan-upgrades.md index 38428e6b..d060b67d 100644 --- a/docs/platform/howto/payment-issues-plan-upgrades.md +++ b/docs/platform/howto/payment-issues-plan-upgrades.md @@ -2,27 +2,25 @@ title: Solve payment issues when upgrading to larger service plans --- -When you have set up a project without a valid credit card or other -payment method and no invoices have been paid, you may receive the -following error when you try to spin up a new service or upgrade the -plan of an existing one: +When you a project has an invalid payment method and no invoices have been paid, you may receive the following error when starting a new service or upgrade the plan of an existing one: ```text -Creating plan this large requires valid payment information and at least one invoice having been paid. +Creating a plan this large requires valid payment information and +at least one invoice having been paid. -Please contact support to enable creation of larger plans when these conditions are not met. +Please contact support to enable creation of larger plans +when these conditions are not met. ``` -In order to gain access to higher plans, please contact our support team -at [support@aiven.io](mailto:support@aiven.io) and we will help you get going with your new plan. +To upgrade to larger plans, contact the [sales team](mailto:sales@aiven.io). Alternatively, when creating a service or upgrading the plan you may also see: -:::warning +```text Payment method is not set and there is not enough credits for the service. -::: +``` This indicates that no valid credit card or other payment method has been assigned to the project yet, and there are not enough credits diff --git a/docs/platform/howto/prepare-for-high-load.md b/docs/platform/howto/prepare-for-high-load.md index 36e88d30..d25086cb 100644 --- a/docs/platform/howto/prepare-for-high-load.md +++ b/docs/platform/howto/prepare-for-high-load.md @@ -2,10 +2,9 @@ title: Prepare services for high load --- -If you are expecting higher than usual traffic on your Aiven services, -you can follow the recommendations and best practices detailed below -ahead of time to make sure you have the best tools and your service is -ready to sustain high loads. + +When you expect higher than usual traffic on your Aiven services, follow these recommendations and best practices. + :::tip If your services are already experiencing high load, under-performing or @@ -20,11 +19,11 @@ load](https://help.aiven.io/en/articles/4660372-reacting-to-high-load). To receive notifications about the service health, you can set the appropriate emails in [Aiven Console](https://console.aiven.io/): -1. Go to your project, and select **Settings** from the sidebar. -1. In the **Settings** page, include relevant email addresses in the - **Technical Emails** section. +1. Go to your project, and select **Settings** from the sidebar. +1. In the **Settings** page, include relevant email addresses in the + **Technical Emails** section. -The specified email addressees will receive notifications related to +The specified email addresses will receive notifications related to plan size change, performance, outages and upcoming maintenance. :::warning @@ -51,11 +50,8 @@ updates on incidents directly from ## Monitor the services - -It's difficult to prepare for high load if the usual load is not -monitored. Check out how to setup adequate monitoring for your needs in -[Monitoring services](monitoring-services). - +Monitoring helps you prepare for high load. Check out how to setup adequate monitoring +for your needs in [Monitoring services](/docs/platform/howto/monitoring-services). ## Modify the service plan @@ -71,7 +67,7 @@ recommended to schedule backups outside of peak traffic hours. To configure the daily backup time in **Aiven for PostgreSQL®** and **Aiven for MySQL®** services: -1. Access the `Aiven Console `, select your project and then +1. Access the `Aiven Console `, select your project and choose your service. 1. In the service page, select **Service settings** from the sidebar, and scroll down to the **Advanced configuration** section. @@ -116,5 +112,7 @@ your usage, the better you can weather spikes in traffic. ## Related pages + - [Apache Kafka® and Apache Kafka® Connect best practices](/docs/products/kafka/howto/best-practices) - [PostgreSQL® best practices](/docs/products/postgresql/howto/optimize-pg-slow-queries) + diff --git a/docs/platform/howto/project-support-center.md b/docs/platform/howto/project-support-center.md index 68f7509f..be6fba73 100644 --- a/docs/platform/howto/project-support-center.md +++ b/docs/platform/howto/project-support-center.md @@ -15,7 +15,7 @@ in the [Aiven Community Forum](https://aiven.io/community/forum/). The Aiven service level agreement (SLA) is available on [the SLA page](https://aiven.io/sla). Custom SLAs are available for premium -plans. Contact the sales team at [sales@aiven.io](mailto:sales@aiven.io) for more details. +plans. Contact the [sales team](mailto:sales@aiven.io) for more details. ## Upgrade your support tier {#upgrade-support-tier} @@ -27,20 +27,20 @@ Console](https://console.aiven.io/): 1. In the organization, click **Support**. -2. In the **Current support tier** section, click **Upgrade to +1. In the **Current support tier** section, click **Upgrade to Enterprise**. -3. Choose the support tier you want to upgrade to and click **Choose +1. Choose the support tier you want to upgrade to and click **Choose tier**. -4. Select a **Start date**. +1. Select a **Start date**. :::note If you select the current month, you will be charged a percentage of the total service spend for the whole month, starting from the first. ::: -5. Select a **Billing group**. +1. Select a **Billing group**. :::important The support costs for all current and future services in the @@ -48,7 +48,7 @@ Console](https://console.aiven.io/): added to the invoice for this billing group. ::: -6. Click **Upgrade tier**. +1. Click **Upgrade tier**. It typically takes 1-2 business days to set up the new support tier. You can view the status of your request on the support page under **Current @@ -59,16 +59,16 @@ support tier**. 1. In the [Aiven Console](https://console.aiven.io/), click **Support**. -2. Click **Go to Aiven Support Center**. +1. Click **Go to Aiven Support Center**. -3. Click **Create ticket**. +1. Click **Create ticket**. -4. Enter email addresses to CC in the support ticket. All new comments +1. Enter email addresses to CC in the support ticket. All new comments and updates will be sent to these emails. -5. Enter a **Subject**. +1. Enter a **Subject**. -6. Select a **Severity** level: +1. Select a **Severity** level: - Low: The primary functions are working, but some secondary functionality is not working. @@ -77,12 +77,12 @@ support tier**. - Critical: The primary functions are not working and it's not possible to find workarounds. -7. Optional: Enter the ID of the affected projects and services. +1. Optional: Enter the ID of the affected projects and services. -8. Select the affected **Product** and the reason for creating the +1. Select the affected **Product** and the reason for creating the ticket. -9. Enter a detailed **Description** of the issue. +1. Enter a detailed **Description** of the issue. :::note Include the following information in the description to help the @@ -95,7 +95,7 @@ support tier**. - Any languages or frameworks you are using ::: -10. Optional: Upload files such as screenshots, logs, or +1. Optional: Upload files such as screenshots, logs, or [HAR files](#create-har-files). :::important @@ -104,7 +104,7 @@ support tier**. in files that you attach to a support ticket. ::: -11. Click **Create ticket**. +1. Click **Create ticket**. You can track the status of your tickets on the **My tickets** page. [Response times](https://aiven.io/support-services) vary by case @@ -119,10 +119,10 @@ tickets in your organization contact your account team. To add Aiven users to a support ticket: 1. On the **My tickets** page, open the ticket. -2. Click **Add to conversation**. -3. Add the email addresses in the **CC** field separated by a space. +1. Click **Add to conversation**. +1. Add the email addresses in the **CC** field separated by a space. This must be the same email address they use to log in. -4. Enter a comment and click **Submit**. +1. Enter a comment and click **Submit**. ## Get notifications for all support tickets @@ -130,7 +130,7 @@ Super admin can get notifications for updates on all tickets in their organization. 1. Click **My tickets**. -2. On the **Tickets in my organization** tab, click **Follow all +1. On the **Tickets in my organization** tab, click **Follow all tickets**. You will get email notifications for all updates on both existing and @@ -151,13 +151,12 @@ If the support team asks for a HAR file: and Chrome](https://toolbox.googleapps.com/apps/har_analyzer/). - For Safari, make sure you can access the [developer tools](https://support.apple.com/en-ie/guide/safari/sfri20948/mac) - and then follow the instructions for [exporting a HAR - file](https://webkit.org/web-inspector/network-tab/). -2. Replace sensitive data in the file with placeholders while retaining + and [export the HAR file](https://webkit.org/web-inspector/network-tab/). +1. Replace sensitive data in the file with placeholders while retaining the JSON structure and format. Examples of sensitive data include: - Personal identifiers such as email addresses and phone numbers - Authentication tokens or passwords - Sensitive URLs - Sensitive cookies or headers -3. Send the sanitized file to the support team in your reply to their +1. Send the sanitized file to the support team in your reply to their email or in the ticket's comments. diff --git a/docs/platform/howto/rename-a-service.md b/docs/platform/howto/rename-a-service.md index 243f0f2b..8a456cee 100644 --- a/docs/platform/howto/rename-a-service.md +++ b/docs/platform/howto/rename-a-service.md @@ -3,12 +3,11 @@ title: Rename a service --- Currently Aiven **does not support renaming** existing service. The -service name can only be set when creating the service and can\'t be +service name can only be set when creating the service and can't be updated. -If you need to have your service running under a different name, the -best option is to -[create a service fork](/docs/platform/howto/console-fork-service) and to point clients to the new service. +To rename a service, +[create a service fork](/docs/platform/howto/console-fork-service) and point clients to the new service. :::warning After creating a fork, writes to the original service are not synced. @@ -16,7 +15,6 @@ Therefore, to provide a consistency between the original service and the fork, service writes should be stopped before forking. ::: -:::note[See also] -Learn more -[about service forking](/docs/platform/concepts/service-forking). -::: +## Related pages + +- [About service forking](/docs/platform/concepts/service-forking). diff --git a/docs/platform/howto/saml/add-identity-providers.md b/docs/platform/howto/saml/add-identity-providers.md index b5127888..aea59b8b 100644 --- a/docs/platform/howto/saml/add-identity-providers.md +++ b/docs/platform/howto/saml/add-identity-providers.md @@ -20,8 +20,8 @@ To set up single sign-on through an IdP for your organization: 1. Click **Identity providers**. 1. Click **Add identity provider**. 1. Select an IdP and enter a name. -1. On the **Configuration** step are two parameters that you need to - set up the SAML authentication in your IdP: +1. On the **Configuration** step, set up the following parameters to configure the SAML + authentication in your IdP: - Metadata URL - ACS URL diff --git a/docs/platform/howto/saml/add-okta-idp.md b/docs/platform/howto/saml/add-okta-idp.md index 4a1a7c61..951f9392 100644 --- a/docs/platform/howto/saml/add-okta-idp.md +++ b/docs/platform/howto/saml/add-okta-idp.md @@ -2,8 +2,7 @@ title: Add Okta as an identity provider --- -Use [Okta](https://www.okta.com/) to give your organization users single -sign-on (SSO) access to Aiven. +Use [Okta](https://www.okta.com/) to give your organization users single sign-on (SSO) access to Aiven. ## Prerequisite steps in Aiven Console @@ -12,23 +11,16 @@ Add Okta as an ## Configure SAML on Okta {#configure-saml-okta} -This is a two step process. First, you create the SAML SP-Initiated -authentication flow and then you create a bookmark app that will -redirect to the Aiven Console's login page. +Create the SAML SP-Initiated authentication flow and create a bookmark app that will +redirect to the Aiven Console's login page: 1. Log in to the [Okta administrator console](https://login.okta.com/). - -2. Go to the **Applications** tab. - -3. Click **Create a new app integration**. - -4. Select **SAML 2.0** for the **Sign on method**, then click **Next**. - -5. Enter a name for the app and add a logo. - -6. Set it's visibility for your Okta users and click **Next**. - -7. Set the following values in the app configuration: +1. Go to the **Applications** tab. +1. Click **Create a new app integration**. +1. Select **SAML 1.0** for the **Sign on method** and click **Next**. +1. Enter a name for the app and add a logo. +1. Set its visibility for your Okta users and click **Next**. +1. Set the following values in the app configuration: | Parameter | Value | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -41,28 +33,28 @@ redirect to the Aiven Console's login page. fundamental for IdP initiated sign on to function correctly. ::: -8. Add an entry to **Attribute statements** with: +1. Add an entry to **Attribute statements** with: | Parameter | Value | | --------- | ------------ | | `name` | `email` | | `value` | `user.email` | -9. Click **Next** and then click **Finish**. You are redirected to your +1. Click **Next** and click **Finish**. You are redirected to your application in Okta. -10. Click the **View Setup Instructions** for the application. +1. Click the **View Setup Instructions** for the application. -11. Go to the **Sign On** tab and copy the application data to be used +1. Go to the **Sign On** tab and copy the application data to be used in the final configuration in Aiven: - `Identity Provider Signle Sign-On URL` - `Identity Provider Issuer` - `X.509 Certificate` -12. Go to the **Assignments** tab. +1. Go to the **Assignments** tab. -13. Click **Assign** to assign users or groups to the Okta application. +1. Click **Assign** to assign users or groups to the Okta application. :::note New users need to be assigned to the Aiven application in Okta for the @@ -80,22 +72,25 @@ Go back to the Aiven Console to When launching the Aiven SAML application, you get the following error: - Authentication Failed +```text +Authentication Failed +Login failed. Please contact your account administrator for more details. +``` - Login failed. Please contact your account administrator for more details. - -Check that **IdP initiated login** is enabled. +Ensure **IdP initiated login** is enabled. ### Invalid `RelayState` -If you get the `Invalid RelayState` error, then you are attempting an +The `Invalid RelayState` error means you are attempting an IdP-initiated auth flow. This happens, for example, when you click the -Aiven SAML app in Okta. Set the `Default RelayState` in Okta to the +Aiven SAML app in Okta. + +Set the `Default RelayState` in Okta to the corresponding console of your account as defined in the **Configure SAML on Okta** section. ### The Okta password does not work Make sure to use the **Account Link URL** to add the Okta IdP to your -Aiven user account. You can see a list of authentication methods in -**User information** \> **Authentication**. +Aiven user account. You can list the authentication methods in +**User information** > **Authentication**. diff --git a/docs/platform/howto/scale-services.md b/docs/platform/howto/scale-services.md index 3ac61f34..15256432 100644 --- a/docs/platform/howto/scale-services.md +++ b/docs/platform/howto/scale-services.md @@ -2,13 +2,10 @@ title: Scale your service --- -When creating a new Aiven service, you are not tied to a plan. Your -services can be adjusted to better match your needs. Services can be -moved to a higher or lower plan, and to a different tier---Startup, -Business or Premium. +When creating a new Aiven service, you are not tied to a plan. Your services can be adjusted to better match your needs. Services can be moved to a higher or lower plan, and to a different tier. 1. Log into the [Aiven Console](https://console.aiven.io/), select your - project and then select the service you want to scale. + project and select the service you want to scale. 2. On the service page, click **Service settings** from the sidebar. 3. In the **Service plan** section, click **Actions (\...)**. 4. From the dropdown menu, click **Change plan**. @@ -16,11 +13,12 @@ Business or Premium. and tier, if required. 6. Click **Change**. -Your service is in the *Rebuilding* state. Once the rebuilding is over, +Your service is in the **Rebuilding** state. Once the rebuilding is over, your new service plan will be active on your service. The service is still accessible through the plan-change process. :::note + - You can also use the [dedicated service update function](/docs/tools/cli/service-cli#avn-cli-service-update) to scale your service plan via the [Aiven CLI](/docs/tools/cli). @@ -29,4 +27,5 @@ still accessible through the plan-change process. example, when switching from `Startup-4` to `Business-4` or from `Business-4` to `Startup-4`, include all the additional disks available for this service. + ::: diff --git a/docs/platform/howto/static-ip-addresses.md b/docs/platform/howto/static-ip-addresses.md index d6f09523..390f00e1 100644 --- a/docs/platform/howto/static-ip-addresses.md +++ b/docs/platform/howto/static-ip-addresses.md @@ -32,7 +32,7 @@ addresses needed, depending on the size of your service plan. Create a static IP addresses using the [Aiven CLI](/docs/tools/cli), repeat as many times as -you need to create enough IP addresses for your service. Specify the +needed to create enough IP addresses for your service. Specify the name of the cloud that the IP address should be created in, to match the service that will use it. diff --git a/docs/platform/howto/tag-resources.md b/docs/platform/howto/tag-resources.md index d8765f43..8f441cd8 100644 --- a/docs/platform/howto/tag-resources.md +++ b/docs/platform/howto/tag-resources.md @@ -26,7 +26,7 @@ duplicated. To work with tags, you can use the following: - [Aiven Console](https://console.aiven.io/) -- Aiven client: Aiven-client version 2.14.0 or later is required for +- Aiven client: Aiven-client version 1.11.0 or later is required for tagging support. - APIs (for example, [ProjectUpdate](https://api.aiven.io/doc/#tag/Project/operation/ProjectUpdate)) @@ -42,15 +42,15 @@ You can add the following types of tags to projects: - Project tags - returned for resources in the API and displayed in the list of projects -To add tags to a project, take the following steps: +To add tags to a project: 1. Log in to [Aiven Console](https://console.aiven.io/) and select your organization and your project from the top navigation bar. -2. On the project's page, select **Settings** from the sidebar. -3. On the **Settings** page, click **Add tag** and enter a key and its +1. On the project's page, select **Settings** from the sidebar. +1. On the **Settings** page, click **Add tag** and enter a key and its value in the **Billing Reference Tags** or **Project Tags** fields, and select the **+** icon to add more tags in the same manner. -4. Select **Save changes** to save all of your tags. +1. Select **Save changes** to save your tags. You can see the tags listed in the table on the **Projects** page. @@ -60,15 +60,15 @@ To add tags to a service, follow these steps: 1. Log in to the [Aiven Console](https://console.aiven.io/) and select your organization and your project from the top navigation bar. -2. On the **Services** page of your project, select the service you +1. On the **Services** page of your project, select the service you wish to tag. -3. On the service page, select **Service settings** from the sidebar. -4. In the **Service status** section, click **Actions (\...)**, then +1. On the service page, select **Service settings** from the sidebar. +1. In the **Service status** section, click **Actions (\...)**, then click **Add service tags** from the dropdown menu. -5. In the **Tag this service** dialog, enter a key and its value in the +1. In the **Tag this service** dialog, enter a key and its value in the **Service Tags** fields. -6. Click **Add tag** to add additional tags. -7. Click **Save changes** to apply the tags. +1. Click **Add tag** to add additional tags. +1. Click **Save changes** to apply the tags. You can see the tags listed in the table on the **Projects** page. @@ -78,19 +78,19 @@ You can see the tags listed in the table on the **Projects** page. - Add new tags to a service: - ``` + ```bash avn service tags update your-service --add-tag business_unit=sales --add-tag env=smoke_test ``` - Modify or remove tags: - ``` + ```bash avn service tags update your-service --add-tag env=production --remove-tag business_unit ``` - List service tags: - ``` + ```bash avn service tags list your-service KEY VALUE === ========== @@ -99,7 +99,7 @@ You can see the tags listed in the table on the **Projects** page. - Replace tags with a set of new ones, removing the old ones: - ``` + ```bash avn service tags replace your-service --tag cost_center=U1345 avn service tags list your-service @@ -115,20 +115,21 @@ too, and work the same way: - Add tags to a project: - ``` + ```bash avn project tags update --project your-project --add-tag business_unit=sales ``` - Replace project tags: - ``` + ```bash avn project tags replace --project your-project --tag env=smoke_test ``` - List project tags: - ``` + ```bash avn project tags list + KEY VALUE === ========== env smoke_test diff --git a/docs/platform/howto/use-aws-privatelinks.md b/docs/platform/howto/use-aws-privatelinks.md index c935c8b2..36da74ed 100644 --- a/docs/platform/howto/use-aws-privatelinks.md +++ b/docs/platform/howto/use-aws-privatelinks.md @@ -21,7 +21,7 @@ private IP range for the VPC, unless you also want to connect to the project VPC using VPC peering connections. This means that overlaps in the IP range are not an issue. -To set up AWS PrivateLink, you need to use the +To set up AWS PrivateLink, use the [Aiven CLI](/docs/tools/cli). You also need the AWS console or CLI to create a VPC endpoint. @@ -60,7 +60,7 @@ currently support AWS PrivateLink. state changes to `active` and the `aws_service_id` and `aws_service_name` values are set. -2. In the AWS CLI, run the following command to create a VPC endpoint: +1. In the AWS CLI, run the following command to create a VPC endpoint: ```bash aws ec2 --region eu-west-1 create-vpc-endpoint --vpc-endpoint-type Interface --vpc-id $your_vpc_id --subnet-ids $space_separated_list_of_subnet_ids --security-group-ids $security_group_ids --service-name com.amazonaws.vpce.eu-west-1.vpce-svc-0b16e88f3b706aaf1 @@ -99,7 +99,7 @@ currently support AWS PrivateLink. changes to `available` , the connection is visible in Aiven. ::: -3. Enable PrivateLink access for Aiven service components: +1. Enable PrivateLink access for Aiven service components: You can control each service component separately - for example, you can enable PrivateLink access for Kafka while allowing Kafka Connect @@ -121,11 +121,11 @@ currently support AWS PrivateLink. 1. On the **Overview** page of your service, select **Service settings** from the sidebar. - 2. On the **Service settings** page, navigate to the **Cloud + 1. On the **Service settings** page, navigate to the **Cloud and network** section and select **More network configurations** from the actions (**\...**) menu. - 3. In the **Network configuration** window, select **Add + 1. In the **Network configuration** window, select **Add configuration options**. In the search field, enter `privatelink_access`. From the displayed component names, select the names of the components that you want to switch @@ -133,7 +133,7 @@ currently support AWS PrivateLink. ![Aiven Console private link configuration](/images/platform/howto/use-aws-privatelink_image1.png) - 4. Select the toggle switches for the selected components to + 1. Select the toggle switches for the selected components to switch them on. Select **Save configuration**. It takes a couple of minutes before connectivity is available after @@ -181,13 +181,13 @@ PrivateLink, run the avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID ``` -:::note[Where] +Where: + - UTILITY_NAME for Aiven for Apache Kafka®, for example, can be `kcat`. - SERVICE_NAME for Aiven for Apache Kafka®, for example, can be `kafka-12a3b4c5`. - PRIVATELINK_CONNECTION_ID can be `plc39413abcdef`. -::: - For SASL connection information for Aiven for Apache Kafka® service components using AWS PrivateLink, run the following command: @@ -196,13 +196,13 @@ PrivateLink, run the avn service connection-info UTILITY_NAME SERVICE_NAME --privatelink-connection-id PRIVATELINK_CONNECTION_ID -a sasl ``` -:::note[Where] +Where: + - UTILITY_NAME for Aiven for Apache Kafka®, for example, can be `kcat`. - SERVICE_NAME for Aiven for Apache Kafka®, for example, can be `kafka-12a3b4c5`. - PRIVATELINK_CONNECTION_ID can be `plc39413abcdef`. -::: :::note SSL certificates and SASL credentials are the same for all the @@ -228,12 +228,12 @@ allowed to connect a VPC endpoint: - In [Aiven Console](https://console.aiven.io): 1. Select your service from the **Services** page. - 2. On the **Overview** page, select **Service settings** from the + 1. On the **Overview** page, select **Service settings** from the sidebar. - 3. On the **Service settings** page, navigate to the **Cloud and + 1. On the **Service settings** page, navigate to the **Cloud and network** section and select **Edit AWS PrivateLink** from the - actions (**\...**) menu. - 4. In the **Edit AWS PrivateLink** window, enter the principals + actions (**...**) menu. + 1. In the **Edit AWS PrivateLink** window, enter the principals that you want to include in the **Principal ARNs** field and select **Save** . @@ -254,11 +254,11 @@ allowed to connect a VPC endpoint: - Using [Aiven Console](https://console.aiven.io): 1. Select your service from the **Services** page. - 2. On the **Overview** page, select **Service settings** from the + 1. On the **Overview** page, select **Service settings** from the sidebar. - 3. On the **Service settings** page, navigate to the **Cloud and + 1. On the **Service settings** page, navigate to the **Cloud and network** section and select **Delete AWS PrivateLink** from the actions (**\...**) menu. - 4. In the **Confirmation** window, select **Delete** . + 1. In the **Confirmation** window, select **Delete** . This deletes the AWS load balancer and VPC service endpoint. diff --git a/docs/platform/howto/use-google-private-service-connect.md b/docs/platform/howto/use-google-private-service-connect.md index c8af6872..3556fea4 100644 --- a/docs/platform/howto/use-google-private-service-connect.md +++ b/docs/platform/howto/use-google-private-service-connect.md @@ -28,7 +28,7 @@ region where the connecting endpoint will be created. :::note Private Service Connect endpoints are service specific. For each service -you wish to connect to, you need to create a separate endpoint. +you wish to connect to, create a separate endpoint. ::: ## Set up a Private Service Connect connection @@ -183,7 +183,7 @@ The state of your Private Service Connect endpoint should have transitioned from `pending` to `accepted` at this point. Private Service Connect connectivity has been established now. -As the final step, you need to allow connectivity using the Private +As the final step, allow connectivity using the Private Service Connect endpoint. ### Step 4: Enable Private Link access service components diff --git a/docs/platform/howto/user-2fa.md b/docs/platform/howto/user-2fa.md index e3e03cd7..2cd7a91d 100644 --- a/docs/platform/howto/user-2fa.md +++ b/docs/platform/howto/user-2fa.md @@ -17,12 +17,12 @@ Console](https://console.aiven.io/): 1. Click the **User information** icon in the top right and select **Authentication**. -2. On the **Aiven Password** method, toggle on **Two-factor +1. On the **Aiven Password** method, toggle on **Two-factor authentication**. -3. Enter your password and click **Next**. +1. Enter your password and click **Next**. -4. On your mobile device, open your authenticator app and scan the QR +1. On your mobile device, open your authenticator app and scan the QR code shown in Aiven Console. :::note @@ -30,14 +30,14 @@ Console](https://console.aiven.io/): into your authenticator app. ::: -5. Enter the code from the authenticator app in the **Confirmation +1. Enter the code from the authenticator app in the **Confirmation code** field in Aiven Console. -6. Click **Enable**. +1. Click **Enable**. -If you want to change the mobile device that you use for two-factor -authentication, you need to first -[disable two-factor authentication](/docs/platform/howto/user-2fa#disable-2fa) and then enable it on the new device. +To change the mobile device that you use for two-factor +authentication and [disable two-factor authentication](/docs/platform/howto/user-2fa#disable-2fa) +and enable it on the new device. ## Disable two-factor authentication {#disable-2fa} @@ -45,10 +45,9 @@ To disable two-factor authentication on the Aiven Console: 1. Click the **User information** icon in the top right and select **Authentication**. -2. On the **Aiven Password** method, toggle off **Two-factor +1. On the **Aiven Password** method, toggle off **Two-factor authentication**. -3. Enter your password and click **Disable Two-Factor Authentication**. - +1. Enter your password and click **Disable Two-Factor Authentication**. ## Reset two-factor authentication @@ -56,9 +55,9 @@ If you have lost access to your mobile device or authenticator app, you can regain access to your account by resetting your Aiven password: 1. Log out of Aiven Console. -2. Enter your login email and click **Log in**. -3. Click **Forgot password?**. -4. Enter your login email and click **Reset your password**. -5. Follow the instructions in the password reset email to set a new +1. Enter your login email and click **Log in**. +1. Click **Forgot password?**. +1. Enter your login email and click **Reset your password**. +1. Follow the instructions in the password reset email to set a new password. -6. [Enable two-factor authentication](/docs/platform/howto/user-2fa#enable-2fa) on your new mobile device or authenticator app. +1. [Enable two-factor authentication](/docs/platform/howto/user-2fa#enable-2fa) on your new mobile device or authenticator app. diff --git a/docs/platform/howto/vnet-peering-azure.md b/docs/platform/howto/vnet-peering-azure.md index b876b60e..13674fe6 100644 --- a/docs/platform/howto/vnet-peering-azure.md +++ b/docs/platform/howto/vnet-peering-azure.md @@ -230,9 +230,10 @@ in order for the Aiven application object to authenticate with your tenant to give it access to the service principal created in step 7 ( `--peer-azure-tenant-id $user_tenant_id` ). -| `$aiven_project_vpc_id` is the ID of the Aiven Project VPC, and can be - found with `avn vpc list` -| Using the Aiven CLI: +`$aiven_project_vpc_id` is the ID of the Aiven Project VPC, and can be +found with `avn vpc list` + +Using the Aiven CLI: ``` avn vpc peering-connection create --project-vpc-id $aiven_project_vpc_id --peer-cloud-account $user_subscription_id --peer-resource-group $user_resource_group --peer-vpc $user_vnet_name --peer-azure-app-id $user_app_id --peer-azure-tenant-id $user_tenant_id @@ -252,15 +253,16 @@ Run the following command until the state is no longer `APPROVED` , but avn vpc peering-connection get -v --project-vpc-id $aiven_project_vpc_id --peer-cloud-account $user_subscription_id --peer-resource-group $user_resource_group --peer-vpc $user_vnet_name ``` -| A state such as `INVALID_SPECIFICATION` or `REJECTED_BY_PEER` may be - shown if the VNet specified in the previous step did not exist, or the - Aiven app object wasn\'t given permissions to peer with it. If that - occurs, check your configuration and then recreate the peering - connection in step 12 -| If everything went as expected, the state changes to `PENDING_PEER` - within a couple of minutes showing details to set up the peering - connection from your VNet to the Project VPC's VNet in the Aiven - subscription. +A state such as `INVALID_SPECIFICATION` or `REJECTED_BY_PEER` may be +shown if the VNet specified in the previous step did not exist, or the +Aiven app object wasn't given permissions to peer with it. If that +occurs, check your configuration and recreate the peering +connection in step 12. + +If everything went as expected, the state changes to `PENDING_PEER` +within a couple of minutes showing details to set up the peering +connection from your VNet to the Project VPC's VNet in the Aiven +subscription. Save the `to-tenant-id` field from the output. It will be referred to as the `aiven_tenant_id` later. The `to-network-id` field from the output diff --git a/docs/platform/howto/vpc-peering-gcp.md b/docs/platform/howto/vpc-peering-gcp.md index 5da3c38f..30a08fe7 100644 --- a/docs/platform/howto/vpc-peering-gcp.md +++ b/docs/platform/howto/vpc-peering-gcp.md @@ -2,26 +2,24 @@ title: Set up Virtual Private Cloud (VPC) peering on Google Cloud Platform (GCP) --- -Once you\'ve created a -[VPC on the Aiven platform](manage-vpc-peering), you can follow these instructions to set up VPC peering on -GCP. +Once you've created a [VPC on the Aiven platform](manage-vpc-peering), you can set up VPC peering on GCP. 1. Open your GCP Console. -2. Select **VPC Networks** and find the VPC that you want to connect +1. Select **VPC Networks** and find the VPC that you want to connect to. -3. Click the project name, and make note of the **Project ID**. +1. Click the project name, and make note of the **Project ID**. -4. Under **VPC Network**, make note of the **VPC Network Name**. +1. Under **VPC Network**, make note of the **VPC Network Name**. -5. In [Aiven Console](https://console.aiven.io), select **VPCs** from +1. In [Aiven Console](https://console.aiven.io), select **VPCs** from the sidebar on the **Services** page. -6. On the **Virtual private clouds** page, select the VPC connection +1. On the **Virtual private clouds** page, select the VPC connection that you created. -7. In the **VPC Peering connections** view, enter the GCP project ID +1. In the **VPC Peering connections** view, enter the GCP project ID (step 3) into the **GCP project ID** field and the exact GCP VPC network name (step 4) into the **GCP VPC network name** field. Next, select **Add peering connection**. @@ -33,17 +31,17 @@ GCP. project ID and the VPC network name. ::: -8. In your GCP Console, go to **VPC** \> **VPC network peering**, and +1. In your GCP Console, go to **VPC** \> **VPC network peering**, and select **Create peering connection**. -9. To create a peering connection, take the following steps: +1. To create a peering connection: 1. Enter a name for the peering connection. 2. Under **Peered VPC network**, select **In another project**. 3. Enter the Aiven project ID and the VPC network name identified in step 7 in Aiven Console. -10. Click **Create**. +1. Click **Create**. When the peering is successful, it is active in both [Aiven Console](https://console.aiven.io) and your GCP Console. diff --git a/docs/platform/howto/vpc-peering-upcloud.md b/docs/platform/howto/vpc-peering-upcloud.md index 2862be60..3c0a3e3e 100644 --- a/docs/platform/howto/vpc-peering-upcloud.md +++ b/docs/platform/howto/vpc-peering-upcloud.md @@ -14,10 +14,10 @@ on both ends: Aiven and UpCloud. - To set up a peering from Aiven to UpCloud, you can use [Aiven Console](https://console.aiven.io/) to create a VPC for your Aiven project and add a peering connection to UpCloud. For this purpose, - you need to identify the UpCloud SDN network UUID first. + identify the UpCloud SDN network UUID first. - To set up a peering from UpCloud to Aiven, you can use [UpCloud API](https://developers.upcloud.com/1.3/). Since the API takes UUIDs - of both networks as attributes, you need to identify the network + of both networks as attributes, identify the network UUIDs before calling the API. ## Limitations @@ -152,7 +152,7 @@ HTTP/1.1 201 Created ## Renew a DHCP lease You only need to take this step if any of your VMs has been created -before setting up the network peering. In that case, you need to refresh +before setting up the network peering. In this case, refresh the Dynamic Host Configuration Protocol (DHCP) lease for a relevant network interface to get new routes. diff --git a/docs/platform/reference/eol-for-major-versions.md b/docs/platform/reference/eol-for-major-versions.md index e37360ec..d0879005 100644 --- a/docs/platform/reference/eol-for-major-versions.md +++ b/docs/platform/reference/eol-for-major-versions.md @@ -133,7 +133,9 @@ When Aiven sets the EOL date for a service major version: - In the month of the EOL date, the weekly reminders are sent to customers. + ### EOL best practices + It's highly recommended to perform the version upgrade well before EOL so that you can test the compatibility for any breaking changes, plan diff --git a/docs/platform/reference/service-ip-address.md b/docs/platform/reference/service-ip-address.md index 36204934..727b5ef2 100644 --- a/docs/platform/reference/service-ip-address.md +++ b/docs/platform/reference/service-ip-address.md @@ -9,7 +9,7 @@ will dynamically assign one or more public IP address from their connection pool. This IP address is not permanent, and with every service maintenance (in case of failover, maintenance upgrade or cloud migration) the IP address changes since Aiven creates a new node, -migrates the existing data to it and then retire the old node. +migrates the existing data to it and retire the old node. :::note Aiven also offer the ability to define @@ -30,7 +30,7 @@ article](https://docs.aiven.io/docs/platform/howto/manage-vpc-peering). When a new service is being provisioned, its hostname is defined as follows: -``` +```text -.*.aivencloud.com ```