Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add identifiers field to Bolt task metadata schema #161

Merged
merged 1 commit into from
Aug 7, 2024

Conversation

hsnodgrass
Copy link
Contributor

@hsnodgrass hsnodgrass commented Jun 20, 2024

This commit adds the identifiers field to Bolt task metadata. A brief description of why an identifiers field would be useful is included in the tasks/README.md update. A more concrete example is writing Bolt tasks to help with security compliance. In order to map tasks to compliance rules, you either need to name your task after a rule or use comments in the implementation script. With the new identifiers field, you could add a keys under identifiers showing details about the security controls implemented.

"identifiers": {
  "compliance_controls": {
    "cis": ["some_control", "another_one"],
    "stig": ["V-000000"]
  }
}

This PR addresses issue #159

@donoghuc
Copy link
Member

Rolling out something like this needs to happen in the task spec and have a path forward for all task runners (most notably PE).

@hsnodgrass
Copy link
Contributor Author

Rolling out something like this needs to happen in the task spec and have a path forward for all task runners (most notably PE).

Is this something I can help with? If so, where should I look?

tasks/README.md Outdated Show resolved Hide resolved
This commit adds the `identifiers` field to Bolt task metadata. A description
of why an `identifiers` field would be useful is included in the
`tasks/README.md` update.
@hsnodgrass hsnodgrass changed the title Add tags field to Bolt task metadata schema Add identifiers field to Bolt task metadata schema Jul 18, 2024
@hsnodgrass
Copy link
Contributor Author

@donoghuc I've updated this PR based on the discussion in #159

@hsnodgrass
Copy link
Contributor Author

@donoghuc anything else need to be done on this before it gets merged?

@donoghuc
Copy link
Member

donoghuc commented Aug 7, 2024

nope, looks good to me. I think we've waited long enough to allow for other opinions.

@donoghuc donoghuc merged commit 2c2b639 into puppetlabs:master Aug 7, 2024
2 checks passed
@hsnodgrass hsnodgrass deleted the bolt_tags_proposal branch August 7, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants