-
Notifications
You must be signed in to change notification settings - Fork 341
Add WCF sample #136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add WCF sample #136
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
ab1dc6c
add wcf sample
jiayi11 3579207
multi-stage build dockerfiles
jiayi11 47ce213
update readme
jiayi11 609a6c9
update readme
jiayi11 b1c3ffe
small fixes
jiayi11 0225c13
fixes according to comments
jiayi11 5ed33b5
add docker compose files
jiayi11 ebc1896
small fixes according to comment
jiayi11 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
FROM microsoft/dotnet-framework:4.7.2-sdk AS build | ||
WORKDIR /app | ||
COPY WcfClient/. . | ||
RUN msbuild /p:Configuration=Release | ||
|
||
FROM microsoft/dotnet-framework:4.7.2-runtime AS runtime | ||
WORKDIR /app | ||
COPY --from=build /app/bin/Release . | ||
ENTRYPOINT WcfClient.exe |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
FROM microsoft/dotnet-framework:4.7.2-sdk AS build | ||
WORKDIR /app | ||
COPY WcfServiceConsoleApp/. . | ||
RUN msbuild /p:Configuration=Release | ||
|
||
FROM microsoft/dotnet-framework:4.7.2-runtime AS runtime | ||
EXPOSE 80 | ||
EXPOSE 808 | ||
WORKDIR /app | ||
COPY --from=build /app/bin/Release . | ||
ENTRYPOINT WcfServiceConsoleApp.exe |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
FROM microsoft/dotnet-framework:4.7.2-sdk AS build | ||
WORKDIR /app | ||
COPY WcfServiceWebApp/. . | ||
RUN msbuild /p:Configuration=Release | ||
|
||
FROM microsoft/wcf:4.7.2 AS runtime | ||
WORKDIR /inetpub/wwwroot | ||
COPY --from=build /app/ . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,141 @@ | ||
# WCF Docker Sample | ||
This sample demonstrates how to dockerize WCF services, either IIS-hosted or self-hosted. A simple "hello world" service contract is used in all samples for both HTTP and NET.TCP transport bindings. The sample can also be used without Docker. | ||
|
||
The sample builds the application in a container based on the larger [.NET Framework SDK Docker image](https://hub.docker.com/r/microsoft/dotnet-framework-build/). It builds the application and then copies the final build result into a Docker image based on the smaller [WCF Runtime Docker image](https://hub.docker.com/r/microsoft/wcf/) or [.NET Framework Runtime Docker image](https://hub.docker.com/r/microsoft/dotnet-framework/). It uses Docker [multi-stage build](https://github.com/dotnet/announcements/issues/18) and [multi-arch tags](https://github.com/dotnet/announcements/issues/14). | ||
|
||
This sample requires [Docker 17.06](https://docs.docker.com/release-notes/docker-ce) or later of the [Docker client](https://store.docker.com/editions/community/docker-ce-desktop-windows). | ||
|
||
## Try pre-built WCF Docker Images | ||
You can quickly run a container with a pre-built [sample WCF Docker image](https://hub.docker.com/r/microsoft/dotnet-framework-samples/), based on the WCF Docker sample. | ||
|
||
Type the following [Docker](https://www.docker.com/products/docker) command to start a WCF service container: | ||
```console | ||
docker run --name wcfservicesample --rm -it microsoft/dotnet-framework-samples:wcfservice | ||
``` | ||
Find the IP address of the container instance. | ||
```console | ||
docker inspect --format="{{.NetworkSettings.Networks.nat.IPAddress}}" wcfservicesample | ||
172.26.236.119 | ||
``` | ||
Type the following Docker command to start a WCF client container, set environment variable HOST to the IP address of the wcfservicesample container: | ||
```console | ||
docker run --name wcfclientsample --rm -it -e HOST=172.26.236.119 microsoft/dotnet-framework-samples:wcfclient | ||
``` | ||
|
||
## Getting the sample | ||
|
||
The easiest way to get the sample is by cloning the samples repository with [git](https://git-scm.com/downloads), using the following instructions. | ||
|
||
```console | ||
git clone https://github.com/microsoft/dotnet-framework-docker/ | ||
``` | ||
|
||
You can also [download the repository as a zip](https://github.com/microsoft/dotnet-framework-docker/archive/master.zip). | ||
|
||
## Build and run the sample with Docker | ||
WCF service is supported on .NET Framework, which can run in Windows Server Core based containers. For simplicity, we disabled security in these samples. | ||
|
||
### Build a Container with IIS-hosted WCF Service | ||
Project `WcfServiceWebApp` is created from 'WCF Service Application' template in Visual Studio. A [Dockerfile](/Dockerfile.web) is added to the project. We use `microsoft/wcf` image as the base image, which has both HTTP and NET.TCP protocols enabled in IIS and exposes ports 80 (for HTTP) and 808 (for NET.TCP) for the container. We use WCF image with tag `4.7.2` for .NET Framework 4.7.2 in this example, but you can change it to use other tags (eg. `microsoft/wcf:4.7` with tag `4.7`) for WCF images with different versions of .NET Framework. The complete list of [WCF image tags](https://hub.docker.com/r/microsoft/wcf/tags/) can be found from Docker Hub. | ||
|
||
Run commands below to build the container image with name `iishostedwcfservice` and start an instance of it named `myservice1`. Docker parameter `-d` will run the container in background (detached mode). | ||
``` | ||
cd samples | ||
cd wcfapp | ||
docker build --pull -t iishostedwcfservice -f Dockerfile.web . | ||
docker run -d --rm --name myservice1 iishostedwcfservice | ||
``` | ||
Find the IP address of the container instance. This will be used later for a WCF client to connect to the service. | ||
``` | ||
docker inspect --format="{{.NetworkSettings.Networks.nat.IPAddress}}" myservice1 | ||
172.23.70.146 | ||
``` | ||
### Build a Container with Self-hosted WCF Service | ||
Project `WcfServiceConsoleApp` is created from Windows Classic Desktop 'Console App' template in Visual Studio. We added a [Dockerfile](/Dockerfile.console) to the project. We use `microsoft/dotnet-framework` image as the base image and expose ports 80 (for HTTP) and 808 (for NET.TCP) for the container. | ||
|
||
Run commands below to build the container image with name `selfhostedwcfservice` and start an instance of it named `myservice2`. | ||
``` | ||
docker build --pull -t selfhostedwcfservice -f Dockerfile.console . | ||
docker run -it --rm --name myservice2 selfhostedwcfservice | ||
``` | ||
Open another console window to find the IP address of the self-hosted WCF service (alternatively, you can run the self-hosted WCF service container in detached mode by `docker run -d --rm --name myservice2 selfhostedwcfservice`). | ||
``` | ||
docker inspect --format="{{.NetworkSettings.Networks.nat.IPAddress}}" myservice2 | ||
172.23.69.75 | ||
``` | ||
### Build a Container to run WCF Client against the Service | ||
Now that we have WCF services running in containers. Let's run the WCF client against them. Run commands below to build the container image with name `wcfclient`. The IP address of the WCF service is passed through the environment variable `host`. | ||
``` | ||
docker build --pull -t wcfclient -f Dockerfile.client . | ||
docker run -it --rm -e HOST=172.23.70.146 --name myclient wcfclient | ||
Client OS: Microsoft Windows NT 6.2.9200.0 | ||
Service Host: 172.23.70.146 | ||
Hello WCF via Http from Container! | ||
Hello WCF via Net.Tcp from Container! | ||
``` | ||
The result above is from running the WCF client against the IIS-hosted WCF service. Changing the environment variable `host` to the IP address of the self-hosted WCF service, you will get a similar result. | ||
|
||
*To run WCF client on a different machine other than the one that hosts container instance*, we will need to map ports of a container to ports of its host by using Docker parameter `-p` when we start a constainer instance. For example, the command below started an instance of the self-hosted WCF service container named `myservice3` with its ports 80 and 808 mapped to ports 80 and 808 of its host machine respectively. | ||
``` | ||
C:\wcfapp\WcfServiceConsoleApp>docker run -d -p 80:80 -p 808:808 --name myservice3 selfhostedwcfservice | ||
``` | ||
Then for the WCF client to connect to the service, we need to set the `host` to be the IP address (or DNS name) of the container host machine (instead of the IP address of the container instance). The rest will be the same to start the WCF client. | ||
|
||
## Build and run the sample with Docker Compose | ||
[Docker Compose](https://docs.docker.com/compose/overview/) is a tool for defining and running multi-container Docker applications. In this sample, we also added YML files to configure WCF server and client applications. You can directly start and run service and client applications without having to do any work to hookup the client to the WCF service. | ||
|
||
Type the following Docker Compose command to start both iis-hosted WCF service container and client container: | ||
``` | ||
docker-compose -f docker-compose-iishosted.yml up | ||
``` | ||
Alternatively, if you want to build and run self-hosted WCF service container, run commands below: | ||
``` | ||
docker-compose -f docker-compose-selfhosted.yml up | ||
``` | ||
|
||
## Build the sample locally | ||
|
||
You can build this [.NET Framework 4.7.2](https://www.microsoft.com/net/download/dotnet-framework-runtime/net472) application locally with MSBuild using the following instructions. The instructions assume that you are in the root of the repository and using the `Developer Command Prompt for VS 2017`. | ||
|
||
You must have the [.NET Framework 4.7.2 targeting pack](https://go.microsoft.com/fwlink/?LinkId=863261) installed. It is easiest to install with [Visual Studio 2017](https://www.microsoft.com/net/download/Windows/build) with the Visual Studio Installer. | ||
|
||
```console | ||
cd samples | ||
cd wcfapp | ||
msbuild wcfapp.sln /p:Configuration=Release | ||
``` | ||
|
||
Note: The /p:Configuration=Release argument builds the application in release mode (the default is debug mode). See the [MSBuild Command-Line reference](https://msdn.microsoft.com/en-us/library/ms164311.aspx) for more information on commandline parameters. | ||
You can also build, test and debug the application with [Visual Studio 2017](https://www.microsoft.com/net/download/Windows/build). | ||
|
||
## .NET Resources | ||
|
||
More Samples | ||
|
||
* [.NET Framework Docker Samples](../README.md) | ||
* [.NET Core Docker Samples](https://github.com/dotnet/dotnet-docker/blob/master/samples/README.md) | ||
|
||
Docs and More Information: | ||
|
||
* [.NET Docs](https://docs.microsoft.com/dotnet/) | ||
* [WCF Docs](https://docs.microsoft.com/dotnet/framework/wcf/) | ||
* [ASP.NET Docs](https://docs.microsoft.com/aspnet/) | ||
* [dotnet/core](https://github.com/dotnet/core) for starting with .NET Core on GitHub. | ||
* [dotnet/announcements](https://github.com/dotnet/announcements/issues) for .NET announcements. | ||
|
||
## Related Repositories | ||
|
||
.NET Core Docker Hub repos: | ||
|
||
* [microsoft/aspnetcore](https://hub.docker.com/r/microsoft/aspnetcore/) for ASP.NET Core images. | ||
* [microsoft/dotnet](https://hub.docker.com/r/microsoft/dotnet/) for .NET Core images. | ||
* [microsoft/dotnet-nightly](https://hub.docker.com/r/microsoft/dotnet-nightly/) for .NET Core preview images. | ||
* [microsoft/dotnet-samples](https://hub.docker.com/r/microsoft/dotnet-samples/) for .NET Core sample images. | ||
|
||
.NET Framework Docker Hub repos: | ||
|
||
* [microsoft/wcf](https://hub.docker.com/r/microsoft/wcf/) for WCF images. | ||
* [microsoft/aspnet](https://hub.docker.com/r/microsoft/aspnet/) for ASP.NET Web Forms and MVC images. | ||
* [microsoft/dotnet-framework](https://hub.docker.com/r/microsoft/dotnet-framework/) for .NET Framework images. | ||
* [microsoft/dotnet-framework-build](https://hub.docker.com/r/microsoft/dotnet-framework-build/) for building .NET Framework applications with Docker. | ||
* [microsoft/dotnet-framework-samples](https://hub.docker.com/r/microsoft/dotnet-framework-samples/) for .NET Framework and ASP.NET sample images. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<configuration> | ||
<startup> | ||
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2"/> | ||
</startup> | ||
</configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
using System.ServiceModel; | ||
|
||
namespace WcfClient | ||
{ | ||
[ServiceContract] | ||
public interface IService1 | ||
{ | ||
[OperationContract] | ||
string Hello(string name); | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
using System; | ||
using System.ServiceModel; | ||
|
||
namespace WcfClient | ||
{ | ||
class Program | ||
{ | ||
static string host; | ||
|
||
static void Main(string[] args) | ||
{ | ||
Console.WriteLine("Client OS: {0}", Environment.OSVersion); | ||
host = Environment.GetEnvironmentVariable("host") ?? "localhost"; | ||
Console.WriteLine("Service Host: {0}", host); | ||
|
||
CallViaHttp(); | ||
|
||
CallViaNetTcp(); | ||
} | ||
|
||
static void CallViaHttp() | ||
{ | ||
var address = string.Format("http://{0}/Service1.svc", host); | ||
var binding = new BasicHttpBinding(); | ||
var factory = new ChannelFactory<IService1>(binding, address); | ||
var channel = factory.CreateChannel(); | ||
|
||
Console.WriteLine(channel.Hello("WCF via Http")); | ||
} | ||
|
||
static void CallViaNetTcp() | ||
{ | ||
var address = string.Format("net.tcp://{0}/Service1.svc", host); | ||
var binding = new NetTcpBinding(SecurityMode.None); | ||
var factory = new ChannelFactory<IService1>(binding, address); | ||
var channel = factory.CreateChannel(); | ||
|
||
Console.WriteLine(channel.Hello("WCF via Net.Tcp")); | ||
} | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
using System.Reflection; | ||
using System.Runtime.CompilerServices; | ||
using System.Runtime.InteropServices; | ||
|
||
// General Information about an assembly is controlled through the following | ||
// set of attributes. Change these attribute values to modify the information | ||
// associated with an assembly. | ||
[assembly: AssemblyTitle("WcfClient")] | ||
[assembly: AssemblyDescription("")] | ||
[assembly: AssemblyConfiguration("")] | ||
[assembly: AssemblyCompany("")] | ||
[assembly: AssemblyProduct("WcfClient")] | ||
[assembly: AssemblyCopyright("Copyright © 2017")] | ||
[assembly: AssemblyTrademark("")] | ||
[assembly: AssemblyCulture("")] | ||
|
||
// Setting ComVisible to false makes the types in this assembly not visible | ||
// to COM components. If you need to access a type in this assembly from | ||
// COM, set the ComVisible attribute to true on that type. | ||
[assembly: ComVisible(false)] | ||
|
||
// The following GUID is for the ID of the typelib if this project is exposed to COM | ||
[assembly: Guid("ebd37df1-f83c-40c1-ba61-1f6d652a1f60")] | ||
|
||
// Version information for an assembly consists of the following four values: | ||
// | ||
// Major Version | ||
// Minor Version | ||
// Build Number | ||
// Revision | ||
// | ||
// You can specify all the values or you can default the Build and Revision Numbers | ||
// by using the '*' as shown below: | ||
// [assembly: AssemblyVersion("1.0.*")] | ||
[assembly: AssemblyVersion("1.0.0.0")] | ||
[assembly: AssemblyFileVersion("1.0.0.0")] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The nested /app/WcfClient/ path seems unnecessary in the context of Docker. What do you think about eliminating the nesting? It could be simplified to just
/app
or/WcfClient
.