Skip to content

Commit 86eec74

Browse files
docs(redis): components (#3064)
Co-authored-by: Rémy Léone <rleone@scaleway.com>
1 parent 9c6967a commit 86eec74

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

cmd/scw/testdata/test-all-usage-redis-cluster-create-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ ARGS:
1818
[acl-rules.{index}.description] Description of the rule
1919
[endpoints.{index}.private-network.id] UUID of the Private Network to connect to the Database Instance
2020
[endpoints.{index}.private-network.service-ips.{index}] Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node.
21-
[tls-enabled] Whether or not TLS is enabled
21+
[tls-enabled] Defines whether or not TLS is enabled
2222
[cluster-settings.{index}.value] Value of the setting
2323
[cluster-settings.{index}.name] Name of the setting
2424
[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)

cmd/scw/testdata/test-all-usage-redis-node-type-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ USAGE:
66
scw redis node-type list [arg=value ...]
77

88
ARGS:
9-
[include-disabled-types] Whether or not to include disabled types
9+
[include-disabled-types] Defines whether or not to include disabled types
1010
[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)
1111

1212
FLAGS:

cmd/scw/testdata/test-all-usage-redis-setting-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
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.
3+
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.
44

55
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.
66

cmd/scw/testdata/test-all-usage-redis-version-list-usage.golden

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ USAGE:
66
scw redis version list [arg=value ...]
77

88
ARGS:
9-
[include-disabled] Whether or not to include disabled Redis™ engine versions
10-
[include-beta] Whether or not to include beta Redis™ engine versions
11-
[include-deprecated] Whether or not to include deprecated Redis™ engine versions
9+
[include-disabled] Defines whether or not to include disabled Redis™ engine versions
10+
[include-beta] Defines whether or not to include beta Redis™ engine versions
11+
[include-deprecated] Defines whether or not to include deprecated Redis™ engine versions
1212
[version] List Redis™ engine versions that match a given name pattern
1313
[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)
1414

docs/commands/redis.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ scw redis cluster create [arg=value ...]
156156
| acl-rules.{index}.description | | Description of the rule |
157157
| endpoints.{index}.private-network.id | | UUID of the Private Network to connect to the Database Instance |
158158
| endpoints.{index}.private-network.service-ips.{index} | | Endpoint IPv4 address with a CIDR notation. You must provide at least one IPv4 per node. |
159-
| tls-enabled | | Whether or not TLS is enabled |
159+
| tls-enabled | | Defines whether or not TLS is enabled |
160160
| cluster-settings.{index}.value | | Value of the setting |
161161
| cluster-settings.{index}.name | | Name of the setting |
162162
| 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 |
@@ -471,14 +471,14 @@ scw redis node-type list [arg=value ...]
471471

472472
| Name | | Description |
473473
|------|---|-------------|
474-
| include-disabled-types | | Whether or not to include disabled types |
474+
| include-disabled-types | | Defines whether or not to include disabled types |
475475
| 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 |
476476

477477

478478

479479
## Settings management commands
480480

481-
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.
481+
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.
482482

483483
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.
484484

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

570570
| Name | | Description |
571571
|------|---|-------------|
572-
| include-disabled | | Whether or not to include disabled Redis™ engine versions |
573-
| include-beta | | Whether or not to include beta Redis™ engine versions |
574-
| include-deprecated | | Whether or not to include deprecated Redis™ engine versions |
572+
| include-disabled | | Defines whether or not to include disabled Redis™ engine versions |
573+
| include-beta | | Defines whether or not to include beta Redis™ engine versions |
574+
| include-deprecated | | Defines whether or not to include deprecated Redis™ engine versions |
575575
| version | | List Redis™ engine versions that match a given name pattern |
576576
| 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 |
577577

internal/namespaces/redis/v1/redis_cli.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ func redisVersion() *core.Command {
9191
func redisSetting() *core.Command {
9292
return &core.Command{
9393
Short: `Settings management commands`,
94-
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.
94+
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.
9595
9696
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.
9797
`,
@@ -211,7 +211,7 @@ func redisClusterCreate() *core.Command {
211211
},
212212
{
213213
Name: "tls-enabled",
214-
Short: `Whether or not TLS is enabled`,
214+
Short: `Defines whether or not TLS is enabled`,
215215
Required: false,
216216
Deprecated: false,
217217
Positional: false,
@@ -550,7 +550,7 @@ func redisNodeTypeList() *core.Command {
550550
ArgSpecs: core.ArgSpecs{
551551
{
552552
Name: "include-disabled-types",
553-
Short: `Whether or not to include disabled types`,
553+
Short: `Defines whether or not to include disabled types`,
554554
Required: false,
555555
Deprecated: false,
556556
Positional: false,
@@ -589,21 +589,21 @@ func redisVersionList() *core.Command {
589589
ArgSpecs: core.ArgSpecs{
590590
{
591591
Name: "include-disabled",
592-
Short: `Whether or not to include disabled Redis™ engine versions`,
592+
Short: `Defines whether or not to include disabled Redis™ engine versions`,
593593
Required: false,
594594
Deprecated: false,
595595
Positional: false,
596596
},
597597
{
598598
Name: "include-beta",
599-
Short: `Whether or not to include beta Redis™ engine versions`,
599+
Short: `Defines whether or not to include beta Redis™ engine versions`,
600600
Required: false,
601601
Deprecated: false,
602602
Positional: false,
603603
},
604604
{
605605
Name: "include-deprecated",
606-
Short: `Whether or not to include deprecated Redis™ engine versions`,
606+
Short: `Defines whether or not to include deprecated Redis™ engine versions`,
607607
Required: false,
608608
Deprecated: false,
609609
Positional: false,

0 commit comments

Comments
 (0)