Skip to content

Commit

Permalink
fix trusted resources docs error
Browse files Browse the repository at this point in the history 
This commit fixes the error in trusted resources docs. The example of
using kms key uses wrong flag and should be corrected.

Signed-off-by: Yongxuan Zhang [email protected]
  • Loading branch information
@Yongxuanzhang @tekton-robot
Yongxuanzhang authored and tekton-robot committed Jan 5, 2023
1 parent 1d3f2a7 commit bffa7bd
Show file tree
Hide file tree
Showing 12 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipeline_sign.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ tkn pipeline sign
Sign a Pipeline pipeline.yaml:
tkn pipeline sign pipeline.yaml -K=cosign.key -f=signed.yaml
or using kms
tkn pipeline sign pipeline.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml
tkn pipeline sign pipeline.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_pipeline_verify.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ tkn pipeline verify
Verify a Pipeline signed.yaml:
tkn pipeline verify signed.yaml -K=cosign.pub
or using kms
tkn pipeline verify signed.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION
tkn pipeline verify signed.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_task_sign.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ tkn task sign
Sign a Task task.yaml:
tkn task sign task.yaml -K=cosign.key -f=signed.yaml
or using kms
tkn task sign task.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml
tkn task sign task.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/cmd/tkn_task_verify.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ tkn task verify
Verify a Task signed.yaml:
tkn Task verify signed.yaml -K=cosign.pub
or using kms
tkn Task verify signed.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION
tkn Task verify signed.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION

### Options

Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/tkn-pipeline-sign.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For KMS:
Sign a Pipeline pipeline.yaml:
tkn pipeline sign pipeline.yaml \-K=cosign.key \-f=signed.yaml
or using kms
tkn pipeline sign pipeline.yaml \-K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION \-f=signed.yaml
tkn pipeline sign pipeline.yaml \-m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION \-f=signed.yaml


.SH SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/tkn-pipeline-verify.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ For KMS:
Verify a Pipeline signed.yaml:
tkn pipeline verify signed.yaml \-K=cosign.pub
or using kms
tkn pipeline verify signed.yaml \-K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION
tkn pipeline verify signed.yaml \-m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION


.SH SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/tkn-task-sign.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For KMS:
Sign a Task task.yaml:
tkn task sign task.yaml \-K=cosign.key \-f=signed.yaml
or using kms
tkn task sign task.yaml \-K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION \-f=signed.yaml
tkn task sign task.yaml \-m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION \-f=signed.yaml


.SH SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion docs/man/man1/tkn-task-verify.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ For KMS:
Verify a Task signed.yaml:
tkn Task verify signed.yaml \-K=cosign.pub
or using kms
tkn Task verify signed.yaml \-K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION
tkn Task verify signed.yaml \-m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION


.SH SEE ALSO
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/pipeline/sign.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ func signCommand(p cli.Params) *cobra.Command {
eg := `Sign a Pipeline pipeline.yaml:
tkn pipeline sign pipeline.yaml -K=cosign.key -f=signed.yaml
or using kms
tkn pipeline sign pipeline.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml`
tkn pipeline sign pipeline.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml`
long := `
Sign the Tekton Pipeline with user provided private key file or KMS reference. Key files support ecdsa, ed25519, rsa.
For KMS:
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/pipeline/verify.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func verifyCommand(p cli.Params) *cobra.Command {
eg := `Verify a Pipeline signed.yaml:
tkn pipeline verify signed.yaml -K=cosign.pub
or using kms
tkn pipeline verify signed.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION`
tkn pipeline verify signed.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION`
long := `
Verify the Tekton Pipeline with user provided private key file or KMS reference. Key files support ecdsa, ed25519, rsa.
For KMS:
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/task/sign.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func signCommand(p cli.Params) *cobra.Command {
eg := `Sign a Task task.yaml:
tkn task sign task.yaml -K=cosign.key -f=signed.yaml
or using kms
tkn task sign task.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml`
tkn task sign task.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION -f=signed.yaml`
long := `
Sign the Tekton Task with user provided private key file or KMS reference. Key files support ecdsa, ed25519, rsa.
For KMS:
Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/task/verify.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func verifyCommand(p cli.Params) *cobra.Command {
eg := `Verify a Task signed.yaml:
tkn Task verify signed.yaml -K=cosign.pub
or using kms
tkn Task verify signed.yaml -K=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION`
tkn Task verify signed.yaml -m=gcpkms://projects/PROJECTID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY/cryptoKeyVersions/VERSION`
long := `
Verify the Tekton Task with user provided private key file or KMS reference. Key files support ecdsa, ed25519, rsa.
For KMS:
Expand Down

0 comments on commit bffa7bd

Please sign in to comment.