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

docs: add documentation about tkms key-gen and crs-gen #227

Merged
merged 5 commits into from
Jan 6, 2025

Conversation

fd0r
Copy link
Contributor

@fd0r fd0r commented Jan 3, 2025

@fd0r fd0r requested a review from jot2re January 3, 2025 10:43
Copy link
Contributor

@jot2re jot2re left a 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


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:
Copy link
Contributor

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

Copy link
Contributor Author

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

Copy link
Contributor

Choose a reason for hiding this comment

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

Wrote a suggestion

### "Secure"

Secure key generation takes a lot longer and is a two step process.
For development purposes insecure key generation is the recommended way.
Copy link
Contributor

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.

Copy link
Contributor Author

@fd0r fd0r Jan 3, 2025

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?

Copy link
Contributor Author

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.

Copy link
Contributor

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

docs/getting_started/tkms/create.md Outdated Show resolved Hide resolved
docs/getting_started/tkms/create.md Outdated Show resolved Hide resolved
docs/getting_started/tkms/create.md Outdated Show resolved Hide resolved
fd0r and others added 3 commits January 3, 2025 15:37
Co-authored-by: Tore Frederiksen <[email protected]>
@fd0r fd0r merged commit a2e5ce0 into main Jan 6, 2025
3 of 5 checks passed
@fd0r fd0r deleted the fd0r/chore/kms_generation branch January 6, 2025 12:49
antoniupop pushed a commit that referenced this pull request Jan 13, 2025
* docs: add documentation about tkms key-gen and crs-gen

Co-authored-by: Tore Frederiksen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants