research-article

Case Study: Microservice Evolution and Software Lifecycle of the XSEDE User Portal API

Authors:

Walter Scarborough,

Maytal DahanAuthors Info & Claims

XSEDE16: Proceedings of the XSEDE16 Conference on Diversity, Big Data, and Science at Scale

Article No.: 47, Pages 1 - 5

https://doi.org/10.1145/2949550.2949655

Published: 17 July 2016 Publication History

Abstract

The XSEDE User Portal (XUP) [1] is a web interface providing a set of user specific XSEDE services and documentation to a diverse audience. The XUP architecture started out depending on monolithic services provided by large Java libraries, but continues to evolve to use an application programming interface (API) [2] powered by a set of microservices [3]. The goal is to have the XUP API provide development and deployment environments that are agile, sustainable, and capable of handling feature changes. In making this transition, we have developed guidelines for API services that balance complexity and reuse needs with flexibility requirements. In doing so, we have also created our own set of best practices on how to convert to using microservices. In this paper we will use the XSEDE User Portal API development as a case study to explain our rationale, approach, and experiences in working with microservices in a real production environment to provide better and more reliable science services for end users.

References

[1]

XSEDE User Portal Homepage https://portal.xsede.org/ {9 July 2015}

[2]

What APIs Are And Why They're Important http://readwrite.com/2013/09/19/api-defined {9 July 2015}

[3]

Fowler, Martin. Microservices http://martinfowler.com/articles/microservices.html {9 July 2015}

[4]

Core J2EE Patterns - Data Access Object http://www.oracle.com/technetwork/java/dataaccessobject-138824.html {9 July 2015}

[5]

XSEDE Central Database - https://www.xsede.org/for-developers {28 Apr 2016}

[6]

GPIR - http://gw9.iu.xsede.org/ogce/index.php/GPIR {28 Apr 2016}

[7]

Couchdb - http://couchdb.apache.org/ {28 Apr 2016}

[8]

Doxygen http://www.stack.nl/~dimitri/doxygen/ {9 July 2015}

[9]

PHPUnit - https://phpunit.de/ {28 Apr 2016}

[10]

What is Docker? https://www.docker.com/whatisdocker {9 July 2015}

[11]

Apache HTTP Server Project - https://httpd.apache.org/ {28 Apr 2016}

[12]

Dockerfile Reference - https://docs.docker.com/engine/reference/builder/ {28 Apr 2016}

[13]

Docker Compose - https://docs.docker.com/compose/ {28 Apr 2016}

[14]

Google Analytics Solutions - https://www.google.com/analytics {28 Apr 2016}

[15]

Nginx - http://nginx.org/en/ {28 Apr 2016}

[16]

Swagger - http://swagger.io/ {28 Apr 2016}

[17]

Request Tracker https://www.bestpractical.com/rt/ {9 July 2015}

[18]

Dooley, Rion, et al. "Software-as-a-Service: The iPlant Foundation API", 5th IEEE Workshop on Many-Task Computing on Grids and Supercomputers (MTAGS). IEEE, 2012.

[19]

Ansible - https://www.ansible.com/how-ansible-works {14 June 2016}

[20]

Jenkins - https://jenkins.io/ {28 Apr 2016}

[21]

Swagger Codegen - https://github.com/swagger-api/swagger-codegen {28 Apr 2016}

Cited By

Carvalho LGarcia AAssunção Wde Mello Rde Lima MCiolkowski MMarijan DGalster MShang WJedlitschka AShukla RPadmanabhan K(2019)Analysis of the criteria adopted in industry to extract microservicesProceedings of the Joint 7th International Workshop on Conducting Empirical Studies in Industry and 6th International Workshop on Software Engineering Research and Industrial Practice10.1109/CESSER-IP.2019.00012(22-29)Online publication date: 27-May-2019
https://dl.acm.org/doi/10.1109/CESSER-IP.2019.00012
Cerny TDonahoo MTrnka M(2018)Contextual understanding of microservice architectureACM SIGAPP Applied Computing Review10.1145/3183628.318363117:4(29-45)Online publication date: 29-Jan-2018
https://dl.acm.org/doi/10.1145/3183628.3183631
Vural HKoyuncu MGuney S(2017)A Systematic Literature Review on MicroservicesComputational Science and Its Applications – ICCSA 201710.1007/978-3-319-62407-5_14(203-217)Online publication date: 15-Jul-2017
https://doi.org/10.1007/978-3-319-62407-5_14

Recommendations

Anuvaad Pranaali: A RESTful API for Machine Translation
Service-Oriented Computing – ICSOC 2016 Workshops
Abstract
The current web APIs are end-user centric as they mostly focus on the end results. In this paper, we break this paradigm for one class of scientific workflow problems —machine translation, by designing an API that caters not only to the end users ...
The NEWT platform: an extensible plugin framework for creating ReSTful HPC APIs
GCE '14: Proceedings of the 9th Gateway Computing Environments Workshop

This work describes the NEWT platform, a framework for creating ReSTful web APIs for high-performance scientific computing. The NEWT platform is designed to be a customizable framework that can be deployed at an HPC center, and enables access to various ...
Automated capacity analysis of limitation-aware microservices architectures
ESEC/FSE 2022: Proceedings of the 30th ACM Joint European Software Engineering Conference and Symposium on the Foundations of Software Engineering

Over the last years, the concept of API economy has fostered the creation of an ecosystem of public APIs used as business elements. These APIs include various pricing plans, which allow developers to consume an API for a specific price and under ...

Comments

Please enable JavaScript to view thecomments powered by Disqus.

Information & Contributors

Information

Published In

cover image ACM Other conferences

XSEDE16: Proceedings of the XSEDE16 Conference on Diversity, Big Data, and Science at Scale

July 2016

405 pages

ISBN:9781450347556

DOI:10.1145/2949550

General Chair:
Kelly Gaither
Texas Advanced Computing Center

Copyright © 2016 ACM.

Permission to make digital or hard copies of all or part of this work for personal or classroom use is granted without fee provided that copies are not made or distributed for profit or commercial advantage and that copies bear this notice and the full citation on the first page. Copyrights for components of this work owned by others than the author(s) must be honored. Abstracting with credit is permitted. To copy otherwise, or republish, to post on servers or to redistribute to lists, requires prior specific permission and/or a fee. Request permissions from [email protected].

In-Cooperation

SIGAPP: ACM Special Interest Group on Applied Computing
Xsede: Xsede
San Diego Supercomputer Center: San Diego Supercomputer Center
NICS: National Institute for Computational Sciences
University of Illinois: The University of Illinois at Urbana-Champaign

Publisher

Association for Computing Machinery

New York, NY, United States

Publication History

Published: 17 July 2016

Permissions

Request permissions for this article.

Request Permissions

Check for updates

Author Tags

Qualifiers

Research-article
Research
Refereed limited

Conference

XSEDE16

XSEDE16: Diversity, Big Data, and Science at Scale

July 17 - 21, 2016

Miami, USA

Acceptance Rates

Overall Acceptance Rate 129 of 190 submissions, 68%

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

3
Total Citations
View Citations
422
Total Downloads

Downloads (Last 12 months)9
Downloads (Last 6 weeks)0

Reflects downloads up to 27 Jan 2025

Other Metrics

View Author Metrics

Citations

Cited By

Carvalho LGarcia AAssunção Wde Mello Rde Lima MCiolkowski MMarijan DGalster MShang WJedlitschka AShukla RPadmanabhan K(2019)Analysis of the criteria adopted in industry to extract microservicesProceedings of the Joint 7th International Workshop on Conducting Empirical Studies in Industry and 6th International Workshop on Software Engineering Research and Industrial Practice10.1109/CESSER-IP.2019.00012(22-29)Online publication date: 27-May-2019
https://dl.acm.org/doi/10.1109/CESSER-IP.2019.00012
Cerny TDonahoo MTrnka M(2018)Contextual understanding of microservice architectureACM SIGAPP Applied Computing Review10.1145/3183628.318363117:4(29-45)Online publication date: 29-Jan-2018
https://dl.acm.org/doi/10.1145/3183628.3183631
Vural HKoyuncu MGuney S(2017)A Systematic Literature Review on MicroservicesComputational Science and Its Applications – ICCSA 201710.1007/978-3-319-62407-5_14(203-217)Online publication date: 15-Jul-2017
https://doi.org/10.1007/978-3-319-62407-5_14

View Options

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Figures

Tables

Media

View Table of Conten