Create a run configuration

Ensure that the project setup in your IDE aligns with the development workload you intend to develop.

JetBrains IDE uses configurations to run, debug, and test your code. Each run configuration is a named set of startup properties that define what to execute, and what parameters and environment to use. Velocity works with native JetBrains run configurations. This process explains how to create a Velocity run configuration by building a dedicated Dockerfile image.

This process explains how to set up a Velocity run configuration from scratch for a private project, or how to create a pre-defined base configuration for your team. If you are working as part of an organization with an already pre-configured Velocity base configuration, see Start from a Base Configuration to get started.

Set up the configuration

1. Click Create a new configuration to launch the onboarding wizard.

   

   Velocity Getting Started Walkthrough
2. From the dropdown list at the top of the next screen, choose the programming language you are developing and then choose whether to create your configuration based on an existing workload or a Dockerfile. For this walkthrough, choose Based on Dockerfile and click Next.

   

   Based on Dockerfile
3. Now, configure the workload that you are developing. Confirm that all of the values auto-populated by Velocity are correct, or update them as needed, and click Next.

   

Field	Description
Configuration name	Choose a name that suggests the goal of the run configuration - for example, the name of the application you're developing
Dockerfile	The path to the Dockerfile associated with the service that you're developing
Build context path	The build context is the set of files that your build can access. The positional argument that you pass to the build command specifies the context (for example, the local path) that you want to use for the build. Read more here.
Kubernetes context	The Kubernetes cluster that you're working in
Kubernetes namespace	The namespace in which your deployed service is running
Kubernetes workload	The specific Kubernetes workload that you're developing

4. Now review and, if necessary, provide additional details for Velocity to build a Dockerfile:

   1. For projects using Python or NodeJS, skip this step. If the build step of the application is outside of the Dockerfile and your project uses neither Python nor NodeJS, provide the build command so that Velocity can build it and copy it into the new target image. For Does your Dockerfile contain the application's build command? click No and then enter the relevant details.
   2. If your Dockerfile requires any build arguments to be passed with the --build-argflag in a docker build command, the list of expected build arguments dynamically loads; additionally you can add any commands necessary. For example, the ARG instruction in a Dockerfile sets a variable that is passed as a build argument. If you were to build this Dockerfile locally, you would pass the --build-arg flag; however, with Velocity this build argument is supplied in the Velocity Setup Wizard, as follows:
   3. If your Dockerfile requires an SSH key to access private packages or repositories during the docker build process, choose the SSH key. If this option is not visible to you, it means that your Dockerfile doesn't require an SSH key.
5. Click Create. The wizard closes, a new Velocity run configuration is created and you can get familiar with Velocity in your IDE and start your first development session with Velocity.