webconfig-example-app

Example app for web config transform buildpack.

In our example app and configuration files we demonstrate the use of general configuration transformation through tokenization, as well as the special use case for transformation without tokenization for appSettings and connectionStrings.

For instructions on how to use this buildpack with your own application and external configuration files, please see the buildpack repository

Usage :

This repository includes solution files specific to Visual Studio. Once you download this application, cd into the web project folder (WebConfigSampleApp) to run the below commands as is.

1. Create a service for Spring Cloud Config Server

• Make sure you have config server available in your CF marketplace. To check if you have this server, run cf marketplace. You should see p.config-server or p-config-server in this list.

• Create config server using the CF cli. This will target an example config server repository found here

  cf create-service p-config-server standard my_configserver  -c .\config-server.json
  

Note: If you're having trouble creating the service, make sure your config-server.json is saved with standard UTF-8 encoding. You can also try giving the full path to your config-server.json for the configuration (-c) parameter, which seems to resolve some JSON issues with the CLI.

2. Push the sample app to CF

• Open the application in Visual Studio, and publish the web project to bin/Release/Publish. We will push this folder's contents to CF. In Advanced make sure to select the Release configuration when publishing the app

• Push the app to CF. The below command will target the Development configuration file in the example config server repository. If you want to target another environment (e.g. Production), swap this value out for the env argument.

  cf push --var env=Development
  

• Observe the logs. The web-configtranform buildpack emits logs when it replaces settings.

  Downloading hwc_buildpack...
  Downloaded hwc_buildpack
  Cell b8e4aaa7-f146-4777-8702-b3faf909b6c6 creating container for instance e543ac9a-9224-4c7f-a59a-f5357adc13d3
  Cell b8e4aaa7-f146-4777-8702-b3faf909b6c6 successfully created container for instance e543ac9a-9224-4c7f-a59a-f5357adc13d3
  Downloading app package...
  Downloading build artifacts cache...
  Downloaded build artifacts cache (237B)
  Downloaded app package (6.9M)
  Downloaded buildpack `https://github.com/cloudfoundry-community/web-config-transform-buildpack/releases/download/v1.1.8/Web.Config
  ================================================================================
  =============== WebConfig Transform Buildpack execution started ================
  ================================================================================
  -----> Using Environment: Development
  -----> Config server binding found...
  info: Steeltoe.Extensions.Configuration.ConfigServer.ConfigServerConfigurationProvider[0]
        Fetching config from server at: https://config-f7c2aba4-5dfd-41a6-b5b7-456d6372367f.apps.pcfone.io
  info: Steeltoe.Extensions.Configuration.ConfigServer.ConfigServerConfigurationProvider[0]
        Located environment: sampleapp, Development, (null), 78da03e611009eb7f8c3388b5fdf08d5807f878b, (null)
  -----> Replacing value for matching appSetting key `CommonSetting` in web.config
  -----> Replacing token `#{client:Default_IMyLogService:bindingConfiguration}` in web.config
  -----> Replacing token `#{client:Default_IMyLogService:binding}` in web.config
  -----> Replacing token `#{client:Default_IMyLogService:address}` in web.config
  ================================================================================
  ============== WebConfig Transform Buildpack execution completed ===============
  ================================================================================
  

3. Observe changes made to the web.Config file

You can directly view the changes made to the web.Config file by ssh'ing into your app container.

  cf ssh sampleapp  

Once ssh'd into the container, cd into the app directory and view the web.Config files.

cd app
type web.Config 

You should now see the replaced values that are defined in the configuration repository. In the above example, we targeted the Development environment, so the updated web.Config will now have the development environment configuration values. Observe these values are different than the original web.Config file in the app repository:

<?xml version="1.0" encoding="utf-8"?>
<!--
  For more information on how to configure your ASP.NET application, please visit
  https://go.microsoft.com/fwlink/?LinkId=169433
  -->
<configuration>
  <appSettings>
    <add key="Setting1" value="git dev setting" />
    <add key="CommonSetting" value="common setting from git" />
  </appSettings>
  <connectionStrings>
    <add name="MyDB" connectionString="Data Source=GithubDevSQLServer;Initial Catalog=MyDB;User ID=xxxx;Password=xxxx" />
  </connectionStrings>
  <system.serviceModel>
    <client>
      <endpoint address="git_dev_endpoint" binding="git_dev_binding" bindingConfiguration="git_dev_bindingConfiguration" contract="ServiceProxy.IMyLogService" name="Default_IMyLogService" />
    </client>
  </system.serviceModel>
  <system.web>
    <compilation targetFramework="4.7.2" />
    <httpRuntime targetFramework="4.7.2" />
  </system.web>
  <system.codedom>
    <compilers>
      <compiler language="c#;cs;csharp" extension=".cs" type="Microsoft.CodeDom.Providers.DotNetCompilerPlatform.CSharpCodeProvider, Microsoft.CodeDom.Providers.DotNetCompilerPlatform, Version=2.0.0.0, Culture=neutral, Pu
blicKeyToken=31bf3856ad364e35" warningLevel="4" compilerOptions="/langversion:default /nowarn:1659;1699;1701" />
      <compiler language="vb;vbs;visualbasic;vbscript" extension=".vb" type="Microsoft.CodeDom.Providers.DotNetCompilerPlatform.VBCodeProvider, Microsoft.CodeDom.Providers.DotNetCompilerPlatform, Version=2.0.0.0, Culture=
neutral, PublicKeyToken=31bf3856ad364e35" warningLevel="4" compilerOptions="/langversion:default /nowarn:41008 /define:_MYTYPE=\&quot;Web\&quot; /optionInfer+" />
    </compilers>
  </system.codedom>
</configuration>

You will see these values change if you target the Production environment.

Notes on the example external configuration server repository:

The configuration server repository used with this application is found here

• The following settings were externalized:

  • appSettings - Setting1 and CommonSetting
  • connectionStrings - MyDB
  • serviceModel - address, binding and bindingConfiguration

• In our example, CommonSetting is a value we want common across all environments. We have that setting in the common configuration file sampleapp.yml.

• In our example, we want Setting1, MyDB and serviceModel settings to differ by environment, Development or Production. Thus, we have them in environment-specific files:

  • sampleapp-Development.yml
  • sampleapp-Production.yml

  Note: file names should match to your app name. In this example filenames start with sampleapp since we specified application name as sampleapp in our app's manifest.yml