-
Notifications
You must be signed in to change notification settings - Fork 15
Live Reloading the TimeLock Block, Part 4: Documentation and Release Notes #2648
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, few suggestions for things that would be cleaner.
.. warning:: | ||
|
||
Although we support starting up without knowledge of any TimeLock nodes, note that if you are using TimeLock | ||
your service will fail to start if asynchronous initialization (``initializeAsync``) is set to ``false``, as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"...will fail to start if there are no TimeLock nodes and asynchronous initialization..." is clearer
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, changed.
|
||
Optional parameters: | ||
* - serversList::sslConfiguration |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this change with the move to live reloading? Can you have live reloaded list of Timelock nodes but a static security block?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes - but the static security block must be provided in the runtime config. I've added another paragraph to the note here explaining how this is handled.
|
||
Also, although we support live-reloading of the server configuration, AtlasDB needs to know at install time that it | ||
should talk to TimeLock - thus, the install configuration must contain a ``timelock`` block (even if said block is | ||
possibly empty). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How do I specify an empty block? Does it contain nothing or does it need something to say it is a object with no fields set?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've added an example of an empty block (it is the YAML empty object: {}
)
bb68dd4
to
2f5debf
Compare
5bd58f0
to
7467051
Compare
Codecov Report
@@ Coverage Diff @@
## jkong/lrt-3 #2648 +/- ##
=================================================
- Coverage 60.36% 60.04% -0.32%
- Complexity 4467 4470 +3
=================================================
Files 871 868 -3
Lines 40105 40425 +320
Branches 4021 4054 +33
=================================================
+ Hits 24208 24272 +64
- Misses 14420 14678 +258
+ Partials 1477 1475 -2
Continue to review full report at Codecov.
|
Goals (and why):
Live reload the timelock block - see #2621, #2622 and #2647
This is the last in the series for now. There is a Part 5 I might want to do (ETE testing) but that's not as high on internal priority list at this time.
Implementation Description (bullets):
Concerns (what feedback would you like?):
Where should we start reviewing?:
timelock_client_config.rst
Priority (whenever / two weeks / yesterday): this week?
This change is