This document outlines the characteristics and best practices for developing 'friendly' microservices, emphasizing independence, helpfulness, and ease of use. Key recommendations include maintaining comprehensive documentation, utilizing monitoring tools, ensuring security, and facilitating deployment and integration. It also stresses the importance of service coexistence and communication within a broader system.

1. Making Friendly Microservices
Michele
Titolo
Lead Software Engineer,
Capital One

2. Definition:
/microservice/
Small service that does one thing well
Independent
Owns its own data

3. Definition:
/friendly/
Helpful
An ally
Kind
Easy to use, understand
Able to coexist without causing harm

4. What Makes A
Microservice…
Helpful, An Ally, Kind, Easy to Use,
Able to Coexist

5. Why?

6. Helpful

7. Documentation
Documentation
Documentation

8. Version And
Revision History
Historical record of when things changed
and why

9. Live Documentation

10. Document
Dependencies

12. Create A
Dependency Graph

13. Autogenerate
Documentation

14. Tools
Open API Specification/Swagger
APIBlueprint
RAML

15. Open Api Spec

16. Api Blueprint

17. RAML

18. Ally

19. Integrate
Monitoring Tools

20. Log All The Things
Use unique request IDs so logs are easier
to sort through

21. Avoid Playing
Red Light Green Light

22. What Happens When
A Dependency Fails?

23. Hint:
Your Service Should
Not Go Down

24. Macro Dependencies
Micro Dependencies

25. Help Identify
Bottlenecks
Before They Happen

26. Communication

27. Gather Data

28. Tools
Docker
Atlas
Zipkin

29. Docker

30. Atlas

31. Zipkin

32. Kind

33. Make Your Service
Easy To Deploy
And Scale

34. Consumers Should Be
Able To Hit The API
Directly In A Non-Prod
Environment

35. Consistent Error
Messaging

36. HTTP/1.1
206 Partial Content

37. Do Not Make Others
Setup A Development
Environment To
Troubleshoot Issues

38. Tools
Docker
Jenkins
Capistrano

39. Docker

40. Containers
Each service should stand alone
Use docker-compose for dependencies
Swarm and Scale

41. Use Containers
For Local
Development

42. Jenkins

43. Capistrano

44. Easy To Use

45. Use One Base URL
For Everything

46. Use An API Gateway
Or Load Balancer To
Route API Calls

47. Be Security
Conscious

48. Cookie Security
Don’t use wildcards
Always use HTTPS and Secure
Set correct domain

49. Mobile Security
SSL Certificate Pinning

50. Tools
Docker
Zuul
NGINIX
HAProxy

51. Docker

52. Zuul

53. NGINIX

54. HAProxy

55. Coexist

56. Consistency
Conventions

57. How Does Your
Service Fit In With
The Rest?

58. Services Need To
Work Together

59. Don’t Take Single
Responsibility
Too Far

61. Assumptions

62. Tools

63. Microservice
Discovery

64. API Discovery

66. The Friendly
Microservice
Helpful Documentation
Built With Monitoring And Troubleshooting In Mind
Easily Deployable
Easy To Consume
Coexists With Established Conventions

67. Thank you!
@micheletitolo

68. Resources
• https://opencredo.com/rest-api-tooling-review/
• http://www.capitalone.io/blog/delivering-microservices-for-enterprise-with-devops/
• https://medium.com/capital-one-developers/mobile-orchestration-innovation-on-
the-edge-9835e4cbd69e#.vpbsiyqmq
• http://swagger.io/open-source-integrations/
• https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
• https://www.owasp.org/index.php/Testing_for_cookies_attributes_(OTG-SESS-002)
• http://www.onegeek.com.au/articles/waiting-for-dependencies-in-docker-compose
• http://techblog.netflix.com/2014/12/introducing-atlas-netflixs-primary.html
• https://github.com/justone/dockviz

69. Photo Credits
• https://unsplash.com/photos/h13Y8vyIXNU
• https://unsplash.com/collections/380/petunia-the-pug
• https://www.flickr.com/photos/32179495@N04/21211072432/
• https://www.flickr.com/photos/78134717@N08/7154609638
• https://www.flickr.com/photos/33622296@N04/5870006633/
• https://www.flickr.com/photos/7255089@N05/5415983081
• https://www.flickr.com/photos/95477820@N02/8730925814
• https://www.flickr.com/photos/35137530@N00/16406998986/