Creating a configuration for a Cloud Apps product

Creating a configurationCreating a configuration

1. Log in to the Marketplace partner dashboard.

2. Select the product for which you want to create a configuration.

3. Navigate the Configurations tab.

4. Click Create configuration.

5. Select how you want to create your configuration:

   From scratch

   Based on another configuration

   Based on preset

   To create an empty configuration:

   1. Select a folder to host your configuration. You need the cloudapps.editor role for that folder.
   2. Name the configuration.
   3. Optionally, provide a description for the configuration.

   To create a configuration based on an existing one:

   1. Select the configuration based on which you want to create a new one.
   2. Select a folder to save your configuration. You need the cloudapps.editor role for that folder.
   3. Name the configuration.
   4. Optionally, provide a description for the configuration.

   All artifacts, fields, and resources in the configuration based on which you are creating the new one will be automatically added to the new configuration.

   To create a configuration with a predefined set of typical fields and resources:

   1. Select the preset based on which you want to create a configuration. A preset is a set of Yandex Cloud services based on your app will operate. The following presets are currently available:

      • Network Load Balancer + Instance Groups + Managed Service for PostgreSQL
      • Network Load Balancer + Instance Groups + Managed Service for MySQL®
      • Network Load Balancer + Instance Groups + Object Storage
      • Network Load Balancer + Instance Groups.

   2. Select a folder to save your configuration. You need the cloudapps.editor role for that folder.

   3. Name the configuration.

   4. Optionally, provide a description for the configuration.

   5. Optionally, under Preset parameters, specify default parameter values for the resources that will be created during application (product instance) installation. Make sure the Instance Groups VM disk image meets the requirements.

Setting up a configurationSetting up a configuration

Adding an artifactAdding an artifact

Add artifacts: Yandex Compute Cloud disk images, Yandex Container Registry Docker images, and static files used by the application, placed in Yandex Object Storage buckets.

To add an artifact:

1. The configuration you created will appear in the list with the Draft status. Select it.
2. Add the artifacts required for the application to work:

   1. Click Add artifact.

   2. Select the artifact type:

      • Disk image:

        Disk images are used to initialize disks of Compute Cloud VM instances, including those in instance groups.

        1. Name the artifact.
        2. Select the Yandex Compute Cloud disk image. It must meet these requirements.
        3. Click Add.

      • Container image:

        Container images are used to create containerized applications with Yandex Serverless Containers or Yandex Container Solution.

        1. Name the artifact.
        2. Select the Docker image uploaded to Yandex Container Registry. It must meet these requirements.
        3. Click Add.

      • Object Storage:

        Object Storage buckets are used to store static files of an application version, such as logos, global configuration files, executable code of functions from Yandex Cloud Functions, etc.

        1. Name the artifact.
        2. Select the Yandex Object Storage bucket that stores the files required for the application to function correctly.
        3. Provide the full path to the file, e.g., prefix/subprefix/data.json.
        4. Click Add.

Create a formCreate a form

Create a form, i.e., a set of fields for the user to fill out before installing the application. You can use the values obtained from the fields both when configuring application resources and during its execution.

If you created a configuration based on another configuration or a preset, the configuration already has form fields. Modify them if required.

To add a field:

1. Navigate to the Parameters tab.

2. Add a field to the form for the user to fill out when installing the application:

   1. Click Add field.
   2. Specify the field parameters. For a description of the field parameters, see this section.

Adding resourcesAdding resources

Describe the Yandex Cloud resources that the user must create before installing the application and that will be automatically created in the user folder during application deployment.

If you created a configuration based on another configuration or a preset, the configuration already has resources. Modify them if required.

To add a resource:

1. Navigate to the Resources tab.

2. Click Add resource.

3. Select:

   • New resource, so that a new resource is automatically created in the user folder when installing the application.
   • User resource, so that when installing the application, the user can select a resource from those already existing in their folder or create a new one at their own discretion.

4. Select a resource from those available.

5. In the right pane, select the resource you added. User resources are distinguished from new ones by the icon.

6. Edit the resource name. To do this, click next to the resource name that was generated automatically. The resource name must be unique within the configuration. The user will see it when installing the application.

7. Specify the resource parameters. The possible types of parameter values:

   • Value: Static value you specify in the field.
   • Application attribute: Value of one of the application attributes, e.g., the ID of the folder in which the user will install the application.
   • Reference: Value of one of the parameters pertaining to the resource you added.
   • Parameters: Value obtained from a form field the user fills out when installing the application.
   • No value: Empty value.
   • Resource: Selecting one of the resources you added.
   • Expression: Calculated expression allowing you to dynamically generate the field value based on other values, input parameters, and calculations.

   For descriptions of the resource parameters, see the Terraform provider documentation. The options available when creating resources and those described in the documentation may differ.

   Example of adding a resource

   1. Select the resource type: VPC cloud network.
   2. Click next to the yandex-vpc-network-1 cloud network name; this name was generated automatically. Edit the cloud network name. It must be unique within the configuration. The user will see this name when installing the application.
   3. In the ID field, select Input field and select a variable to get the cloud network ID from. The variable name is specified when adding a field to the form. The user specifies the field value when installing the application.

8. Click Save to save the configuration.

See alsoSee also

• Creating a demo Cloud Apps product