fix(rdb): add documentation about password validation (#4296)

scaleway · Nov 25, 2024 · 2563ee0 · 2563ee0
1 parent 86fd6ca
commit 2563ee0
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-instance-create-usage.golden
@@ -11,7 +11,7 @@ ARGS:
   engine                                         Database engine of the Database Instance (PostgreSQL, MySQL, ...)
   user-name                                      Username created when the Database Instance is created
   [generate-password=true]                       Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols
-  [password]                                     Password of the user
+  [password]                                     Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character
   node-type=DB-DEV-S                             Type of node to use for the Database Instance
   [is-ha-cluster]                                Defines whether or not High-Availability is enabled
   [disable-backup]                               Defines whether or not backups are disabled

diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-create-usage.golden
@@ -9,7 +9,7 @@ ARGS:
   instance-id                UUID of the Database Instance in which you want to create a user
   [name]                     Name of the user you want to create
   [generate-password=true]   Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols
-  [password]                 Password of the user you want to create
+  [password]                 Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character
   [is-admin]                 Defines whether the user will have administrative privileges
   [region=fr-par]            Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

diff --git a/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden b/cmd/scw/testdata/test-all-usage-rdb-user-update-usage.golden
@@ -9,7 +9,7 @@ ARGS:
   instance-id                UUID of the Database Instance the user belongs to
   name                       Name of the database user
   [generate-password=true]   Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols
-  [password]                 Password of the database user
+  [password]                 Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character
   [is-admin]                 Defines whether or not this user got administrative privileges
   [region=fr-par]            Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 

diff --git a/docs/commands/rdb.md b/docs/commands/rdb.md
@@ -752,7 +752,7 @@ scw rdb instance create [arg=value ...]
 | engine | Required | Database engine of the Database Instance (PostgreSQL, MySQL, ...) |
 | user-name | Required | Username created when the Database Instance is created |
 | generate-password | Default: `true` | Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols |
-| password |  | Password of the user |
+| password |  | Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character |
 | node-type | Required<br />Default: `DB-DEV-S` | Type of node to use for the Database Instance |
 | is-ha-cluster |  | Defines whether or not High-Availability is enabled |
 | disable-backup |  | Defines whether or not backups are disabled |
@@ -1579,7 +1579,7 @@ scw rdb user create [arg=value ...]
 | instance-id | Required | UUID of the Database Instance in which you want to create a user |
 | name |  | Name of the user you want to create |
 | generate-password | Default: `true` | Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols |
-| password |  | Password of the user you want to create |
+| password |  | Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character |
 | is-admin |  | Defines whether the user will have administrative privileges |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
@@ -1667,7 +1667,7 @@ scw rdb user update [arg=value ...]
 | instance-id | Required | UUID of the Database Instance the user belongs to |
 | name | Required | Name of the database user |
 | generate-password | Default: `true` | Will generate a 21 character-length password that contains a mix of upper/lower case letters, numbers and special symbols |
-| password |  | Password of the database user |
+| password |  | Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character |
 | is-admin |  | Defines whether or not this user got administrative privileges |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 

diff --git a/go.mod b/go.mod
@@ -26,7 +26,7 @@ require (
 	github.com/mattn/go-isatty v0.0.20
 	github.com/moby/buildkit v0.13.2
 	github.com/opencontainers/go-digest v1.0.0
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241120144232-edea130e856d
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241122155133-e059a3142116
 	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
 	github.com/spf13/cobra v1.8.1
 	github.com/spf13/pflag v1.0.5

diff --git a/go.sum b/go.sum
@@ -466,8 +466,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
 github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241120144232-edea130e856d h1:fx/KN+3OD7BFzJuAycHL9dZAhX+ERmizIR8Zpk4rpFg=
-github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241120144232-edea130e856d/go.mod h1:kAoejOVBg1E/aVAR6IwKWEmbLCEg2IXklzPAkxzAaXA=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241122155133-e059a3142116 h1:cMGaFcZ2ByIdOWy/QkRvMOu0HtwzQDLv+InToiqJPaM=
+github.com/scaleway/scaleway-sdk-go v1.0.0-beta.30.0.20241122155133-e059a3142116/go.mod h1:kAoejOVBg1E/aVAR6IwKWEmbLCEg2IXklzPAkxzAaXA=
 github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
 github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
 github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=

diff --git a/internal/namespaces/rdb/v1/rdb_cli.go b/internal/namespaces/rdb/v1/rdb_cli.go
@@ -887,7 +887,7 @@ func rdbInstanceCreate() *core.Command {
 			},
 			{
 				Name:       "password",
-				Short:      `Password of the user`,
+				Short:      `Password of the user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character`,
 				Required:   true,
 				Deprecated: false,
 				Positional: false,
@@ -2034,7 +2034,7 @@ func rdbUserCreate() *core.Command {
 			},
 			{
 				Name:       "password",
-				Short:      `Password of the user you want to create`,
+				Short:      `Password of the user you want to create. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,
@@ -2085,7 +2085,7 @@ func rdbUserUpdate() *core.Command {
 			},
 			{
 				Name:       "password",
-				Short:      `Password of the database user`,
+				Short:      `Password of the database user. Password must be between 8 and 128 characters, contain at least one digit, one uppercase, one lowercase and one special character`,
 				Required:   false,
 				Deprecated: false,
 				Positional: false,