Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

jpower432 · 2023-11-17T20:58:02Z

Description:

Adds initial vendor directory for OSCAL content with REV4 and REV5 NIST 800-53 catalogs and FedRAMP High profiles. Adds update-vendor.yaml for automated updates of content

Rationale:

Allow upstream OSCAL content to be updated, reviewed, and stored to aid to generating OSCAL component definitions.
Partially address issue #11106

Review Hints:

This is part one to a two part feature add. The update-vendor.yaml was tested/verified locally using act.

Adds initial vendor directory for OSCAL content with REV4 and REV5 NIST 800-53 catalogs and FedRAMP High profiles. Adds update-vendor.yaml for automated updates of content Signed-off-by: Jennifer Power <[email protected]>

openshift-ci · 2023-11-17T20:58:15Z

Hi @jpower432. Thanks for your PR.

I'm waiting for a ComplianceAsCode member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

github-actions · 2023-11-17T20:59:25Z

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment

Oracle Linux 8 Environment

Mab879 · 2023-11-17T21:38:56Z

We store other vendor files (such as the STIG XML files) in shared/references that might be a better place for these files.

Mab879

Thanks for the PR.

I have a few minor points mainly around style.

Mab879 · 2023-11-17T21:39:22Z

.github/workflows/update-vendor.yaml

+          delete-branch: true
+          commit-message: "Update vendored OSCAL content"
+          add-paths: |
+            vendor/


Please add a new line at the end of the file.

Mab879 · 2023-11-17T21:42:15Z

.github/workflows/update-vendor.yaml

+      - name: Update content
+        uses: peter-evans/[email protected]
+        with:
+          base: master


Please add a useful title for these PRs.

https://github.com/peter-evans/create-pull-request#action-inputs

Mab879 · 2023-11-17T21:43:06Z

.github/workflows/update-vendor.yaml

@@ -0,0 +1,55 @@
+name: Update vendored OSCAL content


Per the project style gude please use 4 space indention.

Mab879 · 2023-11-17T21:45:40Z

.github/workflows/update-vendor.yaml

+        uses: peter-evans/[email protected]
+        with:
+          base: master
+          branch: "vendor-update-${{ github.run_id }}"


A body on the PR might be useful as well.

…tion Moves vendor to shared/references/oscal Updates update-vendor.yml to update-oscal.yml Updates formatting on update-oscal.yml to meet styling requirements Adds PR title and body to PR step in update-oscal.yml Signed-off-by: Jennifer Power <[email protected]>

jpower432 · 2023-11-17T23:44:27Z

Thanks for the feedback @Mab879. I moved the directory to shared/references/oscal. Also changed some of the names to be more OSCAL specific since OSCAL is just one type of vendored file. Styling fixes also added in the last commit. Please let me know if any other changes are needed.

This updates the NIST references to the latest supported version for trestle. Instead of updating it in multiple places, this adds environment variables to store that information. Signed-off-by: Jennifer Power <[email protected]>

jpower432 · 2023-12-01T19:09:42Z

Adding information on the last change. The workflow was originally pointing to the to the oscal-content v1.0.0 release, but there are newer version of the catalog. Added environment variables so the references are easier to change and updated to the latest commit on the repository before the update to OSCAL version 1.1.1. compliance-trestle does not support this version yet.

Mab879 · 2023-12-01T20:44:30Z

/packit retest-failed

Mab879 · 2023-12-01T20:48:51Z

.github/workflows/update-oscal.yml

+                      - usnistgov NIST 800-53 from "${{ matrix.variables.catalog-source }}"
+                      - GSA FedRAMP OSCAL profiles from "${{ matrix.variables.profile-source }}"
+
+                      Auto-generated by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action


Could you also provide the path to this GitHub Actions file as well?

Mab879 · 2023-12-01T20:52:28Z

shared/references/oscal/REAMDE.adoc

Per the style guide please use Markdown unless there is a compelling reason.

I missed that detail in the guide. I will convert to Markdown.

Signed-off-by: Jennifer Power <[email protected]>

Updates the "auto-generated message" to point to the actions worflow file and updates the environment variable reference in the matrix variables to ensure the correct values are used when referencing the content sources. Signed-off-by: Jennifer Power <[email protected]>

codeclimate · 2023-12-01T21:49:04Z

Code Climate has analyzed commit 8e0b2ae and detected 0 issues on this pull request.

Too many changed lines in diff

View more on Code Climate.

Mab879 · 2023-12-05T14:31:21Z

/packit retest-failed

Mab879

LGTM.

Thanks for the PR!

feat(action): adds directory and action for vendor dir

5b30405

Adds initial vendor directory for OSCAL content with REV4 and REV5 NIST 800-53 catalogs and FedRAMP High profiles. Adds update-vendor.yaml for automated updates of content Signed-off-by: Jennifer Power <[email protected]>

openshift-ci bot added the needs-ok-to-test Used by openshift-ci bot. label Nov 17, 2023

Mab879 requested changes Nov 17, 2023

View reviewed changes

Mab879 added the Infrastructure Our content build system label Nov 17, 2023

jpower432 force-pushed the add_vendor_dir branch from 3593ca6 to 91304f9 Compare November 17, 2023 23:10

jpower432 force-pushed the add_vendor_dir branch from 91304f9 to dd6de8b Compare November 17, 2023 23:21

jpower432 requested a review from Mab879 November 17, 2023 23:44

jpower432 mentioned this pull request Nov 20, 2023

Adds utilities for OSCAL Component Definitions from policies #11292

Merged

jpower432 changed the title ~~feat(action): adds directory and action for vendor dir~~ Adds an oscal directory and GitHub Actions workflow for upstream OSCAL conent Nov 20, 2023

vojtapolasek added this to the 0.1.72 milestone Nov 29, 2023

Mab879 reviewed Dec 1, 2023

View reviewed changes

jpower432 added 2 commits December 1, 2023 16:02

Converts the README under shared/references/oscal to Markdown

6d2aa19

Signed-off-by: Jennifer Power <[email protected]>

jpower432 requested a review from Mab879 December 1, 2023 22:34

Mab879 self-assigned this Dec 4, 2023

jpower432 changed the title ~~Adds an oscal directory and GitHub Actions workflow for upstream OSCAL conent~~ Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content Dec 6, 2023

Mab879 approved these changes Dec 6, 2023

View reviewed changes

Mab879 merged commit 1a50ebd into ComplianceAsCode:master Dec 6, 2023
34 checks passed

Mab879 mentioned this pull request Dec 11, 2023

OSCAL Import Job Fails When Ran #11371

Closed

jpower432 mentioned this pull request Jan 9, 2024

OSCAL Import/Update Job fails with OSCAL 1.1.1 content #11435

Open

vojtapolasek added Highlight This PR/Issue should make it to the featured changelog. and removed Highlight This PR/Issue should make it to the featured changelog. labels Feb 9, 2024

marcusburghardt added the OSCAL PRs and Issues releated to OSCAL label Oct 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

jpower432 commented Nov 17, 2023

openshift-ci bot commented Nov 17, 2023

github-actions bot commented Nov 17, 2023

Mab879 commented Nov 17, 2023

Mab879 left a comment

Mab879 Nov 17, 2023

Mab879 Nov 17, 2023

Mab879 Nov 17, 2023

Mab879 Nov 17, 2023

jpower432 commented Nov 17, 2023

jpower432 commented Dec 1, 2023

Mab879 commented Dec 1, 2023

Mab879 Dec 1, 2023

Mab879 Dec 1, 2023

jpower432 Dec 1, 2023

codeclimate bot commented Dec 1, 2023

Mab879 commented Dec 5, 2023

Mab879 left a comment

Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

Adds an oscal directory and GitHub Actions workflow for upstream OSCAL content #11286

Conversation

jpower432 commented Nov 17, 2023

Description:

Rationale:

Review Hints:

openshift-ci bot commented Nov 17, 2023

github-actions bot commented Nov 17, 2023

Mab879 commented Nov 17, 2023

Mab879 left a comment

Choose a reason for hiding this comment

Mab879 Nov 17, 2023

Choose a reason for hiding this comment

Mab879 Nov 17, 2023

Choose a reason for hiding this comment

Mab879 Nov 17, 2023

Choose a reason for hiding this comment

Mab879 Nov 17, 2023

Choose a reason for hiding this comment

jpower432 commented Nov 17, 2023

jpower432 commented Dec 1, 2023

Mab879 commented Dec 1, 2023

Mab879 Dec 1, 2023

Choose a reason for hiding this comment

Mab879 Dec 1, 2023

Choose a reason for hiding this comment

jpower432 Dec 1, 2023

Choose a reason for hiding this comment

codeclimate bot commented Dec 1, 2023

Mab879 commented Dec 5, 2023

Mab879 left a comment

Choose a reason for hiding this comment