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.

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

docs(AzureRedis): user docs #739

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

Conversation

ijovovic
Copy link
Contributor

Changes proposed in this pull request:

  • initial user documentatio

@ijovovic ijovovic requested a review from a team as a code owner October 18, 2024 07:23
@kyma-bot kyma-bot added cla: yes Indicates the PR's author has signed the CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 18, 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


> [!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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

> [!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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
IP addresses can be configured via IpRange CR.
IP addresses can be configured using the IpRange CR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.


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

> [!Note] Non SSL port is disabled.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> [!Note] Non SSL port is disabled.
> [!Note]
> Non-SSL port is disabled.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

| **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) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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) |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also add a description for redisConfiguration? Here, it only says "Optional".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, thanks.


| Parameter | Type | Description |
|---------------------------|--------|--------------------------------------------------------------------------------------------------------|
| **.metadata.name** | string | Name of the auth Secret. It will share the name with the AzureRedisInstance unless specified otherwise |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 |

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes Indicates the PR's author has signed the CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants