diff --git a/docs/images/OcelotBasic.jpg b/docs/images/OcelotBasic.jpg new file mode 100644 index 00000000..bf42a496 Binary files /dev/null and b/docs/images/OcelotBasic.jpg differ diff --git a/docs/images/OcelotIndentityServer.jpg b/docs/images/OcelotIndentityServer.jpg new file mode 100644 index 00000000..730af85b Binary files /dev/null and b/docs/images/OcelotIndentityServer.jpg differ diff --git a/docs/images/OcelotMultipleInstances.jpg b/docs/images/OcelotMultipleInstances.jpg new file mode 100644 index 00000000..8ed6b0aa Binary files /dev/null and b/docs/images/OcelotMultipleInstances.jpg differ diff --git a/docs/images/OcelotMultipleInstancesConsul.jpg b/docs/images/OcelotMultipleInstancesConsul.jpg new file mode 100644 index 00000000..95c8e90a Binary files /dev/null and b/docs/images/OcelotMultipleInstancesConsul.jpg differ diff --git a/docs/index.rst b/docs/index.rst index cb06e424..6e410970 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,29 +1,7 @@ Welcome to Ocelot ================= -This project is aimed at people using .NET running -a micro services / service orientated architecture -that need a unified point of entry into their system. - -In particular I want easy integration with -IdentityServer reference and bearer tokens. - -We have been unable to find this in my current workplace -without having to write our own Javascript middlewares -to handle the IdentityServer reference tokens. We would -rather use the IdentityServer code that already exists -to do this. - -Ocelot is a bunch of middlewares in a specific order. - -Ocelot manipulates the HttpRequest object into a state specified by its configuration until -it reaches a request builder middleware where it creates a HttpRequestMessage object which is -used to make a request to a downstream service. The middleware that makes the request is -the last thing in the Ocelot pipeline. It does not call the next middleware. -The response from the downstream service is stored in a per request scoped repository -and retrived as the requests goes back up the Ocelot pipeline. There is a piece of middleware -that maps the HttpResponseMessage onto the HttpResponse object and that is returned to the client. -That is basically it with a bunch of other features. +Thanks for taking a look at the Ocelot documentation. Please use the left hand nav to get around. I would suggest taking a look at introduction first. .. toctree:: :maxdepth: 2 diff --git a/docs/introduction/bigpicture.rst b/docs/introduction/bigpicture.rst index 4b9168a3..a86bbf78 100644 --- a/docs/introduction/bigpicture.rst +++ b/docs/introduction/bigpicture.rst @@ -1,4 +1,38 @@ Big Picture =========== -Coming soon... \ No newline at end of file +Ocleot is aimed at people using .NET running +a micro services / service orientated architecture +that need a unified point of entry into their system. + +In particular I want easy integration with +IdentityServer reference and bearer tokens. + +Ocelot is a bunch of middlewares in a specific order. + +Ocelot manipulates the HttpRequest object into a state specified by its configuration until +it reaches a request builder middleware where it creates a HttpRequestMessage object which is +used to make a request to a downstream service. The middleware that makes the request is +the last thing in the Ocelot pipeline. It does not call the next middleware. +The response from the downstream service is stored in a per request scoped repository +and retrived as the requests goes back up the Ocelot pipeline. There is a piece of middleware +that maps the HttpResponseMessage onto the HttpResponse object and that is returned to the client. +That is basically it with a bunch of other features. + +The following are configuration that you use when deploying Ocelot. + +Basic Implementation +^^^^^^^^^^^^^^^^^^^^ +.. image:: images/OcelotBasic.jpg + +With IdentityServer +^^^^^^^^^^^^^^^^^^^ +.. image:: images/OcelotIndentityServer.jpg + +Multiple Instances +^^^^^^^^^^^^^^^^^^ +.. image:: images/OcelotMultipleInstances.jpg + +With Consul +^^^^^^^^^^^ +.. image:: images/OcelotMultipleInstancesConsul.jpg