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

Update used Snyk annotations for the builtin data source #1130

Merged
merged 1 commit into from
Sep 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions content/docs/tech-insights/builtin-data-sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,18 @@ Authentication is done via

### Snyk Data Source

Generates fact data about Snyk projects configured for the entity
Generates fact data about Snyk projects configured for the entity.

**Annotations used:**
* `snyk.io/project-ids`
* `snyk.io/org-name`, if omitted, globally configured Snyk org is used
* `snyk.io/target-id`, specify a single target by name or ID
* `snyk.io/targets`, specify one or more targets, by name or ID
* `snyk.io/project-ids`, are the project ID (see slug in url or ID in project settings) If multiple projects (like multiple package.json or pom files, add them with increasing number), add them comma separated
* `github.com/project-slug`, to identify the target based on its GitHub repository name
* `snyk.io/exclude-project-ids`, to exclude specific projects you might not want.

The data source follows the same annotation structure as the official Snyk Backstage plugin. It is possible to use multiple different annotations. At a minimum one of `targets`, `target-id`, `project-ids` or GitHub project slug is needed.


#### Authentication
Authentication is done via
Expand Down