Skip to content

Experiment files documentation#13

Merged
glenn-operant merged 3 commits intodevfrom
glennmcdonald/sc-1662/experiment-files-documentation
Nov 2, 2023
Merged

Experiment files documentation#13
glenn-operant merged 3 commits intodevfrom
glennmcdonald/sc-1662/experiment-files-documentation

Conversation

@glenn-operant
Copy link
Copy Markdown
Collaborator

No description provided.

@shortcut-integration
Copy link
Copy Markdown

This pull request has been linked to Shortcut Story #1662: Mention the experiment files in the README.

@glenn-operant glenn-operant force-pushed the glennmcdonald/sc-1662/experiment-files-documentation branch from 99ea0fe to 0374e42 Compare November 1, 2023 21:07
Comment thread experiments/README.md

Each experiment within `secops-chaos` adheres to a shared interface, this allows for a common set of functionality to be used across all experiments.

When implementing a new experiment you should create a new file starting with `experiment_` within the [internal/experiments](https://github.com/OperantAI/secops-chaos/blob/main/internal/experiments/) directory, and implement the `Experiment` interface.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

we could also add an example of the config model saying that every experiment would need to define its own config model like the PrivilegedContainerConfig and add in an example of one of the experiments

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This should now be added, have a read through when you have a sec.

Comment thread experiments/README.md
@glenn-operant glenn-operant force-pushed the glennmcdonald/sc-1662/experiment-files-documentation branch from 0374e42 to 6920bfb Compare November 2, 2023 15:28
@glenn-operant glenn-operant merged commit f069ab0 into dev Nov 2, 2023
@glenn-operant glenn-operant deleted the glennmcdonald/sc-1662/experiment-files-documentation branch November 2, 2023 21:41
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