ConsulRx.Templating 1.2.0-beta02

.NET 6.0

This is a prerelease version of ConsulRx.Templating.

dotnet add package ConsulRx.Templating --version 1.2.0-beta02

NuGet\Install-Package ConsulRx.Templating -Version 1.2.0-beta02

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="ConsulRx.Templating" Version="1.2.0-beta02" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add ConsulRx.Templating --version 1.2.0-beta02

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ConsulRx.Templating, 1.2.0-beta02"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install ConsulRx.Templating as a Cake Addin
#addin nuget:?package=ConsulRx.Templating&version=1.2.0-beta02&prerelease

// Install ConsulRx.Templating as a Cake Tool
#tool nuget:?package=ConsulRx.Templating&version=1.2.0-beta02&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ConsulRx

A set of libraries for interacting with Hashicorp's Consul from .NET. These libraries leverage the Reactive Extensions to allow you to consume Consul values as a stream so your application can react to changes very quickly.

ConsulRx.Configuration

Provides the ability to add config values into the Microsoft.Extensions.Configuration framework from Consul's KV Store and Service Catalog.

Getting started

In your Startup.cs (or equivilent bootstrapping file where you build your configuration):

Configuration = new ConfigurationBuilder()
    .AddConsul(c =>
        c.Endpoint("http://myconsulserver:8500") //defaults to localhost if you omit
         .MapHttpService("mywidgetservice", "serviceEndpoints:widget") //maps the address of the consul service mywidgetservice to the serviceEndpoints:widget config key in IConfiguration
         .MapKeyPrefix("apps/myapp", "consul") //recursively maps all keys underneath apps/myapp to live in equivilent structure under the consul section in IConfiguration
         .MapKey("shared/key1", "key1")
    );

ConsulRx.Templating

Similar to Hashicorp's consul-template but in .NET using Razor templates. Why? consul-template is a popular, capable and reliable solution for generating templates from consul values. Why write an alternative in .NET? After using consul-template in several production projects, I have been frustrated by the lack of flexibility of the go templates. In my experience, when trying to do anything somewhat complex, the templates become very hard to read and understand. This project is an experiment to see if I can get similar functionality as consul-template in .NET with a much more flexible templating language of Razor that is easier to write and understand.

Product	Versions
.NET	net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows

Compatible target framework(s)

Additional computed target framework(s)

Learn more about Target Frameworks and .NET Standard.

net6.0
- ConsulRx (>= 1.2.0-beta02)
- Microsoft.AspNetCore.Razor (>= 1.1.2)
- Microsoft.CodeAnalysis.CSharp (>= 2.0.0)
- Spiffy.Monitoring (>= 4.0.5)
- System.Runtime.Loader (>= 4.3.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
1.2.0-beta02	93	10/10/2022
1.2.0-beta01	69	10/10/2022

# ConsulRx
- Start targeting netstandard2.0
- Expose metadata on ServiceNode

# ConsulRx.Templating
- New package available for executing templates with consul data