add text in the pruning images section for --skip-registry option #6535

gabemontero · 2017-11-29T15:48:41Z

Doc for https://trello.com/c/V1anqimn/1418-5-image-soft-prune-imagestreams

@openshift/sig-developer-experience @bmcelvee ptal

disclaimer: I sided on full transparency for this initial stab, trying to capture the warnings/concerns/recommendations that surfaced during the card planning and pr review activities. Certainly during the
review here, aside form massaging the wording to get it as good as possible, if the details are not appropriate for this context (perhaps better suited to the yet to be crafted, more comprehensive general image pruning recommendation/best-practices guide that @bparees cited), we can of course "prune" ;-) as needed.

gabemontero · 2017-11-29T15:49:14Z

(5) Image soft prune [imagestreams]

bmcelvee · 2017-12-01T14:45:42Z

@gabemontero, thanks! For the most part, this looks good to me. I would suggest rewording the note a bit, something along the lines of:

"Separating the removal of {product-title} Image API Objects and Image data
from the Registry by using --skip-registry followed by xref:#hard-pruning-registry[Hard Pruning the Registry] narrows some timing windows, and is safer when compared to trying
to prune both through one command. However, timing windows are not completely removed.

For example, you can still create a Pod referencing an Image as pruning identifies that Image for pruning. You should still keep track of an API Object created during the pruning operations that might reference Images, so you can mitigate any references to deleted content."

Does it still convey the warning properly?

gabemontero · 2017-12-01T20:55:18Z

pushed update for both flip of name/default for arg, as well as @bmcelvee 's suggestion.

bparees · 2017-12-01T21:48:54Z

admin_guide/pruning_resources.adoc

+
+.^|`--prune-registry`
+|In conjunction with the conditions stipulated by the other options, this option controls
+the operation only considers the {product-title} Image API Objects, or also processes


this option controls the operation only considers the

should be "this option controls whether the"?

bparees · 2017-12-01T21:51:27Z

admin_guide/pruning_resources.adoc

+the corresponding data in the registry.  By default, image pruning processes both the
+Image API Objects and corresponding data in the registry.
+This option makes most sense when there is either a large amount of data in etcd
+and/or a large number of images or blobs. After running with this option set to `false`, you can


I would phrase it as "This options is useful when you are only concerned with removing etcd content, possibly to reduce the number of image objects, but are not concerned with cleaning up registry storage, or intend to do that separately via hard prune, possibly during an appropriate maintenance window for the registry."

bparees · 2017-12-01T21:52:08Z

admin_guide/pruning_resources.adoc

+For example, you can still create a Pod referencing an Image as pruning identifies that
+Image for pruning. You should still keep track of an API Object created during the pruning
+operations that might reference Images, so you can mitigate any references to deleted
+content.


+1, but @legionus may have some additional comments on what we should say here.

Please add a warning that re-doing the pruning without --prune-registry option or with --prune-registry=true will not lead to pruning the storage of image registry. I mean that all images that was pruned with --prune-registry=false can be deleted from the registry storage only by using the hard-pruning otherwise the space will be lost.

Good catch!

gabemontero · 2017-12-04T15:44:02Z

update pushed for @bparees and @legionus suggestions

bparees · 2017-12-04T17:42:56Z

lgtm

bmcelvee · 2017-12-04T19:53:03Z

admin_guide/pruning_resources.adoc

+
+.^|`--prune-registry`
+|In conjunction with the conditions stipulated by the other options, this option controls
+whethers the data in the registry corresponding to the {product-title} Image API Objects


s/whethers/whether

bmcelvee · 2017-12-04T19:53:37Z

admin_guide/pruning_resources.adoc

+.^|`--prune-registry`
+|In conjunction with the conditions stipulated by the other options, this option controls
+whethers the data in the registry corresponding to the {product-title} Image API Objects
+is pruned.  By default, image pruning processes both the


Double space after "...pruned."

bmcelvee · 2017-12-04T19:54:27Z

admin_guide/pruning_resources.adoc

+Image API Objects and corresponding data in the registry.
+This options is useful when you are only concerned with removing etcd content, possibly
+to reduce the number of image objects, but are not concerned with cleaning up registry
+storage, or intend to do that separately via xref:#hard-pruning-registry[Hard Pruning the Registry],


s/registry storage,/registry storage; --Does that make more sense?

bmcelvee · 2017-12-04T19:54:44Z

admin_guide/pruning_resources.adoc

+Image API Objects and corresponding data in the registry.
+This options is useful when you are only concerned with removing etcd content, possibly
+to reduce the number of image objects, but are not concerned with cleaning up registry
+storage, or intend to do that separately via xref:#hard-pruning-registry[Hard Pruning the Registry],


bmcelvee · 2017-12-04T19:58:27Z

admin_guide/pruning_resources.adoc

+
+Also, keep in mind that re-doing the pruning without the `--prune-registry` option or with
+`--prune-registry=true` will not lead to pruning the associated storage in the image registry
+for image previously pruned via `--prune-registry=false`.


bmcelvee · 2017-12-04T19:59:07Z

admin_guide/pruning_resources.adoc

+
+Also, keep in mind that re-doing the pruning without the `--prune-registry` option or with
+`--prune-registry=true` will not lead to pruning the associated storage in the image registry
+for image previously pruned via `--prune-registry=false`.


s/image previously/images previously

or "an image"

bmcelvee · 2017-12-04T19:59:51Z

admin_guide/pruning_resources.adoc

+`--prune-registry=true` will not lead to pruning the associated storage in the image registry
+for image previously pruned via `--prune-registry=false`.
+Any images that were pruned with `--prune-registry=false` can only be deleted from
+registry storage via xref:#hard-pruning-registry[Hard Pruning the Registry].


bmcelvee · 2017-12-04T20:01:37Z

Just a few suggestions from me. Otherwise, looks good!

gabemontero · 2017-12-04T21:07:18Z

thanks @bmcelvee updates pushed

note, let's not merge into latest until openshift/origin#17480 merges

bmcelvee · 2017-12-04T21:10:11Z

Thanks, @gabemontero! Sounds good :)

gabemontero · 2017-12-06T14:46:18Z

hey @bmcelvee openshift/origin#17480 has merged

bmcelvee · 2017-12-06T15:46:26Z

Thanks, @gabemontero! This is going into 3.9 correct?

bmcelvee · 2017-12-06T15:46:54Z

[rev_history]
|xref:..admin_guide/pruning_resources.adoc#admin-guide-pruning-resources[Pruning Objects]
|Added --prune-registry CLI configuration option and corresponding note to the xref:..admin_guide/pruning_resources.adoc#pruning-images[Pruning Images] section.
%

gabemontero · 2017-12-06T16:06:00Z

On Wed, Dec 6, 2017 at 10:46 AM, Brandi McElveen Munilla < ***@***.***> wrote: Thanks, @gabemontero <https://github.com/gabemontero>! This is going into 3.9 correct?

yep 3.9

…

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6535 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ADbadAa-_FR7D0XrpGnfao7Xw6v_Aa4Nks5s9rbUgaJpZM4QvLiF> .

…egistry option (cherry picked from commit 1015e9a) xref:openshift#6535

gabemontero force-pushed the soft-prune branch from e74a594 to 7c48e61 Compare December 1, 2017 20:54

openshift-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 1, 2017

bparees reviewed Dec 1, 2017

View reviewed changes

gabemontero force-pushed the soft-prune branch from 7c48e61 to a722744 Compare December 4, 2017 15:42

openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Dec 4, 2017

bmcelvee reviewed Dec 4, 2017

View reviewed changes

add text in the pruning images section for --prune-registry option

1015e9a

gabemontero force-pushed the soft-prune branch from a722744 to 1015e9a Compare December 4, 2017 21:06

bmcelvee added the branch/enterprise-3.9 label Dec 6, 2017

bmcelvee added this to the Future Release milestone Dec 6, 2017

bmcelvee merged commit b55f0c9 into openshift:master Dec 6, 2017

bmcelvee pushed a commit to bmcelvee/openshift-docs that referenced this pull request Dec 6, 2017

[enterprise-3.9] add text in the pruning images section for --prune-r…

4038b5a

…egistry option (cherry picked from commit 1015e9a) xref:openshift#6535

bmcelvee mentioned this pull request Dec 6, 2017

[enterprise-3.9] add text in the pruning images section for --prune-r… #6632

Merged

gabemontero deleted the soft-prune branch December 6, 2017 20:01

vikram-redhat modified the milestones: Future Release, OCP 3.9 GA Mar 28, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add text in the pruning images section for --skip-registry option #6535

add text in the pruning images section for --skip-registry option #6535

gabemontero commented Nov 29, 2017

gabemontero commented Nov 29, 2017

bmcelvee commented Dec 1, 2017

gabemontero commented Dec 1, 2017

bparees Dec 1, 2017

bparees Dec 1, 2017

bparees Dec 1, 2017

legionus Dec 3, 2017

bparees Dec 3, 2017

gabemontero commented Dec 4, 2017

bparees commented Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee Dec 4, 2017

bmcelvee commented Dec 4, 2017

gabemontero commented Dec 4, 2017

bmcelvee commented Dec 4, 2017

gabemontero commented Dec 6, 2017

bmcelvee commented Dec 6, 2017

bmcelvee commented Dec 6, 2017

gabemontero commented Dec 6, 2017 via email

add text in the pruning images section for --skip-registry option #6535

add text in the pruning images section for --skip-registry option #6535

Conversation

gabemontero commented Nov 29, 2017

gabemontero commented Nov 29, 2017

bmcelvee commented Dec 1, 2017

gabemontero commented Dec 1, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gabemontero commented Dec 4, 2017

bparees commented Dec 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bmcelvee commented Dec 4, 2017

gabemontero commented Dec 4, 2017

bmcelvee commented Dec 4, 2017

gabemontero commented Dec 6, 2017

bmcelvee commented Dec 6, 2017

bmcelvee commented Dec 6, 2017

gabemontero commented Dec 6, 2017 via email