Creating compositions

Create environment configurations in Codefresh

Compositions can be launched as part of a unit test step, an integration test step, or to run an image for manual testing. You can create compositions from scratch or import an existing docker-compose.yml file.

Create composition

1. In the Codefresh UI, from Artifacts in the sidebar, select Compositions.
2. Click Create Composition.

1.In the Composition Name text box, type a name for your composition, and click Next.

4. Select the type of composition to create:
   • From file in repo: Start a new composition from a Docker Compose file in your repository.
   • From template: Use a template as a starting point for the composition, if your repository doesn’t include a docker-compose.yml file.
   • Empty composition: Create a composition from scratch.

5. Click Next, and continue with one of the following:
   • From file in repo
   • From template
   • Empty composition (Advanced)

From file in repo

Start a new composition from a Docker Compose file in your repository.

1. To search for the repo, in the search box, type the name of the repository.
   OR
   Click Add by URL, and then enter the URL of the repo.
2. From the Branch dropdown, select a branch for the first build.
3. Click Next.
4. Enter the path to docker-compose.yml.
   By default, Codefresh searches for your docker-compose.yml at the root level of your repository, for the name docker-compose.yml. If your docker-compose.yml is in a subdirectory, provide the path as well, for example, ./foo/bar/docker-compose.yml.

5. Click Next.

   NOTE
   We don’t support the build property of Docker Compose. We will replace it with images automatically using a pipeline that is automatically created.

6. Click Create. Once ready, your composition is displayed in the Compositions list.

From template

If your repository doesn’t include a docker-compose.yml file, use one of our templates to see how it works.

1. Choose the template.
2. Click Create.

You will see the Composition editor, where you can tweak the template as needed, and then launch the composition to see results.

Empty composition

Create a composition from scratch.

1. To add a service, click the Add Service button.
   You can add existing services, or provide the name for the Docker image to be pulled from the Docker registry.

2. (Optional) Click Edit, and modify the content based on Docker Compose YAML .
3. Click Save on the upper-right corner.

Working with existing compositions

You can edit any composition you created, regardless of the method used to create it, by selecting it from the Compositions list. Edit as needed in the YAML editor.

Manually launching compositions

When you are ready with the composition, launch it to inspect your application. Launching a composition creates a temporary test environment in your Codefresh account that you can use to inspect your application.

1. In the Codefresh UI, from Artifacts in the sidebar, select Compositions.
2. From the list, select the composition to launch.

3. Click the Launch icon.

4. To verify that the launch completed successfully, review the log.

Sharing the environment URL

View a record for the running environment and all containers for the environment in the Running Compositions tab.

1. In the Codefresh UI, from Artifacts in the sidebar, select Compositions.
2. Click Running Compositions.

3. To share your environment with your team, click the Hashtag icon.

Related articles

Unit tests
Integration tests
Creating test reports