-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,39 @@ | ||
# dynatrace-bootstrapper | ||
|
||
TODO: Add todod | ||
The `dynatrace-bootstrapper` is a small CLI binary built into a [Dynatrace CodeModule](https://gallery.ecr.aws/dynatrace/dynatrace-codemodules) (after version `<to-be-determined-codemodule-version>`) so that it can be used in conjunction with the [dynatrace-operator](https://github.com/Dynatrace/dynatrace-operator) to optimize the download and configuration of a CodeModule in Kubernetes. | ||
|
||
## Responsibilities | ||
|
||
- Copy a Dynatrace CodeModule to a target directory | ||
- Configure the Dynatrace CodeModule according to the configuration options provided | ||
|
||
## How to use | ||
|
||
### Args | ||
|
||
#### `--source` | ||
|
||
*Example*: `--source="/opt/dynatrace/oneagent"` | ||
|
||
- ⚠️This is a **required** arg⚠️ | ||
- The `--source` arg defines the base path where to copy the CodeModule FROM. | ||
|
||
#### `--target` | ||
|
||
*Example*: `--target="example/bins/1.2.3"` | ||
|
||
- ⚠️This is a **required** arg⚠️ | ||
- The `--target` arg defines the base path where to copy the CodeModule TO. | ||
|
||
#### `--work` | ||
|
||
*Example*: `--work="/example/work"` | ||
|
||
- This is an **optional** arg | ||
- The `--work` arg defines the base path for a tmp folder, this is where the command will do its work, to make sure the operations are atomic. It must be on the same disk as the target folder. | ||
|
||
## Development | ||
|
||
- To run tests: `make test` | ||
- To run linting: `make lint` | ||
- To build a testing image: `make build` |