This demo and accompanying source code is designed to help facilitate a deeper understanding of Pivotal Application Services, Spring Cloud Services, and Steeltoe.
A live demonstration can be found here. This project is still in development and will be updated regularly.
This application is intended to be deployed using Pivotal Application Services on Cloud Foundry. The source code for this project is implemented using dependency injection in .NET Core v2 and the following technologies:
- Steeltoe v2 Open Source Libraries
- Syncfusion UI Controls
- Configuration Server
- Eureka Discovery Server
- Hystrix Circuit Breakers
- RabbitMQ Messaging
- Redis Caching
- Pivotal UAC/SSO
- MySQL Connector
- Microsoft SQL Server
- User Provided Services
- Swagger UI for .NET and.NET Core
The following are required for building and deploying the applications in this workshop.
- Cloud Foundry CLI
- Git Client
- .NET Core SDK 2.0
- Visual Studio Code or Visual Studio 2017
- Java 8 JDK - Optional, needed to run Eureka and Config servers locally
While the Steeltoe workshop application helps demonstrate the functionality of Pivotal Application Services and Spring Cloud Services using Steeltoe, there was a need to expose some of the underlying workings of these applications running on PAS. This workshop and demo will help users better understand how PAS can help developers deploy at scale. Some additional techniques are used in the development of these applications such as utilizing service client libraries and shared model libraries.
The following are some of the patterns used in development:
- Micro services using service client shared libraries
- Configuration Services to handle application configuration
- User Provided Services and Configurtion Services to handle service connections
- User and Service Security using OAuth and JWT methods
- Application support for Blue Green Deployments
- Continuous integration and deployment using Visual Studio Team Services
- Messaging using RabbitMQ and Steeltoe connector
The workshop application can be navigated through the home page links through the various topics. The workshop can also be used as a demo for the capabilities of PAS. The following areas are designed to support the navigation of many of the features of PAS, SCS, and Steeltoe.
The Platform section provides a demonstration of the platform's capabilities and enhancements provided by Steeltoe. Links to logging, tasks, metrics, and health accutators are included on the page to assist in navigation to key functionality.
The Configuration section provides a demonstration of configuration best practices and using steeltoe configuration services. Links to environment variables, the config server dashboard, the config server repository, and build information are included on the page to assist in navigation to key functionality.
The Services section provides a demonstration of service discovery and circuit breaker patterns. Redis is used to store the service counters. Service security is demonstrated through the SSO feature of the portal. If the user is not logged in, the service will respond with "You will have a happy day!". Links to the Hystrix and Eureka dashboards are included on the page to assist in navigation to key functionality.
The Connections section provides a demonstration of how to leverage user provided services and/or the config server to manage connection string data for services. This can be demonstrated by binding and unbinding the user provided service and by changing the environment for the config server.
The Zero Downtime section provides a demonstration of a Blue/Green deployment. The code leverages Redis cache and config server to coordinate the cutover between applications by consitently showing the usage counters increment. The page will use colors to highlight the two applications participating on the mapped route.
The application provides the ability to log in and log out of the application using Single Sign-On. If a user is already logged into the Apps Manager, the user will be automatically signed into the Workshop application.
The entire project is setup to demonstrate continuous delivery via CI/CD pipelines setup in Visual Studio Team Services. When a change is checked in by a developer, the pipeline will build the application, deploy the artifacts back into the github repository, and push the applications on to PAS.
The following are the projects found in this repository and a short description of the functionality that each is designed to demonstrate.
Main demo application web application
Provides fortunes as a service used to demonstrate the circuit breaker and service discovery design patterns.
A .NET 4.6x version of the fortune service to demonstrate full framework support integrated with the Swagger API interface. This project requires Visual Studio to compile and build a deployment package.
Example of a console application processing RabbitMQ message queues.
Provides a reusable client for accessing the fortune teller service.
Common set of functions used by several applications.
This demo source code repository has been integrated into a CI/CD pipeline using Visual Studio Team Services. The build and release jobs developed leverage the Cloud Foundry plug-in to deploy the application on to Pivotal Cloud Foundry. The portal for the VSTS CI/CD pipeline can be found here. Access is required to the portal to view the job definitions.
Installation packages that are ready to push are available in the Release section of this repository. You can find them here.
Projects can be built using .NET Core 2.0 SDK from a console window. Use the publish commmand to create a deployment package or push the source code directly onto cloud foundry.
`dotnet publish {nameofproject}.csproj -o {outputpath}`
This project is developed using Visual Studio 2017. To build this solution, clone this repo and open the solution file. The projects can then be published and pushed from the publish folder.
Additional configuration instructions can be found in the content directory of this project.