docs(AzureRedis): user docs #739
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kyma-bot
added
cla: yes
grego952
reviewed
Oct 21, 2024
| 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 the AzureRedisInstance. |
There was a problem hiding this comment.
Suggested change
| By default, the created auth Secret has the same name as the AzureRedisInstance. | |
| By default, the created auth Secret has the same name as AzureRedisInstance. |
| 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 the AzureRedisInstance. | ||
|
|
||
| The current implementation supports *Premium* tier, which is explained in detail on the [Azure Cache for Redis overview page](https://azure.microsoft.com/en-us/products/cache). |
There was a problem hiding this comment.
Suggested change
| The current implementation supports *Premium* tier, which is explained in detail on the [Azure Cache for Redis overview page](https://azure.microsoft.com/en-us/products/cache). | |
| 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. *Premium* tear supports [up to 3 shards.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) |
There was a problem hiding this comment.
Suggested change
| > Redis requires 2 IP addresses per shard. *Premium* tear supports [up to 3 shards.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) | |
| > Redis requires 2 IP addresses per shard. The Premium tier supports [up to 3 shards.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) |
| > [!TIP] _Only for advanced cases of network topology_ | ||
| > | ||
| > Redis requires 2 IP addresses per shard. *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 via IpRange CR. |
There was a problem hiding this comment.
Suggested change
| IP addresses can be configured via IpRange CR. | |
| IP addresses can be configured using the IpRange CR. |
|
|
||
| Optionally, you can specify the `redisConfiguration`, `redisVersion`, `shardCount`, `replicasPerPrimary` and `redisConfiguration` fields. | ||
|
|
||
| > [!Note] Non SSL port is disabled. |
There was a problem hiding this comment.
Suggested change
| > [!Note] Non SSL port is disabled. | |
| > [!Note] | |
| > Non-SSL port is disabled. |
| | **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. | | ||
| | **replicasPerPrimary** | int | Optional. Number of replicas, for `Premium` tier it is [up to 3.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) | |
There was a problem hiding this comment.
Suggested change
| | **replicasPerPrimary** | int | Optional. Number of replicas, for `Premium` tier it is [up to 3.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) | | |
| | **replicasPerPrimary** | int | Optional. Number of replicas, for the Premium tier it is [up to 3.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) | |
There was a problem hiding this comment.
replicasPerPrimary completely removed from docs, as this option will be not be available in following revision.
| | **redisVersion** | int | Optional. The version of Redis software. Defaults to `6.0`. | | ||
| | **shardCount** | int | Optional. Number of shards. | | ||
| | **replicasPerPrimary** | int | Optional. Number of replicas, for `Premium` tier it is [up to 3.](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-high-availability) | | ||
| | **redisConfiguration** | object | Optional. | |
There was a problem hiding this comment.
Can you also add a description for redisConfiguration? Here, it only says "Optional".
|
|
||
| | Parameter | Type | Description | | ||
| |---------------------------|--------|--------------------------------------------------------------------------------------------------------| | ||
| | **.metadata.name** | string | Name of the auth Secret. It will share the name with the AzureRedisInstance unless specified otherwise | |
There was a problem hiding this comment.
Suggested change
| | **.metadata.name** | string | Name of the auth Secret. It will share the name with the AzureRedisInstance unless specified otherwise | | |
| | **.metadata.name** | string | Name of the auth Secret. It shares the name with AzureRedisInstance unless specified otherwise | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request: