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
Non-generally available features (features in Closed Beta or Early Access)
Snyk platform prerequisites
Base SSO connection configuration
SSO Custom Mapping
Requires an admin for your IDP to create an application within the IDP and create the mappings.
Snyk Group Admin access
(Template Org) Custom Roles and Service account configuration
(Template Org) Notification configuration
Template Org) Open Source and Code settings configuration
(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
Coverage & Visibility Configuration
Snyk Group Admin, SCM Read Access token, 'Application context' credentials
Walk-through of coverage and visibility use cases in the Asset Inventory
Walk-through of prioritized issues in the Asset Dashboard Report
Developer training
Developers
Snyk Open Source prerequisites
Repository import (one SCM integration)
Projects must be in a supported language/package manager
.NET (NuGet or Paket)
Bazel
C/C++
Go (Go Modules)
Java and Kotlin (Maven or Gradle)
JavaScript (NPM or Yarn)
PHP (Composer)
Python (pip, Poetry, Pipenv, or setup.py)
Ruby (Bundler)
Scala (sbt)
Swift and Objective-C (Cocoapods) No monorepos greater than 20GB
SCM Admin access
Snyk 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 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
Repository import (one SCM integration)
Projects must be in a supported language/package manager
Apex
C# (.NET, ASP.NET, .NET Core)
C/C++ (C++ Standard Library, POSIX, Win32)
Go
Java (Apache Camel, Apache Struts, Spring MVC, Spring JDBC, Jakarta XML Services, Dropwizard)
Javascript (React, Vue.js, Express, JQuery)
Kotlin
PHP (Symphony, Laravel)
Python (Django, Flask)
Ruby on Rails
Scala (Play, Akka, HTTP4S)
Swift (AlamoFire, Pathos, SQLite, CryptoKit)
Typescript
VB.NET No monorepos greater than 20GB
SCM Admin access
Snyk 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
Interpreting and actioning Snyk Code Results
Snyk Container prerequisites
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
Repository import (one SCM integration)
Must be using a supported IAC language:
AWS CloudFormation
Kubernetes Manifests
Terraform (Single File)
Terraform (modules)
Terraform (variables file)
Azure Resource Manager
SCM Admin access
Snyk Admin access
Interpreting and actioning IaC results
IaC Settings
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
Snyk API & Web prerequisites
Web Target configuration, including authenticated scans (up to three web applications)
Credentials for Web Targets to configure authorization (form, sequence, or 2FA)
API Target configuration (up to one API collection)
Postman Collection or OpenAPI definition for API
Domain Ownership Verification
Web infrastructure access to verify ownership of domain using a txt file, DNS, meta tag, Cloudflare connection, or AWS connection
Scanning Agent configuration (one agent)
Prerequisites detailed in the Snyk API & Web help article How to install a Scanning Agent
Admin/Root access to the infrastructure on which the Scanning Agent will be configured
Target scanning in CI/CD configuration
User with pipeline edit access for CI/CD tool
Issue ticketing integration configuration
Jira or Azure Boards admin
Review of Target Scan results
Snyk Learning Management Add-On prerequisites
Best Practices and Content Overview
Snyk Admin
Custom Roles and User Management
Snyk Admin
Configuring Assignments using a Learning Organization
Snyk Admin
Tracking Assignments and controlling access
Snyk Admin
Last updated
Was this helpful?