-
Notifications
You must be signed in to change notification settings - Fork 1
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
docs: add documentation about tkms key-gen and crs-gen #227
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.
Thanks! Just a couple of suggestions
docs/getting_started/tkms/create.md
Outdated
|
||
To do so one can use the TKMS cli tool packaged in the following [docker image](https://github.com/zama-ai/kms-core/pkgs/container/kms-blockchain-simulator). | ||
|
||
The configuration file of the CLI will need to be modified or mounted with a volume to include: |
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.
Maybe it is just me because of my lack of ops knowledge; but it is not really clear to me what "mounted with a volume" means here
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.
Just that the config file is accessible inside the docker container.
Not sure how to re-phrase it
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.
Wrote a suggestion
docs/getting_started/tkms/create.md
Outdated
### "Secure" | ||
|
||
Secure key generation takes a lot longer and is a two step process. | ||
For development purposes insecure key generation is the recommended way. |
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.
Maybe also just add the command for secure key generation.
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.
Being "mostly untested" I'm not sure we want to advertise it here do we?
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 added the commands in case some user actually wants to try it.
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.
Thanks. I believe we actually want to write these things as extensively as possible; i.e. based on how we want things to be used at the release time. Alternatively we need to reiterate documentation writing for non-breaking changes as well as breaking ones
Co-authored-by: Tore Frederiksen <[email protected]>
Co-authored-by: Tore Frederiksen <[email protected]>
Co-authored-by: Tore Frederiksen <[email protected]>
* docs: add documentation about tkms key-gen and crs-gen Co-authored-by: Tore Frederiksen <[email protected]>
closes https://github.com/zama-ai/kms-core/issues/1803