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

chore: update docs to include simulation specs #187

Conversation

samika98
Copy link
Contributor

@samika98 samika98 commented Jun 18, 2024

Updates the docs to include scenarios added and inclides instructions on how to run them
Scenarios :
1) ceramic-anchoring-benchmark : This is the e2e test which creates models and passes when sync on the network is working and all streams have been anchored. We should set the CAS Api url in the network with proper dids to test against the CAS.


  casApiUrl: https://cas-dev-direct.3boxlabs.com
  networkType: dev-unstable
  privateKeySecret: ceramic-v4-dev

New Simulation vars for ceramic-anchoring-benchmark :

    ` anchorWaitTime : Wait time in seconds for how long we want to wait after streams have been created to check when they have been anchored. This should be a high number like 30-40 minutes.`
  1. cas-benchmark : This tests the write CAS load directly by passing c1 nodes. New Simulation vars for cas-benchmark :
          casNetwork : Network-url. Similar to CAS api url. We can use dev-direct if we wish to bypass auth here.

          casController : Did key we want to provide in the network. Format : "did:key:<secret>"

@samika98 samika98 requested a review from 3benbox June 18, 2024 22:31
@samika98 samika98 self-assigned this Jun 18, 2024
Copy link
Contributor

@3benbox 3benbox left a comment

Choose a reason for hiding this comment

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

Thank you for the docs!

1 suggestion

keramik/src/simulation.md Outdated Show resolved Hide resolved
@samika98 samika98 added this pull request to the merge queue Jun 20, 2024
Merged via the queue into main with commit f8d3e0d Jun 20, 2024
4 of 5 checks passed
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.

3 participants