Rework the command-line interface #292
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
jrbriggs
approved these changes
Jan 13, 2020
kewillford
approved these changes
Jan 14, 2020
|
|
||
| private string GetMaintenanceDelayFilePath() | ||
| { | ||
| return Path.Combine(this.registryFolderPath, "maintenance-pause.time"); |
There was a problem hiding this comment.
Why use a .time extension? My personal preference would be to use the name of maintenance-pause-time and a .txt extension or no extension.
There was a problem hiding this comment.
That's what we are using for the loose object step and packfile maintenance step.
| new PhysicalFileSystem(), | ||
| repoRegistryLocation); | ||
|
|
||
| if (!repoRegistry.TryPauseMaintenanceUntil(pauseTime, out string error)) |
There was a problem hiding this comment.
Thinking out loud here and what do we expect if there are tasks running when someone runs pause? Are they going to expect that nothing is running now and they can do some work without them running or will they know that there could be some tasks running that would need to finish?
There was a problem hiding this comment.
That's a good question. Do we expect those steps to stop? If there are multiple enlistments, then should it stop during the "for each enlistment" loop?
There was a problem hiding this comment.
I added details to #284 with these questions.
Co-Authored-By: Kevin Willford <kewillf@microsoft.com> Co-Authored-By: John Briggs <jobriggs@microsoft.com> Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
derrickstolee
added a commit
that referenced
this pull request
Jan 23, 2020
…task The `PauseVerb` was added along with a lot of other things in #292. It creates a file storing a timestamp for marking how long to pause maintenance. As noted in #284, this was inadequate. If there are a lot of enlistments and a user runs `scalar pause` in the middle of iterating over those enlistments, the maintenance task will continue to run over all of those enlistments. Now, stop before triggering a new `scalar run <task>` process. Modify the markdown with the details for how many maintenance tasks completed and whether or not it was halted due to a pause. Here is a formatted version of a trace event for a task during pause: ``` [2020-01-22 17:17:57.7293 -05:00] RunMaintenanceTaskForRepos_MaintenanceSummary { "task":"loose-objects", "UserId":"S-1-5-21-4082248826-4152932973-4176629329-1001", "SessionId":1, "traceMessage":"Maintenance is paused until 1/23/2020 4:14:44 AM.", "reposInRegistryForUser":11, "reposSkipped":11, "reposSuccessfullyRemoved":0, "repoRemovalFailures":0, "reposMaintained":0, "haltedForPause":true } ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is probably too large and I'll need to split it into smaller parts. However, it has the full story of how to redo our command-line interface:
Commands
clone,diagnose,config,cache-serverare untouched.The
reposcommand is dropped in favor ofregister,list, andunregister. Resolves ReposVerb: alternate names for add/remove #286.Created the
pauseandresumecommands. Starts New Feature: pause maintenance #284.Replaced
removewithdelete. Resolves MakeRemoveVerba subset ofReposVerb#274.Reorganized the
docsfolder. Instead of a command reference page for each command, commands are grouped by purpose and documented together. These sections are:clone,register,unregister,delete.run,pause,resume.upgrade,diagnose,config,cache-server.Not done yet, but can be done in a later PR:
Update the
README.mdwith new information and point to the docs.scalar run allto run all maintenance tasks on an enlistment. (See MaintenanceVerb: run all tasks #287)