Skip to main content

Proof of value (POV) prerequisites

Before starting a Moderne DX proof of value, your team will need to:

  • Set up source control access
  • Prepare a repository list
  • Set aside a machine for Moderne DX

This page covers everything you need to do so nothing is missed on day one.

Checklist​

#RequirementDetails
1SCM service account with read access to all in-scope repositoriesUsed by the CLI and mass ingest to clone and build repositories
2An optional SCM OAuth applicationLets Moderne DX show each user only the repositories they can read
3Repository list (repos.csv)Generated with our repository fetcher scripts
4A machine for Moderne DX, with Java 25 and the Moderne CLImacOS on Apple silicon or Linux. See the installation guide

Source control access​

You will need a source control management (SCM) service account with read access to all in-scope repositories. The Moderne CLI and mass ingest will use this account to clone your repositories and build Lossless Semantic Trees (LSTs) from them.

You won't need to store these credentials in a container image. Instead, you'll provide them when the container starts. To see how that works, check out where the credentials file is mounted in the mass ingest example's README.

Preparing your repository list​

You will need a repos.csv file that lists the repositories to work with. The more repositories you include, the more value you will see from the POV. This is because Moderne's strength is working across repositories at scale.

The easiest way to generate this file is with our repository fetcher scripts, which are available for GitHub, GitLab, Bitbucket (Data Center and Cloud), and Azure DevOps. These scripts query your SCM's API and produce a ready-to-use repos.csv file.

Mass ingest​

You may want to plan for mass ingest early, even though it's typically set up after the initial POV rather than during it. Mass ingest builds all of your repositories and creates the LST artifacts that recipes run against. It runs as a container. You can host that container on a VM or in a Kubernetes cluster.

ResourceMinimumRecommended
CPU2 cores4 cores
Memory16 GB16 GB
Disk10 GB freeSized to your largest repository (the example Kubernetes Job requests 150 GB)

The minimums are what mod doctor checks before you start. The check fails on fewer than 2 CPUs and warns below 16 GB of memory or 10 GB of free disk. The recommended figures are the size of the machine that the example Kubernetes Job runs each shard on.

Only one repository is stored on disk at a time. This is because each container builds one repository at a time and then deletes it once its LST is published.

To finish a large repository list sooner, you can run several containers in parallel. You will need to choose the number of shards you want - the CLI will then assign the repositories to them automatically.

The mass ingest guide covers sizing and sharding. The mass ingest example repository has a Docker script and a Kubernetes Job that run the shards for you.

If you have a standard base image that includes your existing certificates or other configuration, we can build on top of that. If you don't, we'll build from standard open-source base images and configure it with any certificates, credentials, and build tool settings during the engagement.

What Moderne provides​

During the POV process, Moderne will provide:

  • A Moderne DX license key, which your developers' CLIs will also use for their license
  • A Code Genome Project token, which Moderne DX will use to download recipes and to get its name under moderne.direct
  • Technical support throughout the setup and evaluation process

Next steps​

Once these prerequisites are in place, install Moderne DX, then proceed to the proof of value process to start running recipes against your code.