Skip to content

Commit

Permalink
update: Rename Redis to Aiven for Caching (#171)
Browse files Browse the repository at this point in the history
Signed-off-by: Harshini Rangaswamy <108724024+harshini-rangaswamy@users.noreply.github.com>
Signed-off-by: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com>
Signed-off-by: dorota <114921900+wojcik-dorota@users.noreply.github.com>
Co-authored-by: Aris Tritas <113912678+aris-aiven@users.noreply.github.com>
Co-authored-by: Stacey Salamon <111294980+staceysalamon-aiven@users.noreply.github.com>
Co-authored-by: ArthurFlageul <arthur.flageul-marquez@aiven.io>
Co-authored-by: dorota <114921900+wojcik-dorota@users.noreply.github.com>
Co-authored-by: Prabhjot Singh <prabnz@gmail.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: GitHub <noreply@github.com>
  • Loading branch information
8 people authored May 27, 2024
1 parent b2215c1 commit e317277
Show file tree
Hide file tree
Showing 81 changed files with 21,944 additions and 3,186 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ level: error
scope: text
ignorecase: false

first: '\b(Redis)(?!®\*)'
second: '(Redis)(?:®\*)'
first: '\b(Caching)(?!®)'
second: '(Caching)(?:®)'
1 change: 1 addition & 0 deletions .github/vale/styles/config/vocabularies/Aiven/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ Grafana
Grafana/M
GSuite
hardcoded
HAProxy
HashiCorp
Heatmap
Hillyer
Expand Down
6 changes: 3 additions & 3 deletions docs/platform/concepts/free-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: Free plans
---

The free plan is available for Aiven for PostgreSQL®, Aiven for MySQL,
and Aiven for Redis®\* services. You don't need a credit card to sign
and Aiven for Caching® 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.
create one free PostgreSQL, one free MySQL, and one free Caching® service.

To try a different service, you may want to consider a
30-day
Expand All @@ -27,7 +27,7 @@ Free plans include:
- 1 CPU per virtual machine
- 1 GB RAM
- For PostgreSQL and MySQL: 5 GB disk storage
- For Redis: `maxmemory` set to 50%
- For Caching: `maxmemory` set to 50%
- Management via our web console, CLI, API, Terraform provider, or
Kubernetes® operator
- Monitoring for metrics and logs
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/maintenance-window.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,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.

For **MySQL®**, **PostgreSQL®** and **Redis®**\*, the maintenance
For **MySQL®**, **PostgreSQL®** and **Caching®**, 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
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/concepts/service-forking.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You can fork the following Aiven services:

- PostgreSQL®
- MySQL
- Redis®\*
- Caching®
- Apache Cassandra® (Limitation: you cannot fork to a lower amount of
nodes)
- Elasticsearch
Expand Down
12 changes: 6 additions & 6 deletions docs/platform/concepts/service_backups.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ backups with the appropriate tooling:
`pgdump`
- [MySQL®](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html):
`mysqldump`
- [Redis®\*](https://redis.io/docs/connect/cli/#remote-backups-of-rdb-files):
- [Caching®](https://redis.io/docs/connect/cli/#remote-backups-of-rdb-files):
`redis-cli`
- [Cassandra®](https://docs.datastax.com/en/archived/cql/3.3/cql/cql_reference/cqlshCopy.html)
`cqlsh`
Expand Down Expand Up @@ -115,7 +115,7 @@ data.
<td>Single day backup</td>
</tr>
<tr>
<td>Aiven for Redis®*</td>
<td>Aiven for Caching®</td>
<td>Single backup only for disaster recovery</td>
<td>Backup every 12 hours up to 1 day</td>
<td>Backup every 12 hours up to 3 days</td>
Expand Down Expand Up @@ -268,17 +268,17 @@ point-in-time recovery (PITR) feature is currently not available.
To be notified once the PITR feature is available for Cassandra, contact the Aiven support.
:::

### Aiven for Redis™\*
### Aiven for Caching®

Aiven for Redis backups are taken every 12 hours.
Aiven for Caching® backups are taken every 12 hours.

For persistence, Aiven supports Redis Database Backup (RDB).

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
- When `redis_persistence` is set to `rdb`, Aiven for Caching 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,
Expand All @@ -288,7 +288,7 @@ You can control the persistence feature using `redis_persistence` under

:::note
AOF persistence is currently not supported by Aiven for the managed
Redis service.
Aiven for Caching® service.
:::

### Aiven for ClickHouse®
Expand Down
18 changes: 8 additions & 10 deletions docs/platform/howto/integrations/prometheus-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ 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
the dropdown list.
**Projects** in the top navigation bar, and select your project.
1. On the **Services** page, select **Integration endpoints** from the
left sidebar.
1. On the **Integration endpoints** page, select **Prometheus** from
Expand All @@ -44,8 +43,7 @@ Aiven offers Prometheus endpoints for your services. To enable this
feature:

1. Log in to [Aiven Console](https://console.aiven.io/), go to
**Projects** in the top navigation bar, and select your project from
the dropdown list.
**Projects** in the top navigation bar, and select your project.

1. On the **Services** page, select **Integration endpoints** from the
left sidebar.
Expand All @@ -66,7 +64,7 @@ feature:
1. On the **Integrations** page, select **Prometheus**.

1. In the **Prometheus integration** window, select the endpoint name
you created from the dropdown list, and select **Enable**.
you created, and select **Enable**.

:::note
At the top of the **Integrations** page, you will see the Prometheus
Expand Down Expand Up @@ -95,7 +93,7 @@ If you use a VPC in your project, follow these steps to access
Prometheus:

1. Access [Aiven Console](https://console.aiven.io/).
1. Select your project, and select the service you want to monitor
1. Select your project, and select the service to monitor
using Prometheus.
1. Click **Service settings** from the sidebar.
1. In the **Cloud and network** section, click the actions
Expand All @@ -109,7 +107,7 @@ Prometheus:
## Configure Prometheus

After enabling Prometheus on your project, add a scrape configuration to
Prometheus for the servers you want to pull data from. The examples in
Prometheus for the servers to pull data from. The examples in
this section show how to set up the scrape configuration for both
single-node and multi-node services.

Expand All @@ -119,11 +117,11 @@ For single-node services, configure the following in your
`scrape_config` job entry in `prometheus.yml`:

- `basic_auth` details: Check your service's the **Overview** page >
the **Connection information** section > the **Prometheus** tab).
the **Connection information** section > the **Prometheus** tab.

- `PROMETHEUS_SERVICE_URI`: Check **Service URI** on your service's
the **Overview** page > the **Connection information** section >
the **Prometheus** tab).
the **Prometheus** tab.

- `ca_file`: Download the CA certificate from your service's the
**Overview** page, and specify its location (the certificates are
Expand Down Expand Up @@ -192,7 +190,7 @@ your service.
sure to include the replica DNS names in the list. If you have
`<PROMETHEUS_SERVICE_URI>` as `public-example.aivencloud.com`, then you
will need to add `public-replica-example.aivencloud.com`. This applies
to PostgreSQL®, MySQL®, Apache Kafka®, and Redis®\* services.
to PostgreSQL®, MySQL®, Apache Kafka®, and Caching® services.
:::

### View full list of metrics
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/migrate-services-cloud-region.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ does not affect your service until the service has been rebuilt at the
new region. The migration includes the DNS update for the named service
to point to the new region. Most of the services have usually no service
interruption expected. However, for services like PostgreSQL®, MySQL®,
and Redis®\*, it may cause a short interruption (5 to 10 seconds) in
and Caching®, it may cause a short interruption (5 to 10 seconds) in
service while the DNS changes are propagated.

The short interruption does not include potential
Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/migrate-services-vpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,4 +154,4 @@ the process. Always equip your client applications with failure and
retry logic to adapt to changes in servers and IP addresses. While this
is typically straightforward for clustered services like Apache Kafka®
and OpenSearch®, additional configurations might be necessary for
services like PostgreSQL® and Redis®.
services like PostgreSQL® and Caching®.
2 changes: 1 addition & 1 deletion docs/platform/howto/search-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To filter the services by service type, use these filter values:
| MySQL® | `mysql` |
| OpenSearch® | `opensearch` |
| PostgreSQL® | `pg` |
| Redis®* | `redis` |
| Caching® | `redis` |

### Filter by status

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/howto/use-azure-privatelink.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Azure Private Link is supported for the following services:
- Aiven for MySQL®
- Aiven for OpenSearch®
- Aiven for PostgreSQL®
- Aiven for Redis®\*
- Aiven for Caching®

## Prerequisites

Expand Down
13 changes: 13 additions & 0 deletions docs/products/caching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Aiven for Caching®
---

Aiven for Caching®, formerly known as Aiven for Redis®, is a fully managed in-memory NoSQL database. Deployable in the cloud of your choice, it helps you store and access data efficiently.

For insights into he service name change and the latest updates, read the
[blog post](https://aiven.io/blog/aiven-for-redis-becomes-aiven-for-caching).


import DocCardList from '@theme/DocCardList';

<DocCardList />
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: High availability in Aiven for Redis®*
title: High availability in Aiven for Caching®
---

Aiven for Redis®\* is available on a variety of plans, offering
different levels of high availability. The selected plan defines the
features available, and a summary is provided in the table below:
Explore high availability with Aiven for Caching® across multiple plans. Gain insights into service continuity and understand the approach to handling failures.

Compare Aiven for Caching plans in the table below. Each plan offers unique
configurations and features. Choose what best fits your needs.

| Plan | Node configuration | High availability & Backup features | Backup history |
| ------------ | ---------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
Expand All @@ -14,7 +15,7 @@ features available, and a summary is provided in the table below:
| **Premium** | Three-node (primary + standby + standby) | Enhanced high availability with automatic failover among multiple standby nodes if the primary fails. | Automatic backups to a remote location. |
| **Custom** | Custom configurations | Custom high availability and failover features based on user requirements. | Custom backup features based on user requirements. |

Check out our [Plans & Pricing](https://aiven.io/pricing?product=redis)
Refer to the [Plans & Pricing](https://aiven.io/pricing?product=redis)
page for more information.

## Failure handling
Expand All @@ -34,37 +35,36 @@ page for more information.
replacement node.

:::note
In case of database failover, your service's **Service URI** remains
the same---only the IP address changes to point to the new primary node.
In case of database failover, the **Service URI** remains unchanged, and only the IP address
is updated to point to the new primary node.
:::

## Highly available business, premium, and custom service plans

If a standby Redis node fails, the primary node continues running
If a standby Caching node fails, the primary node continues running
normally, serving client applications without interruption. Once the
replacement standby node is ready and synchronized with the primary, it
begins real-time replication until the system stabilizes.

When the failed node is a Redis primary, the combined information from
When the failed node is a Caching primary, the combined information from
the Aiven monitoring infrastructure and the standby node is used to make
a failover decision. The standby node is promoted as the new primary and
immediately serves clients. A new replacement node is automatically
scheduled and becomes the new standby node.

If both the primary and standby nodes fail simultaneously, new nodes
will be created automatically to take their place as the new primary and
are created automatically to take their place as the new primary and
standby. However, this process involves some degree of data loss since
the primary node is restored from the most recent backup available.
Therefore, any writes made to the database since the last backup will be
lost.
Therefore, any writes made to the database since the last backup is lost.

:::note
The amount of time it takes to replace a failed node depends mainly on
the used **cloud region** and the **amount of data** that needs to be
restored. However, in the case of services with two or more node
Business, Premium and Custom plans the surviving nodes will keep on
serving clients even during the recreation of the other node. All of
this is automatic and requires no administrator intervention.
restored. However, in services with two or more nodes,
such as business, premium, and custom plans, the surviving nodes continue serving
clients even while recreating the other node. This is automatic and
requires no administrator intervention.
:::

## Single-node hobbyist and startup service plans
Expand All @@ -73,6 +73,5 @@ Losing the only node in the service triggers an automatic process of
creating a new replacement node. The new node then restores its state
from the latest available backup and resumes serving customers.

Since there was just a single node providing the service, the service
will be unavailable for the duration of the restore operation. All the
write operations made since the last backup are lost.
During the restore operation, the service is unavailable since there is only
one node providing the service. Any write operations made after the last backup are lost.
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
title: Lua scripts with Aiven for Redis®*
title: Lua scripts with Aiven for Caching®
---

Learn how to leverage the inbuilt support for Lua scripting in Redis®\*
using Aiven.
Learn how to leverage the built-in support for Lua scripting in Aiven for Caching®.

Redis®\* has inbuilt support for running Lua scripts to perform various
Aiven for Caching has inbuilt support for running Lua scripts to perform various
actions directly on the Redis server. Scripting is typically controlled
using the `EVAL`, `EVALSHA` and `SCRIPT LOAD` commands.

For all newly-created Redis instances, `EVAL`, `EVALSHA` and
For all newly created Aiven for Caching instances, `EVAL`, `EVALSHA` and
`SCRIPT LOAD` commands are enabled by default.

:::note
Expand Down
Loading

0 comments on commit e317277

Please sign in to comment.