Skip to content

Commit 075707f

Browse files
authored
feat(cockpit): update wording (#4831)
1 parent 2ce33f9 commit 075707f

9 files changed

+29
-41
lines changed

cmd/scw/testdata/test-all-usage-cockpit-data-source-create-usage.golden

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
You must specify the data source type upon creation. Available data source types include:
4-
- metrics
5-
- logs
6-
- traces
3+
You must specify the data source name and type (metrics, logs, traces) upon creation.
74
The name of the data source will then be used as reference to name the associated Grafana data source.
85

96
USAGE:
@@ -13,7 +10,7 @@ ARGS:
1310
[project-id] Project ID to use. If none is passed the default project ID will be used
1411
[name] Data source name
1512
[type] Data source type (unknown_type | metrics | logs | traces)
16-
[retention-days] BETA - Duration for which the data will be retained in the data source
13+
[retention-days] Duration for which the data will be retained in the data source
1714
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1815

1916
FLAGS:

cmd/scw/testdata/test-all-usage-cockpit-data-source-delete-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-
Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
3+
Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
44

55
USAGE:
66
scw cockpit data-source delete [arg=value ...]

cmd/scw/testdata/test-all-usage-cockpit-data-source-list-usage.golden

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
4-
You can list data sources by Project, type and origin.
54

65
USAGE:
76
scw cockpit data-source list [arg=value ...]
87

98
ARGS:
109
[order-by] Sort order for data sources in the response (created_at_asc | created_at_desc | name_asc | name_desc | type_asc | type_desc)
1110
[project-id] Project ID to use. If none is passed the default project ID will be used
12-
[origin] Origin to filter for, only data sources with matching origin will be returned (unknown_origin | scaleway | external | custom)
13-
[types.{index}] Types to filter for, only data sources with matching types will be returned (unknown_type | metrics | logs | traces)
11+
[origin] Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned (unknown_origin | scaleway | external | custom)
12+
[types.{index}] Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned (unknown_type | metrics | logs | traces)
1413
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
1514

1615
FLAGS:

cmd/scw/testdata/test-all-usage-cockpit-data-source-update-usage.golden

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Update a given data source name, specified by the data source ID.
3+
Update a given data source attributes (name and/or retention_days).
44

55
USAGE:
66
scw cockpit data-source update [arg=value ...]
77

88
ARGS:
99
data-source-id ID of the data source to update
1010
[name] Updated name of the data source
11-
[retention-days] BETA - Duration for which the data will be retained in the data source
11+
[retention-days] Duration for which the data will be retained in the data source
1212
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
1313

1414
FLAGS:

cmd/scw/testdata/test-all-usage-cockpit-usage-overview-get-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-
Retrieve the data source usage overview per type for the specified Project.
3+
Retrieve the volume of data ingested for each of your data sources in the specified project and region.
44

55
USAGE:
66
scw cockpit usage-overview get [arg=value ...]

docs/commands/cockpit.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -188,10 +188,7 @@ Datasource management commands.
188188

189189
### Create a data source
190190

191-
You must specify the data source type upon creation. Available data source types include:
192-
- metrics
193-
- logs
194-
- traces
191+
You must specify the data source name and type (metrics, logs, traces) upon creation.
195192
The name of the data source will then be used as reference to name the associated Grafana data source.
196193

197194
**Usage:**
@@ -208,14 +205,14 @@ scw cockpit data-source create [arg=value ...]
208205
| project-id | | Project ID to use. If none is passed the default project ID will be used |
209206
| name | | Data source name |
210207
| type | One of: `unknown_type`, `metrics`, `logs`, `traces` | Data source type |
211-
| retention-days | | BETA - Duration for which the data will be retained in the data source |
208+
| retention-days | | Duration for which the data will be retained in the data source |
212209
| 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 |
213210

214211

215212

216213
### Delete a data source
217214

218-
Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
215+
Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
219216

220217
**Usage:**
221218

@@ -256,7 +253,6 @@ scw cockpit data-source get [arg=value ...]
256253
### List data sources
257254

258255
Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
259-
You can list data sources by Project, type and origin.
260256

261257
**Usage:**
262258

@@ -271,15 +267,15 @@ scw cockpit data-source list [arg=value ...]
271267
|------|---|-------------|
272268
| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `type_asc`, `type_desc` | Sort order for data sources in the response |
273269
| project-id | | Project ID to use. If none is passed the default project ID will be used |
274-
| origin | One of: `unknown_origin`, `scaleway`, `external`, `custom` | Origin to filter for, only data sources with matching origin will be returned |
275-
| types.{index} | One of: `unknown_type`, `metrics`, `logs`, `traces` | Types to filter for, only data sources with matching types will be returned |
270+
| origin | One of: `unknown_origin`, `scaleway`, `external`, `custom` | Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned |
271+
| types.{index} | One of: `unknown_type`, `metrics`, `logs`, `traces` | Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned |
276272
| region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
277273

278274

279275

280276
### Update a data source
281277

282-
Update a given data source name, specified by the data source ID.
278+
Update a given data source attributes (name and/or retention_days).
283279

284280
**Usage:**
285281

@@ -294,7 +290,7 @@ scw cockpit data-source update [arg=value ...]
294290
|------|---|-------------|
295291
| data-source-id | Required | ID of the data source to update |
296292
| name | | Updated name of the data source |
297-
| retention-days | | BETA - Duration for which the data will be retained in the data source |
293+
| retention-days | | Duration for which the data will be retained in the data source |
298294
| 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 |
299295

300296

@@ -710,7 +706,7 @@ Usage overview management commands.
710706

711707
### Get data source usage overview
712708

713-
Retrieve the data source usage overview per type for the specified Project.
709+
Retrieve the volume of data ingested for each of your data sources in the specified project and region.
714710

715711
**Usage:**
716712

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ require (
2323
github.com/mattn/go-isatty v0.0.20
2424
github.com/moby/buildkit v0.13.2
2525
github.com/opencontainers/go-digest v1.0.0
26-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250613151004-c065a4eb7430
26+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250616150134-9c1bc4cca50a
2727
github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966
2828
github.com/spf13/cobra v1.9.1
2929
github.com/spf13/pflag v1.0.6

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -466,8 +466,8 @@ github.com/rogpeppe/go-internal v1.11.0/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUz
466466
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
467467
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
468468
github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
469-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250613151004-c065a4eb7430 h1:npqerdt+HbDkv1+43FdhXNKnzKqkxfwgCCZDHgZRKNE=
470-
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250613151004-c065a4eb7430/go.mod h1:zFWiHphneiey3s8HOtAEnGrRlWivNaxW5T6d5Xfco7g=
469+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250616150134-9c1bc4cca50a h1:p6Zw2NuBsVe9jMhTFtvzDBJYsupKmtV86wEqf5oDevo=
470+
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.33.0.20250616150134-9c1bc4cca50a/go.mod h1:zFWiHphneiey3s8HOtAEnGrRlWivNaxW5T6d5Xfco7g=
471471
github.com/sclevine/spec v1.4.0 h1:z/Q9idDcay5m5irkZ28M7PtQM4aOISzOpj4bUPkDee8=
472472
github.com/sclevine/spec v1.4.0/go.mod h1:LvpgJaFyvQzRvc1kaDs0bulYwzC70PbiYjC4QnFHkOM=
473473
github.com/secure-systems-lab/go-securesystemslib v0.8.0 h1:mr5An6X45Kb2nddcFlbmfHkLguCE9laoZCUzEEpIZXA=

internal/namespaces/cockpit/v1/cockpit_cli.go

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -542,10 +542,7 @@ Deprecated: retention is now managed at the data source level.`,
542542
func cockpitDataSourceCreate() *core.Command {
543543
return &core.Command{
544544
Short: `Create a data source`,
545-
Long: `You must specify the data source type upon creation. Available data source types include:
546-
- metrics
547-
- logs
548-
- traces
545+
Long: `You must specify the data source name and type (metrics, logs, traces) upon creation.
549546
The name of the data source will then be used as reference to name the associated Grafana data source.`,
550547
Namespace: "cockpit",
551548
Resource: "data-source",
@@ -576,7 +573,7 @@ The name of the data source will then be used as reference to name the associate
576573
},
577574
{
578575
Name: "retention-days",
579-
Short: `BETA - Duration for which the data will be retained in the data source`,
576+
Short: `Duration for which the data will be retained in the data source`,
580577
Required: false,
581578
Deprecated: false,
582579
Positional: false,
@@ -635,7 +632,7 @@ func cockpitDataSourceGet() *core.Command {
635632
func cockpitDataSourceDelete() *core.Command {
636633
return &core.Command{
637634
Short: `Delete a data source`,
638-
Long: `Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.`,
635+
Long: `Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.`,
639636
Namespace: "cockpit",
640637
Resource: "data-source",
641638
Verb: "delete",
@@ -675,9 +672,8 @@ func cockpitDataSourceDelete() *core.Command {
675672

676673
func cockpitDataSourceList() *core.Command {
677674
return &core.Command{
678-
Short: `List data sources`,
679-
Long: `Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
680-
You can list data sources by Project, type and origin.`,
675+
Short: `List data sources`,
676+
Long: `Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.`,
681677
Namespace: "cockpit",
682678
Resource: "data-source",
683679
Verb: "list",
@@ -702,7 +698,7 @@ You can list data sources by Project, type and origin.`,
702698
core.ProjectIDArgSpec(),
703699
{
704700
Name: "origin",
705-
Short: `Origin to filter for, only data sources with matching origin will be returned`,
701+
Short: `Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned`,
706702
Required: false,
707703
Deprecated: false,
708704
Positional: false,
@@ -715,7 +711,7 @@ You can list data sources by Project, type and origin.`,
715711
},
716712
{
717713
Name: "types.{index}",
718-
Short: `Types to filter for, only data sources with matching types will be returned`,
714+
Short: `Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned`,
719715
Required: false,
720716
Deprecated: false,
721717
Positional: false,
@@ -756,7 +752,7 @@ You can list data sources by Project, type and origin.`,
756752
func cockpitDataSourceUpdate() *core.Command {
757753
return &core.Command{
758754
Short: `Update a data source`,
759-
Long: `Update a given data source name, specified by the data source ID.`,
755+
Long: `Update a given data source attributes (name and/or retention_days).`,
760756
Namespace: "cockpit",
761757
Resource: "data-source",
762758
Verb: "update",
@@ -779,7 +775,7 @@ func cockpitDataSourceUpdate() *core.Command {
779775
},
780776
{
781777
Name: "retention-days",
782-
Short: `BETA - Duration for which the data will be retained in the data source`,
778+
Short: `Duration for which the data will be retained in the data source`,
783779
Required: false,
784780
Deprecated: false,
785781
Positional: false,
@@ -804,7 +800,7 @@ func cockpitDataSourceUpdate() *core.Command {
804800
func cockpitUsageOverviewGet() *core.Command {
805801
return &core.Command{
806802
Short: `Get data source usage overview`,
807-
Long: `Retrieve the data source usage overview per type for the specified Project.`,
803+
Long: `Retrieve the volume of data ingested for each of your data sources in the specified project and region.`,
808804
Namespace: "cockpit",
809805
Resource: "usage-overview",
810806
Verb: "get",

0 commit comments

Comments
 (0)