Create a product

This page contains instructions for creating a new product in Foundry DevOps. Users can browse and install available products via the Marketplace storefront. Read more about use cases for which you may want to create a product.

Stores

To create a new product, select a store in which to publish your product. To select an existing store or create a new one, select the Change Store option in the top-right.

Store selection view.

New stores are saved to a project and inherit the permissions of that project. Specifically, anyone with edit access to a store's project can create new products and edit existing products in that store, and anyone with view or edit access to the store's project can install products from that store.

Product creation

Once you've chosen a store, select New product to begin creating your product.

Store overview.

General

Give your product a name and configure other settings depending on the product in the General step.

General step.

Content

Content is what will be created when users install your product. To begin building your product, select content that you would like to include. Some resource types will be highlighted, but you can always select See more entity types to see the full list of supported resource types.

add content

DevOps will automatically identify dependencies, so we recommend first adding the furthest downstream resources. For example, if you want to package a Workshop application and five object types, start by adding the Workshop application only. Once you add content, select a resource to open an information panel to the right side.

Content information.

Select the Dependencies tab to review dependencies. Dependencies will also be surfaced as inputs.

Inputs

As you add content, dependencies will automatically be surfaced as Inputs. Product installers will need to provide resources to satisfy these inputs.

Surfaced inputs.

To view more information about a specific input, select the input to open an information panel. The Dependents tab includes information on which content resources require this input.

input information

When designing your product, you can opt to promote inputs to be included as content. There are two ways to do this: from the Dependencies tab or from the Inputs list.

  • To promote inputs to be included as content from the Dependencies tab, view the content information panel for a single resource and then select Edit multiple to bulk-select multiple dependencies for inclusion.

information dependencies

  • To promote inputs to be included as content from the Inputs list, select the resources you would like to include and then select Include in the top-right corner.

include inputs

As a general rule, if you want installers to provide their own version of a resource (for example, their own datasource, object type, and so on), we recommend listing that requirement as an input. If you want your product to instead provide a resource for your installers, you should promote the input to content. If you promote all inputs to content, your installers will not need to map anything during installation.

Documentation

In the documentation step, you can add a Short description that will be visible to users who are browsing products in the storefront, a screenshot of content that installers will get when they install your product, and if relevant, a longer description that includes information on how to use your product.

Submitting documentation information.

Installation mode

Use Installation mode to set the default settings for any installations of your product. These settings can be changed per installation.

installation mode

  • Production: Recommended when you want to manage all installations centrally and use features such as automatic upgrades. By default, installations have automatic upgrades enabled and resources are installed into a locked-down project to ensure safe upgrades.
  • Bootstrap: Recommended when you expect that installers will use your product as a starting point for their own custom work. By default, installations have automatic upgrades disabled and installers can install into any location where they have edit access.

Review and publish

Once you are happy with your product, select Publish to make the product available in the storefront. Depending on the size of your product, publishing may take a few minutes.

publish