Skip to content

fix(secret): remake examples #2881

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 20, 2023
Merged

fix(secret): remake examples #2881

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/scw/testdata/test-all-usage-secret-secret-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ USAGE:

EXAMPLES:
Add a given Secret
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"

ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
Expand Down
4 changes: 4 additions & 0 deletions cmd/scw/testdata/test-all-usage-secret-version-create-usage.golden
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ Create a SecretVersion.
USAGE:
scw secret version create [arg=value ...]

EXAMPLES:
Add a given Secret Version
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>

ARGS:
secret-id ID of the Secret
data Content of the secret version. Base64 is handled by the SDK (Support file loading with @/path/to/file)
Expand Down
12 changes: 11 additions & 1 deletion docs/commands/secret.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ scw secret secret create [arg=value ...]

Add a given Secret
```
scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"
scw secret secret create project-id=<your-project-id> name="foobar" description="bar"
```


Expand Down Expand Up @@ -203,6 +203,16 @@ scw secret version create [arg=value ...]
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |


**Examples:**


Add a given Secret Version
```
scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>
```




### Destroy a SecretVersion, permanently destroying the sensitive data

Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ require (
github.com/kubernetes-client/go-base v0.0.0-20190205182333-3d0e39759d98
github.com/mattn/go-colorable v0.1.13
github.com/mattn/go-isatty v0.0.17
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02
github.com/spf13/cobra v1.6.1
github.com/spf13/pflag v1.0.5
github.com/stretchr/testify v1.8.2
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ github.com/pkg/term v1.1.0/go.mod h1:E25nymQcrSllhX42Ok8MRm1+hyBdHY0dCeiKZ9jpNGw
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42 h1:8X7HJIk2/9N3PCt7jrp3DPLDr8ev3ilzJJaW+vx4LN4=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230314173919-2ec24bb08c42/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02 h1:Ipdjm5oXQtzoHxsc1Pj7LqOlNJh5HrVb4R9TRpFiwKM=
github.com/scaleway/scaleway-sdk-go v1.0.0-beta.14.0.20230318120603-8df14b12fd02/go.mod h1:fCa7OJZ/9DRTnOKmxvT6pn+LPWUptQAmHF/SBJUGEcg=
github.com/sergi/go-diff v1.2.0 h1:XU+rvMAioB0UC3q1MFrIQy4Vo5/4VsRDQQXHsEya6xQ=
github.com/sergi/go-diff v1.2.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=
Expand Down
8 changes: 7 additions & 1 deletion internal/namespaces/secret/v1alpha1/secret_cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ func secretSecretCreate() *core.Command {
Examples: []*core.Example{
{
Short: "Add a given Secret",
Raw: `scw secret secret create name=foobar description="$(cat <path/to/your/secret>)"`,
Raw: `scw secret secret create project-id=<your-project-id> name="foobar" description="bar"`,
},
},
}
Expand Down Expand Up @@ -347,6 +347,12 @@ func secretVersionCreate() *core.Command {
return api.CreateSecretVersion(request)

},
Examples: []*core.Example{
{
Short: "Add a given Secret Version",
Raw: `scw secret version create name=foobar secret-id="<secret-id>" data=@<path/to/your/secret/file>`,
},
},
}
}

Expand Down