Dependencies File - nosinovacao/name-sdk GitHub Wiki

1. What is the dependencies file?
2. Format
   1. Infrastructure Dependency
   2. Service Dependency
   3. connection_string
   4. Overrides
3. Example

The dependencies file is the place where the developer should declare the dependencies of the application, where to find the connection string and the minimum and maximum required versions of the dependencies.

By default the file is named dependencies.json and is present at the root of the application. This file should contain all the dependencies of your application.

Even if a dependency is not using NAME yet consider declaring it in this file.

In its simplest form, the dependencies file has a root object with two properties, infrastructure_dependencies and service_dependencies of type array, these properties contain the infrastructure dependencies and services dependencies respectively.

An infrastructure dependency represents a third-party external service, that will not have NAME installed. These dependencies have the following properties:

A OneOf dependency is a special kind allowed in Infrastructure dependencies. It is represented by a OneOf property of type array.

This dependency works as a conditional OR, which passes the checks if at least one the dependencies in it pass the check.

You can use it by putting dependencies inside its array.

When the type of the dependency is OperatingSystem you must set the name of the expected OS in the property os_name, the allowed values are Windows and any Linux distribution.

Also, you can use the following values for the min_version and max_version:

A service dependency represents a service that has or will have NAME installed, with the manifest endpoint exposed.

These dependencies have the following properties:

This property, present in all dependencies which require a connection string is more versatile than the other properties and can be configured in one of the following ways:

A locator is a mechanism created to get a connection string from a specified resource.

Using a locator to get the connection string, allows you to keep the connection string where you previously had it, without making any changes to the initial code base.

The possible locators and required properties can be checked in the table below.

The connection_string value can be a string with the connection string. This should only be used for testing purposes, using a locator is the preferred way to set the connection string.

The Overrides is an object property at the root of the file that allows the developer to control some NAME behaviour, unlike the other properties this values are only read from the dependencies.json file once at the start of the application. The following are the properties supported:

Default value: Standard

This sets how NAME will interact with the Central Registration, supported values are Standard, AnnounceDisabled, HeartbeatDisabled, BootstrapDisabled and NAMEDisabled. For more information check the Central Registration page.

Default value:

[ 
  "http://registry1.name.local.internal:80/api/v1",
  "http://registry2.name.local.internal:80/api/v1",
  "http://registry1-name:80/api/v1",
  "http://registry2-name:80/api/v1" 
]

This defines the endpoints where NAME will try to register itself in a Central Registration scenario. For more information check the Central Registration page.

Default value: 40500

Defines the first port that will be attempted in a self-host NAME configuration. Only applicable to SelfHost packages.

Default value: 40600

Defines the last port that will be attempted in a self-host NAME configuration. Only applicable to SelfHost packages.

Default value: 5

The maximum number of hops performed when fetching the dependencies manifests recursively.

Default value: true

Wether the dependencies connection strings should be added to the manifest. *You should set this to false in services exposed in the web.

Default value: 7000

The timeout for connecting to a dependency.

Default value: 7000

The timeout for reading or writing from a dependency.

Default value: 00.00:05:00

The frequency at which NAME will ping the Central Registration service. For more information check the Central Registration page.

Default value: 00.00:10:00

The frequency at which NAME will reannounce the manifest to the Central Registration service. For more information check the Central Registration page.

Default value: 00.01:00:00

The frequency at which NAME try to bootstrap in the Central Registration service. For more information check the Central Registration page.

Default value: 00.00:00:05

The timeout when bootstrapping in the Central Registration service. For more information check the Central Registration page.

{
  "infrastructure_dependencies": [
    {
      "oneOf": [
        {
          "os_name": "Ubuntu",
          "type": "OperatingSystem",
          "min_version": "16.04",
          "max_version": "14.04"
        },
        {
          "os_name": "Windows",
          "type": "OperatingSystem",
          "min_version": "WindowsServer2008R2",
          "max_version": "*"
        }
      ]
    },
    {
      "type": "MongoDb",
      "min_version": "2.4",
      "max_version": "3.2",
      "connection_string": {
        "locator": "ConnectionStrings",
        "key": "MongoDBConnectionString"
      }
    },
    {
      "type": "RabbitMq",
      "name": "rabbitmq",
      "min_version": "3.5.8",
      "max_version": "*",
      "connection_string": {
        "locator": "ConnectionStrings",
        "key": "RabbitConnectionString"
      }
    }
  ],
  "service_dependencies": [
    {
      "name": "Recommendations Engine",
      "min_version": "2.3.7",
      "max_version": "3.2",
      "connection_string": {
        "locator": "JSONPath",
        "file": "appSettings.json",
        "expression": "$.ConnectionStrings.RecEngine"
      }
    },
    {
      "name": "Logins Management",
      "min_version": "1.1.0",
      "max_version": "1.1.0",
      "connection_string": {
        "locator": "VSSettingsFile",
        "section": "SampleApp.Properties.Settings",
        "key": "LoginsManagementUrl"
      }
    },
    {
      "name": "Catalog Manager",
      "min_version": "1",
      "max_version": "*",
      "connection_string": {
        "locator": "AppSettings",
        "key": "CatalogRESTEndpoint"
      }
    }
  ]
}