Merge pull request #28961 from bmcelvee/BZ1916082

Bug 1916082 bring forward updates to Automatically pruning images

Author: bmcelvee

modules/pruning-images.adoc

@@ -5,12 +5,8 @@
 [id="pruning-images_{context}"]
 = Automatically pruning images
 
-Images that are no longer required by the system due to age, status, or exceed limits are automatically pruned. Cluster administrators can configure the pruning custom resource, or delete it to disable it.
-
-[NOTE]
-====
-When the pruning custom resource is deleted, the pruning `CronJob` and its related components should also be deleted.
-====
+Images that are no longer required by the system due to age,
+status, or exceed limits are automatically pruned. Cluster administrators can configure the Pruning Custom Resource, or suspend it.
 
 .Prerequisites
 
@@ -24,21 +20,20 @@ When the pruning custom resource is deleted, the pruning `CronJob` and its relat
 [source,yaml]
 ----
 spec:
-  schedule: "0 0 * * *" <1>
+  schedule: 0 0 * * * <1>
   suspend: false <2>
   keepTagRevisions: 3 <3>
-  keepYoungerThan: 60m <4>
-  resources: {} <5>
-  affinity: {} <6>
-  nodeSelector: {} <7>
-  tolerations: {} <8>
-  startingDeadlineSeconds: 60 <9>
+  keepYoungerThanDuration: 60m <4>
+  keepYoungerThan: 3600000000000 <5>
+  resources: {} <6>
+  affinity: {} <7>
+  nodeSelector: {} <8>
+  tolerations: [] <9>
   successfulJobsHistoryLimit: 3 <10>
   failedJobsHistoryLimit: 3 <11>
-  logLevel: Normal <12>
 status:
-  observedGeneration: 2 <13>
-  conditions: <14>
+  observedGeneration: 2 <12>
+  conditions: <13>
   - type: Available
     status: "True"
     lastTransitionTime: 2019-10-09T03:13:45
@@ -55,24 +50,19 @@ status:
     reason: Succeeded
     message: "Most recent image pruning job succeeded."
 ----
-<1> `schedule`: `CronJob` formatted schedule, defaults to daily at midnight for new clusters. This is a required field.
-<2> `suspend`: If set to `true`, the `CronJob` running pruning is suspended. This is an optional field, and it defaults to `false`.
-<3> `keepTagRevisions`: The number of revisions per tag to keep. This is an optional field, and it defaults to `3` if not set.
-<4> `keepYoungerThan`: Retain images younger than this duration. This is an optional field, and it defaults `60m` if not set.
-<5> `resources`: Standard `Pod` resource requests and limits. This is an optional field.
-<6> `affinity`: Standard pod affinity. This is an optional field.
-<7> `nodeSelector`: Standard pod node selector for the image pruner pod. This is an optional field.
-<8> `tolerations`: Standard pod tolerations. This is an optional field.
-<9> `startingDeadlineSeconds`: Start deadline for `CronJob`. This is an optional field.
-<10> `successfulJobsHistoryLimit`: The maximum number of successful jobs to retain. Must be `>= 1` to ensure metrics are reported. Defaults to `3` if not set.
-<11> `failedJobsHistoryLimit`: The maximum number of failed jobs to retain. Must be `>= 1` to ensure metrics are reported. Defaults to `3` if not set.
-<12> `logLevel`: Sets the log level for the pruner job. Defaults to `Normal`.
-* `Normal`
-* `Debug`
-* `Trace`
-* `TraceAll`
-<13> `observedGeneration`: The generation observed by the Operator.
-<14> `conditions`: The standard condition objects with the following types:
+<1> `schedule`: `CronJob` formatted schedule. This is an optional field, default is daily at midnight.
+<2> `suspend`: If set to `true`, the `CronJob` running pruning is suspended. This is an optional field, default is `false`. The initial value on new clusters is `false`.
+<3> `keepTagRevisions`: The number of revisions per tag to keep. This is an optional field, default is `3`. The initial value is `3`.
+<4> `keepYoungerThanDuration`: Retain images younger than this duration. This is an optional field. If a value is not specified, either `keepYoungerThan` or the default value `60m` (60 minutes) is used.
+<5> `keepYoungerThan`: Deprecated. The same as `keepYoungerThanDuration`, but the duration is specified as an integer in nanoseconds. This is an optional field. When `keepYoungerThanDuration` is set, this field is ignored.
+<6> `resources`: Standard Pod resource requests and limits. This is an optional field.
+<7> `affinity`: Standard Pod affinity. This is an optional field.
+<8> `nodeSelector`: Standard Pod node selector. This is an optional field.
+<9> `tolerations`: Standard Pod tolerations. This is an optional field.
+<10> `successfulJobsHistoryLimit`: The maximum number of successful jobs to retain. Must be `>= 1` to ensure metrics are reported. This is an optional field, default is `3`. The initial value is `3`.
+<11> `failedJobsHistoryLimit`: The maximum number of failed jobs to retain. Must be `>= 1` to ensure metrics are reported. This is an optional field, default is `3`. The initial value is `3`.
+<12> `observedGeneration`: The generation observed by the Operator.
+<13> `conditions`: The standard condition objects with the following types:
 * `Available`: Indicates if the pruning job has been created. Reasons can be Ready or Error.
 * `Scheduled`: Indicates if the next pruning job has been scheduled. Reasons can be Scheduled, Suspended, or Error.
 * `Failed`: Indicates if the most recent pruning job failed.