Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(AzureRedis): user docs #739

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

docs(AzureRedis): user docs #739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2c20fed
Azure Redis user docs
ijovovic Oct 18, 2024
5eb6eb6
Merge branch 'main' into azure_redis_user_docs
ijovovic Oct 18, 2024
082c7d4
Merge branch 'main' into azure_redis_user_docs
ijovovic Oct 21, 2024
72bc073
remove nonSSL port support
ijovovic Oct 21, 2024
31b9685
Changes required by @tws
ijovovic Oct 21, 2024
7663809
Improve wording.
ijovovic Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions docs/user/resources/04-80-azure-redis-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# AzureRedisInstance Custom Resource
The `AzureRedisInstance.cloud-resources.kyma-project.io` is a namespace-scoped custom resource (CR).
It describes the Azure Cache for Redis instance.
Once the instance is provisioned, a Kubernetes Secret with endpoint and credential details is provided in the same namespace.
By default, the created auth Secret has the same name as AzureRedisInstance.

The current implementation supports the Premium tier, which is explained in detail on the [Azure Cache for Redis overview page](https://azure.microsoft.com/en-us/products/cache).

> [!TIP] _Only for advanced cases of network topology_
>
> Redis requires 2 IP addresses per shard. The Premium tear supports [up to 3 shards.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability)
IP addresses can be configured using the IpRange CR.
To learn more, read [Configure a reserved IP address range](https://cloud.google.com/filestore/docs/creating-instances#configure_a_reserved_ip_address_range).
Those IP addresses are allocated from the [IpRange CR](./04-10-iprange.md).
If an IpRange CR is not specified in the AzureRedisInstance, then the default IpRange is used.
If the default IpRange does not exist, it is automatically created.
Manually create a non-default IpRange with specified Classless Inter-Domain Routing (CIDR) and use it only in advanced cases of network topology when you want to control the network segments to avoid range conflicts with other networks.

When creating AzureRedisInstance, one field is mandatory: `sku.capacity`.

Optionally, you can specify the `redisConfiguration`, `redisVersion`, `shardCount` and `redisConfiguration` fields.

> [!Note]
> Non SSL port is disabled.

# Specification

This table lists the parameters of AzureRedisInstance, together with their descriptions:

| Parameter | Type | Description |
|---------------------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **ipRange** | object | Optional. IpRange reference. If omitted, the default IpRange is used. If the default IpRange does not exist, it will be created. |
| **ipRange.name** | string | Required. Name of the existing IpRange to use. |
| **sku.capacity** | int | Required. The service capacity of the instance. Supported values are 1, 2, 3, and 4. Note that tear is 'P' - Premium. |
| **redisVersion** | int | Optional. The version of Redis software. Defaults to `6.0`. |
| **shardCount** | int | Optional. Number of shards. |
| **redisConfiguration** | object | Optional. Object containing Redis configuration options. |
| **redisConfiguration.maxclients** | int | Optional. Max number of Redis clients. Limited to [7,500 to 40,000.](https://azure.microsoft.com/en-us/pricing/details/cache/) |
| **redisConfiguration.maxmemory-reserved** | int | Optional. [Configure your maxmemory-reserved setting to improve system responsiveness.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-best-practices-memory-management#configure-your-maxmemory-reserved-setting) |
| **redisConfiguration.maxmemory-delta** | int | Optional. Gets or sets value in megabytes reserved for non-cache usage per shard e.g. failover. |
| **redisConfiguration.maxmemory-policy** | int | Optional. The setting for how Redis will select what to remove when maxmemory (the size of the cache offering you selected when you created the cache) is reached. Defaults to `volatile-lru`. |
| **redisConfiguration.maxfragmentationmemory-reserved** | int | Optional. [Configure your maxmemory-reserved setting to improve system responsiveness.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-best-practices-memory-management#configure-your-maxmemory-reserved-setting) |

# Auth Secret Details

The following table list the meaningful parameters of the auth Secret:

| Parameter | Type | Description |
|---------------------------|--------|-------------------------------------------------------------------------------------------------|
| **.metadata.name** | string | Name of the auth Secret. It shares the name with AzureRedisInstance unless specified otherwise. |
| **.metadata.labels** | object | Specified custom labels (if any) |
| **.metadata.annotations** | object | Specified custom annotations (if any) |
| **.data.host** | string | Primary connection host. Base64 encoded. |
| **.data.port** | string | Primary connection port. Base64 encoded. |
| **.data.primaryEndpoint** | string | Primary connection endpoint. Provided in <host>:<port> format. Base64 encoded. |
| **.data.authString** | string | Auth string. Base64 encoded. |


# Custom Resource Sample

```yaml
apiVersion: cloud-resources.kyma-project.io/v1beta1
kind: AzureRedisInstance
metadata:
name: azureRedisInstanceExample
spec:
redisConfiguration:
maxclients: "8"
redisVersion: "6.0"
sku:
capacity: 1
```
1 change: 1 addition & 0 deletions docs/user/resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Cloud Manager custom resources:
* [GcpVpcPeering Custom Resource](./04-50-gcp-vpc-peering.md)
* [GcpRedisInstance Custom Resource](./04-60-gcp-redis-instance.md)
* [AwsRedisInstance Custom Resource](./04-70-aws-redis-instance.md)
* [AzureRedisInstance Custom Resource](./04-80-azure-redis-instance.md)
Loading