Microservice Configuration Sample Data Generation

Resolve Bottlenecks,
Find Innovative Solutions
Generate Solutions

Solution Overview

Problem

Current client user interfaces in microservice architectures provide only syntax-based sample data, requiring recoding every time provisioning rules are updated, which limits the ability to present detailed, runtime-valid configuration options without human intervention.

Innovation Solution

Shift the generation of sample data from client interfaces to servers, using messaging APIs to provide context-aware sample data that can be presented through any interface, allowing services to expand on sample data and present valid configuration options to users without requiring them to code or interpret rules.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Loss of information

If client user interfaces generate sample data locally, then syntax-based sample data can be provided, but detailed runtime-valid configuration options cannot be presented without recoding

Engineering Contradiction:
Improveconfiguration validity informationVSAvoidinterface recoding complexity
Core Design Contradiction:
Loss of informationVSDevice complexity

Solution Approach 1:

The patent introduces an intermediary service component that generates and provides sample configuration data to client interfaces. This mediator service contains the provisioning rules and validation logic, allowing clients to receive runtime-valid sample data without needing to recode their interfaces. The intermediary translates complex server-side logic into usable sample data for clients.

Inventive Principle:
Principle #24Intermediary (Mediator)

Solution Approach 2:

The system enables self-service by allowing the service infrastructure itself to generate and provide sample configuration data automatically. Instead of requiring client interfaces to manually recode sample data generation logic, the system self-generates context-aware sample data based on current provisioning rules and makes it available to clients through standardized APIs.

Inventive Principle:
Principle #25Self-service

2Ease of operation

If detailed sample data is provided at client interfaces, then runtime-valid configuration options can be presented, but the interfaces must be recoded every time rules are updated

Engineering Contradiction:
Improveconfiguration provisioning easeVSAvoidrule update adaptability
Core Design Contradiction:
Ease of operationVSAdaptability or versatility

Solution Approach 1:

The patent implements dynamics by making the sample data generation adaptive and changeable without recoding. The service that provides sample data dynamically updates based on changing provisioning rules, allowing the system to adapt to new requirements while clients continue to use the same interface code. This dynamic behavior is achieved through service-based architecture where the generation logic can be updated independently of client interfaces.

Inventive Principle:
Principle #15Dynamics

Solution Approach 2:

The system performs preliminary action by pre-generating context-aware sample data on the service side before clients need it. This allows provisioning rules to be validated and sample data to be prepared in advance, so when clients request configuration options, they receive ready-to-use, runtime-valid sample data without needing to recode or reprocess logic.

Inventive Principle:
Principle #10Preliminary action

3Device complexity

If syntax-based sample data is provided, then interface implementation is simple, but understanding of provisioning rules is insufficient

Engineering Contradiction:
Improveinterface implementation complexityVSAvoidprovisioning rule understanding
Core Design Contradiction:
Device complexityVSLoss of information

Solution Approach 1:

The patent uses copying by creating simplified copies of the actual provisioning data and rules in the form of context-aware sample data. Instead of requiring clients to implement or understand complex provisioning logic, the system generates representative sample data that mirrors the structure and constraints of valid configurations, making the rules understandable through example rather than through complex interface implementation.

Inventive Principle:
Principle #26Copying

Data Source

PatentUS12063279B2Method and apparatus to self-document configuration in distributed microservice architectures
Publication Date: 2024.08.13 CIENA CORP
  • US12063279B2 patent drawing
  • US12063279B2 patent drawing
  • US12063279B2 patent drawing

AI summary

Aspects of the subject disclosure may include, for example, receiving, over a communication network via a user interface, a first request for first sample data for a first parameter associated with a first microservice. The first sample data is associated with a first portion of communication equipment. The server is configured to perform the first microservice. Further embodiments include identifying a first group of values for the first parameter based on the first portion of communication equipment and the first microservice. Additional embodiments can include providing, over the communication network, the first group of values for the first parameter to the user interface as the first sample data. The user interface presents the first group of values for the first parameter as the first sample data on a display. Other embodiments are disclosed.