Skip to content

Commit

Permalink
Update README.md and galaxy.yml files
Browse files Browse the repository at this point in the history
  • Loading branch information
WStechura committed Dec 20, 2024
1 parent d2df2ef commit bab88ea
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,16 @@ broken in the latest version (please report an issue in this repository). Use th
ansible-galaxy collection install dynatrace.oneagent:==1.0.0
```

See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more
details.
See [using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html) for more details.

## Use Cases

See [OneAgent role README](roles/oneagent/README.md) for more details.

## Testing

The collection was tested against Ansible sanity tests and component tests. The latter runs regular deployment with
the installer and checks veriety of installation scenarios.
See [OneAgent role tests README](roles/oneagent/tests/README.md) for more details.

## Support
Expand Down
6 changes: 5 additions & 1 deletion galaxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ license_file: LICENSE
tags:
- dynatrace
- oneagent
- monitoring
- agent
- deployment
- monitoring
- infrastructure
- linux
- windows
repository: https://github.com/Dynatrace/Dynatrace-OneAgent-Ansible
documentation: https://docs.dynatrace.com/docs/setup-and-configuration/dynatrace-oneagent/deployment-orchestration/ansible
build_ignore:
Expand Down
4 changes: 4 additions & 0 deletions roles/oneagent/tests/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Component tests

The tests support two types of deployment:
- local - the tests are run on the same Unix machine as main node;
- remote - the tests are run on a remote Windows (Unix is not supported at the moment) machine;
Currently, there is no option to mix these two types of deployment and the tests must be run for one platform at a time.

## Remote deployment

For remote deployment, regular OneAgent installers are used, which are downloaded from the Dynatrace environment during
the tests. To use this type of deployment, the following parameters must be provided:
- `--user` - username for the remote machine;
Expand All @@ -15,12 +17,14 @@ the tests. To use this type of deployment, the following parameters must be prov
Failing to provide any of these parameters will result in failure.

## Local deployment

For local deployment, the tests are using mocked version of the OneAgent installer, which simulates its basic behavior -
returning version, deploying `uninstall.sh` script and creating `oneagentctl`, used for configuring installation.
To use this type of deployment, the only required parameter is `--linux_x86=localhost`. In case, multiple platforms for
local deployment are specified or any other platforms is used along with local one, only the first local platform is used.

## Requirements

- Python 3.10+
- pip 21.0+
- venv 20.0+
Expand Down

0 comments on commit bab88ea

Please sign in to comment.