Skip to content

fix(docs): update security opt Docker Compose link#8048

Open
omribz156 wants to merge 2 commits into
Checkmarx:masterfrom
omribz156:codex/security-opt-doc-link
Open

fix(docs): update security opt Docker Compose link#8048
omribz156 wants to merge 2 commits into
Checkmarx:masterfrom
omribz156:codex/security-opt-doc-link

Conversation

@omribz156
Copy link
Copy Markdown

Closes #8027

Reason for Proposed Changes

  • The generated docs for the Docker Compose Security Opt Not Set query still link to the legacy Compose v3 security_opt anchor.
  • Docker now documents security_opt on the Compose services reference at https://docs.docker.com/reference/compose-file/services/#security_opt.

Proposed Changes

  • Update the security_opt_not_set query metadata descriptionUrl to the current Docker Compose services reference.
  • Update the generated per-query docs page for query 610e266e-6c12-4bca-9925-1ed0cd29742b.
  • Update the Docker Compose query index entry for Security Opt Not Set.

Verification:

  • Confirmed the current Docker security_opt reference is at https://docs.docker.com/reference/compose-file/services/#security_opt.
  • node -e "JSON.parse(require('fs').readFileSync('assets/queries/dockerCompose/security_opt_not_set/metadata.json','utf8')); console.log('metadata json ok')"
  • git diff --check

Note: the issue body mentions query id ce76b7d0-9e77-464d-b86f-c5c48e03e22d, but that id currently maps to Container Capabilities Unrestricted. This patch updates the Security Opt Not Set query referenced by the issue title and current docs page.

This was implemented with Codex assistance, with the patch kept focused and manually reviewed before sending.

I submit this contribution under the Apache-2.0 license.

Copy link
Copy Markdown
Contributor

@cx-artur-ribeiro cx-artur-ribeiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @omribz156,
Thanks for the contribution.

Take a look at my comments, pretty straigthforward.
Despite those, looks good to me, thanks for your help improving KICS!

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an automatic generated file, no need to change anything. Just the query descriptionUrl does the work 😃

Comment thread docs/queries/dockercompose-queries.md Outdated
|Memory Not Limited<br/><sup><sub>bb9ac4f7-e13b-423d-a010-c74a1bfbe492</sub></sup>|<span style="color:#ff7213">Medium</span>|Resource Management|<a href="../dockercompose-queries/bb9ac4f7-e13b-423d-a010-c74a1bfbe492" onclick="newWindowOpenerSafe(event, '../dockercompose-queries/bb9ac4f7-e13b-423d-a010-c74a1bfbe492')">Query details</a><br><a href="https://docs.docker.com/compose/compose-file/compose-file-v3/#resources">Documentation</a><br/>|
|Pids Limit Not Set<br/><sup><sub>221e0658-cb2a-44e3-b08a-db96a341d6fa</sub></sup>|<span style="color:#ff7213">Medium</span>|Resource Management|<a href="../dockercompose-queries/221e0658-cb2a-44e3-b08a-db96a341d6fa" onclick="newWindowOpenerSafe(event, '../dockercompose-queries/221e0658-cb2a-44e3-b08a-db96a341d6fa')">Query details</a><br><a href="https://docs.docker.com/compose/compose-file/compose-file-v3/#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir">Documentation</a><br/>|
|Security Opt Not Set<br/><sup><sub>610e266e-6c12-4bca-9925-1ed0cd29742b</sub></sup>|<span style="color:#ff7213">Medium</span>|Resource Management|<a href="../dockercompose-queries/610e266e-6c12-4bca-9925-1ed0cd29742b" onclick="newWindowOpenerSafe(event, '../dockercompose-queries/610e266e-6c12-4bca-9925-1ed0cd29742b')">Query details</a><br><a href="https://docs.docker.com/compose/compose-file/compose-file-v3/#security_opt">Documentation</a><br/>|
|Security Opt Not Set<br/><sup><sub>610e266e-6c12-4bca-9925-1ed0cd29742b</sub></sup>|<span style="color:#ff7213">Medium</span>|Resource Management|<a href="../dockercompose-queries/610e266e-6c12-4bca-9925-1ed0cd29742b" onclick="newWindowOpenerSafe(event, '../dockercompose-queries/610e266e-6c12-4bca-9925-1ed0cd29742b')">Query details</a><br><a href="https://docs.docker.com/reference/compose-file/services/#security_opt">Documentation</a><br/>|
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing applies here. Remove both changes on .md files, please.

Remove generated markdown changes per maintainer feedback; the metadata descriptionUrl remains the source for regenerated docs.
@omribz156
Copy link
Copy Markdown
Author

Thanks, fixed in the latest push.

Removed the two generated .md updates and kept the change limited to the source metadata.json descriptionUrl. Verified with JSON parse and git diff --check.

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.

Docs: "Security Opt Not Set" query points to outdated Docker Compose documentation

2 participants