search

square / keywhiz

A system for distributing and managing secrets
https://square.github.io/keywhiz/
Apache License 2.0
2.62k stars 216 forks source link

documentation links broken #425

Closed via-justa closed 5 years ago

via-justa commented 5 years ago

Hey, please note that a lot of the documentation links are not working. In general it looks like the tool documentation is very light for that size of a tool.

mbyczkowski commented 5 years ago

Yes, the public-facing documentation could use some clean-up. Is there something in particular that you find missing?

via-justa commented 5 years ago

Hey @mbyczkowski thanks for replying. basically the entire bootstrapping process from both the server and client sides :)

A bit of information about the background process so we'll know what to expect (and how to sale it to the mgmt) and some Q&A for knowen issues like the h2 flyway issue.

We like the concept very much but I cannot really implement it without having some documentation to work with.

Because the concept is so nice and fits like a glove to what we need, we decided to try and develop internally something with the same concept (in Go for the ease of it), although we would have preferred to use your product

mbyczkowski commented 5 years ago

FWIW, we've been using Keywhiz in production for a few years now. The biggest change in recent years have been a move away from Keywhiz-FS to using Keysync.

The bootstrapping process is very Square-specific and it depends on how your infrastructure looks like. We're currently adopting SPIFFE, so in the near future Keywhiz bootstrapping will be simplified if you're planning to use SPIFFE.

alokmenghrajani commented 5 years ago

If you write notes/docs on how to bootstrap, we'll be more than happy to review. Also, if you get stuck, we can help you debug things.

The docs live in https://github.com/square/keywhiz/tree/master/docs and PRs, even just small ones to fix broken links, are welcome.