Update compliance-scan.md #3841
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vadimzharov
requested review from
karl-cardenas-coding,
lennessyy and
caroldelwing
✅ Deploy Preview for docs-spectrocloud ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
| ## Scan reports | ||
|
|
||
| All scan reports are available for users in Palette UI, where users can download reports as CSV or PDF file. In | ||
| addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'display' instead of 'see'.
| All scan reports are available for users in Palette UI, where users can download reports as CSV or PDF file. In | ||
| addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the | ||
| status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use | ||
| Admin Kubeconfig file downloaded from Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'admin' instead of 'Admin'.
| All scan reports are available for users in Palette UI, where users can download reports as CSV or PDF file. In | ||
| addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the | ||
| status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use | ||
| Admin Kubeconfig file downloaded from Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'kubeconfig' instead of 'Kubeconfig'.
| All scan reports are available for users in Palette UI, where users can download reports as CSV or PDF file. In | ||
| addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the | ||
| status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use | ||
| Admin Kubeconfig file downloaded from Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| ``` | ||
|
|
||
| The output of this command provides the list of all reports executed on this Kubernetes cluster with the status for each | ||
| report: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| cluster-66d8a761ed405e70b86a8a17 syft-66df6d437cda16db7074cefe-czfxq 21m Complete | ||
| ``` | ||
|
|
||
| To see details for the particular report, execute command |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'display' instead of 'see'.
| ``` | ||
|
|
||
| To see details for the particular report, execute command | ||
| `kubectl get audits.cluster.spectrocloud.com -n cluster-<cluster-uuid> <name of the report> -o yaml`, for example: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.longform] Avoid using the short form of commands. Replace the short form flag in 'com -n' with the corresponding long form flag.
| ``` | ||
|
|
||
| To see details for the particular report, execute command | ||
| `kubectl get audits.cluster.spectrocloud.com -n cluster-<cluster-uuid> <name of the report> -o yaml`, for example: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
|
|
||
| ## Scan reports | ||
|
|
||
| All scan reports are available for users in the Palette UI, where users can download reports as CSV or PDF file. In addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use admin kubeconfig file downloaded from the Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.ableism] Avoid using ableism terms. Use 'display' instead of 'see'.
|
|
||
| ## Scan reports | ||
|
|
||
| All scan reports are available for users in the Palette UI, where users can download reports as CSV or PDF file. In addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use admin kubeconfig file downloaded from the Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| kubectl get audits.cluster.spectrocloud.com -A | ||
| ``` | ||
|
|
||
| The output of this command provides the list of all reports executed on this Kubernetes cluster with the status for each report: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| cluster-66d8a761ed405e70b86a8a17 syft-66df6d437cda16db7074cefe-czfxq 21m Complete | ||
| ``` | ||
|
|
||
| To check details for the particular report, including report content, execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| To check details for the particular report, including report content, execute command: | ||
|
|
||
| ``` | ||
| kubectl get audits.cluster.spectrocloud.com -n cluster-<cluster-uuid> <name of the report> -o yaml``` |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.longform] Avoid using the short form of commands. Replace the short form flag in 'com -n' with the corresponding long form flag.
| ``` | ||
| kubectl get audits.cluster.spectrocloud.com -n cluster-<cluster-uuid> <name of the report> -o yaml``` | ||
|
|
||
| For example: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
| For example: | ||
|
|
||
| ``` | ||
| # kubectl get audits.cluster.spectrocloud.com -n cluster-66d8a761ed405e70b86a8a17 kube-bench-66df28ab3c13fb7876674c98-xscvq -o yaml |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Units] Put a nonbreaking space between the number and the unit in '66d'.
| For example: | ||
|
|
||
| ``` | ||
| # kubectl get audits.cluster.spectrocloud.com -n cluster-66d8a761ed405e70b86a8a17 kube-bench-66df28ab3c13fb7876674c98-xscvq -o yaml |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Units] Put a nonbreaking space between the number and the unit in '66d'.
| For example: | ||
|
|
||
| ``` | ||
| # kubectl get audits.cluster.spectrocloud.com -n cluster-66d8a761ed405e70b86a8a17 kube-bench-66df28ab3c13fb7876674c98-xscvq -o yaml |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'yaml'?
| All scan reports are available for users in the Palette UI, where users can download reports as CSV or PDF file. In | ||
| addition, Palette agent stores reports on the Kubernetes cluster, where users can list all available reports, see the | ||
| status per each report and get the report as Kubernetes resource. To retrieve the list of all available reports, use | ||
| admin kubeconfig file downloaded from the Palette UI and execute command: |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[spectrocloud-docs-internal.colon] Use colons only to introduce lists, unless in code blocks or inline code.
karl-cardenas-coding
approved these changes
Sep 20, 2024
karl-cardenas-coding
added
backport-version-4-0
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
docs/docs-content/clusters/cluster-management/compliance-scan.md
Outdated
Show resolved
Hide resolved
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Sep 20, 2024
* Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Sep 20, 2024
* Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Sep 20, 2024
* Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Sep 20, 2024
* Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440)
vault-token-factory-spectrocloud bot
pushed a commit
that referenced
this pull request
Sep 20, 2024
* Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation and see the Github Action logs for details |
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Sep 20, 2024
* docs: update compliance-scan.md (#3841) * Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440) * chore: fix gitleaks --------- Co-authored-by: Vadim Zharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Sep 20, 2024
* docs: update compliance-scan.md (#3841) * Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440) * chore: fix gitleaks --------- Co-authored-by: Vadim Zharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Sep 20, 2024
* docs: update compliance-scan.md (#3841) * Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440) * chore: fix gitleaks --------- Co-authored-by: Vadim Zharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Sep 20, 2024
* docs: update compliance-scan.md (#3841) * Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440) * chore: fixed gitleaks --------- Co-authored-by: Vadim Zharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
vault-token-factory-spectrocloud bot
added a commit
that referenced
this pull request
Sep 20, 2024
* docs: update compliance-scan.md (#3841) * Update compliance-scan.md * ci: auto-formatting prettier issues * text updated * ci: auto-formatting prettier issues * docs: minor fixes to match voice and style in docs * docs: vale fix * Update docs/docs-content/clusters/cluster-management/compliance-scan.md --------- Co-authored-by: vadimzharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> Co-authored-by: Karl Cardenas <[email protected]> (cherry picked from commit 9253440) * chore: fixed gitleaks --------- Co-authored-by: Vadim Zharov <[email protected]> Co-authored-by: Karl Cardenas <[email protected]>
|
🎉 This issue has been resolved in version 4.5.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe the Change
This PR is to add to the documentation commands users can use to get scan reports from K8S cluster.
Changed Pages
[💻 Add Preview URL for Page
](https://docs.spectrocloud.com/clusters/cluster-management/compliance-scan/)
Jira Tickets
🎫 Jira Ticket
Backports
Can this PR be backported?