Skip to content

Assessment: Actions #14

@eddie-knight

Description

@eddie-knight

After documenting the Actors, it’s time to show what their Actions are. This is a high-level description of how the actors interact with each other.

If you have a more complex system, you may want to create a chart using a tool such as draw.io (the system used for the purpose of this demonstration has relatively low complexity, so the following example may be a bit overkill).

If you find another way to communicate this for your situation, do what you think will best aid your readers in understanding the actions.

### Actions

The Privateer Core will read the user config to determine which Raids are to be read, and customize the runtime behavior based on options such as loglevel.

One at a time, Privateer will initialize Raids by calling the respective subprocess by name, based on user input. Each Raid subprocess will independently read the configuration file for information such as runtime customization or resource authentication values.

The Privateer SDK enables each Raid to print and write logs or output for the execution. Upon completion of all Raids, Privateer will print a summary of the Raid results.

![Flowchart of the actors discussed above](actors_actions.png)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions