Snyk Jumpstart Customer Prerequisites
Overview of Snyk Jumpstart Customer Prerequisites
A Snyk Implementation Consultant will provide services to help the Customer accelerate integration of Snyk through assisted account configuration. The engagement will consist of knowledge transfer and paired configuration.
Before engagement starts, prerequisites must be met for each product module.
What is excluded from Jumpstart?
Snyk Code Local Engine
Snyk Code Custom Rules
Drift detection configuration
API scripting
Monorepos larger than 20 GB
Package manager repository integration
Beta features except those listed below:
Code PR Checks
Clone through broker
IaC+
Git Cloning
Snyk platform prerequisites
Snyk platform - initial setup | Prerequisites | Customer participants |
---|---|---|
|
| |
(Template Org) Custom Roles and Service account configuration | Snyk Group Admin access | |
(Template Org) Notification configuration | Snyk Group Admin access | |
(Template Org) Language settings configuration | Snyk Group Admin access | |
(Template Org) Account Organization and Group configuration | Snyk Group Admin access | |
(Template Org) Jira or Slack App configuration | Jira Cloud, Slack, or Jira v5 and later | Jira or Slack Admin |
Admin training | Snyk Admins |
Snyk Open Source prerequisites
Snyk Open Source configuration | Prerequisites | Customer participants |
---|---|---|
Repository import (SCM-only up to 50 targets) | Projects must be in a supported language/package manager: No monorepos greater than 20GB |
|
SCM integration setting | Must be using a supported SCM integration |
|
SCM Broker installation | Snyk Broker environment must be on Linux, meet the prerequisites for Snyk Broker, and be procured ahead of the engagement start | Admin/Root access to the infrastructure where Broker will be configured |
Snyk Tools - API Import and SCM Sync | Access to repositories |
|
Single pipeline configuration (direct integration OR CLI) | Service Account created by Org or Group Admin with Group or Org Admin permissions | User with pipeline edit access for CI/CD tool |
SBOM Walkthrough (CLI and API) | Minimum of Snyk CLI version 1.1071.0 | |
Interpreting and actioning Open Source results |
Snyk Code prerequisites
Snyk Code configuration | Prerequisites | Customer participants |
---|---|---|
Repository import (SCM-only up to 50 targets) | Projects must be in a supported language No monorepos more than 20 GB |
|
SCM integration settings | Must be using a supported SCM integration |
|
SCM Broker installation | Snyk Broker environment must be on Linux, meet the prerequisites for Snyk Broker, and be procured ahead of the engagement start | Admin/Root access to the infrastructure where Broker will be configured |
Snyk Tools - API Import and SCM Sync |
| |
Interpreting and actioning Snyk Code Results |
Snyk Container prerequisites
Snyk Container configuration | Prerequesites | Customer participants |
---|---|---|
Single Broker Container Registry installation and configuration | Snyk Broker environment must be on Linux, meet the prerequisites for Snyk Broker, and be procured ahead of the engagement start Broker Server: running on the Snyk SaaS backend. Broker Client and Container Registry Agent: two Docker images deployed in your infrastructure, creating two separate services, responsible for sampling your container registries in a secured manner and sending the allowed information to Snyk | Admin/Root access to the infrastructure where Broker will be configured |
Container Registry Import (Up to 50 targets) | User with Container Registry Admin access | |
Interpreting and actioning Container results | ||
Single CI/CD CLI integration | CI/CD user with pipeline edit access for CI/CD tool and Snyk Admin permissions | |
Custom Base Images walkthrough (UI and CLI) | Snyk CLI installed locally |
Snyk IaC prerequisites
Snyk IaC+ configuration | Prerequisites | Customer participants |
---|---|---|
Repository import (SCM only up to 50 targets) | Must be using a supported IaC language | SCM Admin access Snyk Admin access |
Interpreting and actioning IAC+ results | ||
SCM integration settings | Must be using a supported SCM integration | User with SCM Admin access |
SCM Broker installation | Snyk Broker environment must be on Linux, meet the prerequisites for Snyk Broker, and be procured ahead of the engagement start | Admin/Root access to the infrastructure where Broker will be configured |
Single pipeline CI/CD CLI configuration | Must be using Terraform | CI/CD user with pipeline edit access for CI/CD tool and Snyk Admin permissions |
Configure eloud environments (up to 3) | Must be Azure, GCP, or AWS | User with access to the specified cloud environment Snyk Admin access |
Snyk AppRisk Essentials Prioritization prerequisites
AppRisk configuration | Prerequisites | Customer particiapnts |
---|---|---|
Coverage and visibility configuration |
| Snyk Group Admin or User with Edit AppRisk permission
SCM Read Access token |
Walkthrough of coverage and visibility use cases in AppRisk |
|
|
Snyk Container for AppRisk* Setup of 1 of the following integration methods
| If Broker for Container Registry, Snyk Broker environment must be on Linux, meet the prerequisites for Snyk Broker, and be procured ahead of the engagement start
| If Broker for Container Registry, Admin/Root access to the infrastructure where Broker will be configured
If Container Registry integration, user with Container Registry Admin access
If CI/CD CLI integration, CI user with pipeline edit access for CI/CD tool and Snyk Admin permissions |
Snyk Container for AppRisk - steps required when the Customer does not already have Snyk Container on contract. Container Registry import |
| User with Container Registry Admin access |
Single Kubernetes connector for AppRisk installation | Able to meet the documented prerequisites for Kubernetes connector for AppRisk | User with access to deploy on the target kubernetes environment using a Helm chart |
Component tagging automation | If Container Registry integration, able to provide the container image naming convention mapping or list, so the tags can be applied in accordance with the tagging requirements for linking container Projects to source code Projects | Admin/Root access to the infrastructure where the tagging job will be configured and scheduled |
Walkthrough of prioritized issues in AppRisk |
|
|
Last updated