Actioning system for observability platforms
Methods and systems provide smart actioning by augmenting open application programming interface data with cloud event definitions to generate a serverless workflow which executes in a cloud native environment to perform required orchestrations to external systems. These methods involve obtaining data describing an open application programming interface that includes one or more cloud event definitions and application programming interface calls for integrating with an external system and generating at least one serverless workflow based on the one or more cloud event definitions. The at least one serverless workflow executes in a cloud native environment. These methods further involve deploying the at least one serverless workflow in the cloud native environment for integration with the external system.
1 . A method comprising:
obtaining at least one schema and data describing an open application programming interface (API) that includes one or more cloud event definitions and API calls for integrating with an external system;
applying the at least one schema to generate serverless workflow data based on the data describing the API;
generating, based on the one or more cloud event definitions and the serverless workflow data, at least one serverless workflow that executes in a cloud native environment and defines actions to be performed in the external system; and
deploying the at least one serverless workflow in the cloud native environment for integration with the external system.
2 . The method of claim 1 , wherein each of the one or more cloud event definitions includes at least one of:
a unique tag that defines a respective workflow of the at least one serverless workflow,
at least one sequence identifier which defines a state of the respective workflow,
a name of an event which defines the event of the respective workflow that triggers next state in the respective workflow,
a source of the event, and
a type of the event.
3 . The method of claim 1 , wherein each of the one or more cloud event definitions are defined as an x-action extension in the data describing the open API and wherein an x-action tagged resource generates a function in the at least one serverless workflow.
4 . The method of claim 1 , wherein:
the serverless workflow data includes cloud native computing foundation (CNCF) serverless workflow data;
the at least one schema provides a model to interpret and transform the open API to serverless workflows; and
generating includes generating the at least one serverless workflow based on the CNCF serverless workflow data to perform one or more of:
executing an action with respect to the external system, or
obtaining telemetry data from the external system.
5 . The method of claim 1 , further comprising:
generating a docker image based on the at least one serverless workflow; and
storing, in a docker registry, the docker image.
6 . The method of claim 5 , further comprising:
generating at least one service for integrating with the external system based on the docker image.
7 . The method of claim 1 , wherein deploying the at least one serverless workflow includes:
executing at least one service that performs at least one API call to the external system and that obtains at least one event from the external system.
8 . The method of claim 1 , wherein:
the serverless workflow data includes one or more states that are triggered by events occurring in the external system and operations that are to be performed at each state.
9 . An apparatus comprising:
a memory;
a network interface configured to enable network communications; and
a processor, wherein the processor is configured to perform operations comprising:
obtaining at least one schema and data describing an open application programming interface (API) that includes one or more cloud event definitions and API calls for integrating with an external system;
applying the at least one schema to generate serverless workflow data based on the data describing the API;
generating, based on the one or more cloud event definitions and the serverless workflow data, at least one serverless workflow that executes in a cloud native environment and defines actions to be performed in the external system; and
deploying the at least one serverless workflow in the cloud native environment for integration with the external system.
10 . The apparatus of claim 9 , wherein each of the one or more cloud event definitions includes at least one of:
a unique tag that defines a respective workflow of the at least one serverless workflow,
at least one sequence identifier which defines a state of the respective workflow,
a name of an event which defines the event of the respective workflow that triggers next state in the respective workflow,
a source of the event, and
a type of the event.
11 . The apparatus of claim 9 , wherein each of the one or more cloud event definitions are defined as an x-action extension in the data describing the open API and wherein an x-action tagged resource generates a function in the at least one serverless workflow.
12 . The apparatus of claim 9 , wherein:
the serverless workflow data includes cloud native computing foundation (CNCF) serverless workflow data;
the at least one schema provides a model to interpret and transform the open API to serverless workflows; and
the processor is configured to perform generating by generating the at least one serverless workflow based on the CNCF serverless workflow data to perform one or more of:
executing an action with respect to the external system, or
obtaining telemetry data from the external system.
13 . The apparatus of claim 9 , wherein the processor is further configured to perform additional operations comprising:
generating a docker image based on the at least one serverless workflow; and
storing, in a docker registry, the docker image.
14 . The apparatus of claim 13 , wherein the processor is further configured to perform an additional operation comprising:
generating at least one service for integrating with the external system based on the docker image.
15 . The apparatus of claim 9 , wherein the processor is further configured to deploy the at least one serverless workflow by:
executing at least one service that performs at least one API call to the external system and that obtains at least one event from the external system.
16 . One or more non-transitory computer readable storage media encoded with instructions that, when executed by a processor, cause the processor to execute a method comprising:
obtaining at least one schema and data describing an open application programming interface (API) that includes one or more cloud event definitions and API calls for integrating with an external system;
applying the at least one schema to generate serverless workflow data based on the data describing the API;
generating, based on the one or more cloud event definitions and the serverless workflow data, at least one serverless workflow that executes in a cloud native environment and defines actions to be performed in the external system; and
deploying the at least one serverless workflow in the cloud native environment for integration with the external system.
17 . The one or more non-transitory computer readable storage media of claim 16 ,
wherein each of the one or more cloud event definitions includes at least one of:
a unique tag that defines a respective workflow of the at least one serverless workflow,
at least one sequence identifier which defines a state of the respective workflow,
a name of an event which defines the event of the respective workflow that triggers next state in the respective workflow,
a source of the event, and
a type of the event.
18 . The one or more non-transitory computer readable storage media of claim 16 , wherein each of the one or more cloud event definitions are defined as an x-action extension in the data describing the open API and wherein an x-action tagged resource generates a function in the at least one serverless workflow.
19 . The one or more non-transitory computer readable storage media of claim 16 , wherein:
the serverless workflow data includes cloud native computing foundation (CNCF) serverless workflow data;
the at least one schema provides a model to interpret and transform the open API to serverless workflows; and
generating includes generating the at least one serverless workflow based on the CNCF serverless workflow data to perform one or more of:
executing an action with respect to the external system, or
obtaining telemetry data from the external system.
20 . The one or more non-transitory computer readable storage media of claim 16 , wherein the method further comprises:
generating a docker image based on the at least one serverless workflow; and
storing, in a docker registry, the docker image.