Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KMS Documentation/Tutorial. How to run a Validator with a Ledger device #3659

Merged
merged 4 commits into from
Apr 24, 2019

Conversation

jleni
Copy link
Member

@jleni jleni commented Feb 15, 2019

Adding a new section for KMS including:

  • Build instructions
  • Configuration examples:
    • YubiHSM
    • Ledger Tendermint App
  • Frequently asked questions

  • Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation (docs/)
  • Added entries in PENDING.md with issue #
  • rereviewed Files changed in the github PR explorer

For Admin Use:

  • Added appropriate labels to PR (ex. wip, ready-for-review, docs)
  • Reviewers Assigned
  • Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

@jleni
Copy link
Member Author

jleni commented Feb 15, 2019

This is definitely work in progress and there are still a few issues that need to be solved.

I thought it was a good idea to share as early feedback is appreciated.

I will add more information once we release a KMS + signatory version that includes a few additional fixes.

Related to tendermint/tmkms#172

@jleni jleni requested a review from liamsi February 19, 2019 08:29
@jleni
Copy link
Member Author

jleni commented Feb 19, 2019

@liamsi @gamarin2 this is very much work in progress but maybe you can provide some quick feedback. This is an area where documentation was lacking as far as I know.

@jleni jleni changed the title WIP: KMS Documentation + Ledger Tendermint App integration KMS Documentation/Tutorial. How to run a Validator with a Ledger device Mar 6, 2019
@jleni jleni added T:Docs Changes and features related to documentation. ready-for-review C:Keys Keybase, KMS and HSMs labels Mar 12, 2019
@jleni
Copy link
Member Author

jleni commented Mar 12, 2019

It would be good to start reviewing this. Maybe @gamarin2 you can have a look at it and help with any missing details?

Copy link
Collaborator

@fedekunze fedekunze left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Maybe @liamsi or @gamarin2 could review as well

@jackzampolin jackzampolin merged commit 29755e6 into cosmos:develop Apr 24, 2019
@jleni jleni deleted the docs/kms branch April 25, 2019 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Keys Keybase, KMS and HSMs T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants