orca: updating help text (#738)

* orca: updating help text
This commit is contained in:
James Hodgkinson 2022-05-03 13:34:23 +10:00 committed by GitHub
parent da7ae6118c
commit 704d278fac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -107,10 +107,15 @@ impl std::fmt::Display for TestTypeOpt {
Orca works in a few steps.
1. (Optional) preprocess an anonymised 389-ds access log (created from an external tool) into an orca data set.
Create an orca config which defines the targets you want to be able to setup and load test. See example_profiles/small/orca.toml
2. 'orca setup' the kanidm/389-ds instance from the orca data set. You can see an example of this in example_profiles/small/data.json. This will reset the database, and add tons of entries etc.
3. 'orca run' one of the metrics, based on that data set. For example:
1. Create an orca config which defines the targets you want to be able to setup and load test. See example_profiles/small/orca.toml
2. (Optional) preprocess an anonymised 389-ds access log (created from an external tool) into an orca data set.
3. 'orca setup' the kanidm/389-ds instance from the orca data set. You can see an example of this in example_profiles/small/data.json. This will reset the database, and add tons of entries etc. For example:
orca setup kanidm -p ./example_profiles/small/orca.toml
4. 'orca run' one of the metrics, based on that data set. For example:
orca run -p example_profiles/small/orca.toml kanidm search-basic