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

Documentation improvements #170

Open
skeet70 opened this issue Oct 7, 2024 · 1 comment
Open

Documentation improvements #170

skeet70 opened this issue Oct 7, 2024 · 1 comment

Comments

@skeet70
Copy link
Member

skeet70 commented Oct 7, 2024

We got this question on Discord:

The attached screenshot is taken from the “pinecone-semantic-search.ipynb”, and I assume that, in production, this portion of the code needs to be edited to configure the encryption for ourselves, is that right? I have questions about what some of these things are, such as “RotabtableSecret”, “StandardSecretes” and “StandaloneSecrete”, and haven’t found much descriptive information yet. I wonder if you could explain them or point me to where I could read about them.
Also, for generating the key_bytes, do you have any suggestions on how it should be done in Python? I am wondering if you have any recommended libraries or functions?

We have some high level documentation coverage on docs.ironcorelabs.com and some very low level, low context, in-library documentation. What this question shows is that we're missing some of the connective tissue, so someone can understand how to go from the examples to a production setup (for both Standard and SaaS Shield modes). What do the different secret types mean? How does one go about rotation? Why is there a list of StandardSecrets, and should they be rotating those? What sources of randomness are acceptable for cryptographic use? etc

@coltfred
Copy link
Member

Timebox this to a 5 and make as many improvements as we can.

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

No branches or pull requests

2 participants