Skip to content

Files

Latest commit

May 8, 2024
f40af88 · May 8, 2024

History

History
67 lines (47 loc) · 18.4 KB

README.en.md

File metadata and controls

67 lines (47 loc) · 18.4 KB

中文 / English


About

Neatlogic deploy is a publishing module that can solve the scenario of one click publishing in application environments, mainly including application configuration, version center, one click publishing, and other functions.

Feature

Application Configuration

Application configuration mainly manages the configuration of pipeline scripts and parameters for application, module layer, and environment layer. img.png img.png

  • Support configuration application continuous integration.
  • Support the configuration of application super pipelines, and only the current application can be selected in the template.
  • Support for configuring notification policies.
  • Support managing user scope through authorization.
  • Support for editing application, module, and environmental information

Version Center

The version center is used to manage the versions and engineering materials of application modules. The compiled version of the engineering physics library supports uploading and downloading. img.png img.png

One-click publishing

One-click publishing page supports launching single publishing jobs and launching batch jobs.

  1. Initiate a single publish job
    Select the application and module that initiated the job (with a configured assembly line and environment), and then click the Add Job button to complete the configuration of initiating and publishing the job and save it. img.png img.png
  2. Batch Publish Job
    Batch publishing jobs can be created directly or initiated through a super assembly line. Direct creation refers to adding existing jobs to a collection, and the super pipeline method is initiated through templates. img.png img.png img.png

Superpipeline

The Superpipeline manages global batch publishing job templates, and supports the initiation of batch jobs and scheduled jobs. img.png img.png

Scheduled job

Scheduled job are initiated and published by configuring a fixed job timer, which supports two types of jobs: regular jobs and super pipeline jobs. img.png

Webhook

The webhook page is used to manage job triggers, including configuring trigger ranges and trigger actions. The trigger range is the trigger point, and the object of the trigger range is the job state associated with the application module's environment. The trigger action is an integrated configuration associated with the "Publish Trigger Data Specification" type. img.png

All Features

NumberCategoryFunction PointDescription
1ParametersGlobal ParametersSupports basic management of adding, deleting, modifying, and querying global parameters for automated jobs.
2Supports global parameter fields such as text, password, date, and text area.
3Predefined ParametersSupports basic management of adding, deleting, modifying, and querying predefined parameters for automated jobs.
4Supports predefined parameter sets based on tool libraries and atomic operations.
5Supports referencing global parameters in predefined parameter sets.
6CategoriesTool CategoriesSupports basic management of adding, deleting, modifying, and querying tool categories.
7Supports viewing the statistics of tool libraries, custom atomic operations, and associated orchestrations under a category.
8Supports setting tool library permissions based on types.
9Tool DirectorySupports basic management of adding, deleting, modifying, and querying tool directories.
10Supports setting permissions for tool libraries based on directories.
11ScenesOrchestration ScenesSupports basic management of adding, deleting, modifying, and querying automation scenes.
12Supports defining automation scene categories based on types, scenes, and job positions.
13Supports setting different usage scenes within a combination orchestration, where each scene represents a different execution phase in the orchestration. Scenes can meet the requirements of multiple usage scenarios in one orchestration.
14Tool LibraryBuilt-in Tool LibrariesIn addition to commonly used basic tool libraries, it also includes file operations, configuration backup, SQL execution, service start/stop, WebSphere deployment plugins, K8s deployment plugins, Docker deployment plugins, WebLogic deployment plugins, etc.
15Supports online testing of built-in tools.
16Supports online help for built-in tool libraries, including input parameters, output parameters, execution methods, risk levels, etc.
17Supports associating built-in tool libraries with custom display templates.
18Custom Atomic OperationsSupports common scripting languages, including Python, Ruby, VBScript, Perl, PowerShell, CMD, Bash, csh, ksh, sh, JavaScript.
19Supports various input and output parameter types, including text, text area, password, file, time, date, single choice, multiple choice, switch, account, JSON object, node information. Parameters can be set with default values.
20Supports command-line parameters and can specify the number of command-line parameters.
21Supports setting risk levels for custom tools.
22Supports binding custom tools to tool directories.
23Supports version control based on Git and importing/exporting atomic operations from/to Git.
24Supports version review and release for custom tools.
25Supports common connection protocols such as SSH, WinRM, Tagent, IPMI, HTTP, HTTPS, Telnet, SNMP, SMI, etc.
26Supports connection methods such as remote target machine execution, local execution, and local-to-remote execution.
27Supports online testing and verification of custom atomic operations.
28Supports import and export of atomic operations for environment migration between different environments.
29Release ManagementRelease TemplatesSupports defining templates for specific types of releases, such as WebLogic release, to quickly complete release configuration by selecting the corresponding template when configuring a specific instance.
30Supports template configuration for regular single-instance and clustered deployments, such as WebLogic application updates.
31Release ConfigurationSupports basic management of combining release templates.
32Supports custom scene-based release orchestration, supports graphical drag-and-drop layout design.
33Supports copying existing release combinations for creating new similar combinations.
34Supports customizing stages or stage groups for tools within a release combination orchestration. Tools within a stage can be executed in serial, parallel, or conditionally.
35Supports full, batch, and gray execution strategies for tools within a release combination orchestration stage.
36Supports adding, editing, and deleting basic playbooks. Basic playbooks can be authorized to be called at specific levels, including visibility at the subsystem level, environment level, and instance level.
37Allows direct invocation of orchestration tool libraries and custom atomic operations within orchestration playbooks, simplifying the design process of playbooks.
38Supports orchestration of playbooks at the subsystem, system environment, and release instance levels, enabling orchestration of multiple playbooks, and quick execution, addition, modification, and other operations of playbooks.
39Same playbooks can be inherited and reused between different management units, and the priority order is as follows: application instance level, subsystem environment level, subsystem level.
40Scene PresetsSupports preselecting settings for releases within a system based on scenes, such as compile-only, build, backup, rollback, SQL execution, application start/stop, etc.
41Compile & BuildSupports automated compilation, packaging, and automatic deployment of application code starting from SVN or Git code repositories. It also supports automatic execution and deployment of database scripts and application configuration files obtained from SVN.
42Supports automatic maintenance of code baselines, automatically merging modifications from the baseline to the release branch after deployment, and automatically merging modifications from the baseline to the deployment branch before compilation.
43Supports extraction and display of JUnit test result data.
44Supports integration with SonarQube code scanning and provides scanning result list.
45Provides version locking functionality. After locking, only authorized users can compile the code again to prevent untested code changes before production release.
46Supports automatic compilation and packaging of Java applications using tools such as Maven, Ant, Gradle; supports automated compilation and packaging of .Net, C, VC++, Java applications; also supports custom script design for compilation and packaging to accomplish custom compilation and packaging of applications.
47For completed applications after compilation, the platform supports material organization based on custom needs and re-completes automated packaging of the organized materials.
48Configuration Modification/ReplacementSupports automated deployment of application configuration files, including automated modification and replacement of configuration files.
49Supports automatic configuration for server-specific differences, supports configuration template functionality, and combines configuration templates with environment configuration to generate final configuration files that can adapt to different environments (e.g., SIT, UAT, PRD).
50Database Script Auto ExecutionAutomatically identifies the target and execution sequence of DB scripts based on certain rules and runs them in serial or parallel. Users can choose to commit or roll back when errors occur. Operations are reentrant, and successfully executed scripts will not be executed again. The platform can automatically detect modified DB scripts and provide prompts. DB script execution is supported using MySql client, Oracle SQLPlus, db2cli-compatible execution methods, allowing DB scripts that can be run in the above-mentioned tools to be executed directly in the deployment tool.
51When there is an error in the execution of database scripts, the platform page supports user interaction, and users can choose to submit or roll back. Supports real-time display of rollback/commit transactions, and supports color marking of keywords and their corresponding lines.
52Supports one-click publishing of multiple DB scripts without input and explanations; supports selecting and executing multiple DB scripts.
53DB script operations are reentrant, and successfully executed scripts will not be repeated. The platform can automatically detect modified database scripts and provide prompts.
54Supports rollback of database scripts, clearly lists rollback script list, and allows interactive rollback operations. Rollback script operations are reentrant, and successfully executed scripts cannot be repeated.
55Checks and recompiles invalid objects for Oracle databases.
56Deployment & PublishingSupports automated deployment of applications on Linux, Unix, Windows, and other systems.
57Supports built-in deployment plugins, including Tomcat, WebLogic, and WAS, and supports extension.
58Supports one-click batch deployment of applications, where multiple system versions can be released at once. The priority of application systems should be considered. During the release process, operations in the batch release can be paused, rerun, etc., and already fixed operations can be re-released.
59Real-time display of the status of each release process is required for both automated deployment of a single application and one-click deployment of multiple applications.
60Supports application version rollback, and the platform can quickly select any historical version for rollback.
61Supports monitoring the status of application instances. After version release, the platform can easily detect and view the health status of application instances.
62Supports application restart. Multiple instances of the application can be started and stopped in parallel or sequentially. Independent authorization management is provided, which can be granted to specific users, enabling users to deploy the platform to restart applications and view logs automatically.
63Supports completeness and version consistency verification of materials to be released, supports automatic scanning of database scripts.
64Code ManagementCode ManagementSupports checking if version branches (integration branches) have merged code changes from the code baseline (master) before compilation.
65After production release and successful verification, automatically triggers the merging of corresponding versions of code back to the baseline (master).
66Supports triggering automatic compilation of versions and automatic deployment to the SIT environment by setting Git or SVN hooks, and allows viewing relevant descriptions of code changes corresponding to the compilation.
67Supports automatic tagging of code branches.
68Version CenterArtifact ManagementSupports built-in application version artifact management, and production can obtain versions from its own artifacts.
69Supports integration with third-party version artifact repositories such as Nexus.
70Version ManagementSupports archiving of released version codes, SQL, configuration files.
71Supports version definition, version open/close operations.
72Version PublishingBatch PublishingSupports defining batch publishing orchestration based on release pipelines and release jobs.
73Supports batch execution of multiple jobs. Within the same batch, multiple release jobs can be orchestrated in serial or parallel based on the logical relationship between applications. Users can complete the batch execution of all jobs with a single button.
74Supports lane definition and configuration for tasks in batch publishing.
75Supports task status policies in batch publishing, such as continuing on failure, waiting strategies, etc.
76
77Supports batch publishing authorization configuration.
78One-Click PublishingSupports viewing the release list from an application perspective and provides quick search functionality to quickly find configurations of application systems or modules.
79Supports release rollback.
80Supports execution based on scene or full release configuration.
81Allows selective execution of specific steps in existing automated deployment processes.
82Supports outer loop execution of multiple operational playbooks based on application server instances. DB scripts can be executed within a specific loop.
83Supports scheduled execution of job tasks. The platform supports regular and periodic job execution, automatically creating and running jobs based on defined trigger rules, facilitating the automatic deployment of the test environment.
84Supports viewing application logs. Users can view and download application log files in real time within the automated deployment platform.
85Supports white-box release, where every action during the release process should be displayed in real-time scrolling logs.
86Supports viewing operation log records during the release process. Each release step should have log information, including but not limited to operator, operation time, and duration. The operation logs can be exported for auditing purposes.
87Supports real-time scrolling printout of release logs. For applications with asynchronous startup, the log can be tailed in real-time until the application startup is completed.
88All status logs displayed in real-time should be differentiated by different colors to distinguish error messages, warning messages, and normal messages, facilitating user identification.