You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -141,9 +141,9 @@ named arguments:
141
141
-s {true,false}, --skipprcreation {true,false}
142
142
Only update image tag store. Skip creating PRs
143
143
-x X comment snippet mentioned in line just before FROM instruction for ignoring a child image. Defaults to 'no-dfiu'
144
-
-r, --rate-limit-pr-creations
144
+
-r, --rate_limit_pr_creations
145
145
Enable rateLimiting for throttling the number of PRs DFIU will cut over a period of time.
146
-
The argument value should be in format "<positive_integer>-<ISO-8601_formatted_time>". For example "--rate-limit-pr-creations 60-PT1H" to create 60 PRs per hour.
146
+
The argument value should be in format "<positive_integer>-<ISO-8601_formatted_time>". For example "--rate_limit_pr_creations 60-PT1H" to create 60 PRs per hour.
147
147
Default is not set, this means no ratelimiting is imposed.
148
148
149
149
subcommands:
@@ -220,11 +220,11 @@ FROM imagename:imagetag # no-dfiu
220
220
### PR throttling
221
221
222
222
In case you want to throttle the number of PRs cut by DFIU over a period of time,
223
-
set --rate-limit-pr-creations with appropriate value.
223
+
set --rate_limit_pr_creations with appropriate value.
224
224
225
225
##### Default case:
226
226
227
-
By default, this feature is disabled. This will be enabled when argument ``--rate-limit-pr-creations`` will be passed
227
+
By default, this feature is disabled. This will be enabled when argument ``--rate_limit_pr_creations`` will be passed
228
228
with appropriate value.
229
229
230
230
```
@@ -234,9 +234,9 @@ example: dockerfile-image-update all image-tag-store-repo-falcon //throttling wi
234
234
##### Configuring the rate limit:
235
235
236
236
Below are some examples that will throttle the number of PRs cut based on values passed to the
237
-
argument ``--rate-limit-pr-creations``
237
+
argument ``--rate_limit_pr_creations``
238
238
The argument value should be in format ``<positive_integer>-<ISO-8601_formatted_time>``.
239
-
For example ``--rate-limit-pr-creations 60-PT1H`` would mean the tool will cut 60 PRs every hour and the rate of adding
239
+
For example ``--rate_limit_pr_creations 60-PT1H`` would mean the tool will cut 60 PRs every hour and the rate of adding
240
240
a new PR will be (PT1H/60) i.e. one minute.
241
241
This will distribute the load uniformly and avoid sudden spikes, The process will go in waiting state until next PR
242
242
could be sent.
@@ -245,11 +245,11 @@ Below are some more examples:
245
245
246
246
```
247
247
Usage:
248
-
dockerfile-image-update --rate-limit-pr-creations 60-PT1H all image-tag-store-repo-falcon //DFIU can send up to 60 PRs per hour.
249
-
dockerfile-image-update --rate-limit-pr-creations 500-PT1H all image-tag-store-repo-falcon //DFIU can send up to 500 PRs per hour.
250
-
dockerfile-image-update --rate-limit-pr-creations 86400-PT24H all image-tag-store-repo-falcon //DFIU can send up to 1 PRs per second.
251
-
dockerfile-image-update --rate-limit-pr-creations 1-PT1S all image-tag-store-repo-falcon //Same as above. DFIU can send up to 1 PRs per second.
252
-
dockerfile-image-update --rate-limit-pr-creations 5000 all image-tag-store-repo-falcon //rate limiting will be disabled because argument is not in correct format.
248
+
dockerfile-image-update --rate_limit_pr_creations 60-PT1H all image-tag-store-repo-falcon //DFIU can send up to 60 PRs per hour.
249
+
dockerfile-image-update --rate_limit_pr_creations 500-PT1H all image-tag-store-repo-falcon //DFIU can send up to 500 PRs per hour.
250
+
dockerfile-image-update --rate_limit_pr_creations 86400-PT24H all image-tag-store-repo-falcon //DFIU can send up to 1 PRs per second.
251
+
dockerfile-image-update --rate_limit_pr_creations 1-PT1S all image-tag-store-repo-falcon //Same as above. DFIU can send up to 1 PRs per second.
252
+
dockerfile-image-update --rate_limit_pr_creations 5000 all image-tag-store-repo-falcon //rate limiting will be disabled because argument is not in correct format.
0 commit comments