Skip to content

Commit

Permalink
docs(redis): components (#3064)
Browse files Browse the repository at this point in the history
Co-authored-by: Rémy Léone <rleone@scaleway.com>
  • Loading branch information
scaleway-bot and remyleone committed Apr 24, 2023
1 parent 9c6967a commit 86eec74
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ARGS:
[acl-rules.{index}.description] Description of the rule
[endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance
[endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.
[tls-enabled] Whether or not TLS is enabled
[tls-enabled] Defines whether or not TLS is enabled
[cluster-settings.{index}.value] Value of the setting
[cluster-settings.{index}.name] Name of the setting
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ USAGE:
scw redis node-type list [arg=value ...]

ARGS:
[include-disabled-types] Whether or not to include disabled types
[include-disabled-types] Defines whether or not to include disabled types
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all)

FLAGS:
Expand Down
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-redis-setting-usage.golden
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint.
Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint.

Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ USAGE:
scw redis version list [arg=value ...]

ARGS:
[include-disabled] Whether or not to include disabled Redis™ engine versions
[include-beta] Whether or not to include beta Redis™ engine versions
[include-deprecated] Whether or not to include deprecated Redis™ engine versions
[include-disabled] Defines whether or not to include disabled Redis™ engine versions
[include-beta] Defines whether or not to include beta Redis™ engine versions
[include-deprecated] Defines whether or not to include deprecated Redis™ engine versions
[version] List Redis™ engine versions that match a given name pattern
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | nl-ams-2 | pl-waw-1 | pl-waw-2 | all)

Expand Down
12 changes: 6 additions & 6 deletions docs/commands/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ scw redis cluster create [arg=value ...]
| acl-rules.{index}.description | | Description of the rule |
| endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance |
| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. |
| tls-enabled | | Whether or not TLS is enabled |
| tls-enabled | | Defines whether or not TLS is enabled |
| cluster-settings.{index}.value | | Value of the setting |
| cluster-settings.{index}.name | | Name of the setting |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2` | Zone to target. If none is passed will use default zone from the config |
Expand Down Expand Up @@ -471,14 +471,14 @@ scw redis node-type list [arg=value ...]

| Name | | Description |
|------|---|-------------|
| include-disabled-types | | Whether or not to include disabled types |
| include-disabled-types | | Defines whether or not to include disabled types |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config |



## Settings management commands

Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint.
Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint.

Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.

Expand Down Expand Up @@ -569,9 +569,9 @@ scw redis version list [arg=value ...]

| Name | | Description |
|------|---|-------------|
| include-disabled | | Whether or not to include disabled Redis™ engine versions |
| include-beta | | Whether or not to include beta Redis™ engine versions |
| include-deprecated | | Whether or not to include deprecated Redis™ engine versions |
| include-disabled | | Defines whether or not to include disabled Redis™ engine versions |
| include-beta | | Defines whether or not to include beta Redis™ engine versions |
| include-deprecated | | Defines whether or not to include deprecated Redis™ engine versions |
| version | | List Redis™ engine versions that match a given name pattern |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `nl-ams-1`, `nl-ams-2`, `pl-waw-1`, `pl-waw-2`, `all` | Zone to target. If none is passed will use default zone from the config |

Expand Down
12 changes: 6 additions & 6 deletions internal/namespaces/redis/v1/redis_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ func redisVersion() *core.Command {
func redisSetting() *core.Command {
return &core.Command{
Short: `Settings management commands`,
Long: `Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](https://developers.scaleway.com/en/products/redis/api/v1/#get-209533) endpoint.
Long: `Advanced settings allow you to tune the behavior of your Redis™ database engine to better fit your needs. Available settings depend on the version of the Redis™ engine. Note that some settings can only be defined upon the Redis™ engine initialization. These are called init settings. You can find a full list of the settings available in the response body of the [list available Redis™ versions](#path-redistm-engine-versions-list-available-redistm-versions) endpoint.
Each advanced setting entry has a default value that users can override. The deletion of a setting entry will restore the setting to default value. Some of the defaults values can be different from the engine's defaults, as we optimize them to the Scaleway platform.
`,
Expand Down Expand Up @@ -211,7 +211,7 @@ func redisClusterCreate() *core.Command {
},
{
Name: "tls-enabled",
Short: `Whether or not TLS is enabled`,
Short: `Defines whether or not TLS is enabled`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -550,7 +550,7 @@ func redisNodeTypeList() *core.Command {
ArgSpecs: core.ArgSpecs{
{
Name: "include-disabled-types",
Short: `Whether or not to include disabled types`,
Short: `Defines whether or not to include disabled types`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -589,21 +589,21 @@ func redisVersionList() *core.Command {
ArgSpecs: core.ArgSpecs{
{
Name: "include-disabled",
Short: `Whether or not to include disabled Redis™ engine versions`,
Short: `Defines whether or not to include disabled Redis™ engine versions`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "include-beta",
Short: `Whether or not to include beta Redis™ engine versions`,
Short: `Defines whether or not to include beta Redis™ engine versions`,
Required: false,
Deprecated: false,
Positional: false,
},
{
Name: "include-deprecated",
Short: `Whether or not to include deprecated Redis™ engine versions`,
Short: `Defines whether or not to include deprecated Redis™ engine versions`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down

0 comments on commit 86eec74

Please sign in to comment.