diff --git a/docs/docs/100-reference/01-command-line/acorn_image.md b/docs/docs/100-reference/01-command-line/acorn_image.md index 1e6985096..05785d1d6 100644 --- a/docs/docs/100-reference/01-command-line/acorn_image.md +++ b/docs/docs/100-reference/01-command-line/acorn_image.md @@ -43,6 +43,4 @@ acorn images * [acorn image copy](acorn_image_copy.md) - Copy Acorn images between registries * [acorn image details](acorn_image_details.md) - Show details of an Image * [acorn image rm](acorn_image_rm.md) - Delete an Image -* [acorn image sign](acorn_image_sign.md) - Sign an Image -* [acorn image verify](acorn_image_verify.md) - Verify Image Signatures diff --git a/docs/docs/100-reference/01-command-line/acorn_image_sign.md b/docs/docs/100-reference/01-command-line/acorn_image_sign.md deleted file mode 100644 index ddca98245..000000000 --- a/docs/docs/100-reference/01-command-line/acorn_image_sign.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: "acorn image sign" ---- -## acorn image sign - -Sign an Image - -``` -acorn image sign IMAGE_NAME [flags] -``` - -### Examples - -``` -acorn image sign my-image --key ./my-key -``` - -### Options - -``` - -a, --annotation strings Annotations to add to the signature - -h, --help help for sign - -k, --key string Key to use for signing -``` - -### Options inherited from parent commands - -``` - --config-file string Path of the acorn config file to use - --debug Enable debug logging - --debug-level int Debug log level (valid 0-9) (default 7) - --kubeconfig string Explicitly use kubeconfig file, overriding the default context - -j, --project string Project to work in -``` - -### SEE ALSO - -* [acorn image](acorn_image.md) - Manage images - diff --git a/docs/docs/100-reference/01-command-line/acorn_image_verify.md b/docs/docs/100-reference/01-command-line/acorn_image_verify.md deleted file mode 100644 index c4fc523d5..000000000 --- a/docs/docs/100-reference/01-command-line/acorn_image_verify.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "acorn image verify" ---- -## acorn image verify - -Verify Image Signatures - -``` -acorn image verify IMAGE_NAME [flags] -``` - -### Examples - -``` -# Verify using a locally stored public key file -acorn image verify my-image --key ./my-key.pub - -# Verify using a public key belonging to a GitHub Identity -acorn image verify my-image --key gh://ibuildthecloud - -# Verify using a public key belonging to an Acorn Manager Identity -acorn image verify my-image --key acorn://ibuildthecloud - -``` - -### Options - -``` - -a, --annotation strings Annotations to check for in the signature - -h, --help help for verify - -k, --key string Key to use for verifying -``` - -### Options inherited from parent commands - -``` - --config-file string Path of the acorn config file to use - --debug Enable debug logging - --debug-level int Debug log level (valid 0-9) (default 7) - --kubeconfig string Explicitly use kubeconfig file, overriding the default context - -j, --project string Project to work in -``` - -### SEE ALSO - -* [acorn image](acorn_image.md) - Manage images - diff --git a/docs/docs/100-reference/01-command-line/acorn_push.md b/docs/docs/100-reference/01-command-line/acorn_push.md index a7dc2aa77..d5edf0592 100644 --- a/docs/docs/100-reference/01-command-line/acorn_push.md +++ b/docs/docs/100-reference/01-command-line/acorn_push.md @@ -12,10 +12,7 @@ acorn push [flags] IMAGE ### Options ``` - -h, --help help for push - -k, --key string Key to use for signing (default "./cosign.key") - -s, --sign Sign the image before pushing - -a, --signature-annotation strings Annotations to add to the signature + -h, --help help for push ``` ### Options inherited from parent commands diff --git a/pkg/cli/images_sign.go b/pkg/cli/images_sign.go index e2c3f23e8..9544f9bcc 100644 --- a/pkg/cli/images_sign.go +++ b/pkg/cli/images_sign.go @@ -28,6 +28,7 @@ func NewImageSign(c CommandContext) *cobra.Command { Short: "Sign an Image", ValidArgsFunction: newCompletion(c.ClientFactory, imagesCompletion(true)).complete, Args: cobra.ExactArgs(1), + Hidden: true, }) _ = cmd.MarkFlagFilename("key") return cmd diff --git a/pkg/cli/images_verify.go b/pkg/cli/images_verify.go index 5d14c7bfa..5862d303b 100644 --- a/pkg/cli/images_verify.go +++ b/pkg/cli/images_verify.go @@ -28,6 +28,7 @@ acorn image verify my-image --key acorn://ibuildthecloud Short: "Verify Image Signatures", ValidArgsFunction: newCompletion(c.ClientFactory, imagesCompletion(true)).complete, Args: cobra.ExactArgs(1), + Hidden: true, }) _ = cmd.MarkFlagFilename("key") return cmd diff --git a/pkg/cli/push.go b/pkg/cli/push.go index 29034bf96..ee26e2adb 100644 --- a/pkg/cli/push.go +++ b/pkg/cli/push.go @@ -20,9 +20,9 @@ func NewPush(c CommandContext) *cobra.Command { type Push struct { client ClientFactory - Sign bool `usage:"Sign the image before pushing" short:"s" local:"true" default:"false"` - Key string `usage:"Key to use for signing" short:"k" local:"true" default:"./cosign.key"` - SignatureAnnotations map[string]string `usage:"Annotations to add to the signature" short:"a" local:"true" name:"signature-annotation"` + Sign bool `hidden:"true" usage:"Sign the image before pushing" short:"s" local:"true" default:"false" ` + Key string `hidden:"true" usage:"Key to use for signing" short:"k" local:"true" default:"./cosign.key"` + SignatureAnnotations map[string]string `hidden:"true" usage:"Annotations to add to the signature" short:"a" local:"true" name:"signature-annotation"` } func (s *Push) Run(cmd *cobra.Command, args []string) error {