Deployment document generation method, apparatus, device, and program product

Abstract

The application discloses a kind of deployment document generation method, device, equipment and program product, it is related to the field of financial technology.The method comprises the following steps: obtaining target version target configuration parameter set and benchmark version benchmark configuration parameter set;The target configuration parameter set and the benchmark configuration parameter set are analyzed, and target difference result is obtained;According to the target difference result, corresponding reference check item is inquired in checking rule base;According to the target difference result and the reference check item, target checkpoint information is generated;The target difference result and the target checkpoint information are merged to generate target deployment document.The technical scheme of the embodiment of the application realizes the automatic generation of deployment document, improves the generation efficiency of deployment document, avoids the omission and misjudgment of checkpoint, improves the integrity and accuracy of deployment document.

Description

Technical Field

[0001] This invention relates to the field of financial technology, and in particular to a method, apparatus, device, and program product for deploying document generation. Background Technology

[0002] Currently, during the system launch or deployment process, it is usually necessary to prepare deployment documentation to record changes in configuration parameters, adjustments to network access policies, and operational verification steps.

[0003] In existing technologies, deployment documentation is primarily created manually. This means developers or operations personnel need to manually compare configuration parameters across different versions to identify which parameters have changed. For these changes, developers or operations personnel need to manually create corresponding checkpoints. Finally, all this information is compiled into the deployment documentation.

[0004] The existing method of manually writing deployment documents has the following shortcomings: First, as the system scales up, the number of configuration parameters and network policies becomes enormous, making manual comparison and recording time-consuming and labor-intensive, resulting in low efficiency in deployment document writing. Second, manual checking is prone to overlooking or misjudging differences, leading to incomplete or even erroneous deployment documents, making them prone to errors. Finally, new projects still need to write them from scratch, resulting in significant duplication of work and making them difficult to reuse. Summary of the Invention

[0005] This invention provides a deployment document generation method, apparatus, device, and program product, which realizes automated generation of deployment documents, improves the generation efficiency of deployment documents, avoids omissions and misjudgments of checkpoints, and improves the completeness and accuracy of deployment documents.

[0006] According to one aspect of the present invention, a deployment document generation method is provided, the method comprising: Obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version; A difference analysis is performed between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results; Based on the target difference results, query the corresponding reference check items in the check rule base; Based on the target difference results and the reference check items, target checkpoint information is generated; The target difference results and the target checkpoint information are merged to generate a target deployment document.

[0007] According to another aspect of the present invention, a deployment document generation apparatus is provided, the apparatus comprising: The data acquisition module is used to acquire the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version; The difference analysis module is used to perform difference analysis between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference result. The rule base matching module is used to query the corresponding reference inspection item in the inspection rule base based on the target difference result; The checkpoint generation module is used to generate target checkpoint information based on the target difference results and the reference check items; The document generation module is used to merge the target difference results and the target checkpoint information to generate a target deployment document.

[0008] According to another aspect of the present invention, an electronic device is provided, the electronic device comprising: At least one processor; and A memory communicatively connected to the at least one processor; wherein, The memory stores a computer program that can be executed by the at least one processor, the computer program being executed by the at least one processor to enable the at least one processor to perform the deployment document generation method according to any embodiment of the present invention.

[0009] According to another aspect of the present invention, a computer-readable storage medium is provided, the computer-readable storage medium storing computer instructions for causing a processor to execute and implement the deployment document generation method according to any embodiment of the present invention.

[0010] According to another aspect of the present invention, a computer program product is provided, the computer program product comprising a computer program that, when executed by a processor, implements the deployment document generation method described in any embodiment of the present invention.

[0011] The technical solution of this invention introduces an inspection rule base, determines reference inspection items based on target difference results, generates target checkpoint information based on the target difference results and reference inspection items, and then generates target deployment documents based on the target difference results and target checkpoint information. This reduces manual intervention, automates the generation of deployment documents, and improves the efficiency of deployment document generation. Moreover, by introducing an inspection rule base, omissions and misjudgments of checkpoints are avoided, improving the completeness and accuracy of deployment documents. In addition, the inspection rule base is reusable, avoiding repetitive work in the process of generating new deployment documents.

[0012] It should be understood that the description in this section is not intended to identify key or essential features of the embodiments of the present invention, nor is it intended to limit the scope of the invention. Other features of the invention will become readily apparent from the following description. Attached Figure Description

[0013] To more clearly illustrate the technical solutions in the embodiments of the present invention, the accompanying drawings used in the description of the embodiments will be briefly introduced below. Obviously, the accompanying drawings described below are only some embodiments of the present invention. For those skilled in the art, other drawings can be obtained based on these drawings without creative effort.

[0014] Figure 1 This is a flowchart of a deployment document generation method provided in Embodiment 1 of the present invention; Figure 2 This is a flowchart of a deployment document generation method provided in Embodiment 2 of the present invention; Figure 3 This is a schematic diagram of the structure of a deployment document generation device according to Embodiment 2 of the present invention; Figure 4 This is a schematic diagram of a deployment document generation device according to Embodiment 3 of the present invention; Figure 5 This is a schematic diagram of the structure of an electronic device that implements the deployment document generation method of this invention. Detailed Implementation

[0015] To enable those skilled in the art to better understand the present invention, the technical solutions of the present invention will be clearly and completely described below with reference to the accompanying drawings of the embodiments of the present invention. Obviously, the described embodiments are only some embodiments of the present invention, and not all embodiments. Based on the embodiments of the present invention, all other embodiments obtained by those skilled in the art without creative effort should fall within the scope of protection of the present invention.

[0016] It should be noted that the terms "first," "second," etc., in the specification, claims, and accompanying drawings of this invention are used to distinguish similar objects and are not necessarily used to describe a specific order or sequence. It should be understood that such data can be interchanged where appropriate so that the embodiments of the invention described herein can be implemented in orders other than those illustrated or described herein. Furthermore, the terms "comprising" and "having," and any variations thereof, are intended to cover a non-exclusive inclusion; for example, a process, method, system, product, or apparatus that comprises a series of steps or units is not necessarily limited to those steps or units explicitly listed, but may include other steps or units not explicitly listed or inherent to such processes, methods, products, or apparatus.

[0017] Example 1 Figure 1This is a flowchart illustrating a deployment document generation method according to Embodiment 1 of the present invention. This embodiment of the invention is applicable to situations where deployment documents are automatically generated during system launch or deployment. The method can be executed by a deployment document generation device, which can be implemented in hardware and / or software. This deployment document generation device can be configured in an electronic device that carries the deployment document generation function, such as a client or server.

[0018] See Figure 1 The deployment document generation method shown includes: S101. Obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version.

[0019] During system deployment and go-live, configuration parameters are critical to determining system behavior, performance, stability, and security. Configuration parameters involve multiple aspects, including hardware resource allocation, software operating modes, network access policies, and logging policies. The baseline version is the original version of the system without adjusted configuration parameters. Baseline configuration parameters are the configuration parameters for the baseline version. The baseline configuration parameter set is the set of basic configuration parameters. The target version is the version of the system after adjusting configuration parameters. The target configuration parameters are the configuration parameters for the target version. The target configuration parameter set is the set of target configuration parameters. The system may include information systems or business systems, etc.

[0020] Optionally, the filename or directory structure of the system configuration file can be identified to obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version. Optionally, the system configuration file can be obtained, and a target file parser can be acquired based on the system configuration file name. This target file parser is then used to parse the system configuration file to obtain the configuration parameter set. Here, the system configuration file refers to the system configuration file for the target version. The system configuration file name is the filename of the system configuration file. The system configuration file name is used to identify the system configuration file. The target file parser is used to parse the system configuration file, converting it into a structured data structure. This can be understood as each system configuration file having a corresponding file parser for accurate parsing of different system configuration files. The correspondence between system configuration file names and file parsers can be predetermined and stored in the device. By using the file parser corresponding to the system configuration file name to parse the corresponding version of the system configuration file and obtain the configuration parameter set for that version, the accuracy of the configuration parameter set is improved.

[0021] Optionally, the configuration parameter special table or version field marker in the database table can be identified to obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version.

[0022] Optionally, the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version can be detected through the version control system.

[0023] S102. Perform a difference analysis on the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results.

[0024] The target difference result represents the difference between the target configuration parameter set and the base configuration parameter set. For example, the target difference result includes target difference parameters and target change types for these parameters. Target difference parameters are the configuration parameters in the target configuration parameter set that differ from the base configuration parameter set. Target change types are the types of changes to the target difference parameters. For example, target change types include adding parameters, deleting parameters, and modifying parameters.

[0025] Specifically, the difference analysis algorithm is invoked to compare the target configuration parameter set with the baseline configuration parameter set field by field, identify the target difference parameters and the types of changes in the target difference parameters, and obtain the target difference results.

[0026] In an optional embodiment of the present invention, a difference analysis is performed on the target configuration parameter set and the baseline configuration parameter set to obtain a target difference result, including: calculating the target configuration hash value of each target configuration parameter attribute in the target configuration parameter set; calculating the baseline configuration hash value of each baseline configuration parameter attribute in the baseline configuration parameter set; comparing each target configuration hash value and each baseline configuration hash value; determining a first target difference parameter and a first target change type of the first target difference parameter based on the comparison results of each target configuration hash value and each baseline configuration hash value; and generating a first target difference result based on the first target difference parameter and the first target change type of the first target difference parameter.

[0027] The target configuration parameter attribute is the attribute information of the target configuration parameter. For example, the target configuration parameter attribute can be metadata of the target configuration parameter. The target configuration hash value is the hash value corresponding to the target configuration parameter attribute. The baseline configuration parameter attribute is the attribute information of the baseline configuration parameter. For example, the baseline configuration parameter attribute can be metadata of the baseline configuration parameter. The baseline configuration hash value is the hash value corresponding to the target configuration parameter attribute. The first target difference parameter is the configuration parameter where there is a difference between the target configuration hash value and the baseline configuration hash value. Optionally, the first target difference parameter may include the baseline configuration parameter and / or the target configuration parameter. The first target change type is the change type of the first target difference parameter. For example, the first target change type includes adding a parameter, deleting a parameter, and modifying a parameter. The first target difference result is the difference between the target configuration parameter and the baseline configuration parameter determined based on the target configuration hash value and the baseline configuration hash value.

[0028] Specifically, a hash algorithm is used to calculate the target configuration hash value for each target configuration parameter attribute in the target configuration parameter set. The same hash algorithm used to calculate the target configuration hash value is used to calculate the baseline configuration hash value for each baseline configuration parameter attribute in the baseline configuration parameter set. Each target configuration hash value and each baseline configuration hash value are compared one by one. If no baseline configuration hash value exists that matches the target configuration hash value, the target configuration parameter corresponding to the target configuration hash value is determined as the first target difference parameter, and the first target change type of the first target difference parameter is "added parameter". If no baseline configuration hash value exists that matches the baseline configuration hash value, the baseline configuration parameter corresponding to the baseline configuration hash value is determined as the first target difference parameter, and the first target change type of the first target difference parameter is "deleted parameter". If a baseline configuration hash value exists that matches the target configuration hash value, the target configuration parameter value corresponding to the target configuration hash value is compared with the baseline configuration parameter value corresponding to the baseline configuration hash value. When the target configuration parameter value and the baseline configuration parameter value are inconsistent, the target configuration parameter corresponding to the target configuration hash value and the baseline configuration parameter corresponding to the baseline configuration hash value are determined as the first target difference parameters, and the target change type of the first target difference parameter is "modified parameter".

[0029] This scheme introduces a comparison process between the target configuration hash value and the baseline configuration hash value, thereby determining the first target difference result and improving the efficiency of configuration parameter difference analysis.

[0030] In an optional embodiment of the present invention, a difference analysis is performed on the target configuration parameter set and the baseline configuration parameter set to obtain a target difference result, including: detecting the target key name of each target configuration parameter in the target configuration parameter set; detecting the baseline key name of each baseline configuration parameter in the baseline configuration parameter set; comparing each target key name and each baseline key name; determining a second target difference parameter and a second target change type of the second target difference parameter based on the comparison result of each target key name and each baseline key name; and generating a second target difference result based on the second target difference parameter and the second target change type of the second target difference parameter.

[0031] The target key name is the key name of the target configuration parameter. The base key name is the key name of the base configuration parameter. The second target difference parameter is the configuration parameter that differs from the target key name and the base key name. Optionally, the second target difference parameter may include the base configuration parameter and / or the target configuration parameter. The second target change type is the change type of the second target difference parameter. For example, the second target change type includes adding a parameter, deleting a parameter, and modifying a parameter. The second target difference result is the difference between the target configuration parameter and the base configuration parameter determined based on the target key name and the base key name.

[0032] Specifically, the system detects the target key names of each target configuration parameter in the target configuration parameter set. It also detects the base key names of each base configuration parameter in the base configuration parameter set. Each target key name and each base key name can be compared. If no base key value exists that matches the target key value, the target configuration parameter corresponding to the target key value is determined as the second target difference parameter, and the second target change type of the second target difference parameter is "added parameter". If no target key value exists that matches the base key value, the base configuration parameter corresponding to the base key value is determined as the second target difference parameter, and the second target change type of the second target difference parameter is "deleted parameter". If a base key value exists that matches the target key value, the target configuration parameter value corresponding to the target key value is compared with the base configuration parameter value corresponding to the base key value. When the target configuration parameter value and the base configuration parameter value are inconsistent, the target configuration parameter corresponding to the target key value and the base configuration parameter corresponding to the base key value are determined as the second target difference parameters, and the target change type of the second target difference parameter is "modified parameter".

[0033] This approach introduces a comparison process between the target key name and the baseline key name, thereby determining the second target difference result and improving the efficiency of configuration parameter difference analysis.

[0034] S103. Based on the target difference results, query the corresponding reference check item in the check rule base.

[0035] The rule base is used to match reference check items corresponding to target difference results. It can be understood that the rule base pre-stores at least one rule. Each rule includes a single check item and the correspondence between the difference result and the check item. Optionally, users can extend the rule base according to business needs, i.e., add or modify rules.

[0036] Reference check items are used to characterize the content that needs to be checked based on the target difference results. Optionally, reference check items include the check items that need to be performed on the system and the specific execution steps of the check items. For example, check items may include environment check items and runtime check items. Among them, environment check items are static check items of the system, such as parameter correctness verification. Runtime check items are dynamic check items of the system, such as database connectivity verification, firewall connectivity verification, query statement execution verification, and access permission verification.

[0037] Specifically, based on the target difference results, the corresponding check items are queried in the check rule base to obtain the reference check items.

[0038] S104. Generate target checkpoint information based on the target difference results and reference check items.

[0039] The target checkpoint information refers to the specific content that needs to be checked in the system. For example, target checkpoint information includes target difference parameters, reference check items, and the target execution location of the reference check items.

[0040] Specifically, based on the target difference results, target difference parameters are determined. Based on the target difference parameter attributes and reference check items, the target execution location of the reference check items is determined. Based on the target difference parameters, reference check items, and the target execution location of the reference check items, target checkpoint information is generated.

[0041] S105. Merge the target difference results and target checkpoint information to generate a target deployment document.

[0042] During system deployment, deployment documentation is a standardized document that details the steps involved in migrating, installing, configuring, and running the system from the development environment to the production environment. As an "operation manual" for the deployment process, deployment documentation ensures that the system can be deployed stably, efficiently, and repeatedly to the target environment, while reducing the risk of human error and improving team collaboration efficiency. Target deployment documentation describes the deployment document corresponding to the change from the base version to the target version during system deployment. Target deployment documentation not only includes information on configuration parameter changes but also the steps for checking these changes. Therefore, target deployment documentation serves as an executable document during system deployment.

[0043] Specifically, the target difference results and target checkpoint information can be directly merged to generate a target deployment document.

[0044] In an optional embodiment of the present invention, the target difference results and target checkpoint information are merged to generate a target deployment document, including: obtaining a deployment document template; extracting information from the target difference results and target checkpoint information according to the target placeholders in the deployment document template to obtain target data corresponding to the target placeholders; inserting the target data into the position corresponding to the target placeholders in the deployment document to generate a target deployment document.

[0045] Deployment document templates are used to assist in generating standardized deployment documents. For example, a deployment document template may include structured content such as parameter change tables, checkpoint description documents, and checklists. The parameter change table records parameter changes between the target version and the baseline version, i.e., the target difference results. The checkpoint description document contains target checkpoint information generated based on the target difference results. The checklist records the specific checks to be performed. For example, the checklist includes an environment checklist and a runtime checklist. The environment checklist performs static checks, i.e., checks the correctness of parameters. The runtime checklist performs dynamic checks, i.e., checks that depend on system operation. Target placeholders identify the locations and attributes of data to be inserted in the deployment document template. A deployment document template may include multiple target placeholders. Different target placeholders correspond to different data types to be inserted. Target data is the data content to be inserted at the location corresponding to the target placeholder.

[0046] Specifically, the process involves: obtaining a pre-generated deployment document template; identifying target placeholders within the template; extracting target data corresponding to these placeholders from the target difference results and target checkpoint information; and inserting the target data into the positions corresponding to the target placeholders in the deployment document to generate the target deployment document.

[0047] This solution introduces target placeholders in the deployment document template, performs data filtering and document merging on target difference results and target checkpoint information, and generates target deployment documents, thereby improving the efficiency, standardization, and consistency of deployment document generation.

[0048] The technical solution of this invention introduces an inspection rule base, determines reference inspection items based on target difference results, generates target checkpoint information based on the target difference results and reference inspection items, and then generates target deployment documents based on the target difference results and target checkpoint information. This reduces manual intervention, automates the generation of deployment documents, and improves the efficiency of deployment document generation. Moreover, by introducing an inspection rule base, omissions and misjudgments of checkpoints are avoided, improving the completeness and accuracy of deployment documents. In addition, the inspection rule base is reusable, avoiding repetitive work in the process of generating new deployment documents.

[0049] Example 2 Figure 2This is a flowchart of a deployment document generation method provided in Embodiment 2 of the present invention. Based on the above embodiments, this embodiment of the present invention specifies "generating target checkpoint information based on target difference results and reference check items" as "obtaining a system configuration file, and querying target check items based on the target difference parameter attributes, reference check items, and the system configuration file contained in the target difference results; generating target checkpoint information based on the target difference parameter attributes, target difference parameter values, target difference change types, and target check items." The introduction of a system configuration file improves the efficiency of target check item filtering, thereby improving the efficiency of determining target checkpoint information. It should be noted that parts not detailed in this embodiment of the present invention can be found in the descriptions of other embodiments.

[0050] See Figure 2 The deployment document generation method shown includes: S201. Obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version.

[0051] S202. Perform a difference analysis between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results.

[0052] S203. Based on the target difference results, query the corresponding reference check item in the check rule base.

[0053] In an optional embodiment of the present invention, querying the corresponding reference check item in the check rule base according to the target difference result includes: querying the corresponding reference check item in the check rule base according to the target difference parameter attribute, target difference parameter value and / or target difference parameter length of the target difference parameter in the target difference result.

[0054] The target difference parameter attribute contains attribute information about the target difference parameter. It characterizes the parameter type of the target difference parameter. For example, the target difference parameter attribute can be metadata about the target difference parameter. The target difference parameter value is the specific numerical value corresponding to the target difference parameter. The target difference parameter length is the data length of the target difference parameter.

[0055] Optionally, based on the target difference parameter attribute in the target difference result, the reference check item corresponding to the target difference parameter attribute can be queried in the check rule base.

[0056] For example, the target difference parameter attribute can be "database"; correspondingly, the check item corresponding to "database" can be queried in the check rule base, such as database connection check (or database connectivity verification).

[0057] For example, the target difference parameter attribute can be "Application Programming Interface"; correspondingly, the check item corresponding to "Application Programming Interface" can be queried in the check rule base, such as application programming interface access permission check.

[0058] Optionally, the target difference parameter value in the target difference result is compared with a preset parameter value range to obtain the target parameter value comparison result. The reference check item corresponding to the target parameter value comparison result is then queried from the check rule base. The preset parameter value range is a pre-defined normal value range for the target difference parameter. The target parameter value comparison result is the comparison between the target difference parameter value and the preset parameter value range.

[0059] For example, the target difference parameter is the port number; the target difference parameter value is 88888; the preset parameter value range is no more than 65535; accordingly, the port number "88888" is compared with the preset parameter value range "no more than 65535", and the target parameter value comparison result is obtained, namely "the port number exceeds the preset parameter value range". The check item corresponding to "the port number exceeds the preset parameter value range" is then queried in the check rule base, i.e., the port range check.

[0060] For example, the target difference parameter value is 0; the preset parameter value range is greater than or equal to 0; accordingly, the target difference parameter value "0" is compared with the preset parameter value range "greater than or equal to 0" to obtain the target parameter value comparison result, namely "target difference parameter value is less than 0". The check item corresponding to "target difference parameter value is less than 0" is then queried in the check rule base, i.e., parameter value negative value check.

[0061] Optionally, the target difference parameter length in the target difference result is compared with a preset parameter length range to obtain a target difference length comparison result. The reference check item corresponding to the target difference length comparison result is then queried from the check rule base. The preset parameter length range is a pre-defined normal range for the data length of the target difference parameter. The target difference length comparison result is the comparison between the target difference parameter length and the preset parameter length range.

[0062] For example, the target difference parameter length is 2000; the preset parameter length range is less than or equal to 1000; accordingly, the target difference parameter length "2000" is compared with the preset parameter length range "less than or equal to 1000", and the target difference length comparison result is obtained, namely "target difference parameter length exceeds 1000". The reference check item corresponding to "target difference parameter length exceeds 1000" is then queried in the check rule base, i.e., parameter length too long check.

[0063] Optionally, based on the target difference parameter attribute in the target difference result, the reference check item corresponding to the target difference parameter attribute is queried in the check rule base. The target difference parameter value in the target difference result is compared with a preset parameter value range to obtain the target parameter value comparison result. The reference check item corresponding to the target parameter value comparison result is queried in the check rule base. The target difference parameter length in the target difference result is compared with a preset parameter length range to obtain the target difference length comparison result. The reference check item corresponding to the target difference length comparison result is queried in the check rule base.

[0064] This solution improves the typicality of reference check items by querying the corresponding reference check items in the check rule base based on the target difference parameter attributes, target difference parameter values, and / or target difference parameter lengths, thereby improving the screening efficiency of reference check items.

[0065] S204. Obtain the system configuration file, and query the target check items based on the target difference parameter attributes, reference check items, and system configuration file contained in the target difference results.

[0066] System configuration files are text files used to define and control the behavior of system software, hardware, and services. Target checkpoints are the specific things that need to be checked in the system. In contrast, reference checkpoints are the things that need to be checked, such as database connectivity verification. Target checkpoint information includes not only reference checkpoints but also the specific execution location of the reference checkpoints; for example, which configuration parameter in the system should be used to perform database connectivity verification in which database.

[0067] Specifically, the system is queried to obtain the system configuration file. Based on the target difference parameter attributes and reference check items contained in the target difference results, the specific execution location of the reference check items is queried in the system configuration file to determine the target check items.

[0068] S205. Generate target checkpoint information based on target difference parameter attributes, target difference parameter values, target difference change types, and target check items.

[0069] Specifically, the target difference parameter attributes, target difference parameter values, target difference change types, and target check items are integrated to generate target checkpoint information.

[0070] For example, target difference parameter attributes, target difference parameter values, target difference change types, and target check items can be structurally integrated to generate target checkpoint information. S206. Merge the target difference results and target checkpoint information to generate a target deployment document.

[0071] The technical solution of this invention determines target inspection items based on target difference parameter attributes, reference inspection items, and system configuration files. Then, it generates target inspection point information based on target difference parameter attributes, target difference parameter values, target difference change types, and target inspection items. The introduction of system configuration files improves the efficiency of target inspection item filtering, thereby improving the efficiency of target inspection point information determination.

[0072] Based on the above embodiments, the present invention also provides a preferred embodiment of the deployment document generation device. See also Figure 3 The deployment document generation device shown includes: a data acquisition module, a difference analysis module, a rule base matching module, a checkpoint generation module, a document generation module, and a user interaction module.

[0073] The system comprises several modules: a data acquisition module for obtaining raw data such as configuration parameter sets and network policy sets for the baseline and target versions; a difference analysis module for comparing the two sets of data to obtain target difference results for additions, modifications, and deletions; a rule base matching module for storing mapping rules between parameter changes (i.e., difference results) and checkpoints (i.e., check items); a checkpoint generation module for automatically generating target checkpoint information based on target difference results and reference check items, including runtime checkpoints or environment checkpoints; a document generation module for integrating target difference results and target checkpoint information and outputting the target deployment document according to a deployment document template; and a user interaction module for receiving user rule configurations, template configurations, and output requests, and providing the final target deployment document to the user. The user interaction module is the only part of the system open to users. Rule configuration is used to maintain the rules in the rule base matching module. Since the system ultimately generates a standardized "deployment document," template configuration is used to maintain specific deployment document templates. Output requests are used to initiate requests to generate the "deployment document," which can be considered a trigger operation. This device can be deployed in a server environment or run as a standalone tool.

[0074] The present invention also provides a preferred embodiment of a deployment document generation method. This deployment document generation method includes: S301, Data Acquisition Phase: Receive the configuration parameter set of the target version and the baseline version.

[0075] The set of configuration parameters comes from system configuration files, database tables, or version control systems.

[0076] Specifically, during the data acquisition phase, the program control processor loads the parameter file, i.e., the system configuration file, from the storage medium. It then selects the corresponding target file parser based on the system configuration file name extension. The target file parser parses the system configuration file to obtain standardized structured data, i.e., the set of configuration parameters for the target version and the baseline version.

[0077] S302 The difference analysis module compares the two sets of configuration parameters and identifies the target difference results.

[0078] The target difference results include the target difference parameters and the target change types of these parameters. The target change types include added parameters, modified parameters, and deleted parameters. For example, when the target version adds a cache configuration parameter or adjusts the database connection pool size from 100 to 200, the difference analysis module will record this change as a target difference result.

[0079] Optionally, a difference analysis algorithm is invoked to compare the configured parameter set field by field to obtain the target difference result. For example, the difference analysis algorithm may include abstract syntax trees, hash mapping, or key-value mapping, etc.

[0080] For example, first, a configuration hash value is calculated for each configuration parameter attribute (such as database address and port number) in both the target and base versions. The configuration hash value acts as an identifier for the configuration parameter attribute. Next, each target configuration hash value is compared with each base configuration hash value. If a target configuration hash value exists in the target version but not in the base version, then the target configuration parameter is a newly added target difference parameter. If a base configuration hash value exists in the base version but not in the target version, then the base configuration parameter is a deleted target difference parameter. If a target configuration hash value exists in both versions, but the corresponding configuration parameter value differs between the two versions, then both the target and base configuration parameters are modified target difference parameters. This allows for quick and accurate identification of all changes, i.e., rapid identification of target difference parameters.

[0081] For example, retrieve all target key names and base key names for the target and base versions. If a target key name exists in the target version but not in the base version, it indicates that the target configuration parameter is a newly added target difference parameter. If a base key name exists in the base version but not in the target version, it indicates that the base configuration parameter is a deleted target difference parameter. If a target key name and a base key name share a common key name (i.e., both exist in both versions, but the corresponding configuration parameter values ​​differ), it indicates that the target configuration parameter and the base configuration parameter are modified target difference parameters. Collect these results to obtain the target difference results, i.e., added parameters, deleted parameters, and modified parameters.

[0082] Optionally, target difference results can be output. These results can be a detailed change report, organizing all changes into a clear list. For example, the target difference results might include which configuration items were added, which were modified, and which were deleted. Each change is recorded with specific details, such as the original value and the new value. This allows subsequent processing steps to perform corresponding operations based on the target difference results, such as triggering specific reference checks in the rule base or generating the corresponding target deployment document. The target difference results transform the raw configuration changes into structured information, making it easier for other parts to use.

[0083] S303. Input the target difference results into the rule base matching module, and the rule base matching module outputs reference check items.

[0084] The rule base includes multiple predefined rules. For example, when the database connection configuration changes, a "database connectivity verification" rule and its specific execution steps are generated; when a new network port is added, a "port accessibility verification" rule and its specific execution steps are generated; and when runtime parameters are adjusted, a "correctness verification" rule and its specific execution steps are generated. The rule base supports extension, allowing users to add or modify rules according to their business needs.

[0085] Specifically, the system invokes the inspection rule base, takes the target difference result as input, executes the matching logic, and outputs reference inspection items. The matching logic can be considered an intelligent judgment system, that is, the correspondence between the target difference result and the reference inspection items, which determines which reference inspection items need to be executed based on the various target difference parameter attributes in the target difference result.

[0086] For example, if it is found that the target difference parameter attribute of a target difference parameter is a database, a database connection check will be automatically added.

[0087] For example, if it is found that the target difference parameter attribute of a target difference parameter is an application interface, an application interface access permission check will be automatically added.

[0088] For example, if the value of a target difference parameter is found to be outside the safe range, such as the port number exceeding 65535, a port range check will be automatically added; if the target difference parameter value is less than 0, a negative value check will be automatically added.

[0089] For example, if it is found that the length of a target difference parameter exceeds the safe range, such as the length of the target difference parameter exceeding 1000, then a parameter length too long check will be automatically added.

[0090] S304. The checkpoint generation module converts the reference check item output into structured target checkpoint information.

[0091] Each system upgrade and deployment involves modifying, adding, or deleting configuration parameters. Therefore, it's necessary to verify these changes. Manual verification is time-consuming and labor-intensive, so checking the target difference results is essential. Target checkpoint information is a file used to check the correctness of target difference parameters. For example, target difference parameters can be a spreadsheet or a lightweight data exchange format. Optionally, the checkpoint file (i.e., target checkpoint information) can be imported into a specified verification platform for final verification. Therefore, target checkpoint information can be considered a file verifying the correctness of configuration parameters, and can also be called a verification point. Target checkpoint information contains all the specific checks that need to be performed. Each target checkpoint typically includes a target checkpoint number, target checkpoint type (e.g., running checkpoint or environment checkpoint), target checkpoint description (e.g., which database connection availability is being verified), target difference parameter name (e.g., the specific configuration item to be checked), target difference parameter value, reference check item (e.g., database connection test), and target difference type.

[0092] For example, Table 1 contains target checkpoint information in tabular form. S305. The document generation module merges the target difference results with the target checkpoint information based on the deployment document template to generate a standardized deployment document, namely the target deployment document.

[0093] The deployment document template typically includes structured content such as parameter change tables, checkpoint description documents, and environment checklists (or runtime checklists). The final target deployment document not only records parameter change information (i.e., target difference results) but also includes corresponding check steps (i.e., target checkpoint information), thus forming a standardized and executable deployment reference.

[0094] The parameter change table records which parameters were modified during this deployment. The checkpoint description document is a checkpoint file generated for the aforementioned changed parameters. The environment checklist is used for static checks, specifically checking the correctness of parameters. The environment checklist performs static checks, verifying whether the changed parameters were implemented correctly. The runtime checklist performs dynamic checks, i.e., checks performed while the system is running. Examples include checking database connectivity, server firewall connectivity, and verifying the correctness of database query results.

[0095] Specifically, the deployment document template is read. The target difference results and target checkpoint information are traversed and inserted into the corresponding target placeholders in the deployment document template. The output is then rendered as the target deployment document.

[0096] Optionally, the target difference results and corresponding target checkpoint information can be accessed in the order they were generated. Optionally, the priority of target check items can be determined based on their target check type, i.e., the target check order, processing important target check items first. Optionally, target check items can be grouped based on their target check type, allowing for grouped processing to improve efficiency. Optionally, multiple independent target check items can be processed in parallel.

[0097] For example, the deployment document template contains many target placeholders, which need to be filled with specific content, i.e., target data. First, locate the target placeholder in the deployment document template. Then, find the corresponding target difference parameter value in the target difference results, i.e., the target data. Finally, fill in the target data into the corresponding position of the target placeholder. For instance, if the deployment document template states that the database server address is xxxx: / / xxxxxx, the actual server address, i.e., xxxx: / / xxxxxx, will be filled into the corresponding target placeholder for the database server address.

[0098] S306 The user interaction module receives the final target deployment document and supports downloading, previewing, or pushing it to the internal deployment system.

[0099] Specifically, this device will save the generated target deployment document to the disk and notify the user interaction module. Users can download or preview the target deployment document through the visual user interface.

[0100] The purpose of this invention is to address the problems of low efficiency, easy omissions, and lack of standardization in existing deployment documentation. It provides an automated deployment documentation generation method and apparatus based on difference analysis and a rule-driven generation mechanism. Through automated data comparison and rule-driven generation, it reduces manual operations and improves the completeness and accuracy of deployment documentation. Specifically, the difference analysis module automatically identifies configuration parameter differences between different versions. Based on the rule-driven generation mechanism, the target difference results are transformed into reference check items, i.e., runtime checkpoints or environment checkpoints. Finally, the document generation module integrates the target difference results with the target checkpoint information, outputting a structured target deployment document. Heterogeneous analysis and rule-driven approaches enable automated generation of deployment documents, reducing manual intervention. A rule base mechanism ensures that checkpoints for common scenarios are not overlooked, reducing error rates and improving the accuracy and completeness of deployment documents. Deployment document templates are introduced to generate target deployment documents, ensuring consistent formatting and complete content, thus improving standardization. Furthermore, the rule base can be expanded to meet the needs of different systems or enterprises, adapting to various application scenarios and enhancing its scalability. Finally, the rule base and deployment document templates form a knowledge base, avoiding repetitive work, reducing reliance on manual intervention, and improving knowledge reusability during deployment document generation.

[0101] Example 3 Figure 4 This is a schematic diagram of a deployment document generation device provided in Embodiment 3 of the present invention. This embodiment of the invention is applicable to situations where deployment documents are automatically generated during system launch or deployment. The device can execute a deployment document generation method and can be implemented in hardware and / or software. The device can be configured in an electronic device that carries the deployment document generation function, such as a client or server.

[0102] See Figure 4 The deployment document generation device shown includes: a data acquisition module 401, a difference analysis module 402, a rule base matching module 403, a checkpoint generation module 404, and a document generation module 405. Specifically, the data acquisition module 401 acquires the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version; the difference analysis module 402 performs difference analysis on the target configuration parameter set and the baseline configuration parameter set to obtain target difference results; the rule base matching module 403 queries the checkpoint rule base for corresponding reference check items based on the target difference results; the checkpoint generation module 404 generates target checkpoint information based on the target difference results and the reference check items; and the document generation module 405 merges the target difference results and the target checkpoint information to generate a target deployment document.

[0103] The technical solution of this invention introduces an inspection rule base, determines reference inspection items based on target difference results, generates target checkpoint information based on the target difference results and reference inspection items, and then generates target deployment documents based on the target difference results and target checkpoint information. This reduces manual intervention, automates the generation of deployment documents, and improves the efficiency of deployment document generation. Moreover, by introducing an inspection rule base, omissions and misjudgments of checkpoints are avoided, improving the completeness and accuracy of deployment documents. In addition, the inspection rule base is reusable, avoiding repetitive work in the process of generating new deployment documents.

[0104] In an optional embodiment of the present invention, the rule base matching module 403 includes: a reference check item query unit, used to query the corresponding reference check item in the check rule base according to the target difference parameter attribute, target difference parameter value and / or target difference parameter length of the target difference parameter in the target difference result.

[0105] In an optional embodiment of the present invention, the checkpoint generation module 404 includes: a target check item query unit, configured to obtain a system configuration file and query a target check item based on the target difference parameter attribute of the target difference parameter included in the target difference result, the reference check item, and the system configuration file; and a target checkpoint information generation unit, configured to generate target checkpoint information based on the target difference parameter attribute, the target difference parameter value, the target difference change type, and the target check item.

[0106] In an optional embodiment of the present invention, the target checkpoint information generation unit includes: a unit checkpoint information generation subunit, configured to generate unit checkpoint information for a single target check item based on the target difference parameter attribute, the target difference parameter value, the target difference change type, and the target check item; a target check order determination subunit, configured to determine the target check order of each target check item based on the target check type of each target check item; and a target checkpoint information generation subunit, configured to generate target checkpoint information based on the target check order and the unit checkpoint information.

[0107] In an optional embodiment of the present invention, the document generation module 405 includes: a deployment document template acquisition unit, used to acquire a deployment document template; a target data extraction unit, used to extract information from the target difference results and the target checkpoint information according to the target placeholder in the deployment document template, to obtain target data corresponding to the target placeholder; and a target deployment document generation unit, used to insert the target data into the position corresponding to the target placeholder in the deployment document to generate a target deployment document.

[0108] In an optional embodiment of the present invention, the difference analysis module 402 includes: a target configuration hash value calculation unit, configured to calculate the target configuration hash value of each target configuration parameter attribute in the target configuration parameter set; a baseline configuration hash value calculation unit, configured to calculate the baseline configuration hash value of each baseline configuration parameter attribute in the baseline configuration parameter set; a configuration hash value comparison unit, configured to compare each target configuration hash value and each baseline configuration hash value; a first target difference parameter determination unit, configured to determine a first target difference parameter and a first target change type of the first target difference parameter based on the comparison results of each target configuration hash value and each baseline configuration hash value; and a first target difference result generation unit, configured to generate a first target difference result based on the first target difference parameter and the first target change type of the first target difference parameter.

[0109] In an optional embodiment of the present invention, the difference analysis module 402 includes: a target key name detection unit, configured to detect the target key name of each target configuration parameter in the target configuration parameter set; a baseline key name detection unit, configured to detect the baseline key name of each baseline configuration parameter in the baseline configuration parameter set; a key name comparison unit, configured to compare each target key name with each baseline key name; a second target difference parameter determination unit, configured to determine a second target difference parameter and a second target change type of the second target difference parameter based on the comparison results of each target key name and each baseline key name; and a second target difference result generation unit, configured to generate a second target difference result based on the second target difference parameter and the second target change type of the second target difference parameter.

[0110] The deployment document generation apparatus provided in this embodiment of the invention can execute the deployment document generation method provided in any embodiment of the invention, and has the corresponding functional modules and beneficial effects of the execution method.

[0111] In the technical solutions of this invention, the information collected is information and data authorized by the user or fully authorized by all parties. The collection, storage, use, processing, transmission, provision, disclosure and application of the relevant data all comply with the relevant laws, regulations and standards of the relevant countries and regions, take necessary confidentiality measures, do not violate public order and good morals, and provide corresponding operation entry points for users to choose to authorize or refuse.

[0112] Example 4 According to embodiments of the present invention, the present invention also provides an electronic device, a readable storage medium, and a computer program product.

[0113] Figure 5A schematic diagram of an electronic device 500 that can be used to implement embodiments of the present invention is shown. The electronic device is intended to represent various forms of digital computers, such as laptop computers, desktop computers, workstations, personal digital assistants, servers, blade servers, mainframe computers, and other suitable computers. The electronic device can also represent various forms of mobile devices, such as personal digital processors, cellular phones, smartphones, wearable devices (e.g., helmets, glasses, watches, etc.), and other similar computing devices. The components shown herein, their connections and relationships, and their functions are merely illustrative and are not intended to limit the implementation of the invention described and / or claimed herein.

[0114] like Figure 5 As shown, the electronic device 500 includes at least one processor 501 and a memory, such as a read-only memory 502 or a random access memory 503, communicatively connected to the at least one processor 501. The memory stores computer programs executable by the at least one processor. The processor 501 can perform various appropriate actions and processes based on the computer program stored in the read-only memory 502 or loaded from storage unit 508 into the random access memory 503. The random access memory 503 can also store various programs and data required for the operation of the electronic device 500. The processor 501, read-only memory 502, and random access memory 503 are interconnected via a bus 504. An input / output interface 505 is also connected to the bus 504.

[0115] Multiple components in electronic device 500 are connected to input / output interface 505, including: input unit 506, such as keyboard, mouse, etc.; output unit 507, such as various types of monitors, speakers, etc.; storage unit 508, such as disk, optical disk, etc.; and communication unit 509, such as network card, modem, wireless transceiver, etc. Communication unit 509 allows electronic device 500 to exchange information / data with other devices through computer networks such as the Internet and / or various telecommunications networks.

[0116] Processor 501 can be a variety of general-purpose and / or special-purpose processing components with processing and computing capabilities. Some examples of processor 501 include, but are not limited to, central processing units, graphics processing units, various special-purpose artificial intelligence computing chips, various processors running machine learning model algorithms, digital signal processors, and any suitable processor, controller, microcontroller, etc. Processor 501 performs the various methods and processes described above, such as deploying document generation methods.

[0117] In some embodiments, the deployment document generation method may be implemented as a computer program tangibly contained in a computer-readable storage medium, such as storage unit 508. In some embodiments, part or all of the computer program may be loaded and / or installed on electronic device 500 via read-only memory 502 and / or communication unit 509. When the computer program is loaded into random access memory 503 and executed by processor 501, one or more steps of the deployment document generation method described above may be performed. Alternatively, in other embodiments, processor 501 may be configured to perform the deployment document generation method by any other suitable means (e.g., by means of firmware).

[0118] Various embodiments of the systems and techniques described above herein can be implemented in digital electronic circuit systems, integrated circuit systems, field-programmable gate arrays, application-specific integrated circuits (ASICs), application-specific standard products (ASICs), systems-on-a-chip (SoCs), complex programmable logic devices, computer hardware, firmware, software, and / or combinations thereof. These various embodiments may include implementations in one or more computer programs that can be executed and / or interpreted on a programmable system including at least one programmable processor, which may be a dedicated or general-purpose programmable processor, capable of receiving data and instructions from a storage system, at least one input device, and at least one output device, and transmitting data and instructions to the storage system, the at least one input device, and the at least one output device.

[0119] Computer programs used to implement the methods of the present invention may be written in any combination of one or more programming languages. These computer programs may be provided to a processor of a general-purpose computer, a special-purpose computer, or other programmable data processing device, such that when executed by the processor, the computer programs cause the functions / operations specified in the flowcharts and / or block diagrams to be performed. The computer programs may be executed entirely on a machine, partially on a machine, or as a standalone software package, partially on a machine and partially on a remote machine, or entirely on a remote machine or server.

[0120] In the context of this invention, a computer-readable storage medium can be a tangible medium that may contain or store a computer program for use by or in conjunction with an instruction execution system, apparatus, or device. A computer-readable storage medium may include, but is not limited to, electronic, magnetic, optical, electromagnetic, infrared, or semiconductor systems, apparatus, or devices, or any suitable combination thereof. Alternatively, a computer-readable storage medium may be a machine-readable signal medium. More specific examples of machine-readable storage media include electrical connections based on one or more wires, portable computer disks, hard disks, random access memory, read-only memory, erasable programmable read-only memory, optical fibers, portable compact disk read-only memory, optical storage devices, magnetic storage devices, or any suitable combination thereof.

[0121] To provide interaction with a user, the systems and techniques described herein can be implemented on an electronic device having: a display device (e.g., a cathode ray tube or liquid crystal display monitor) for displaying information to the user; and a keyboard and pointing device (e.g., a mouse or trackball) through which the user provides input to the electronic device. Other types of devices can also be used to provide interaction with the user; for example, feedback provided to the user can be any form of sensory feedback (e.g., visual feedback, auditory feedback, or tactile feedback); and input from the user can be received in any form (including sound input, voice input, or tactile input).

[0122] The systems and technologies described herein can be implemented in computing systems that include backend components (e.g., as data servers), or computing systems that include middleware components (e.g., application servers), or computing systems that include frontend components (e.g., user computers with graphical user interfaces or web browsers through which users can interact with implementations of the systems and technologies described herein), or any combination of such backend, middleware, or frontend components. The components of the system can be interconnected via digital data communication of any form or medium (e.g., communication networks). Examples of communication networks include local area networks (LANs), wide area networks (WANs), blockchain networks, and the Internet.

[0123] A computing system can include clients and servers. Clients and servers are generally located far apart and typically interact through communication networks. The client-server relationship is created by computer programs running on the respective computers and having a client-server relationship with each other. The server can be a cloud server, also known as a cloud computing server or cloud host, which is a host product within the cloud computing service system. This addresses the shortcomings of traditional physical hosts and virtual private servers, such as high management difficulty and weak business scalability.

[0124] It should be understood that the various forms of processes shown above can be used, with steps reordered, added, or deleted. For example, the steps described in this invention can be executed in parallel, sequentially, or in different orders, as long as the desired result of the technical solution of this invention can be achieved, and this is not limited herein.

[0125] The specific embodiments described above do not constitute a limitation on the scope of protection of this invention. Those skilled in the art should understand that various modifications, combinations, sub-combinations, and substitutions can be made according to design requirements and other factors. Any modifications, equivalent substitutions, and improvements made within the spirit and principles of this invention should be included within the scope of protection of this invention.

Claims

1. A method for generating deployment documents, characterized in that, The method includes: Obtain the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version; A difference analysis is performed between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results; Based on the target difference results, query the corresponding reference check items in the check rule base; Based on the target difference results and the reference check items, target checkpoint information is generated; The target difference results and the target checkpoint information are merged to generate a target deployment document.

2. The method according to claim 1, characterized in that, The step of querying the corresponding reference inspection item in the inspection rule base based on the target difference result includes: Based on the target difference parameter attributes, target difference parameter values, and / or target difference parameter lengths in the target difference results, the corresponding reference check items are queried in the check rule base.

3. The method according to claim 1, characterized in that, The step of generating target checkpoint information based on the target difference result and the reference check item includes: Obtain the system configuration file, and query the target check item based on the target difference parameter attributes of the target difference parameters contained in the target difference result, the reference check item, and the system configuration file; Target checkpoint information is generated based on the target difference parameter attributes, target difference parameter values, target difference change types, and target check items.

4. The method according to claim 3, characterized in that, The step of generating target checkpoint information based on the target difference parameter attributes, target difference parameter values, target difference change types, and target check items includes: For each target inspection item, unit inspection point information is generated based on the target difference parameter attribute, target difference parameter value, target difference change type, and the target inspection item. The target inspection order of each target inspection item is determined based on its target inspection type. Target checkpoint information is generated based on the target inspection sequence and the checkpoint information of each unit.

5. The method according to claim 1, characterized in that, The step of merging the target difference results and the target checkpoint information to generate a target deployment document includes: Get the deployment document template; Based on the target placeholders in the deployment document template, information is extracted from the target difference results and the target checkpoint information to obtain the target data corresponding to the target placeholders; The target data is inserted into the position corresponding to the target placeholder in the deployment document to generate the target deployment document.

6. The method according to claim 1, characterized in that, The step of performing a difference analysis between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results includes: Calculate the target configuration hash value for each target configuration parameter attribute in the target configuration parameter set; Calculate the baseline configuration hash value for each baseline configuration parameter attribute in the baseline configuration parameter set; The target configuration hash value and the baseline configuration hash value are compared. Based on the comparison results of each target configuration hash value and each baseline configuration hash value, a first target difference parameter and a first target change type of the first target difference parameter are determined. A first target difference result is generated based on the first target difference parameter and the first target change type of the first target difference parameter.

7. The method according to claim 1, characterized in that, The step of performing a difference analysis between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference results includes: Detect the target key name of each target configuration parameter in the target configuration parameter set; Detect the base key name of each base configuration parameter in the base configuration parameter set; Compare each of the target key names and each of the base key names; Based on the comparison results of each target key name and each reference key name, determine the second target difference parameter and the second target change type of the second target difference parameter; The second target difference result is generated based on the second target difference parameter and the second target change type of the second target difference parameter.

8. A deployment document generation device, characterized in that, The device includes: The data acquisition module is used to acquire the target configuration parameter set for the target version and the baseline configuration parameter set for the baseline version; The difference analysis module is used to perform difference analysis between the target configuration parameter set and the baseline configuration parameter set to obtain the target difference result. The rule base matching module is used to query the corresponding reference inspection item in the inspection rule base based on the target difference result; The checkpoint generation module is used to generate target checkpoint information based on the target difference results and the reference check items; The document generation module is used to merge the target difference results and the target checkpoint information to generate a target deployment document.

9. An electronic device, characterized in that, The electronic device includes: At least one processor; and A memory communicatively connected to the at least one processor; wherein, The memory stores a computer program that can be executed by the at least one processor, the computer program being executed by the at least one processor to enable the at least one processor to perform the deployment document generation method according to any one of claims 1-7.

10. A computer program product, characterized in that, The computer program product includes a computer program that, when executed by a processor, implements the deployment document generation method according to any one of claims 1-7.

Images