Deploying documents to a server in a specific environment

• US 10,318,287 B2
• Filed: 12/21/2016
• Issued: 06/11/2019
• Est. Priority Date: 12/21/2016
• Status: Active Grant

• Current Assignee: Hewlett Packard Enterprise Development LP (Hewlett-Packard Enterprise Company)
• Original Assignee: Hewlett Packard Enterprise Development LP (Hewlett-Packard Enterprise Company)
• Inventors: Hamill, Hugh, Shields, Eoghan, Shine, Colin
• Primary Examiner(s): Nguyen, Mongbao
• Application Number:
  US15/387,588
• Publication Number:
  US 20180173522A1
• Time in Patent Office: 902 Days
• CPC Class Codes: G06F 8/60 Software deployment
• CPC Class Codes: G06F 8/73 Program documentation

Abstract

A method includes parsing, by a computing device, configuration data associated with multiple application programming interfaces (APIs) that are served by multiple remote applications executing on multiple servers in different environments respectively; determining, by the computing device, a uniform resource location (URL) of a remote application executing on a particular server deployed in the specific environment; receiving, by the computing device, a version of the remote application at the URL; retrieving, by the computing device, multiple documents associated with the particular API corresponding to the version from an artifact repository; and deploying, by the computing device, the multiple documents to the particular server in the specific environment.

Claims

1. A method for deploy environment-specific application programming interface (API) documentation, the method comprising:

parsing, by a computing device, configuration data associated with multiple application programming interfaces (APIs) that are served by multiple remote applications executing on multiple servers in different environments respectively, each of the different environments comprising a different particular production phase;

determining, by the computing device, a respective uniform resource locators (URLs) of the multiple remote applications executing on respective servers deployed in the different environments;

periodically querying, by the computing device, respective versions of the respective remote applications at the respective URLs;

storing, by the computing device, the respective versions received in results of the queries in a version cache;

monitoring, by the computing device, respective remote applications at the respective URLs for an update in the respective version of the multiple documents associated with respective APIs;

retrieving, by the computing device, multiple documents associated with the respective APIs corresponding to the respective versions from an artifact repository; and

deploying, by the computing device, the multiple documents to the respective servers on which the respective remote applications execute in the different environments, including;

creating a hierarchy of directories;

storing multiple API documentations in the hierarchy of directories; and

installing multiple executable binary artifacts to the hierarchy of directories;

wherein the multiple API documentations and the multiple executable binary artifacts comprise a different collection of documents than a collection of API documentations and executable binary artifacts deployed in another environment.

2. The method of claim 1, wherein each of the different environments comprises a collection of servers and applications that work together at a particular production phase, the collection of servers and the applications being accessible to a particular set of users.

3. The method of claim 2, wherein the particular production phase comprises a production environment accessible to end users, a testing environment accessible to testers, or a development environment accessible to developers.

4. The method of claim 1, wherein the configuration data comprises one of an extensible markup language (XML) file, a JavaScript Object Notation (JSON) file, a YAML file, a binary file, and a database file, and wherein the configuration data includes a plurality of API tags, each API tag being associated with a URL associated with the remote application.

5. The method of claim 1, further comprising:

retrieving, by the computing device, an updated version of the multiple documents associated with the respective API from the artifact repository in response to the change being detected while monitoring the website at the URL; and

deploying, by the computing device, the updated version of the multiple documents to the respective particular server in the respective environment.

6. A system to deploy environment-specific application programming interface (API) documentation, the system comprising:

a processor;

an artifact repository coupled to a document web server to store multiple documents associated with a plurality of APIs in a hierarchy of directories;

a document management component coupled to the document web server to serve the multiple documents associated with the APIs to multiple;

respective servers on which the respective APIs execute, each server being deployed in one of a plurality of different environments, the different environments each comprising a different particular production phase, the document management component to;

parse configuration data associated with each respective API to determine a respective uniform resource location (URL) of a respective remote application executing on a respective server deployed in the different environments;

periodically query for respective versions of the respective remote applications at the respective URLs;

store the versions received in results of the query in a version cache;

monitor each remote application at the respective URL for an update in the version of the multiple documents associated with the respective API associated with the respective remote application;

retrieve the multiple documents associated with each respective API corresponding to the updated version from the artifact repository, the multiple documents to be deployed by the document web server to the respective server in the respective environment;

deploy the multiple documents to the respective servers on which the respective remote applications execute in the respective environment;

create a hierarchy of directories;

store a collection of API documentations in the hierarchy of directories; and

install a collection of executable binary artifacts to the hierarchy of directories;

wherein the multiple API documentations and the multiple executable binary artifacts comprise a different collection of documents than a collection of API documentations and executable binary artifacts deployed in another environment.

7. The system of claim 6, wherein the document management component is external to the document web server and communicates with both the document web server and the artifact repository.

8. The system of claim 6, wherein each of the different environments comprises a collection of servers and applications that work together at a particular production phase, the collection of servers and applications being accessible to a particular set of users.

9. The system of claim 8, wherein the particular production phase comprises a production environment accessible to end users, a testing environment accessible to testers, or a development environment accessible to developers.

10. The system of claim 6, wherein the configuration data comprises one of an extensible markup language (XML) file, a JavaScript Object Notation (JSON) file, a YAML file, a binary file, and a database file, and wherein the configuration data includes a plurality of API tags, each API tag being associated with a URL associated with the remote application.

11. The system of claim 6, wherein the artifact repository comprises a plurality of directories, each directory storing, in compressed form, a collection of API documentations and a collection of executable binary artifacts associated with a particular version of the respective API received from a build server.

12. A non-transitory machine-readable storage medium encoded with instructions executable by at least one processor of a network device, the machine-readable storage medium comprising instructions to:

parse configuration data associated with a plurality of application programming interfaces (APIs) associated with multiple, respective remote applications executing on multiple, respective servers in different environments respectively, the different environments each comprising a different particular production phase;

determine a respective uniform resource location (URL) of a plurality of remote applications executing on a plurality of respective servers deployed in the different environments;

periodically query for respective versions of the respective remote applications at the respective URLs;

store the versions received in results of the queries in a version cache;

monitor the remote applications at the respective URLs for an update in the respective version of the multiple documents associated with the respective API;

retrieve the multiple documents associated with the respective APIs corresponding to the updated version from an artifact repository in response to the update being detected at the respective remote application at the respective URL, the multiple documents to be deployed to the respective particular server in the respective environment;

deploy the multiple documents to the respective particular server in the respective environment;

create a hierarchy of directories;

store multiple API documentations in the hierarchy of directories; and

install multiple executable binary artifacts to the hierarchy of directories,

wherein the multiple API documentations and the multiple executable binary artifacts comprise a different collection of documents than a collection of API documentations and executable binary artifacts deployed in another environment.

13. The non-transitory machine-readable storage medium of claim 12, wherein each of the different environments comprises a collection of servers and applications that work together at a particular production phase, the collection of servers and applications being accessible to a particular set of users.

14. The non-transitory machine-readable storage medium of claim 13, wherein the particular production phase comprises a production environment accessible to end users, a testing environment accessible to testers, and a development environment accessible to developers.