Skip to content

App Configuation

This page details the following app configuration files:

App Definition

The app definition configuration file is a JSON file that provides the details needed to add one or more app definitions to Edge builder.

App definition configuration files have the following format:

{
  "AppDefinitionConfig": [
    {
      "Name": "MultiContainerApp",
      "Description": "Multi container docker-compose appDefinition",
      "Labels": ["appDef_label1", "appDef_label2"],
      "FilePath": "examples/app/multiContainer-example/docker-compose.yml",
      "Type": "docker-compose"
    }
  ]
}

The content of the file is described in the following table:

Parameter Type Required (Y/N) Description
Name String Y The name of the app definition
Description String N A description of the app definition
Labels String Array N A list of labels in which to associate the app config with
FilePath String Y The path to the config file, which defines the app
Type String Y The app type (docker-compose or systemd)

App Config File

The app config file configuration file is a JSON file that provides the details needed to add one or more app config files to Edge builder.

App config file configuration files have the following format:

{
  "AppConfigFileConfig": [
    {
      "Name": "website",
      "Description": "a file to configure the web output",
      "FileName": "index.html",
      "FilePath": "examples/appConfiguration/index.html"
    }
  ]
}

The content of the file is described in the following table:

Parameter Type Required (Y/N) Description
Name String Y The name of the app config file
Description String N A description of the config file
FileName String Y The name given to the config file
FilePath String Y The path to the file

App Config

The app config configuration file is a JSON file that provides the details needed to add one or more app configs to Edge builder. App configs map AppConfigFiles to volumes in an AppDefinition.

App config configuration files have the following format:

{
  "AppConfig": [
    {
      "Name": "NginxConfig",
      "Description": "config to inject into the nginx container",
      "AppDefinitionID": "0093a191-418e-4b4e-9594-e400f2107656",
      "ConfigMappings": [
        {
          "Destination": "web_config",
          "AppConfigFiles": [
            "website"
          ]
        }
      ]
    }
  ]
}

The content of the file is described in the following table:

Parameter Type Required (Y/N) Description
Name String Y The name of the app config
Description String N A description of the app config
AppDefinitionID String Y The ID of the app definition with which to associate this configuration
ConfigMappings Array Y An array of config file to volume mappings
ConfigMappings.Destination String Y The volume to load the config files into
ConfigMappings.AppConfigFiles Array Y An array of app config files to load into the volume