Skip to content

Commit a38ba4a

Browse files
jremy42jremy42
authored
feat(redis): add version settings listing (#5178)
1 parent 5ef6527 commit a38ba4a

8 files changed

Lines changed: 331 additions & 1 deletion

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
List available settings from a Redis™ version.
4+
5+
USAGE:
6+
scw redis version list-settings [arg=value ...]
7+
8+
EXAMPLES:
9+
List settings for Redis™ 7.2.11
10+
scw redis version list-settings version=7.2.11
11+
12+
ARGS:
13+
version Redis™ engine version
14+
[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)
15+
16+
FLAGS:
17+
-h, --help help for list-settings
18+
19+
GLOBAL FLAGS:
20+
-c, --config string The path to the config file
21+
-D, --debug Enable debug mode
22+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
23+
-p, --profile string The config profile to use

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ USAGE:
66
scw redis version <command>
77

88
AVAILABLE COMMANDS:
9-
list List available Redis™ versions
9+
list List available Redis™ versions
10+
list-settings List available settings from a Redis™ version
1011

1112
FLAGS:
1213
-h, --help help for version

‎docs/commands/redis.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ This API allows you to manage your Managed Databases for Redis™.
3333
- [Set advanced settings](#set-advanced-settings)
3434
- [Redis™ version management commands](#redis™-version-management-commands)
3535
- [List available Redis™ versions](#list-available-redis™-versions)
36+
- [List available settings from a Redis™ version](#list-available-settings-from-a-redis™-version)
3637

3738

3839
## Access Control List (ACL) management commands
@@ -629,3 +630,33 @@ scw redis version list [arg=value ...]
629630

630631

631632

633+
### List available settings from a Redis™ version
634+
635+
List available settings from a Redis™ version.
636+
637+
**Usage:**
638+
639+
```
640+
scw redis version list-settings [arg=value ...]
641+
```
642+
643+
644+
**Args:**
645+
646+
| Name | | Description |
647+
|------|---|-------------|
648+
| version | Required | Redis™ engine version |
649+
| 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 |
650+
651+
652+
**Examples:**
653+
654+
655+
List settings for Redis™ 7.2.11
656+
```
657+
scw redis version list-settings version=7.2.11
658+
```
659+
660+
661+
662+

‎internal/namespaces/redis/v1/custom.go‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ func GetCommands() *core.Commands {
2121
cmds.MustFind("redis", "cluster", "migrate").Override(redisClusterMigrateBuilder)
2222

2323
cmds.Merge(core.NewCommands(redisACLUpdateCommand()))
24+
cmds.Merge(core.NewCommands(redisVersionSettingsCommand()))
2425

2526
return cmds
2627
}

‎internal/namespaces/redis/v1/custom_version_settings.go‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
package redis
2+
3+
import (
4+
"context"
5+
"reflect"
6+
7+
"github.com/scaleway/scaleway-cli/v2/core"
8+
"github.com/scaleway/scaleway-sdk-go/api/redis/v1"
9+
"github.com/scaleway/scaleway-sdk-go/scw"
10+
)
11+
12+
func redisVersionSettingsCommand() *core.Command {
13+
type versionSettingsArgs struct {
14+
Version string
15+
Zone scw.Zone
16+
}
17+
18+
return &core.Command{
19+
Short: "List available settings from a Redis™ version",
20+
Long: "List available settings from a Redis™ version.",
21+
Namespace: "redis",
22+
Resource: "version",
23+
Verb: "list-settings",
24+
ArgsType: reflect.TypeOf(versionSettingsArgs{}),
25+
ArgSpecs: core.ArgSpecs{
26+
{
27+
Name: "version",
28+
Short: "Redis™ engine version",
29+
Required: true,
30+
},
31+
core.ZoneArgSpec(
32+
scw.ZoneFrPar1,
33+
scw.ZoneFrPar2,
34+
scw.ZoneNlAms1,
35+
scw.ZoneNlAms2,
36+
scw.ZonePlWaw1,
37+
scw.ZonePlWaw2,
38+
),
39+
},
40+
Examples: []*core.Example{
41+
{
42+
Short: "List settings for Redis™ 7.2.11",
43+
ArgsJSON: `{"version": "7.2.11"}`,
44+
},
45+
},
46+
Run: func(ctx context.Context, argsI any) (any, error) {
47+
args := argsI.(*versionSettingsArgs)
48+
api := redis.NewAPI(core.ExtractClient(ctx))
49+
50+
resp, err := api.ListClusterVersions(&redis.ListClusterVersionsRequest{
51+
Zone: args.Zone,
52+
Version: &args.Version,
53+
})
54+
if err != nil {
55+
return nil, err
56+
}
57+
58+
for _, version := range resp.Versions {
59+
if version.Version == args.Version {
60+
return version.AvailableSettings, nil
61+
}
62+
}
63+
64+
return []*redis.AvailableClusterSetting{}, nil
65+
},
66+
}
67+
}

‎internal/namespaces/redis/v1/custom_version_settings_test.go‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
package redis_test
2+
3+
import (
4+
"testing"
5+
6+
"github.com/scaleway/scaleway-cli/v2/core"
7+
"github.com/scaleway/scaleway-cli/v2/internal/namespaces/redis/v1"
8+
redisSDK "github.com/scaleway/scaleway-sdk-go/api/redis/v1"
9+
"github.com/stretchr/testify/assert"
10+
)
11+
12+
func TestRedisVersionSettingsCommand(t *testing.T) {
13+
t.Run("List settings for Redis version", core.Test(&core.TestConfig{
14+
Commands: redis.GetCommands(),
15+
Cmd: "scw redis version list-settings version=7.2.11",
16+
Check: core.TestCheckCombine(
17+
core.TestCheckExitCode(0),
18+
core.TestCheckGolden(),
19+
func(t *testing.T, ctx *core.CheckFuncCtx) {
20+
t.Helper()
21+
if ctx.Result != nil {
22+
settings := ctx.Result.([]*redisSDK.AvailableClusterSetting)
23+
assert.NotEmpty(t, settings, "should return at least one setting")
24+
// Verify that settings have the expected structure
25+
for _, setting := range settings {
26+
assert.NotEmpty(t, setting.Name, "setting should have a name")
27+
}
28+
}
29+
},
30+
),
31+
}))
32+
}

‎internal/namespaces/redis/v1/testdata/test-redis-version-settings-command-list-settings-for-redis-version.cassette.yaml‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
version: 1
3+
interactions:
4+
- request:
5+
body: '{"total_count":1, "versions":[{"version":"7.2.11", "end_of_life_at":"2026-02-28T00:00:00Z",
6+
"available_settings":[{"name":"tcp-keepalive", "default_value":"300", "type":"INT",
7+
"description":"The specified value (in seconds) is the period used to send ACKs.",
8+
"max_value":65536, "min_value":null, "regex":null, "deprecated":false}, {"name":"maxclients",
9+
"default_value":"10000", "type":"INT", "description":"Set the max number of
10+
connected clients at the same time.", "max_value":65536, "min_value":100, "regex":null,
11+
"deprecated":false}, {"name":"maxmemory-policy", "default_value":"noeviction",
12+
"type":"STRING", "description":"How Redis will select what to remove when maxmemory
13+
is reached: https://redis.io/topics/lru-cache.", "max_value":null, "min_value":null,
14+
"regex":"volatile-lru|allkeys-lru|volatile-lfu|allkeys-lfu|volatile-random|allkeys-random|volatile-ttl|noeviction",
15+
"deprecated":false}, {"name":"databases", "default_value":"16", "type":"INT",
16+
"description":"Set number of Redis databases", "max_value":128, "min_value":1,
17+
"regex":null, "deprecated":false}, {"name":"notify-keyspace-events", "default_value":"\"\"",
18+
"type":"STRING", "description":"Configure the keyspace event notification feature",
19+
"max_value":null, "min_value":null, "regex":"^(?:([KEg$lshzxetdnm])(?!.*\\1))+$",
20+
"deprecated":false}, {"name":"disable-save", "default_value":"false", "type":"BOOLEAN",
21+
"description":"Disable Redis rdb persistence file on disk", "max_value":null,
22+
"min_value":null, "regex":null, "deprecated":false}, {"name":"slowlog-log-slower-than",
23+
"default_value":"10000", "type":"INT", "description":"Log queries that exceed
24+
this duration in microseconds (set to -1 to disable)", "max_value":100000000,
25+
"min_value":-1, "regex":null, "deprecated":false}, {"name":"slowlog-max-len",
26+
"default_value":"128", "type":"INT", "description":"Maximum length of the slow
27+
log", "max_value":10000, "min_value":1, "regex":null, "deprecated":false}],
28+
"logo_url":"https://s3.fr-par.scw.cloud/scw-rkv-logos/logo.svg", "zone":"fr-par-1"}]}'
29+
form: {}
30+
headers:
31+
User-Agent:
32+
- scaleway-sdk-go/v1.0.0-beta.7+dev (go1.25.3; darwin; amd64) cli-e2e-test
33+
url: https://api.scaleway.com/redis/v1/zones/fr-par-1/cluster-versions?include_beta=false&include_deprecated=false&include_disabled=false&version=7.2.11
34+
method: GET
35+
response:
36+
body: '{"total_count":1, "versions":[{"version":"7.2.11", "end_of_life_at":"2026-02-28T00:00:00Z",
37+
"available_settings":[{"name":"tcp-keepalive", "default_value":"300", "type":"INT",
38+
"description":"The specified value (in seconds) is the period used to send ACKs.",
39+
"max_value":65536, "min_value":null, "regex":null, "deprecated":false}, {"name":"maxclients",
40+
"default_value":"10000", "type":"INT", "description":"Set the max number of
41+
connected clients at the same time.", "max_value":65536, "min_value":100, "regex":null,
42+
"deprecated":false}, {"name":"maxmemory-policy", "default_value":"noeviction",
43+
"type":"STRING", "description":"How Redis will select what to remove when maxmemory
44+
is reached: https://redis.io/topics/lru-cache.", "max_value":null, "min_value":null,
45+
"regex":"volatile-lru|allkeys-lru|volatile-lfu|allkeys-lfu|volatile-random|allkeys-random|volatile-ttl|noeviction",
46+
"deprecated":false}, {"name":"databases", "default_value":"16", "type":"INT",
47+
"description":"Set number of Redis databases", "max_value":128, "min_value":1,
48+
"regex":null, "deprecated":false}, {"name":"notify-keyspace-events", "default_value":"\"\"",
49+
"type":"STRING", "description":"Configure the keyspace event notification feature",
50+
"max_value":null, "min_value":null, "regex":"^(?:([KEg$lshzxetdnm])(?!.*\\1))+$",
51+
"deprecated":false}, {"name":"disable-save", "default_value":"false", "type":"BOOLEAN",
52+
"description":"Disable Redis rdb persistence file on disk", "max_value":null,
53+
"min_value":null, "regex":null, "deprecated":false}, {"name":"slowlog-log-slower-than",
54+
"default_value":"10000", "type":"INT", "description":"Log queries that exceed
55+
this duration in microseconds (set to -1 to disable)", "max_value":100000000,
56+
"min_value":-1, "regex":null, "deprecated":false}, {"name":"slowlog-max-len",
57+
"default_value":"128", "type":"INT", "description":"Maximum length of the slow
58+
log", "max_value":10000, "min_value":1, "regex":null, "deprecated":false}],
59+
"logo_url":"https://s3.fr-par.scw.cloud/scw-rkv-logos/logo.svg", "zone":"fr-par-1"}]}'
60+
headers:
61+
Content-Length:
62+
- "2025"
63+
Content-Security-Policy:
64+
- default-src 'none'; frame-ancestors 'none'
65+
Content-Type:
66+
- application/json
67+
Date:
68+
- Thu, 27 Nov 2025 15:34:55 GMT
69+
Server:
70+
- Scaleway API Gateway (fr-par-2;edge02)
71+
Strict-Transport-Security:
72+
- max-age=63072000
73+
X-Content-Type-Options:
74+
- nosniff
75+
X-Frame-Options:
76+
- DENY
77+
X-Request-Id:
78+
- e2b94d11-4e80-4a3a-910f-1d4abd26d3f5
79+
status: 200 OK
80+
code: 200
81+
duration: ""

‎internal/namespaces/redis/v1/testdata/test-redis-version-settings-command-list-settings-for-redis-version.golden‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟩🟩🟩 STDOUT️ 🟩🟩🟩️
3+
NAME DEFAULT VALUE TYPE DESCRIPTION MAX VALUE MIN VALUE REGEX DEPRECATED
4+
tcp-keepalive 300 INT The specified value (in seconds) is the period used to send ACKs. 65536 - - false
5+
maxclients 10000 INT Set the max number of connected clients at the same time. 65536 100 - false
6+
maxmemory-policy noeviction STRING How Redis will select what to remove when maxmemory is reached: https://redis.io/topics/lru-cache. - - volatile-lru|allkeys-lru|volatile-lfu|allkeys-lfu|volatile-random|allkeys-random|volatile-ttl|noeviction false
7+
databases 16 INT Set number of Redis databases 128 1 - false
8+
notify-keyspace-events "" STRING Configure the keyspace event notification feature - - ^(?:([KEg$lshzxetdnm])(?!.*\1))+$ false
9+
disable-save false BOOLEAN Disable Redis rdb persistence file on disk - - - false
10+
slowlog-log-slower-than 10000 INT Log queries that exceed this duration in microseconds (set to -1 to disable) 100000000 -1 - false
11+
slowlog-max-len 128 INT Maximum length of the slow log 10000 1 - false
12+
🟩🟩🟩 JSON STDOUT 🟩🟩🟩
13+
[
14+
{
15+
"name": "tcp-keepalive",
16+
"default_value": "300",
17+
"type": "INT",
18+
"description": "The specified value (in seconds) is the period used to send ACKs.",
19+
"max_value": 65536,
20+
"min_value": null,
21+
"regex": null,
22+
"deprecated": false
23+
},
24+
{
25+
"name": "maxclients",
26+
"default_value": "10000",
27+
"type": "INT",
28+
"description": "Set the max number of connected clients at the same time.",
29+
"max_value": 65536,
30+
"min_value": 100,
31+
"regex": null,
32+
"deprecated": false
33+
},
34+
{
35+
"name": "maxmemory-policy",
36+
"default_value": "noeviction",
37+
"type": "STRING",
38+
"description": "How Redis will select what to remove when maxmemory is reached: https://redis.io/topics/lru-cache.",
39+
"max_value": null,
40+
"min_value": null,
41+
"regex": "volatile-lru|allkeys-lru|volatile-lfu|allkeys-lfu|volatile-random|allkeys-random|volatile-ttl|noeviction",
42+
"deprecated": false
43+
},
44+
{
45+
"name": "databases",
46+
"default_value": "16",
47+
"type": "INT",
48+
"description": "Set number of Redis databases",
49+
"max_value": 128,
50+
"min_value": 1,
51+
"regex": null,
52+
"deprecated": false
53+
},
54+
{
55+
"name": "notify-keyspace-events",
56+
"default_value": "\"\"",
57+
"type": "STRING",
58+
"description": "Configure the keyspace event notification feature",
59+
"max_value": null,
60+
"min_value": null,
61+
"regex": "^(?:([KEg$lshzxetdnm])(?!.*\\1))+$",
62+
"deprecated": false
63+
},
64+
{
65+
"name": "disable-save",
66+
"default_value": "false",
67+
"type": "BOOLEAN",
68+
"description": "Disable Redis rdb persistence file on disk",
69+
"max_value": null,
70+
"min_value": null,
71+
"regex": null,
72+
"deprecated": false
73+
},
74+
{
75+
"name": "slowlog-log-slower-than",
76+
"default_value": "10000",
77+
"type": "INT",
78+
"description": "Log queries that exceed this duration in microseconds (set to -1 to disable)",
79+
"max_value": 100000000,
80+
"min_value": -1,
81+
"regex": null,
82+
"deprecated": false
83+
},
84+
{
85+
"name": "slowlog-max-len",
86+
"default_value": "128",
87+
"type": "INT",
88+
"description": "Maximum length of the slow log",
89+
"max_value": 10000,
90+
"min_value": 1,
91+
"regex": null,
92+
"deprecated": false
93+
}
94+
]

0 commit comments

Comments
 (0)