Describe the bug
The complytime.yaml has several variables for policies, complypacks, targets, etc. Users do not have explicit documentation for what values need to be replaced or where they should be pulled from. This causes issues when following the complete workflow using complyctl commands.
To Reproduce
policies:
- url: ghcr.io/<your-org>/<your-repo>/<bundle-name>:latest # what is a typical bundle name?
id: <policy-id> # where does this come from?
complypacks:
- url: ghcr.io/<your-org>/<your-repo>/complypack:latest
id: <complypack-id> # where does this come from?
targets:
- id: kubernetes
policies:
- <policy-id> # where does this come from?
variables:
input_path: targets/kubernetes/
- id: ci
policies:
- <policy-id> # where does this come from?
variables:
input_path: targets/ci/
Expected behavior
Add inline comments with an example complytime.yaml referencing the correct values to use for the policies.id, complypacks.id, etc. This update should include an id that matches the complypack.yaml reference and an id chosen by the user (random).
Describe the bug
The
complytime.yamlhas several variables for policies, complypacks, targets, etc. Users do not have explicit documentation for what values need to be replaced or where they should be pulled from. This causes issues when following the complete workflow usingcomplyctlcommands.To Reproduce
Expected behavior
Add inline comments with an example
complytime.yamlreferencing the correct values to use for thepolicies.id,complypacks.id, etc. This update should include anidthat matches thecomplypack.yamlreference and an id chosen by the user (random).