Documentation: Add ssl_context option to RedisCluster documentation
#300
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
Signed-off-by: Maximilian Bösing <[email protected]>
boesing
force-pushed
the
docs/redis-cluster-ssl-context
branch
from
b9924f9 to
cb716eb
Compare
froschdesign
requested changes
Apr 18, 2024
| | Name | Data Type | Default Value | Description | | ||
| |-----------------------|---------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `lib_options` | `array` | `[]` | Associative array of Redis options where the array key is the options constant value (see `RedisCluster::OPT_*` [constants](https://github.com/JetBrains/phpstorm-stubs/blob/master/redis/RedisCluster.php) for details). | | ||
| | `namespace_separator` | `string` | ":" | A separator for the namespace and prefix. | |
There was a problem hiding this comment.
Suggested change
| | `namespace_separator` | `string` | ":" | A separator for the namespace and prefix. | | |
| | `namespace_separator` | `string` | `:` | A separator for the namespace and prefix. | |
| |-----------------------|---------------------------|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | `lib_options` | `array` | `[]` | Associative array of Redis options where the array key is the options constant value (see `RedisCluster::OPT_*` [constants](https://github.com/JetBrains/phpstorm-stubs/blob/master/redis/RedisCluster.php) for details). | | ||
| | `namespace_separator` | `string` | ":" | A separator for the namespace and prefix. | | ||
| | `password` | `string` | "" | Password to authenticate with Redis server | |
There was a problem hiding this comment.
I suggest a comment like "(empty)" as the default value.
| | `lib_options` | `array` | `[]` | Associative array of Redis options where the array key is the options constant value (see `RedisCluster::OPT_*` [constants](https://github.com/JetBrains/phpstorm-stubs/blob/master/redis/RedisCluster.php) for details). | | ||
| | `namespace_separator` | `string` | ":" | A separator for the namespace and prefix. | | ||
| | `password` | `string` | "" | Password to authenticate with Redis server | | ||
| | `name` | `string` | "" | Name to determine configuration from [php.ini](https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#loading-a-cluster-configuration-by-name) (**MUST NOT** be combined with `seeds`) | |
| | `timeout` | `float` | `1.0` | Timeout for commands, see [PhpRedis](https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#timeouts) timeouts documentation for more background. | | ||
| | `read_timeout` | `float` | `2.0` | Read timeout for commands, see [PhpRedis](https://github.com/phpredis/phpredis/blob/develop/cluster.markdown#timeouts) timeouts documentation for more background. | | ||
| | `persistent` | `bool` | `false` | Flag to specify whether to create a persistent connection or not | | ||
| | `version` | `string` | "" | The Redis server version. **MUST** be specified in a [Semantic Versioning 2.0.0](https://semver.org/#semantic-versioning-200) format. This information is used to determine some features/capabilities without opening a connection to the server. | |
|
@froschdesign I keep the suggestions here open as they should be done indeed but actually only appeared due to the fact that I reformatted all the tables to match markdown codingstyle. Contents where not changed by me and thus lets keep this focused on adding I am still unhappy with the way how adapter configuration has to be maintained.
I'd like to still see all the docs regarding an adapter listed in the appropriate satellites. So we can provide dedicated cache page the same way we do for https://docs.laminas.dev/mvc/ This said, I will merge this for now so that we have the SSL context properly documented. |
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.
Description
This adds the documentation of the new created
ssl_optionsoption flag forRedisClusteroptions.Closes #299
Is a new patch version feasible, this component does actually not change at all.