Add job and service support fields: owner, summary, notes. #310
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
added 8 commits
August 27, 2015 06:58
With a large tronfig managed by many people, it can be difficult to know who should be contacted when performing maintenance. Namespaces help with this, but it is still hard without going to the job code itself, or git blame. This allows job/service authors to put contact details, a summary of the job/services purpose, and any support notes they feel are relevant, by adding the following optional fields to the job and service schemas: * 'owner' (string) * 'summary' (string) * 'notes' (string)
Adds service owner,summary,notes to JSON returned by /api/service Adds service owner,summary,notes to per-service tronview Adds owner to service summary in general tronview.
This adds a sample tronfig that tests out the new service fields. A key change is the addition of the sshd_config, as MaxSessions is needed for Tron.
* owner/summary/notes now available.
For some reason it's still not working, but this fixes the first problem.
|
@yyejun -- could you review? |
yyejun
pushed a commit
that referenced
this pull request
Oct 2, 2015
Add job and service support fields: owner, summary, notes.
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.
When supporting Tron with a large configuration managed by many people and teams, it gets very difficult to see who owns what. 'git blame' and looking at the code of individual jobs, basically.
Namespaces help with this, and naturally comments in the YAML files help too. However, this is pretty basic and very difficult to enforce.
This PR adds the following fields to the configuration, and extends visibility to the API and Tronview.
These should allow job/service authors to give reasonable hints as to who to contact in the event of maintenance/update, what the job/service does, and arbitrary notes (such as links to runbooks, details of business impacts, etc).
The fields are all optional, and default to the empty string.
The PR also updates the Vagrant playground environment to have working playground tronfig, with these fields included.