Skip to content

Commit

Permalink
Improve the GitLab policy description (#262)
Browse files Browse the repository at this point in the history
- Remove odd sales pitch for other providers
- Improve some wording
- Add example of a project scan

---------

Signed-off-by: Tim Smith <[email protected]>
Signed-off-by: Tim Smith <[email protected]>
Co-authored-by: Letha <[email protected]>
  • Loading branch information
tas50 and misterpantz authored Sep 19, 2023
1 parent ab16596 commit ce62440
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 3 deletions.
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ cnspec scan local -f core/mondoo-macos-security.mql.yaml
cnspec scan local -f core/mondoo-windows-security.mql.yaml
```


With the Open Security Registry

```bash
Expand All @@ -49,7 +48,6 @@ cnspec scan local --policy mondoohq/mondoo-macos-security
cnspec scan local --policy mondoohq/mondoo-windows-security
```


## Join the community!

Join the [Mondoo Community GitHub Discussions](https://github.com/orgs/mondoohq/discussions) to collaborate on policy as code and security automation.
Expand Down
2 changes: 1 addition & 1 deletion core/mondoo-gitlab-security.mql.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ policies:
- name: Mondoo, Inc
email: [email protected]
docs:
desc: "## Overview\n\nThe GitLab Security by Mondoo policy bundle provides guidance for establishing minimum recommended security and operational best practices for GitLab groups and projects. This policy is early access.\n\n## Remote scan\n\nRemote scans use native transports in `cnspec` to provide on demand scan results without the need to install any agents, or integration. \n\nFor a complete list of native transports run: \n\n```bash\ncnspec scan --help\n``` \n\n### Prerequisites\n\nRemote scans of GitLab requires a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with access to the group.\n\n### Run a scan of a GitLab group\n\nOpen a terminal and configure an environment variable with your GitLab personal access token:\n\n```bash\nexport GITLAB_TOKEN=<your personal access token> \n```\n\nRun a remote scan of your GitLab group: \n\n```bash\ncnspec scan gitlab --group <group_name>\n``` \n \n## Join the community!\n\nOur goal is to build policies that are simple to deploy, accurate, and actionable. \n\nIf you have any suggestions on how to improve this policy, or if you need support, [join the community](https://github.com/orgs/mondoohq/discussions) in GitHub Discussions."
desc: "## Overview\n\nThe GitLab Security policy by Mondoo offers guidance on establishing minimum recommended security best practices for GitLab groups and projects. \n\n## Remote scan\n\nRemote scans of GitLab groups and projects use native transports in cnspec to provide on-demand scan results without the need to install agents or configure integrations.\n\n### Prerequisites\n\nRemote scans of GitLab require a [personal access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html) with access to the group and projects you plan to scan.\n\n### Scan a GitLab group and projects\n\nOpen a terminal and configure an environment variable with your GitLab personal access token:\n\n```bash\nexport GITLAB_TOKEN=<your personal access token>\n```\n\nRun a remote scan of your GitLab group:\n\n```bash\ncnspec scan gitlab --group <group_name>\n```\n\n### Scan a single GitLab project\n\nOpen a terminal and configure an environment variable with your GitLab personal access token:\n\n```bash\nexport GITLAB_TOKEN=<your personal access token>\n```\n\nScan a GitLab group:\n\n```bash\ncnspec scan gitlab --group <group_name> --project <project_name>\n```\n\n## Join the community!\n\nOur goal is to build policies that are simple to deploy, accurate, and actionable.\n\nIf you have any suggestions on how to improve this policy, or if you need support, [join the community](https://github.com/orgs/mondoohq/discussions) in GitHub Discussions.\"\n"
groups:
- title: GitLab Group
filters: asset.platform == "gitlab" || asset.platform == "gitlab-group"
Expand Down

0 comments on commit ce62440

Please sign in to comment.