Skip to content
This repository has been archived by the owner on Mar 24, 2022. It is now read-only.

vmware-archive/spring-cloud-dotnet-configuration

Repository files navigation

.NET Configuration Providers

With the introduction of ASP.NET Core, Microsoft is providing a new application configuration model for accessing configuration settings for an application. This new model supports access to key/value configuration data from a variety of different configuration providers or sources. Out of the box, ASP.NET Core comes with support for JSON, XML and INI files, as well as environment variables and command line parameters. Additionally, Microsoft has also enabled developers to write their own custom configuration providers should those provided by Microsoft not meet your needs.

This repo contains a custom configuration provider purpose built for CloudFoundry and Spring Cloud Services - Config Server. The Pivotal.Extensions.Configuration.ConfigServer enables using the Config Server for Pivotal Cloud Foundry as a provider of configuration data.

Windows Master: AppVeyor Master

Windows Dev: AppVeyor Dev

Linux/OSX Master: Travis Master

Linux/OSX Dev: Travis Dev

.NET Runtime & Framework Support

Like the ASP.NET Core configuration providers, these providers are intended to support both .NET 4.6.1+ and .NET Core (CoreCLR/CoreFX) runtimes. The providers are built and unit tested on Windows, Linux and OSX.

While the primary usage of the providers is intended to be with ASP.NET Core applications, they should also work fine with UWP, Console and ASP.NET 4.x apps. An ASP.NET 4.x sample app is available illustrating how this can be done.

Currently all of the code and samples have been tested on .NET Core 2.0, .NET 4.6.x, and on ASP.NET Core 2.0.0

Usage

For more information on how to use these components see the online Steeltoe documentation.

Nuget Feeds

All new configuration provider development is done on the dev branch. More stable versions of the providers can be found on the master branch. The latest prebuilt packages from each branch can be found on one of two MyGet feeds. Released version can be found on nuget.org.

Building Pre-requisites

To build and run the unit tests:

  1. .NET Core SDK 2.0.3 or greater
  2. .NET Core Runtime 2.0.3

Building Packages & Running Tests - Windows

To build the packages on windows:

  1. git clone ...
  2. cd clone directory
  3. cd src/project (e.g. cd src/Pivotal.Extensions.Configuration.ConfigServer)
  4. dotnet restore
  5. dotnet pack --configuration Release or Debug

The resulting artifacts can be found in the bin folder under the corresponding project. (e.g. src/Pivotal.Extensions.Configuration.ConfigServer/bin

To run the unit tests:

  1. git clone ...
  2. cd clone directory
  3. cd test/test project (e.g. cd test\Pivotal.Extensions.Configuration.ConfigServer.Test)
  4. dotnet restore
  5. dotnet xunit -verbose

Building Packages & Running Tests - Linux/OSX

To build the packages on Linux/OSX:

  1. git clone ...
  2. cd clone directory
  3. cd src/project (e.g.. cd src/Pivotal.Extensions.Configuration.ConfigServer)
  4. dotnet restore
  5. dotnet pack --configuration Release or Debug

The resulting artifacts can be found in the bin folder under the corresponding project. (e.g. src/Pivotal.Extensions.Configuration.ConfigServer/bin

To run the unit tests:

  1. git clone ...
  2. cd clone directory
  3. cd test\test project (e.g. cd test/Pivotal.Extensions.Configuration.ConfigServer.Test)
  4. dotnet restore
  5. dotnet xunit -verbose -framework netcoreapp2.0

Sample Applications

See the Samples repo for examples of how to use these packages.