Merge pull request #11973 from smarterclayton/mirror_pullthrough

Merged by openshift-bot

Author: OpenShift Bot

contrib/completions/bash/oadm

@@ -4108,6 +4108,8 @@ _oadm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

contrib/completions/bash/oc

@@ -4161,6 +4161,8 @@ _oc_adm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

contrib/completions/bash/openshift

@@ -4108,6 +4108,8 @@ _openshift_admin_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")
@@ -8723,6 +8725,8 @@ _openshift_cli_adm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

contrib/completions/zsh/oadm

@@ -4269,6 +4269,8 @@ _oadm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

contrib/completions/zsh/oc

@@ -4322,6 +4322,8 @@ _oc_adm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

contrib/completions/zsh/openshift

@@ -4269,6 +4269,8 @@ _openshift_admin_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")
@@ -8884,6 +8886,8 @@ _openshift_cli_adm_prune_images()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--all")
+    local_nonpersistent_flags+=("--all")
     flags+=("--certificate-authority=")
     local_nonpersistent_flags+=("--certificate-authority=")
     flags+=("--confirm")

docs/generated/oadm_by_example_content.adoc

@@ -649,7 +649,7 @@ Remove unreferenced images
   oadm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm
   
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   oadm prune images --prune-over-size-limit
   
   # To actually perform the prune operation, the confirm flag must be appended

docs/generated/oc_by_example_content.adoc

@@ -649,7 +649,7 @@ Remove unreferenced images
   oc adm prune images --keep-tag-revisions=3 --keep-younger-than=60m --confirm
   
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   oc adm prune images --prune-over-size-limit
   
   # To actually perform the prune operation, the confirm flag must be appended

docs/man/man1/oadm-prune-images.1

@@ -13,7 +13,10 @@ oadm prune images \- Remove unreferenced images
 
 .SH DESCRIPTION
 .PP
-Prune images no longer needed due to age and/or status
+Remove image stream tags, images, and image layers by age or usage
+
+.PP
+This command removes historical image stream tags, unused images, and unreferenced image layers from the integrated registry. It prefers images that have been directly pushed to the registry, but you may specify \-\-all to include images that were imported (if registry mirroring is enabled).
 
 .PP
 By default, the prune operation performs a dry run making no changes to internal registry. A \-\-confirm flag is needed for changes to be effective.
@@ -23,6 +26,10 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
 
 
 .SH OPTIONS
+.PP
+\fB\-\-all\fP=false
+    Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires \-\-registry\-url
+
 .PP
 \fB\-\-certificate\-authority\fP=""
     The path to a certificate authority bundle to use when communicating with the managed Docker registries. Defaults to the certificate authority data from the current user's config file.
@@ -127,7 +134,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
   oadm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm
 
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   oadm prune images \-\-prune\-over\-size\-limit
 
   # To actually perform the prune operation, the confirm flag must be appended

docs/man/man1/oc-adm-prune-images.1

@@ -13,7 +13,10 @@ oc adm prune images \- Remove unreferenced images
 
 .SH DESCRIPTION
 .PP
-Prune images no longer needed due to age and/or status
+Remove image stream tags, images, and image layers by age or usage
+
+.PP
+This command removes historical image stream tags, unused images, and unreferenced image layers from the integrated registry. It prefers images that have been directly pushed to the registry, but you may specify \-\-all to include images that were imported (if registry mirroring is enabled).
 
 .PP
 By default, the prune operation performs a dry run making no changes to internal registry. A \-\-confirm flag is needed for changes to be effective.
@@ -23,6 +26,10 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
 
 
 .SH OPTIONS
+.PP
+\fB\-\-all\fP=false
+    Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires \-\-registry\-url
+
 .PP
 \fB\-\-certificate\-authority\fP=""
     The path to a certificate authority bundle to use when communicating with the managed Docker registries. Defaults to the certificate authority data from the current user's config file.
@@ -127,7 +134,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
   oc adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm
 
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   oc adm prune images \-\-prune\-over\-size\-limit
 
   # To actually perform the prune operation, the confirm flag must be appended

docs/man/man1/openshift-admin-prune-images.1

@@ -13,7 +13,10 @@ openshift admin prune images \- Remove unreferenced images
 
 .SH DESCRIPTION
 .PP
-Prune images no longer needed due to age and/or status
+Remove image stream tags, images, and image layers by age or usage
+
+.PP
+This command removes historical image stream tags, unused images, and unreferenced image layers from the integrated registry. It prefers images that have been directly pushed to the registry, but you may specify \-\-all to include images that were imported (if registry mirroring is enabled).
 
 .PP
 By default, the prune operation performs a dry run making no changes to internal registry. A \-\-confirm flag is needed for changes to be effective.
@@ -23,6 +26,10 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
 
 
 .SH OPTIONS
+.PP
+\fB\-\-all\fP=false
+    Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires \-\-registry\-url
+
 .PP
 \fB\-\-certificate\-authority\fP=""
     The path to a certificate authority bundle to use when communicating with the managed Docker registries. Defaults to the certificate authority data from the current user's config file.
@@ -127,7 +134,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
   openshift admin prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm
 
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   openshift admin prune images \-\-prune\-over\-size\-limit
 
   # To actually perform the prune operation, the confirm flag must be appended

docs/man/man1/openshift-cli-adm-prune-images.1

@@ -13,7 +13,10 @@ openshift cli adm prune images \- Remove unreferenced images
 
 .SH DESCRIPTION
 .PP
-Prune images no longer needed due to age and/or status
+Remove image stream tags, images, and image layers by age or usage
+
+.PP
+This command removes historical image stream tags, unused images, and unreferenced image layers from the integrated registry. It prefers images that have been directly pushed to the registry, but you may specify \-\-all to include images that were imported (if registry mirroring is enabled).
 
 .PP
 By default, the prune operation performs a dry run making no changes to internal registry. A \-\-confirm flag is needed for changes to be effective.
@@ -23,6 +26,10 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
 
 
 .SH OPTIONS
+.PP
+\fB\-\-all\fP=false
+    Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires \-\-registry\-url
+
 .PP
 \fB\-\-certificate\-authority\fP=""
     The path to a certificate authority bundle to use when communicating with the managed Docker registries. Defaults to the certificate authority data from the current user's config file.
@@ -127,7 +134,7 @@ Only a user with a cluster role system:image\-pruner or higher who is logged\-in
   openshift cli adm prune images \-\-keep\-tag\-revisions=3 \-\-keep\-younger\-than=60m \-\-confirm
 
   # See, what the prune command would delete if we're interested in removing images
-  # exceeding currently set LimitRanges ('openshift.io/Image')
+  # exceeding currently set limit ranges ('openshift.io/Image')
   openshift cli adm prune images \-\-prune\-over\-size\-limit
 
   # To actually perform the prune operation, the confirm flag must be appended

images/dockerregistry/config.yml

@@ -13,7 +13,7 @@ storage:
 auth:
   openshift:
     realm: openshift
-    
+
     # tokenrealm is a base URL to use for the token-granting registry endpoint.
     # If unspecified, the scheme and host for the token redirect are determined from the incoming request.
     # If specified, a scheme and host must be chosen that all registry clients can resolve and access:
@@ -27,6 +27,7 @@ middleware:
       options:
         acceptschema2: false
         pullthrough: true
+        mirrorpullthrough: true
         enforcequota: false
         projectcachettl: 1m
         blobrepositorycachettl: 10m

pkg/cmd/admin/prune/images.go

@@ -34,7 +34,12 @@ const PruneImagesRecommendedName = "images"
 
 var (
 	imagesLongDesc = templates.LongDesc(`
-		Prune images no longer needed due to age and/or status
+		Remove image stream tags, images, and image layers by age or usage
+
+		This command removes historical image stream tags, unused images, and unreferenced image
+		layers from the integrated registry. It prefers images that have been directly pushed to
+		the registry, but you may specify --all to include images that were imported (if registry
+		mirroring is enabled).
 
 		By default, the prune operation performs a dry run making no changes to internal registry. A
 		--confirm flag is needed for changes to be effective.
@@ -51,7 +56,7 @@ var (
 	  %[1]s %[2]s --keep-tag-revisions=3 --keep-younger-than=60m --confirm
 
 	  # See, what the prune command would delete if we're interested in removing images
-	  # exceeding currently set LimitRanges ('openshift.io/Image')
+	  # exceeding currently set limit ranges ('openshift.io/Image')
 	  %[1]s %[2]s --prune-over-size-limit
 
 	  # To actually perform the prune operation, the confirm flag must be appended
@@ -70,6 +75,7 @@ type PruneImagesOptions struct {
 	KeepYoungerThan     *time.Duration
 	KeepTagRevisions    *int
 	PruneOverSizeLimit  *bool
+	AllImages           *bool
 	CABundle            string
 	RegistryUrlOverride string
 	Namespace           string
@@ -82,11 +88,13 @@ type PruneImagesOptions struct {
 
 // NewCmdPruneImages implements the OpenShift cli prune images command.
 func NewCmdPruneImages(f *clientcmd.Factory, parentName, name string, out io.Writer) *cobra.Command {
+	allImages := false
 	opts := &PruneImagesOptions{
 		Confirm:            false,
 		KeepYoungerThan:    &defaultKeepYoungerThan,
 		KeepTagRevisions:   &defaultKeepTagRevisions,
 		PruneOverSizeLimit: &defaultPruneImageOverSizeLimit,
+		AllImages:          &allImages,
 	}
 
 	cmd := &cobra.Command{
@@ -104,6 +112,7 @@ func NewCmdPruneImages(f *clientcmd.Factory, parentName, name string, out io.Wri
 	}
 
 	cmd.Flags().BoolVar(&opts.Confirm, "confirm", opts.Confirm, "Specify that image pruning should proceed. Defaults to false, displaying what would be deleted but not actually deleting anything.")
+	cmd.Flags().BoolVar(opts.AllImages, "all", *opts.AllImages, "Include images that were not pushed to the registry but have been mirrored by pullthrough. Requires --registry-url")
 	cmd.Flags().DurationVar(opts.KeepYoungerThan, "keep-younger-than", *opts.KeepYoungerThan, "Specify the minimum age of an image for it to be considered a candidate for pruning.")
 	cmd.Flags().IntVar(opts.KeepTagRevisions, "keep-tag-revisions", *opts.KeepTagRevisions, "Specify the number of image revisions for a tag in an image stream that will be preserved.")
 	cmd.Flags().BoolVar(opts.PruneOverSizeLimit, "prune-over-size-limit", *opts.PruneOverSizeLimit, "Specify if images which are exceeding LimitRanges (see 'openshift.io/Image'), specified in the same namespace, should be considered for pruning. This flag cannot be combined with --keep-younger-than nor --keep-tag-revisions.")
@@ -130,6 +139,11 @@ func (o *PruneImagesOptions) Complete(f *clientcmd.Factory, cmd *cobra.Command,
 			o.KeepTagRevisions = nil
 		}
 	}
+	if *o.AllImages {
+		if len(o.RegistryUrlOverride) == 0 {
+			return kcmdutil.UsageError(cmd, "--registry-url must be specified when --all is true")
+		}
+	}
 	o.Namespace = kapi.NamespaceAll
 	if cmd.Flags().Lookup("namespace").Changed {
 		var err error
@@ -228,6 +242,7 @@ func (o PruneImagesOptions) Run() error {
 		KeepYoungerThan:    o.KeepYoungerThan,
 		KeepTagRevisions:   o.KeepTagRevisions,
 		PruneOverSizeLimit: o.PruneOverSizeLimit,
+		AllImages:          o.AllImages,
 		Images:             allImages,
 		Streams:            allStreams,
 		Pods:               allPods,