Table of Contents

Config Server Provider

This provider enables the Spring Cloud Config Server to be used as a source of configuration data for a .NET application.

The Spring Cloud Config Server is an application configuration service that gives you a central place to manage an application's configuration values externally across all environments. As an application moves through the deployment pipeline from development to test and into production, you can use the config server to manage the configuration between environments and be certain that the application has everything it needs to run when you migrate it. The config server easily supports labelled versions of environment-specific configurations and is accessible to a wide range of tooling for managing its content.

To gain a better understanding of the Spring Cloud Config Server, you should read the Spring Cloud documentation.

The Steeltoe Config Server provider supports the following .NET application types:

  • ASP.NET (MVC, WebForm, WebAPI, WCF)
  • ASP.NET Core
  • Console apps (.NET Framework and .NET Core)

In addition to the Quick Start below, there are several other Steeltoe sample applications that you can refer to when needing help in understanding how to use this provider:

  • AspDotNetCore/Simple: ASP.NET Core sample app showing how to use the open source Config Server.
  • AspDotNet4/Simple: Same as AspDotNetCore/Simple but built for ASP.NET 4.x
  • AspDotNet4/SimpleCloudFoundry: Same as the Quick Start sample mentioned later but built for ASP.NET 4.x.
  • AspDotNet4/AutofacCloudFoundry: Same as AspDotNet4/SimpleCloudFoundry but built using the Autofac IOC container.
  • MusicStore: A sample application showing how to use all of the Steeltoe components together in a ASP.NET Core application. This is a micro-services based application built from the ASP.NET Core MusicStore reference app provided by Microsoft.
  • FreddysBBQ: A polyglot microservices-based sample app showing inter-operability between Java and .NET on Cloud Foundry. It is secured with OAuth2 Security Services and using Spring Cloud Services.

IMPORTANT: The Pivotal.Extensions.Configuration.ConfigServer* packages have been deprecated in Steeltoe 2.2 and are not included in future releases. All functionality provided in those packages has been pushed into the corresponding Steeltoe.Extensions.Configuration.ConfigServer* packages.

Usage

You should know how the new .NET Configuration services work before starting to use this provider. A basic understanding of the ConfigurationBuilder and how to add providers to the builder is necessary.

You should also have a good understanding of the Spring Cloud Config Server.

To use the Steeltoe provider, you need to do the following:

  1. Add the appropriate NuGet package reference to your project.
  2. Configure the settings that the Steeltoe provider uses to access the Spring Cloud Config Server.
  3. Add the provider to the configuration builder.
  4. Optionally, configure the returned config server config data as Options.
  5. Inject and use Options or ConfigurationRoot to access configuration data.

Add NuGet Reference

You can choose from two Config Server client NuGets, depending on your needs.

If you plan on only connecting to the open source version of Spring Cloud Config Server, then you should use one of the packages described by the following table, depending on your application type and needs:

App Type Package Description
Console/ASP.NET 4.x Steeltoe.Extensions.Configuration.ConfigServerBase Base functionality. No dependency injection.
ASP.NET Core Steeltoe.Extensions.Configuration.ConfigServerCore Includes base. Adds ASP.NET Core dependency injection.
ASP.NET 4.x with Autofac Steeltoe.Extensions.Configuration.ConfigServerAutofac Includes base. Adds Autofac dependency injection.

To add this type of NuGet to your project, add a PackageReference that resembles the following:

<ItemGroup>
...
    <PackageReference Include="Steeltoe.Extensions.Configuration.ConfigServerCore" Version="2.5.2" />
...
</ItemGroup>

Configure Settings

The most convenient way to configure settings for the provider is to put them in a file and then use one of the other file-based configuration providers to read them.

The following example shows some provider settings put in a JSON file. Only two settings are really necessary. spring:application:name configures the "application name" to be sample, and spring:cloud:config:uri the address of the config server.

NOTE: The spring:application:name is also used by other Steeltoe libraries in addition to the config server.

{
  "spring": {
    "application": {
      "name": "sample"
    },
    "cloud": {
      "config": {
        "uri": "http://localhost:8888"
      }
    }
  }
  ...
}

The following table describes all the settings that can be used to configure the behavior of the provider:

Key Description Default
name App name for which to request config IHostingEnvironment.ApplicationName
enabled Enable or disable config server client true
uri Comma-separated list of config server endpoints http://localhost:8888
env Environment or profile used in the server request IHostingEnvironment.EnvironmentName
validateCertificates Enable or disable certificate validation true
label Comma-separated list of labels to request master
timeout Time to wait for response from server, in milliseconds 6000
username Username for basic authentication none
password Password for basic authentication none
failFast Enable or disable failure at startup false
token HashiCorp Vault authentication token none
tokenTtl HashiCorp Vault token renewal TTL. Valid on Cloud Foundry only 300000ms
tokenRenewRate HashiCorp Vault token renewal rate. Valid on Cloud Foundry only 60000ms
retry:enabled Enable or disable retry logic false
retry:maxAttempts Max retries if retry enabled 6
retry:initialInterval Starting interval 1000ms
retry:maxInterval Maximum retry interval 2000ms
retry:multiplier Retry interval multiplier 1.1
clientId OAuth2 client id when using OAuth security none
clientSecret OAuth2 client secret when using OAuth security none
accessTokenUri Uri to use to obtain OAuth access token none
discovery:enabled Enable or disable discovery first feature false
discovery:serviceId Config Server service id to use in discovery first feature configserver
health:enabled Enable or disable config server health check contributor true
health:timeToLive Health check contributor cache time to live in ms 60*5ms

As mentioned earlier, all settings should start with spring:cloud:config:

NOTE: If you use self-signed certificates on Cloud Foundry, you might run into certificate validation issues when pushing an application. A quick way to work around this is to disable certificate validation until a proper solution can be put in place.

Add Configuration Provider

Once the provider's settings have been defined and put in a file (such as a JSON file), the next step is to read them and make them available to the provider.

In the next C# example, the provider's configuration settings from the preceding example are put in the appsettings.json file included with the application. Then, by using the .NET JSON configuration provider, we can read the settings by adding the JSON provider to the configuration builder (AddJsonFile("appsettings.json").

Then, after the JSON provider has been added, you can add the config server provider to the builder. We include an extension method, AddConfigServer(), that you can use to do so.

Because the JSON provider that reads appsettings.json has been added before the config server provider, the JSON-based settings become available to the Steeltoe provider. Note that you do not have to use JSON for the Steeltoe settings. You can use any of the other off-the-shelf configuration providers for the settings (such as INI files, environment variables, and so on).

You need to Add*() the source of the config server clients settings (AddJsonFile(..)) before you AddConfigServer(..). Otherwise, the settings are not picked up and used.

The following sample shows how to add a configuration provider:

using Steeltoe.Extensions.Configuration;
...

var builder = new ConfigurationBuilder()
    .SetBasePath(env.ContentRootPath)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
    .AddJsonFile($"appsettings.{env.EnvironmentName}.json", optional: true, reloadOnChange: true)
    .AddConfigServer(env)
    .AddEnvironmentVariables();

var config = builder.Build();
...

When developing a .NET Core application, you can accomplish the same thing by using the AddConfigServer() extension method for either the IWebHostBuilder or Generic IHostBuilder. The following example shows how to do so:

public class Program
{
    public static void Main(string[] args)
    {
        BuildWebHost(args).Run();
    }
    public static IWebHost BuildWebHost(string[] args) =>
        WebHost.CreateDefaultBuilder(args)
            .UseCloudFoundryHosting()

            // Use Config Server for configuration data
            .AddConfigServer()
            .UseStartup<Startup>()
            .Build();
}

Bind to Cloud Foundry

When you want to use a Config Server on Cloud Foundry and you have installed Spring Cloud Services, you can create and bind an instance of it to your application by using the Cloud Foundry CLI, as follows:

# Create config server instance named `myConfigServer`
cf create-service p-config-server standard myConfigServer

# Wait for service to become ready
cf services

# Bind the service to `myApp`
cf bind-service myApp myConfigServer

# Restage the app to pick up change
cf restage myApp

Once the service is bound to the application, the config server settings are available and can be setup in VCAP_SERVICES.

Then, when you push the application, the Steeltoe provider takes the settings from the service binding and merges those settings with the settings that you have provided through other configuration mechanisms (such as appsettings.json).

If there are any merge conflicts, the last provider added to the Configuration takes precedence and overrides all others.

Access Configuration Data

When the ConfigurationBuilder builds the configuration, the Config Server client makes the appropriate REST calls to the Config Server and retrieves the configuration values based on the settings that have been provided.

If there are any errors or problems accessing the server, the application continues to initialize, but the values from the server are not retrieved. If this is not the behavior you want, you should set the spring:cloud:config:failFast to true. Once that's done, the application fails to start if problems occur during the build.

After the configuration has been built, you can access the retrieved data directly by using IConfiguration. The following example shows how to do so:

...
var config = builder.Build();
var property1 = config["myconfiguration:property1"]
var property2 = config["myconfiguration:property2"]
...

Alternatively, you can create a class to hold your configuration data and then use the Options framework together with Dependency Injection to inject an instance of the class into your controllers and view.

To do so, first create a class representing the configuration data you expect to retrieve from the server, as shown in the following example:

public class MyConfiguration {
    public string Property1 { get; set; }
    public string Property2 { get; set; }
}

Next, use the Configure<>() method to tell the Options framework to create an instance of that class with the returned data. For the preceding MyConfiguration class, you could add the following code to the ConfigureServices() method in the Startup class in an ASP.NET Core application, as shown in the following example:

public class Startup
{
    public Startup(IConfiguration configuration)
    {
        Configuration = configuration;
    }

    public IConfiguration Configuration { get; set; }
    public void ConfigureServices(IServiceCollection services)
    {
        // Setup Options framework with DI
        services.AddOptions();

        // Configure IOptions<MyConfiguration>
        services.Configure<MyConfiguration>(Configuration.GetSection("myconfiguration"));
        ...
    }
}

The preceding Configure<MyConfiguration>(Configuration.GetSection("myconfiguration")) method call instructs the Options framework to bind the myconfiguration:... values to an instance of the MyConfiguration class.

After this has been done, you can gain access to the data in your Controller or View through dependency injection. The following example shows how to do so:


public class HomeController : Controller
{
    public HomeController(IOptions<MyConfiguration> myOptions)
    {
        MyOptions = myOptions.Value;
    }

    MyConfiguration MyOptions { get; private set; }

    // GET: /<controller>/
    public IActionResult Index()
    {
        ViewData["property1"] = MyOptions.Property1;
        ViewData["property2"] = MyOptions.Property2;
        return View();
    }
}

Enable Logging

Out of the box, configuration providers in .NET do not have access to the same logging infrastructure that is available to the rest of the application.

Logging in the Steeltoe Config Server Client is enabled when an ILoggerFactory has been provided. The following example shows how to create a LoggerFactory with Debug-level logging enabled:

using Steeltoe.Extensions.Configuration;

LoggerFactory logFactory = new LoggerFactory();
logFactory.AddConsole(minLevel: LogLevel.Debug);

var builder = new ConfigurationBuilder().AddConfigServer(logFactory);
Note

This method of creating a LoggerFactory was removed in .NET Core 3.0. Please refer to Migrate from Microsoft.Extensions.Logging 2.1 to 2.2 or 3.0 for guidance as needed.

Configuring Discovery First

The default behavior for the Steeltoe Config Client is to access the Config Server through the spring:cloud:config:uri configuration setting. This of course requires that the application needs a appsettings.json or an environment variable with the Config Servers address set in spring:cloud:config:uri. This mode of operation, the default, is called Config First.

Alternatively, you can setup your Config Server to register with a Discovery service such as Netflix Eureka. This enables you application to lookup the address of the Config Server using a Discovery Service instead of configuring it in appsettings.json. Note that you have to specifically configure your Config Server deployment to register with an Discovery service as this doesn't happen automatically. See the Spring Cloud Config Server documentation on how to do this.

However, with the default Config First mode of the Steeltoe client you are not able to take advantage of the Config Server registration unless you change the clients mode of operation to Discovery First. To do this follow these steps:

  1. If your application is not using a Service Discovery service you need to configure your application to do so. See the Steeltoe Discovery documentation for details on how to do this. Note that currently we only support Netflix Eureka. You will at a minimum need to configure the Eureka Server address.
  2. Change the Steeltoe Config Server client setting spring:cloud:config:discovery:enabled; set it to be true; the default is false.
  3. Optionally, if you change the service name registered by the Config Server with Eureka, you can use spring:cloud:config:discovery:serviceId=YourNewName to change the name used by the client for lookup.

Note that the price for using this mode of operation is an extra network round trip on startup to locate the Config Server service registration. The benefit is, as long as the Discovery Service is at fixed point, the Config Server can change its address and no changes are need to applications.

Configuring Health Contributor

The Config Server package provides a Steeltoe Management Health contributor that attempts to load configuration from the Config Server and contributes health information to the results of the Health endpoint.

If you use the AddConfigServer() extension method of the IWebHostBuilder the contributor is automatically added to the container and will automatically picked up an used. Otherwise you can manually add the contributor to the container using the AddConfigServerHealthContributor() extension method.

The contributor is enabled by default, but can be disabled by setting spring:cloud:config:health:enabled=false.

The response from the Config Server is cached for performance reasons. The default cache time to live is 5 minutes. To change that value, set the spring:cloud:config:health:timeToLive=xxxx setting (in milliseconds).

Configuring Fail Fast

In some cases, you may want to fail the startup of your application if it cannot connect to the Config Server. If this is the desired behavior, set the configuration setting spring:cloud:config:failFast=true to make the client halt with an Exception.

Configuring Retry

If you expect that the Config Server may occasionally be unavailable when your application starts, you can make it keep trying after a failure.

First, you need to set spring:cloud:config:failFast=true. Then you need to enable retry by adding the setting spring:cloud:config:retry:enabled=true.

The default behavior is to retry six times with an initial backoff interval of 1000ms and an exponential multiplier of 1.1 for subsequent backoffs. You can configure these settings (and others) by setting the spring:cloud:config:retry:* configuration settings described earlier.

Configuring Multiple Urls

To ensure high availability when you have multiple instances of Config Server deployed and expect one or more instances to be unavailable from time to time, you can either specify multiple URLs as a comma-separated list for spring:cloud:config:uri or have all your instances register in a Service Registry like Eureka if using Discovery First mode.

Note that doing so ensures high availability only when the Config Server is not running or responding (for example, when the server has exited or when a connection timeout has occurred). For example, if the Config Server returns a 500 (Internal Server Error) response or the Steeltoe client receives a 401 from the Config Server (due to bad credentials or other causes), the client does not try to fetch properties from other URLs. An error of that kind indicates a user issue rather than an availability problem.

If you use HTTP basic auth security on your Config Server, it is currently only possible to support per-Config Server auth credentials if you embed the credentials in each URL you specify for the spring:cloud:config:uri setting. If you use any other kind of security mechanism, you cannot currently support per-Config Server authentication and authorization.

Edit this page