Skip to content

Latest commit

 

History

History
252 lines (208 loc) · 11.7 KB

import.md

File metadata and controls

252 lines (208 loc) · 11.7 KB
Raw

Import

Table of Contents

Prerequisites

You will need to have setup in advance:

  • your Snyk organizations should be setup before running an import
  • your Snyk organizations configured with some connection to SCM (Github/Gitlab/Bitbucket etc) as you will need the integrationId to generate the import files.
  • you will need your Snyk API token, with correct scope & admin access for all Organizations you are importing to. Github Integration Note: As Github is both an auth & integration, how the integration is done has an effect on usage:
    • For users importing via Github Snyk integration use your personal Snyk API token (Service Accounts are not supported for Github integration imports via API as this is a personal auth token only accessible to the user)
    • For Github Enterprise Snyk integration with a url & token (for Github.com, Github Enterprise Cloud & Github Enterprise hosted) use a Snyk API service account token
  • Recommended: have notifications disabled for emails etc to avoid receiving import notifications
  • Recommended: have the fix PRs and PR checks disabled until import is complete to avoid sending extra requests to SCMs (Github/Gitlab/Bitbucket etc)

Any logs will be generated at SNYK_LOG_PATH directory.

Kick off an import

1. Create the import-projects.json file

The file is expected to have a required targets top level key which is an array of import targets.

{
  targets: [
    {..},
    {..}
  ],
}

Each import target has the following keys:

{
  // required
  "orgId": "<public_snyk_org_id>",
  "integrationId": <"public_snyk_integration_id>",
  "target": {..} // the identifier of where the projects can be found (for example branch, repo name and owner for Github)

   // optional
  "files": [ { path: "full/path/to/file1"} , { path: "full/path/to/file2" }],
  "exclusionGlobs": "fixtures, tests, __tests__, node_modules",
}
  • orgId - Can be found in https://app.snyk.io/org/YOUR_ORG/manage/settings
  • integrationId - Can be found in Integrations menu for each SCM https://app.snyk.io/org/YOUR_ORG/manage/settings
  • target, files, exclusionGlobs - see our Import API documentation for more info
    • exclusionGlobs a comma-separated list of up to 10 folder names to exclude from scanning (each folder name must not exceed 100 characters). If not specified, it will default to "fixtures, tests, tests, node_modules". If an empty string is provided - no folders will be excluded
    • files is an object array, each path must be the full relative path to file from the root of the target. Only those files will be imported if located at that location.

Note: For a repo that may have 200+ manifest files it is recommended to split this import into multiple by targeting specific files. Importing hundreds of files at once from 1 repo can cause the import to result in some errors/failures. Note: Keep in mind there is a limit on the # or projects per Organization in Snyk. To reduce the chances of reaching this limit use multiple Organizations in Snyk instead of adding many repos into 1. Splitting it to target some files, or some folders only will benefit from the re-tries and yield a smaller load on the source control management system being used. Populate the the files property to accomplish this in the import JSON.

If you have any tests ot fixtures that should be ignored, please set the exclusionGLobs property:

a comma-separated list of up to 10 folder names to exclude from scanning. If not specified, it will default to "fixtures, tests, tests, node_modules". If an empty string is provided - no folders will be excluded

Note: snyk-api-import supports 100% of the same integration types and project sources as the Import API documentation. If an example is not present below for your use case please see the API documentation

Example: Gitlab

{
  "targets": [
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "id": 13,
        "branch": "master"
      },
    },
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "id": 2,
        "branch": "master"
      },
    },
  ]
}

Example: Bitbucket Server

{
  "targets": [
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "repoSlug": "api-import-circle-test",
        "name": "Snyk api-import-circle-test",
        "projectKey": "PROJECT"
      },
      "files": [
        {
          "path": "package.json"
        },
        {
          "path": "package/package.json"
        },
        {
          "path": "Gemfile.lock"
        }
      ],
      "exclusionGlobs": "fixtures, test"
    },
  ]
}

Example: Github.com | Github Enterprise | dev.azure.com | Hosted Azure Repos

{
  "targets": [
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "name": "shallow-goof-policy",
        "owner": "api-import-circle-test",
        "branch": "master"
      },
      "exclusionGlobs": "fixtures, test"
    }
  ]
}

Example: Google Container Registry

{
  "targets": [
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "name": "projectId/repository:tag"
      },
    }
  ]
}

Example: Azure Container Registry, Elastic Container Registry, Artifactory Container Registry

{
  "targets": [
    {
      "orgId": "******",
      "integrationId": "******",
      "target": {
        "name": "repository:tag"
      },
    }
  ]
}

2. Set the env vars

  • SNYK_IMPORT_PATH- the path to the import file or use --file parameter
  • SNYK_TOKEN - your Snyk api token
  • SNYK_LOG_PATH - the path to folder where all logs should be saved,it is recommended creating a dedicated logs folder per import you have running. (Note: all logs will append)
  • CONCURRENT_IMPORTS (optional) defaults to 15 repos at a time, which is the recommended amount to import at once as a max. Just 1 repo may have many projects inside which can trigger a many files at once to be requested from the user's SCM instance and some may have rate limiting in place. This script aims to help reduce the risk of hitting a rate limit.
  • SNYK_API (optional) defaults to https://api.snyk.io/v1

3. Download & run

Grab a binary from the releases page and run with DEBUG=snyk* snyk-api-import-macos import --file=path/to/imported-targets.json

4. Review logs

When import is started via Snyk API, many files & targets will be added to an import job. This job when complete will provide logs of what projects could be detected, which failed and any errors that were encountered. For more details see Import API documentation

import command will generate several logs:

  • <public_org_id>.failed-polls.log - contains errors received when polling an import job for status (complete / pending)
  • <public_org_id>.failed-projects.log - contains entry per project that was identified but failed to be created
  • <public_org_id>.imported_projects.log - contains entry per projects of all projects that were successfully created in Snyk
  • import-job-results.log - contains the Import API logs received for this job once it completed.
  • imported-targets.log - contains information on which targets have been requested for processing.

Tips

Skip all previously imported targets

This can be used to skip previously imported targets (repos) so only remaining targets will be imported.

This utility helps generate the imported-targets.log file by analysing the projects already in a given Snyk Group. When present in the logging path this file is used to look up targets that should be skipped during the import.

Example:

  • all Github repos have been imported into Snyk into their respective organizations during initial onboarding
  • new Github repos have since been added and now need to be added to Snyk
  • to avoid importing everything again, using this util and running import again provides a way to only import "new" Github repos. This is much much faster and removes unnecessary calls to Snyk & Github to fetch files and do the import for everything again.

Note:

  • The same target imported into a different organization will be allowed to be imported
  • The same target from a differed source be allowed to be imported (For example the same repo is present in Github and now it being imported via Github Enterprise into the same org)

Command to run:

  • skip all previously imported into all orgs in a Group: snyk-api-import-macos list:imported --integrationType=<integration-type> --groupId=<snyk_group_id>
  • skip all previously imported for a specific Organization: snyk-api-import-macos list:imported --integrationType=<integration-type> --orgId=<snyk_org_id>
  • a single integration / projects source snyk-api-import-macos list:imported --integrationType=<integration-type> --groupId=<snyk_group_id>
  • multiple integrations / projects sources snyk-api-import-macos list:imported --integrationType=<integration-type> --integrationType=<integration-type> --orgId=<snyk_org_id>

Supported integration types:

  • Github.com github
  • Github Enterprise github-enterprise
  • Gitlab gitlab
  • Bitbucket Cloud bitbucket-cloud
  • Google Cloud Registry gcr
  • DockerHub registry docker-hub
  • Azure repos azure-repos

Check how many projects successfully imported

We recommend you use jq, which is a lightweight and flexible command-line JSON processor: jq -s length snyk-log/$SNYK_ORG_ID.imported-projects.log

Check how many projects failed to import& why

We recommend you use jq, which is a lightweight and flexible command-line JSON processor: jq . snyk-log/$SNYK_ORG_ID.failed-projects.log