Skip to content

Commit 1518de5

Browse files
authored
Adds a more detailed README (#5)
1 parent dd05cb1 commit 1518de5

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
11
# dynatrace-bootstrapper
22

3-
TODO: Add todod
3+
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.
4+
5+
## Responsibilities
6+
7+
- Copy a Dynatrace CodeModule to a target directory
8+
- Configure the Dynatrace CodeModule according to the configuration options provided
9+
10+
## How to use
11+
12+
### Args
13+
14+
#### `--source`
15+
16+
*Example*: `--source="/opt/dynatrace/oneagent"`
17+
18+
- ⚠️This is a **required** arg⚠️
19+
- The `--source` arg defines the base path where to copy the CodeModule FROM.
20+
21+
#### `--target`
22+
23+
*Example*: `--target="example/bins/1.2.3"`
24+
25+
- ⚠️This is a **required** arg⚠️
26+
- The `--target` arg defines the base path where to copy the CodeModule TO.
27+
28+
#### `--work`
29+
30+
*Example*: `--work="/example/work"`
31+
32+
- This is an **optional** arg
33+
- 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.
34+
35+
## Development
36+
37+
- To run tests: `make test`
38+
- To run linting: `make lint`
39+
- To build a testing image: `make build`

0 commit comments

Comments
 (0)