Documentation rewrite - phase one #112
Conversation
Add link to CLI reference doc
| ## About | ||
| Zathras is a test automation framework for use with bare metal, cloud, and virtualized systems. Tests are defined by wrappers - external, self-contained scripts that enable easy extension of Zathras's functionality. | ||
|
|
||
| Currently, Zathras offers the following test wrappers: |
There was a problem hiding this comment.
Change currently to be
As of 09/11/204
That way there is a time date present, and if a test is added it does not automatically cause problems.
Also add a line something like this.
To see the current available tests the version you are running, and the latest version issue the following command
./burden --test_version_check
| 2. Zathras runs using either a configuration file or by supplying parameters in your command-line interface (CLI) (see the [CLI reference](docs/command_line_reference.md) for more info). | ||
| 3. Test(s) run on the system under test (SUT). | ||
| 4. When tests finish, Zathras copies the results back to the controller system. | ||
| 5. Once results have been retrieved, Zathras will attempt to cleanup the testing environment (such as by tearing down instances in the cloud or by removing directories and files on bare metal). |
There was a problem hiding this comment.
Add this info
To not have zathras cleanup, use the option --no_clean_up to the command line.
There was a problem hiding this comment.
Maybe instead just "This step can be skipped using the --no_clean_up option"
| ### Requirements | ||
| To use Zathras, you need: | ||
| 1. A system that will coordinate the execution of tests, which we will call the *control node* or simply the *controller*. | ||
| 2. One or more systems where tests will be run. This can be another physical system (aka bare metal), an instance on a public cloud like Amazon Web Services (AWS), or even a virtual machine (VM) either on the controller or another host system. |
There was a problem hiding this comment.
For cloud. Instance is created for us. If the cloud instance already exists we can treat it as a bare metal machine.
| Note: for most installations the install script should be run as a user, not root. | ||
|
|
||
| ### Test config files | ||
| Test config files, stored in the config/ directory of the Zathras installation, are the connective tissue between Zathras and the test wrappers. Currently this Zathras repo does not contain any defined test config files. Before you can use this tool, you will need to write your own test configs using the included example.yml, or add the configs from an external source if one is available to you. |
There was a problem hiding this comment.
This has also changed, config files are provided.
|
|
||
| However, there are some aspects that are particular to the testing environment being used. Please refer to the following documentation that matches your use case: | ||
|
|
||
| - [Testing on bare metal](https://github.com/redhat-performance/zathras/blob/documentation-rewrite/docs/test_config_files.md) |
There was a problem hiding this comment.
When you submit, make sure the changes goes to documentation, not documentation-rewrite and you update everything accordingly.
| 2. Zathras runs using either a configuration file or by supplying parameters in your command-line interface (CLI) (see the [CLI reference](docs/command_line_reference.md) for more info). | ||
| 3. Test(s) run on the system under test (SUT). | ||
| 4. When tests finish, Zathras copies the results back to the controller system. | ||
| 5. Once results have been retrieved, Zathras will attempt to cleanup the testing environment (such as by tearing down instances in the cloud or by removing directories and files on bare metal). |
There was a problem hiding this comment.
Maybe instead just "This step can be skipped using the --no_clean_up option"
| Note: for most installations the install script should be run as a user, not root. | ||
|
|
||
| ### Test config files | ||
| Test config files, stored in the config/ directory of the Zathras installation, are the connective tissue between Zathras and the test wrappers. Currently this Zathras repo does not contain any defined test config files. Before you can use this tool, you will need to write your own test configs using the included example.yml, or add the configs from an external source if one is available to you. |
There was a problem hiding this comment.
This has also changed, config files are provided.
| ### --os_vendor \<os vendor> | ||
| Currently rhel, ubuntu, amazon. |
There was a problem hiding this comment.
This is not a Cloud-only option
|
|
||
| ### Scenario file for bare metal | ||
| #### Example 1 | ||
| This scenario would run the STREAM benchmark on a local bare metal system named "test_sys". |
There was a problem hiding this comment.
Probably best to mention the need for a local_config here, with a link to relevant documentation if available.
Documentation in Zathras is currently spread across multiple files, which can create confusion about where to go for information. In order to reduce this confusion, and to improve the readability and maintainability of our documentation, this PR implements the first phase of a larger docs rewrite for Zathras.
The goal of this phase is to revamp the documentation on a structural level (described more below), which will be followed by further expanding and updating the documentation's contents. In order to not lose the knowledge captured by existing documentation, older docs have been moved to a subdirectory within docs/ until the new documentation can fully stand on its own.
Summary of major changes: