Make Ocelot work with service fabric DNS and naming service for guest…

… exe and stateless (ThreeMammals#242) * test for issue * added service fabric sample * working!! * changed sample naming to Ocelot * removed files we dont need * removed files we dont need * updated sample gitignore * updated sample gitignore * getting ocelot to work with service fabric using the reverse proxy * ThreeMammals#238 - added support for service fabric discovery provider, proxies requests through naming service, wont work on partioned service fabric services yet * ThreeMammals#238 - Manually tested service fabric using sample..all seems OK. Made some changes after testing, added docs * ThreeMammals#238 - added docs for servic fabric
MingSN91 · Mar 3, 2018 · 454ba3f · 454ba3f
1 parent 9cb25ab
commit 454ba3f
Show file tree

Hide file tree

Showing 71 changed files with 2,394 additions and 484 deletions.
diff --git a/Ocelot.sln b/Ocelot.sln
@@ -39,6 +39,14 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.Benchmarks", "test\O
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Ocelot.IntegrationTests", "test\Ocelot.IntegrationTests\Ocelot.IntegrationTests.csproj", "{D4575572-99CA-4530-8737-C296EDA326F8}"
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{E78EF991-3401-459A-94FE-EC4F4E5BD702}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OcelotApplicationApiGateway", "samples\OcelotServiceFabric\src\OcelotApplicationApiGateway\OcelotApplicationApiGateway.csproj", "{1A3A3D97-33AB-48FB-8A9F-92905A15DF74}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "OcelotApplicationService", "samples\OcelotServiceFabric\src\OcelotApplicationService\OcelotApplicationService.csproj", "{272DD79B-7D04-4DFB-BB64-B1C098CE8050}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "OcelotServiceFabric", "OcelotServiceFabric", "{98424512-BCF5-4F42-ACB2-6D7040D92487}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -69,6 +77,14 @@ Global
 		{D4575572-99CA-4530-8737-C296EDA326F8}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D4575572-99CA-4530-8737-C296EDA326F8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D4575572-99CA-4530-8737-C296EDA326F8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1A3A3D97-33AB-48FB-8A9F-92905A15DF74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1A3A3D97-33AB-48FB-8A9F-92905A15DF74}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1A3A3D97-33AB-48FB-8A9F-92905A15DF74}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1A3A3D97-33AB-48FB-8A9F-92905A15DF74}.Release|Any CPU.Build.0 = Release|Any CPU
+		{272DD79B-7D04-4DFB-BB64-B1C098CE8050}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{272DD79B-7D04-4DFB-BB64-B1C098CE8050}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{272DD79B-7D04-4DFB-BB64-B1C098CE8050}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{272DD79B-7D04-4DFB-BB64-B1C098CE8050}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -80,6 +96,9 @@ Global
 		{02BBF4C5-517E-4157-8D21-4B8B9E118B7A} = {5B401523-36DA-4491-B73A-7590A26E420B}
 		{106B49E6-95F6-4A7B-B81C-96BFA74AF035} = {5B401523-36DA-4491-B73A-7590A26E420B}
 		{D4575572-99CA-4530-8737-C296EDA326F8} = {5B401523-36DA-4491-B73A-7590A26E420B}
+		{1A3A3D97-33AB-48FB-8A9F-92905A15DF74} = {98424512-BCF5-4F42-ACB2-6D7040D92487}
+		{272DD79B-7D04-4DFB-BB64-B1C098CE8050} = {98424512-BCF5-4F42-ACB2-6D7040D92487}
+		{98424512-BCF5-4F42-ACB2-6D7040D92487} = {E78EF991-3401-459A-94FE-EC4F4E5BD702}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {21476EFF-778A-4F97-8A56-D1AF1CEC0C48}

diff --git a/docs/features/servicediscovery.rst b/docs/features/servicediscovery.rst
@@ -6,16 +6,18 @@ for the downstream service Ocelot is forwarding a request to. At the moment this
 GlobalConfiguration section which means the same service discovery provider will be used for all ReRoutes
 you specify a ServiceName for at ReRoute level. 
 
-At the moment the only supported service discovery provider is Consul. The following is required in the 
-GlobalConfiguration. The Provider is required and if you do not specify a host and port the Consul default
+Consul
+^^^^^^
+
+The following is required in the GlobalConfiguration. The Provider is required and if you do not specify a host and port the Consul default
 will be used.
 
 .. code-block:: json
 
     "ServiceDiscoveryProvider": {
-            "Host": "localhost",
-            "Port": 9500
-        }
+        "Host": "localhost",
+        "Port": 9500
+    }
 
 In the future we can add a feature that allows ReRoute specfic configuration. 
 
@@ -35,4 +37,4 @@ and LeastConnection algorithm you can use. If no load balancer is specified Ocel
         "UseServiceDiscovery": true
     }
 
-When this is set up Ocelot will lookup the downstream host and port from the service discover provider and load balance requests across any available services.
+When this is set up Ocelot will lookup the downstream host and port from the service discover provider and load balance requests across any available services.
diff --git a/docs/features/servicefabric.rst b/docs/features/servicefabric.rst
@@ -0,0 +1,35 @@
+Service Fabric
+==============
+
+If you have services deployed in Service Fabric you will normally use the naming service to access them.
+
+The following example shows how to set up a ReRoute that will work in Service Fabric. The most important thing is the ServiceName which is made up of the 
+Service Fabric application name then the specific service name. We also need to set UseServiceDiscovery as true and set up the ServiceDiscoveryProvider in 
+GlobalConfiguration. The example here shows a typical configuration. It assumes service fabric is running on localhost and that the naming service is on port 19081.
+
+The example below is taken from the samples folder so please check it if this doesnt make sense!
+
+.. code-block:: json
+
+    {
+        "ReRoutes": [
+            {
+            "DownstreamPathTemplate": "/api/values",
+            "UpstreamPathTemplate": "/EquipmentInterfaces",
+            "UpstreamHttpMethod": [
+                "Get"
+            ],
+            "DownstreamScheme": "http",
+            "ServiceName": "OcelotServiceApplication/OcelotApplicationService",
+            "UseServiceDiscovery" :  true
+            }
+        ],
+        "GlobalConfiguration": {
+            "RequestIdKey": "OcRequestId",
+            "ServiceDiscoveryProvider": {
+                "Host": "localhost",
+                "Port": 19081,
+                "Type": "ServiceFabric"
+            }
+        }
+    }
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,6 +22,7 @@ Thanks for taking a look at the Ocelot documentation. Please use the left hand n
    features/routing
    features/requestaggregation
    features/servicediscovery
+   features/servicefabric
    features/authentication
    features/authorisation
    features/administration