Skip to content

Commit

Permalink
update: more content updates
Browse files Browse the repository at this point in the history
  • Loading branch information
harshini-rangaswamy committed May 14, 2024
1 parent 1d93ce9 commit 6858ae4
Show file tree
Hide file tree
Showing 21 changed files with 16,557 additions and 55 deletions.
1 change: 0 additions & 1 deletion docs/products/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Aiven for Caching is a fully managed **in-memory NoSQL database**,
deployable in the cloud of your choice which can help you store and
access data efficiently.


import DocCardList from '@theme/DocCardList';

<DocCardList />
4 changes: 2 additions & 2 deletions docs/products/caching/concepts/high-availability-redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ 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
Expand Down
6 changes: 3 additions & 3 deletions docs/products/caching/concepts/memory-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ and the specifics of the Aiven plan.

:::tip
Writing at about 5 megabytes per second is manageable in most situations. However,
attempting to write at about 50 megabytes per second will likely lead to failures,
attempting to write at about 50 megabytes per second is likely lead to failures,
particularly when memory usage approaches the allowed maximum or during the
initialization of a new node.
:::
Expand All @@ -108,8 +108,8 @@ memory the underlying Redis technology can use. For a 28 gigabyte plan, this is
under 2 gigabytes.

If the volume of changes during the 6 minute initial sync exceeds the replication
log size, the new node cannot start following the replication stream and must
undergo another initial sync.
log size, the new node cannot start following the replication stream and undergoes
another initial sync.

:::tip
Writing new changes at 5 megabytes per second, totaling 1.8 gigabytes over 6 minutes,
Expand Down
2 changes: 1 addition & 1 deletion docs/products/caching/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Aiven for Caching overview
---

Aiven for Caching, a fully managed **in-memory NoSQL database**, offers efficient storage and quick data access in your preferred cloud.
Aiven for Caching, a fully managed **in-memory NoSQL database**, offers efficient storage and quick data access in your preferred cloud. Compatible with legacy Redis® OSS, this service facilitates seamless transitions and compatibility.

With Aiven, you can leverage the power of this in-memory database to improve the
performance of your applications by setting up high-performance data caching.
Expand Down
2 changes: 1 addition & 1 deletion docs/products/caching/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ languages or through `redis-cli`:
Learn how estimate the max number of simultaneous connections in
Aiven for Caching service.

- [Lua scripts with Aiven for Caching](/docs/products/caching/concepts/lua-scripts-redis).
- [Lua scripts with Aiven for Caching](/docs/products/caching/concepts/lua-scripts-caching).

Learn about inbuilt support for running Lua scripts in Aiven for
Caching service.
Expand Down
7 changes: 3 additions & 4 deletions docs/products/caching/howto/benchmark-performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,10 @@ different conditions allows for effective performance comparisons
:::note
Aiven has `rate limit` on services. By default it's `200` new
connections per 0.5 second per CPU core. Also be aware of the connection
limit depending on memory size as explained in [Estimate maximum number
of
connection](https://docs.aiven.io/docs/products/redis/howto/estimate-max-number-of-connections.html).
limit depending on memory size as explained in
[Estimate maximum number of connection](/docs/products/caching/howto/benchmark-performance).

Aiven enforces a `rate limit` on services. By default, it's set to `200` new connections
per 0.5 seconds per CPU core. Additionally, consider the connection limit based on memory
size as explained in [Estimate maximum number of connection](/docs/products/redis/howto/estimate-max-number-of-connections).
size as explained in [Estimate maximum number of connection](/docs/products/caching/howto/benchmark-performance).
:::
8 changes: 4 additions & 4 deletions docs/products/caching/howto/configure-acl-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,28 +83,28 @@ Follow these steps for various user management tasks:

1. Click **Users** from the left sidebar.
1. Find the user whose password needs to be reset and
click <ConsoleLabel name="actions"/> > **Reset password**.
Click <ConsoleLabel name="actions"/> > <ConsoleLabel name="reset password"/>.
1. Confirm the password reset by clicking **Reset** on the confirmation dialog.

### Edit ACL rules

1. Click **Users** from the left sidebar.
1. Find the user whose ACL rules require editing and
click <ConsoleLabel name="actions"/> > **Edit ACL rules**.
Click <ConsoleLabel name="actions"/> > <ConsoleLabel name="edit ACL rules"/>.
1. Make the necessary changes to the ACL rules on the **Edit access control** dialog.
1. Click **Save**.

### Duplicate user

1. Click **Users** from the left sidebar.
1. Locate the user you wish to duplicate and
click <ConsoleLabel name="actions"/> > **Duplicate user**.
click <ConsoleLabel name="actions"/> > <ConsoleLabel name="duplicate user"/>.
1. Enter a name for the new user in the **Duplicate user** dialog.
1. Click **Add user**.

### Delete user

1. Click **Users** from the left sidebar.
1. Find the user you intend to delete and
click <ConsoleLabel name="actions"/> > **Delete user**.
click <ConsoleLabel name="actions"/> > <ConsoleLabel name="delete user"/>.
1. Confirm the deletion by clicking **Delete** on the confirmation dialog.
4 changes: 2 additions & 2 deletions docs/products/caching/howto/connect-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ from your service overview page:

| Variable | Description |
| ----------- | ------------------------------------------------------------ |
| `CACHING_URI` | URI for the Aiven for Caching service connection |
| `SERVICE_URI` | URI for the Aiven for Caching service connection |

## Prerequisites

Expand All @@ -41,7 +41,7 @@ Execute the script with:
go run main.go
```

You will see the following output after successful execution:
Successful execution results in the following output:

```plaintext
The value of key is: hello world
Expand Down
8 changes: 4 additions & 4 deletions docs/products/caching/howto/connect-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ from your service overview page:

| Variable | Description |
| ----------- | ------------------------------------------------------------ |
| `CACHING_URI` | URI for the Redis connection, from the service overview page |
| `SERVICE_URI`| URI for the Redis connection, from the service overview page |

## Prerequisites

Expand Down Expand Up @@ -45,12 +45,12 @@ It then retrieves this key from the caching service and outputs its value.
Replace the placeholder with the **CACHING_URI**, compile and run the
code:

```
```bash
javac -cp lib/*:. RedisExample.java && java -cp lib/*:. RedisExample REDIS_URI
```

You will see the following output after successful execution:
Successful execution results in the following output:

```
```plaintext
The value of key is: hello world
```
8 changes: 4 additions & 4 deletions docs/products/caching/howto/connect-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ from your service overview page:

| Variable | Description |
| ----------- | ------------------------------------------------------------ |
| `CACHING_URI`| URI for the Aiven for Caching service connection |
| `SERVICE_URI`| URI for the Aiven for Caching service connection |

## Prerequisites

Expand All @@ -37,12 +37,12 @@ It then retrieves this key from the caching service and outputs its value.

Execute the script with:

```
```bash
node index.js
```

You will see the following output after successful execution:
Successful execution results in the following output:

```
```plaintext
The value of key is: hello world
```
8 changes: 4 additions & 4 deletions docs/products/caching/howto/connect-php.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ from your service overview page:

| Variable | Description |
| ----------- | ------------------------------------------------------------ |
| `CACHING_URI` | URI for the Aiven for Caching service connection |
| `SERVICE_URI` | URI for the Aiven for Caching service connection |

## Prerequisites

Expand All @@ -37,12 +37,12 @@ It then retrieves this key from the caching service and outputs its value.

Execute the script with:

```
```bash
php index.php
```

You will see the following output after successful execution:
Successful execution results in the following output:

```
```plaintext
The value of key is: hello world
```
13 changes: 6 additions & 7 deletions docs/products/caching/howto/connect-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ from your service overview page:

| Variable | Description |
| ----------- | ------------------------------------------------------------ |
| `CACHING_URI` | URI for the Aiven for Caching service connection |
| `SERVICE_URI` | URI for the Aiven for Caching service connection |

## Prerequisites

Expand All @@ -36,18 +36,17 @@ It then retrieves this key from the caching service and outputs its value.

Execute the script with:

```
```bash
python main.py
```

:::note
Note that on some systems you will need to use `python3` to get Python3
rather than the previous Python2
On some systems, using `python3` is necessary to access Python 3 instead of the
earlier Python 2.
:::

Successful execution results in the following output:

You will see the following output after successful execution:

```
```plaintext
The value of key is: hello world
```
10 changes: 5 additions & 5 deletions docs/products/caching/howto/connect-redis-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ from your service overview page:

| Variable | Description |
| ----------- | -------------------------------------------------------- |
| `CACHING_URI` | URI for the Aiven for Caching service connection |
| `SERVICE_URI` | URI for the Aiven for Caching service connection |

## Prerequisites

Expand All @@ -28,7 +28,7 @@ For this example, you will need:
Execute the following command from a terminal window to connect:

```shell
redis-cli -u REDIS_URI
redis-cli -u SERVICE_URI
```

This command initiates a connection to the Aiven for Caching service.
Expand All @@ -53,15 +53,15 @@ redis_mode:standalone

To set a key, execute the following command:

```
```bash
SET mykey mykeyvalue123
```

You should see a confirmation `OK` upon successful execution.
Following successful execution, a confirmation message `OK` appears.

To retrieve the key value, execute the following command:

```
```bash
GET mykey
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Make sure to convert the memory figure `m` to megabytes.

This number is an estimate based on the available memory, so it varies between plans
and cloud providers. To see the exact maximum connections allowed for your
specific service, use the [redis-cli](/docs/products/redis/howto/connect-redis-cli)
specific service, use the [redis-cli](/docs/products/caching/howto/connect-redis-cli)
with the `info` command as follows:

```shell
Expand Down
2 changes: 1 addition & 1 deletion docs/products/caching/howto/migrate-redis-aiven-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ require project VPC and peering connection.

To update an existing service, run:

```
```bash
avn service update --project test -c migration.host="master.jappja-redis.kdrxxz.euw1.cache.amazonaws.com" -c migration.port=6379 -c migration.password=<password> redis
```

Expand Down
11 changes: 7 additions & 4 deletions docs/products/caching/howto/warning-overcommit_memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ When starting a Redis®\* service on [Aiven
console](https://console.aiven.io/), you may notice on **Logs** the
following **warning** `overcommit_memory`:

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

This warning can be safely ignored as Aiven for Redis®\* ensures that
the available memory will never drop low enough to hit this particular
This warning can be safely ignored as Aiven for Caching ensures that
the available memory never drops low enough to hit this particular
failure case.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ things to check:
documentation for the Redis®* client being used to ensure SSL connections
are supported.
- If you notice older connections terminating, check the value configured for the
[redis_timeout advanced parameter](/docs/products/redis/reference/advanced-params).
[redis_timeout advanced parameter](/docs/products/caching/reference/advanced-params).
This parameter controls the timeout value for idle connections. Once the timeout is
reached, the connection is terminated.

Expand Down
2 changes: 1 addition & 1 deletion docs/products/dragonfly/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ languages:
- Learn about how Aiven for Dragonfly supports
[high availability](/docs/products/dragonfly/concepts/ha-dragonfly).
- Migrate data from
[Aiven for Redis®* to Aiven for Dragonfly](/docs/products/dragonfly/howto/migrate-aiven-redis-df-console).
[Aiven for Caching to Aiven for Dragonfly](/docs/products/dragonfly/howto/migrate-aiven-caching-df-console).
- Migrate data from
[external Dragonfly to Aiven for Dragonfly](/docs/products/dragonfly/howto/migrate-ext-redis-df-console).
Original file line number Diff line number Diff line change
Expand Up @@ -131,5 +131,5 @@ with continuous synchronization of new writes from the source database.

## Related pages

- [Aiven for Caching* documentation](/docs/products/redis/get-started)
- [Aiven for Caching* documentation](/docs/products/caching/get-started)
- [Aiven for Dragonfly overview](/docs/products/dragonfly/concepts/overview)
32 changes: 28 additions & 4 deletions src/components/ConsoleIcons/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ export default function ConsoleLabel({name}): ReactElement {
case 'serviceusers':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.people} />{' '}
<b>Users</b>
<ConsoleIconWrapper icon={ConsoleIcons.people} /> <b>Users</b>
</>
);
case 'services':
Expand Down Expand Up @@ -145,8 +144,7 @@ export default function ConsoleLabel({name}): ReactElement {
case 'viewuserprofile':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.user} />{' '}
<b>View profile</b>
<ConsoleIconWrapper icon={ConsoleIcons.user} /> <b>View profile</b>
</>
);
case 'groups':
Expand Down Expand Up @@ -241,6 +239,32 @@ export default function ConsoleLabel({name}): ReactElement {
<ConsoleIconWrapper icon={ConsoleIcons.download} /> <b>Download</b>
</>
);
case 'resetpassword':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.refresh} />{' '}
<b>Reset password</b>
</>
);
case 'editaclrules':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.edit} /> <b>Edit ACL rules </b>
</>
);
case 'duplicateuser':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.duplicate} />{' '}
<b>Duplicate user</b>
</>
);
case 'deleteuser':
return (
<>
<ConsoleIconWrapper icon={ConsoleIcons.trash} /> <b>Delete user</b>
</>
);
default:
return (
<span style={{padding: 2, backgroundColor: 'red', color: '#ffffff'}}>
Expand Down
Loading

0 comments on commit 6858ae4

Please sign in to comment.