@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc-test.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/NOTICE +27 -0
- package/documentation/arch/aspects.yaml +81 -0
- package/documentation/arch/components/browser.yaml +51 -0
- package/documentation/arch/components/examples/context.yaml +37 -0
- package/documentation/arch/components/examples/order.yaml +92 -0
- package/documentation/arch/components/examples/payment.yaml +92 -0
- package/documentation/arch/components/examples/root.yaml +42 -0
- package/documentation/arch/components/front.yaml +309 -0
- package/documentation/arch/components/gitlab.yaml +81 -0
- package/documentation/arch/components/plantuml.yaml +57 -0
- package/documentation/arch/components/root.yaml +36 -0
- package/documentation/arch/components/user.yaml +41 -0
- package/documentation/arch/components/web.yaml +39 -0
- package/documentation/arch/contexts.yaml +99 -0
- package/documentation/arch/forms.yaml +36 -0
- package/documentation/arch/namespaces.yaml +43 -0
- package/documentation/arch/root.yaml +43 -0
- package/documentation/arch/rules.yaml +91 -0
- package/documentation/arch/technologies.yaml +84 -0
- package/documentation/dochub.yaml +32 -0
- package/documentation/docs/conception/archdistrib.puml +38 -0
- package/documentation/docs/conception/archeco.puml +11 -0
- package/documentation/docs/conception/archeco_proc.puml +29 -0
- package/documentation/docs/conception/archver.puml +24 -0
- package/documentation/docs/conception/facade.puml +20 -0
- package/documentation/docs/conception/introduction.md +144 -0
- package/documentation/docs/conception/mindmap.puml +55 -0
- package/documentation/docs/conception/root.yaml +66 -0
- package/documentation/docs/manual/aspects.md +37 -0
- package/documentation/docs/manual/backend/api.yaml +664 -0
- package/documentation/docs/manual/backend/search-implementation.md +190 -0
- package/documentation/docs/manual/backend/search.yaml +495 -0
- package/documentation/docs/manual/clickstream-setup.md +50 -0
- package/documentation/docs/manual/components.md +45 -0
- package/documentation/docs/manual/config/deployment.md +337 -0
- package/documentation/docs/manual/context_source.puml +17 -0
- package/documentation/docs/manual/contexts.md +200 -0
- package/documentation/docs/manual/datasets.md +120 -0
- package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
- package/documentation/docs/manual/docs/asyncapi.md +63 -0
- package/documentation/docs/manual/docs/bpmn.md +122 -0
- package/documentation/docs/manual/docs/charts.md +371 -0
- package/documentation/docs/manual/docs/docs.md +76 -0
- package/documentation/docs/manual/docs/drawio_intro.md +397 -0
- package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
- package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
- package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
- package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
- package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
- package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
- package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
- package/documentation/docs/manual/docs/editable_table/template.md +24 -0
- package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
- package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
- package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
- package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
- package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
- package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
- package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
- package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
- package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
- package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
- package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
- package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
- package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
- package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
- package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
- package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
- package/documentation/docs/manual/docs/examples/example.html +2 -0
- package/documentation/docs/manual/docs/examples/example.puml +17 -0
- package/documentation/docs/manual/docs/examples/example.yaml +53 -0
- package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
- package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
- package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
- package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
- package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
- package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
- package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
- package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
- package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
- package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
- package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
- package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
- package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
- package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
- package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
- package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
- package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
- package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
- package/documentation/docs/manual/docs/examples/table.yaml +341 -0
- package/documentation/docs/manual/docs/examples/template.puml +6 -0
- package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
- package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
- package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
- package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
- package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
- package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
- package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
- package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
- package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
- package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
- package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
- package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
- package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
- package/documentation/docs/manual/docs/gigachat/template.md +38 -0
- package/documentation/docs/manual/docs/images/cloud.png +0 -0
- package/documentation/docs/manual/docs/images/component.png +0 -0
- package/documentation/docs/manual/docs/images/system.png +0 -0
- package/documentation/docs/manual/docs/images/user.png +0 -0
- package/documentation/docs/manual/docs/markaper.md +278 -0
- package/documentation/docs/manual/docs/markdown.md +148 -0
- package/documentation/docs/manual/docs/mermaid.md +43 -0
- package/documentation/docs/manual/docs/network.md +117 -0
- package/documentation/docs/manual/docs/plantuml.md +28 -0
- package/documentation/docs/manual/docs/root.yaml +736 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
- package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
- package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
- package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
- package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
- package/documentation/docs/manual/docs/smartants.md +583 -0
- package/documentation/docs/manual/docs/svg_inline.md +66 -0
- package/documentation/docs/manual/docs/swagger.md +52 -0
- package/documentation/docs/manual/docs/tables.md +264 -0
- package/documentation/docs/manual/docs/templates/example.drawio +43 -0
- package/documentation/docs/manual/docs/templates/test.svg +79 -0
- package/documentation/docs/manual/docs/templates.md +361 -0
- package/documentation/docs/manual/docs/toc.md +137 -0
- package/documentation/docs/manual/entities/bstages.md +43 -0
- package/documentation/docs/manual/entities/bundle.md +105 -0
- package/documentation/docs/manual/entities/entities.md +727 -0
- package/documentation/docs/manual/entities/images/id_errors.png +0 -0
- package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
- package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
- package/documentation/docs/manual/entities/images/object_select.png +0 -0
- package/documentation/docs/manual/entities/images/problems.png +0 -0
- package/documentation/docs/manual/entities/images/select_inter.png +0 -0
- package/documentation/docs/manual/entities/images/stages.jpg +0 -0
- package/documentation/docs/manual/entities/images/suggests.png +0 -0
- package/documentation/docs/manual/entities/intro.md +73 -0
- package/documentation/docs/manual/entities/rules.md +35 -0
- package/documentation/docs/manual/functions/example.yaml +50 -0
- package/documentation/docs/manual/functions/functions.md +51 -0
- package/documentation/docs/manual/functions/root.yaml +39 -0
- package/documentation/docs/manual/images/jbps1.1.png +0 -0
- package/documentation/docs/manual/images/jbps1.png +0 -0
- package/documentation/docs/manual/images/jbps2.png +0 -0
- package/documentation/docs/manual/images/vsc1.png +0 -0
- package/documentation/docs/manual/imports.md +59 -0
- package/documentation/docs/manual/introduction.md +38 -0
- package/documentation/docs/manual/jsonata.md +268 -0
- package/documentation/docs/manual/plugin-settings.md +134 -0
- package/documentation/docs/manual/plugins/interface.md +226 -0
- package/documentation/docs/manual/plugins/introduction.md +256 -0
- package/documentation/docs/manual/plugins/root.yaml +51 -0
- package/documentation/docs/manual/role-model.md +80 -0
- package/documentation/docs/manual/root-cluster-import.md +82 -0
- package/documentation/docs/manual/root.yaml +199 -0
- package/documentation/docs/manual/rules/exceptions.md +20 -0
- package/documentation/docs/manual/rules/exreason.md +3 -0
- package/documentation/docs/manual/rules/root.yaml +58 -0
- package/documentation/docs/manual/rules/rules.md +8 -0
- package/documentation/docs/manual/rules/standard.md +3 -0
- package/documentation/docs/manual/rules/validators.md +109 -0
- package/documentation/docs/manual/technologies.md +49 -0
- package/documentation/docs/root.yaml +32 -0
- package/documentation/docs/sequence.puml +48 -0
- package/documentation/docs/welcome.md +3 -0
- package/documentation/entities/extentions/entity.yaml +136 -0
- package/documentation/entities/extentions/templates/people.md +4 -0
- package/documentation/entities/interactions/entity.yaml +412 -0
- package/documentation/entities/interactions/templates/blank.puml +18 -0
- package/documentation/entities/interactions/templates/bpmn.xml +59 -0
- package/documentation/entities/interactions/templates/tree.puml +11 -0
- package/documentation/entities/root.yaml +33 -0
- package/documentation/root.yaml +37 -0
- package/metamodel/dochub/entities/aspects/base.yaml +73 -0
- package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
- package/metamodel/dochub/entities/aspects/components.yaml +52 -0
- package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
- package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
- package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
- package/metamodel/dochub/entities/aspects/root.yaml +9 -0
- package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
- package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
- package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
- package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
- package/metamodel/dochub/entities/components/base.yaml +97 -0
- package/metamodel/dochub/entities/components/blank.yaml +64 -0
- package/metamodel/dochub/entities/components/contexts.yaml +55 -0
- package/metamodel/dochub/entities/components/docs.yaml +50 -0
- package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
- package/metamodel/dochub/entities/components/index.yaml +17 -0
- package/metamodel/dochub/entities/components/root.yaml +8 -0
- package/metamodel/dochub/entities/components/summary.yaml +58 -0
- package/metamodel/dochub/entities/components/symbol.yaml +113 -0
- package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
- package/metamodel/dochub/entities/components/templates/summary.md +8 -0
- package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/components/tree.yaml +38 -0
- package/metamodel/dochub/entities/contexts/base.yaml +197 -0
- package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
- package/metamodel/dochub/entities/contexts/root.yaml +5 -0
- package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
- package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
- package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
- package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
- package/metamodel/dochub/entities/documents/base.yaml +73 -0
- package/metamodel/dochub/entities/documents/blank.yaml +28 -0
- package/metamodel/dochub/entities/documents/root.yaml +3 -0
- package/metamodel/dochub/entities/root.yaml +5 -0
- package/metamodel/dochub/functions/root.yaml +2 -0
- package/metamodel/dochub/functions/tools.yaml +46 -0
- package/metamodel/dochub/root.yaml +24 -0
- package/metamodel/dochub/rules/root.yaml +2 -0
- package/metamodel/dochub/rules/validators.yaml +144 -0
- package/metamodel/dochub/samples/01_components.yaml +23 -0
- package/metamodel/dochub/samples/02_contexts.yaml +23 -0
- package/metamodel/dochub/samples/03_documents.yaml +10 -0
- package/metamodel/dochub/samples/root.yaml +4 -0
- package/metamodel/dochub/samples/test.puml +17 -0
- package/metamodel/dochub.yaml +5 -0
- package/metamodel/docs/welcome.md +39 -0
- package/metamodel/root.yaml +8 -0
- package/package.json +29 -0
- package/plugin.html +1961 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Copyright (C) 2021 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2021
|
|
27
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
28
|
+
|
|
29
|
+
# !Устарело!
|
|
30
|
+
# Манифест описывающий пространство имен archtool и gitlab
|
|
31
|
+
namespaces:
|
|
32
|
+
archtool: # Идентификатор области имен
|
|
33
|
+
title: SEAF.ArchTool # Название области имен. Будет отражаться на схемах
|
|
34
|
+
gitlab:
|
|
35
|
+
title: GitLab
|
|
36
|
+
git:
|
|
37
|
+
title: Клиент git
|
|
38
|
+
manifest:
|
|
39
|
+
title: Манифесты
|
|
40
|
+
plantuml:
|
|
41
|
+
title: PlantUML сервер
|
|
42
|
+
web:
|
|
43
|
+
title: WEB-ресурсы
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Copyright (C) 2021 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
# Copyright (C) 2023 Sber
|
|
3
|
+
#
|
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
# you may not use this file except in compliance with the License.
|
|
6
|
+
# You may obtain a copy of the License at
|
|
7
|
+
#
|
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
#
|
|
10
|
+
# In any derivative products, you must retain the information of
|
|
11
|
+
# owner of the original code and provide clear attribution to the project
|
|
12
|
+
#
|
|
13
|
+
# https://dochub.info
|
|
14
|
+
#
|
|
15
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
16
|
+
#
|
|
17
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
18
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
19
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
20
|
+
# See the License for the specific language governing permissions and
|
|
21
|
+
# limitations under the License.
|
|
22
|
+
#
|
|
23
|
+
# Maintainers:
|
|
24
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
25
|
+
#
|
|
26
|
+
# Contributors:
|
|
27
|
+
# R.Piontik <r.piontik@mail.ru> - 2021
|
|
28
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
29
|
+
# Vladislav Markin, Sber - 2023
|
|
30
|
+
|
|
31
|
+
# Манифест описывающий сам SEAF.ArchTool
|
|
32
|
+
imports: # Подключение манифестов
|
|
33
|
+
- components/root.yaml
|
|
34
|
+
- aspects.yaml
|
|
35
|
+
- contexts.yaml
|
|
36
|
+
- namespaces.yaml
|
|
37
|
+
- forms.yaml
|
|
38
|
+
- technologies.yaml
|
|
39
|
+
- rules.yaml
|
|
40
|
+
components:
|
|
41
|
+
archtool: # Корневой компонент (домен)
|
|
42
|
+
title: SEAF.ArchTool
|
|
43
|
+
entity: component
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# Copyright (C) 2022 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2022
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
rules:
|
|
30
|
+
validators:
|
|
31
|
+
archtool.fields:
|
|
32
|
+
title: Заполнение полей # Название валидатора
|
|
33
|
+
archtool.fields.experts: # Валидатор контролирует заполнение поля expert для компонентов L1
|
|
34
|
+
title: Не указаны эксперты для компонентов # Название валидатора
|
|
35
|
+
source: > # Источник данных об ошибках. В данном случае JSONata запрос
|
|
36
|
+
([([
|
|
37
|
+
components.$spread().( /* Сканируем все компоненты */
|
|
38
|
+
$ID := $keys()[0];
|
|
39
|
+
{ /* Генерируем массив признаков проблем */
|
|
40
|
+
"isComponent": *.entity = "component", /* Это компонент */
|
|
41
|
+
"isArchtoolL1Domain": $boolean($match($ID, /archtool\.[^\.]*$/)), /* в домене Archtool L1 */
|
|
42
|
+
"isExpertEmpty": $not($boolean("" & *.expert)), /* и поле expert не заполнено */
|
|
43
|
+
"id": $ID
|
|
44
|
+
}
|
|
45
|
+
)
|
|
46
|
+
][isArchtoolL1Domain and isExpertEmpty and isComponent]).{ /* Отбираем все компоненты где поле 'expert' пустое*/
|
|
47
|
+
"uid": "expert-component-" & id, /* Уникальный идентификатор выявленной ошибки */
|
|
48
|
+
"location": "/architect/components/" & id, /* Ссылка на расположение объекта ошибки */
|
|
49
|
+
"correction": "Укажите эксперта по компоненту", /* Рекомендации как исправить проблему */
|
|
50
|
+
"description": "Компоненты L1 должны иметь сведения об экспертах."
|
|
51
|
+
}])
|
|
52
|
+
archtool.fields.source: # Валидатор контролирует заполнение поля указывающего на исходник для домена Archtool
|
|
53
|
+
# используя для этого JSON schema (https://json-schema.org/)
|
|
54
|
+
title: Не указан файл исходного кода # Название валидатора
|
|
55
|
+
schema: # JSON Schema
|
|
56
|
+
type: object
|
|
57
|
+
properties:
|
|
58
|
+
source:
|
|
59
|
+
type: string
|
|
60
|
+
required:
|
|
61
|
+
- source
|
|
62
|
+
additionalProperties: true
|
|
63
|
+
source: > # Источник данных об ошибках
|
|
64
|
+
(
|
|
65
|
+
/* Создаем валидатор JSON schema */
|
|
66
|
+
$validator := $jsonschema($self.schema); /* Схему валидата получаем из контекста отклонения*/
|
|
67
|
+
/* Формируем базу для проверки */
|
|
68
|
+
([([
|
|
69
|
+
components.$spread().( /* Сканируем все компоненты */
|
|
70
|
+
$ID := $keys()[0];
|
|
71
|
+
{ /* Генерируем массив признаков проблем */
|
|
72
|
+
"isComponent": *.entity = "component", /* Это компонент */
|
|
73
|
+
"isArchtoolDomain": $boolean($match($ID, /archtool\.front.*/)), /* в домене Archtool */
|
|
74
|
+
"id": $ID, /* Запоминаем идентификатор компонента */
|
|
75
|
+
"isvalid": $validator($.*) /* Валидируем компонент по схеме */
|
|
76
|
+
}
|
|
77
|
+
)
|
|
78
|
+
][isArchtoolDomain and isComponent and isvalid != true]).isvalid.{ /* Генерируем отклонения по выявленным нарушениям */
|
|
79
|
+
"uid": $.params.missingProperty & "-component-" & %.id, /* Уникальный идентификатор выявленной ошибки */
|
|
80
|
+
"location": "/architect/components/" & %.id, /* Ссылка на расположение объекта ошибки */
|
|
81
|
+
"correction": "Заполните необходимые поля", /* Рекомендации как исправить проблему */
|
|
82
|
+
"description": message
|
|
83
|
+
}])
|
|
84
|
+
)
|
|
85
|
+
exceptions: # Исключения для валидаторов
|
|
86
|
+
"source-component-archtool.front.spa.blank.doc.markdown": # UID ошибки для исключения
|
|
87
|
+
reason: > # Причина исключения
|
|
88
|
+
Пример исключения для указания исходных кодов
|
|
89
|
+
cause: /docs/archtool.exceptions.examples.doc_markdown # Документ-основание исключения
|
|
90
|
+
"$dh-mm-ofb-archtool":
|
|
91
|
+
reason: Корневой компонент может не входить в контекст
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Copyright (C) 2021 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2021
|
|
27
|
+
|
|
28
|
+
technologies: # Описание технологического стека
|
|
29
|
+
sections: # Определение разделов стека
|
|
30
|
+
language: # Идентификатор раздела
|
|
31
|
+
title: Языки программирования # Название раздела
|
|
32
|
+
parsers:
|
|
33
|
+
title: Парсеры
|
|
34
|
+
tools:
|
|
35
|
+
title: Инструментарий
|
|
36
|
+
storages:
|
|
37
|
+
title: Хранилища
|
|
38
|
+
browsers:
|
|
39
|
+
title: Браузеры
|
|
40
|
+
items: # Перечисление технологий
|
|
41
|
+
JavaScript: # Идентификатор технологии
|
|
42
|
+
aliases: # Синонимы технологии
|
|
43
|
+
- js
|
|
44
|
+
- NodeJS
|
|
45
|
+
title: Супер-крутой язык программирования # Название технологии
|
|
46
|
+
link: https://ru.wikipedia.org/wiki/JavaScript # Ссылка на документацию
|
|
47
|
+
section: language # Идентификатор секции технологии
|
|
48
|
+
status: adopt # Статус технологии adopt / trial / assess / hold
|
|
49
|
+
Chrome:
|
|
50
|
+
aliases:
|
|
51
|
+
- Firefox
|
|
52
|
+
- Safari
|
|
53
|
+
section: browsers
|
|
54
|
+
status: adopt
|
|
55
|
+
VUEJS3:
|
|
56
|
+
aliases:
|
|
57
|
+
- VUE
|
|
58
|
+
- VUE3
|
|
59
|
+
section: tools
|
|
60
|
+
status: adopt
|
|
61
|
+
VUEX:
|
|
62
|
+
section: tools
|
|
63
|
+
status: adopt
|
|
64
|
+
Axios:
|
|
65
|
+
section: tools
|
|
66
|
+
status: adopt
|
|
67
|
+
Git:
|
|
68
|
+
section: tools
|
|
69
|
+
status: adopt
|
|
70
|
+
Markdown:
|
|
71
|
+
section: parsers
|
|
72
|
+
status: adopt
|
|
73
|
+
Swagger:
|
|
74
|
+
section: parsers
|
|
75
|
+
status: adopt
|
|
76
|
+
PluntUML:
|
|
77
|
+
section: parsers
|
|
78
|
+
status: adopt
|
|
79
|
+
GitLab:
|
|
80
|
+
section: storages
|
|
81
|
+
status: adopt
|
|
82
|
+
HTTP:
|
|
83
|
+
section: storages
|
|
84
|
+
status: adopt
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Copyright (C) 2024 owner Roman Piontik R.Piontik@mail.ru
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# In any derivative products, you must retain the information of
|
|
10
|
+
# owner of the original code and provide clear attribution to the project
|
|
11
|
+
#
|
|
12
|
+
# https://dochub.info
|
|
13
|
+
#
|
|
14
|
+
# The use of this product or its derivatives for any purpose cannot be a secret.
|
|
15
|
+
#
|
|
16
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
17
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
18
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
19
|
+
# See the License for the specific language governing permissions and
|
|
20
|
+
# limitations under the License.
|
|
21
|
+
#
|
|
22
|
+
# Maintainers:
|
|
23
|
+
# R.Piontik <r.piontik@mail.ru>
|
|
24
|
+
#
|
|
25
|
+
# Contributors:
|
|
26
|
+
# R.Piontik <r.piontik@mail.ru> - 2024
|
|
27
|
+
|
|
28
|
+
$package:
|
|
29
|
+
dochub-doc:
|
|
30
|
+
version: 3.0.0
|
|
31
|
+
imports:
|
|
32
|
+
- root.yaml
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
@startuml
|
|
2
|
+
title Управление распределенной архитектурой
|
|
3
|
+
actor "Команда А" as team_a
|
|
4
|
+
actor "Команда B" as team_b
|
|
5
|
+
participant "SEAF.ArchTool" as archtool
|
|
6
|
+
database "Репозиторий\nкода\nкоманды A" as repo_a
|
|
7
|
+
database "Репозиторий\nкода\nкоманды B" as repo_b
|
|
8
|
+
database "Центральный\nрепозиторий\nархитектуры" as repo_main
|
|
9
|
+
group Обзор архитектуры
|
|
10
|
+
archtool <- repo_main: Как будет
|
|
11
|
+
archtool <- repo_b: Как есть
|
|
12
|
+
archtool <- repo_a: Как есть
|
|
13
|
+
team_a <- archtool: Артефакты
|
|
14
|
+
team_b <- archtool: Артефакты
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
group Развитие концептуальной архитектуры
|
|
18
|
+
repo_a <- repo_main: Checkout
|
|
19
|
+
team_a <-> repo_a: Развитие
|
|
20
|
+
repo_a -> repo_main: Pull request
|
|
21
|
+
team_b <- repo_main: Pull request
|
|
22
|
+
team_b <- team_b: Review
|
|
23
|
+
team_a <-> team_b: Коммуникации
|
|
24
|
+
team_b -> repo_main: Approve
|
|
25
|
+
repo_main -> repo_main: Merge
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
group Развитие архитектуры "как есть"
|
|
29
|
+
team_b -> repo_b: Checkout
|
|
30
|
+
team_b <-> repo_b: Развитие
|
|
31
|
+
team_b -> repo_b: Pull request
|
|
32
|
+
team_b <- repo_b: Pull request
|
|
33
|
+
team_b <- team_b: Review
|
|
34
|
+
team_b -> repo_b: Approve
|
|
35
|
+
repo_b -> repo_b: Merge
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
@enduml
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
@startuml
|
|
2
|
+
title "Развитие архитектуры экосистем"
|
|
3
|
+
participant "Компания A" as company_a
|
|
4
|
+
participant "SEAF.ArchTool A" as archtool_a
|
|
5
|
+
participant "Компания B" as company_b
|
|
6
|
+
participant "SEAF.ArchTool B" as archtool_b
|
|
7
|
+
database "Branch\nCompany A" as rb_company_a
|
|
8
|
+
database "Branch\nCompany B" as rb_company_b
|
|
9
|
+
database "Branch\nmaster" as rb_master
|
|
10
|
+
|
|
11
|
+
group Обзор архитектуры
|
|
12
|
+
archtool_a <- rb_company_a : Манифесты
|
|
13
|
+
archtool_a <- rb_master : Манифесты
|
|
14
|
+
company_a <- archtool_a : Артефакты
|
|
15
|
+
|
|
16
|
+
archtool_b <- rb_company_b : Манифесты
|
|
17
|
+
archtool_b <- rb_master : Манифесты
|
|
18
|
+
company_b <- archtool_b : Артефакты
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
group Развитие архитектуры
|
|
22
|
+
rb_company_a <- rb_master : Checkout
|
|
23
|
+
company_a <-> rb_company_a : Развитие
|
|
24
|
+
rb_company_a -> rb_master : Pull request
|
|
25
|
+
rb_master -> rb_master : Merge
|
|
26
|
+
rb_company_a <- rb_master : Fetch
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
@enduml
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
@startuml
|
|
2
|
+
title "Инкрементальное развитие архитектуры"
|
|
3
|
+
|
|
4
|
+
package "Центральный репозиторий" {
|
|
5
|
+
database master as master
|
|
6
|
+
database branch1 as branch1
|
|
7
|
+
database branch2 as branch2
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
master --> branch1: Checkout
|
|
11
|
+
master --> branch2: Checkout
|
|
12
|
+
master <-- branch1: Pull request
|
|
13
|
+
master <-- branch2: Pull request
|
|
14
|
+
|
|
15
|
+
actor Architect1 as architect1
|
|
16
|
+
actor Architect2 as architect2
|
|
17
|
+
|
|
18
|
+
architect1 <-up-> branch1: Developing
|
|
19
|
+
architect2 <-up-> branch2: Developing
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
architect1 <-up-> master: Review
|
|
23
|
+
architect2 <-up-> master: Review
|
|
24
|
+
@enduml
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
@startuml
|
|
2
|
+
title "Управление архитектурным фасадом"
|
|
3
|
+
|
|
4
|
+
actor " Внешний\nпользователь" as user
|
|
5
|
+
|
|
6
|
+
rectangle "Компания" {
|
|
7
|
+
cloud WEB {
|
|
8
|
+
rectangle SEAF.ArchTool as archtool
|
|
9
|
+
rectangle "Facade\nmanifests" as static
|
|
10
|
+
}
|
|
11
|
+
cloud Repository {
|
|
12
|
+
database "Facade\nbranch" as facade_branch
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
user <-down- archtool: Артефакты
|
|
17
|
+
archtool <- static : Манифесты
|
|
18
|
+
static <-down- facade_branch : Deploy
|
|
19
|
+
|
|
20
|
+
@enduml
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
## Введение
|
|
2
|
+
|
|
3
|
+
SEAF.ArchTool - инструмент описания архитектуры через код (Architecture as a code). Код архитектуры - ансамбль
|
|
4
|
+
файлов на [языках](#langs), решающих задачу описания архитектуры.
|
|
5
|
+
|
|
6
|
+
Решаемые проблемы:
|
|
7
|
+
1. [Управление версиями архитектуры](#versions);
|
|
8
|
+
2. [Управление децентрализованной архитектурой в Agile-ориентированных компаниях](#distrib);
|
|
9
|
+
3. [Управление архитектурой холдинга (экосистем)](#ecosystem);
|
|
10
|
+
4. [Создание архитектурных фасадов](#facade).
|
|
11
|
+
|
|
12
|
+

|
|
13
|
+
## 1. Управление версиями архитектуры
|
|
14
|
+

|
|
15
|
+
|
|
16
|
+
В развивающихся проектах архитектура мутабельна. Стандартной ситуацией является одновременная проработка нескольких
|
|
17
|
+
архитектурных решений, которые должны стать единым целым. Особенно выражена данная проблема при наличии нескольких
|
|
18
|
+
автономных команд создающих единую систему.
|
|
19
|
+
|
|
20
|
+
Для монокомандых систем проблема остается актуальной. Внезапное изменение приоритетов и требований приводит
|
|
21
|
+
к накапливанию противоречивых архитектурных решений. Формируется технический долг.
|
|
22
|
+
|
|
23
|
+
Аналогичные проблемы свойственны кодовой базе систем. В процессе параллельной разработки фич, разработчики
|
|
24
|
+
сталкиваются с задачей объединения результата в релизы. Решается она через инкрементальное развитие кода.
|
|
25
|
+
Популярным инструментом является - git.
|
|
26
|
+
|
|
27
|
+
Практикуются различные методологии управления кодом. Из популярных можно выделить
|
|
28
|
+
[GitFlow](https://www.atlassian.com/en/git/tutorials/comparing-workflows/gitflow-workflow) и
|
|
29
|
+
[GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow).
|
|
30
|
+
|
|
31
|
+
Идея заключается в том, что разработчик при создании новой фичи клонирует ветку (branch) общей кодовой базы в
|
|
32
|
+
отдельную. В ней он ведет разработку. По завершению работы создается Pull request / Merge request. Это
|
|
33
|
+
специальный, формализованный запрос в рамках системы управления версиями на объединение веток. Он оценивается
|
|
34
|
+
(Code review) другими разработчиками. В случае положительного решения, изменения внедряются в общий код.
|
|
35
|
+
|
|
36
|
+
Решать запросы на объединение помогают инструменты сравнения встроенные в системы управления версиями. Они наглядно
|
|
37
|
+
отображают изменения в коде. Выявляют конфликты. Позволяют их устранять.
|
|
38
|
+
|
|
39
|
+
В отличие от процесса разработки, где все построено на коде, архитектура требует создания графических артефактов.
|
|
40
|
+
Для этого используются визуальные редакторы. Объединение версий диаграмм является проблемой. Тратятся значительные
|
|
41
|
+
ресурсы на механическую деятельность.
|
|
42
|
+
|
|
43
|
+
SEAF.ArchTool предлагает отказаться от использования визуальных редакторов в пользу описания архитектуры кодом. Использовать
|
|
44
|
+
принципы управления архитектурой аналогично принципам управления кодовой базой. Для этого предоставляются четыре
|
|
45
|
+
языка описания архитектуры:
|
|
46
|
+
|
|
47
|
+

|
|
48
|
+
* [PlantUML](https://plantuml.com/) - позволяет создавать диаграммы из обычного текстового языка;
|
|
49
|
+
* [Markdown](https://ru.wikipedia.org/wiki/Markdown) - язык разметки, созданный с целью обозначения форматирования в тексте;
|
|
50
|
+
* [Swagger](https://swagger.io/) - язык описания интерфейсов для описания RESTful API;
|
|
51
|
+
* [Манифесты](/docs/archtool.contexts) - структурированные файлы в формате YAML/JSON для описания архитектурных объектов.
|
|
52
|
+
|
|
53
|
+
Таким образом, процесс развития архитектуры становится максимально близким к разработке систем. Это дает возможность,
|
|
54
|
+
помимо решения основной проблемы (управление версиями), получить дополнительные преимущества:
|
|
55
|
+
|
|
56
|
+
* Унифицировать процессы развития архитектуры и разработки;
|
|
57
|
+
* Архитектурные артефакты могут быть размещены непосредственно в репозитории кодовой базы и развиваться одновременно
|
|
58
|
+
с кодовой базой системы;
|
|
59
|
+
* Возникает возможность управления архитектурными идеями через Pull request;
|
|
60
|
+
* Создается база для взаимного проникновения экспертиз разработки и проектирования.
|
|
61
|
+
|
|
62
|
+

|
|
63
|
+
## 2. Управление децентрализованной архитектурой
|
|
64
|
+
|
|
65
|
+
Под "децентрализованной" понимается сложная, многокомпонентная архитектура системы, части которой распределены
|
|
66
|
+
по командам разработки. Каждая команда развивает свой сегмент параллельно и независимо, но должна учитывать общую
|
|
67
|
+
концепцию. Ярким примером является микросервисная архитектура.
|
|
68
|
+
|
|
69
|
+

|
|
70
|
+
|
|
71
|
+
На первый план здесь выходит синхронизация решений команд, влияющих на общий архитектурный ландшафт. Остро стоит
|
|
72
|
+
вопрос управления технологическим стеком и переиспользование имеющихся в компании наработок.
|
|
73
|
+
|
|
74
|
+
Управление архитектурой "как код", позволяет применить опыт Open Source сообществ. В этом случае существует
|
|
75
|
+
центральный репозиторий с концептуальной архитектурой (как будет). Все имеют доступ к нему, получая необходимые
|
|
76
|
+
сведения о планах развития. Изменения в репозиторий попадают через Pull requests. Ревьюверами являются техлидеры
|
|
77
|
+
команд.
|
|
78
|
+
|
|
79
|
+
Таким образом достигается информирование об архитектурных решениях. Возникает консенсус. Происходит обмен опытом.
|
|
80
|
+
|
|
81
|
+
Описание архитектуры “как есть” остается в командах. Т.е. несмотря на то, что имеется централизованный репозиторий
|
|
82
|
+
"как будет", у команд остается право на автономное принятие быстрых решений. Этот подход реализует
|
|
83
|
+
[Agile манифест](https://wikipedia.org/wiki/Agile_Manifesto). Если необходимо срочно внести обоснованные изменения
|
|
84
|
+
в продукт, должна быть возможность это сделать. Такая ситуация считается инцидентом.
|
|
85
|
+
|
|
86
|
+
Противоречие с центральным репозиторием устраняется путем сверки "как есть" с "как будет". Отклонения обосновываются
|
|
87
|
+
и с отставанием вносятся. Таким образом, инцидентные решения остаются в поле управления.
|
|
88
|
+
|
|
89
|
+

|
|
90
|
+
## 3. Управление архитектурой холдинга (экосистем)
|
|
91
|
+
|
|
92
|
+

|
|
93
|
+
|
|
94
|
+
Под холдингом понимается группа компаний развивающих цифровые продукты имеющие потребность в интеграции с выраженным
|
|
95
|
+
центром стратегического управления.
|
|
96
|
+
|
|
97
|
+
Холдинги имеют проблемы координации развития архитектуры экосистемы. Контроль достижения стратегических целей
|
|
98
|
+
является ключевым для них.
|
|
99
|
+
|
|
100
|
+
Компании холдинга имеют разную степень автономности. Часто находятся на различных этапах развития. Это выражается
|
|
101
|
+
в неоднородности процессов управления.
|
|
102
|
+
|
|
103
|
+
Таким образом, управление архитектурой экосистемы является нетривиальной задачей. SEAF.ArchTool предлагает и тут использовать
|
|
104
|
+
принципы развития кодовой базы Open Source сообществами.
|
|
105
|
+
|
|
106
|
+

|
|
107
|
+
|
|
108
|
+
Центр в этом случае выступает майнтейнером (Maintainer) архитектурного кода. Он является владельцем центрального
|
|
109
|
+
репозитория архитектуры. Устанавливает стандарты работы с ним.
|
|
110
|
+
|
|
111
|
+
Компании выступают в роли контрибьюторов (Contributors). У них есть собственный форк или ветка в центральном
|
|
112
|
+
репозитори. Развитие архитектуры экосистемы ведется через Pull requests.
|
|
113
|
+
|
|
114
|
+
SEAF.ArchTool используется как универсальное средство представления артефактов экосистемы.
|
|
115
|
+
|
|
116
|
+

|
|
117
|
+
## 4. Архитектурные фасады
|
|
118
|
+
|
|
119
|
+

|
|
120
|
+
|
|
121
|
+
Под архитектурным фасадом понимается публичная часть архитектуры. Распространенным примером являются API-контракты
|
|
122
|
+
сервиса.
|
|
123
|
+
|
|
124
|
+
Фасады могут иметь различную степень детализации и состав. В некоторых случаях для клиента достаточно только
|
|
125
|
+
публикации контрактов. Но зачастую, у него возникает ряд вопросов по сценариям использования. Также может
|
|
126
|
+
оказаться полезным отразить верхнеуровневую архитектуру внешних сервисов. Для решения этой задачи необходим
|
|
127
|
+
комплект публичных артефактов.
|
|
128
|
+
|
|
129
|
+
SEAF.ArchTool с этой задачей хорошо справляется. Он может быть развернут в качестве архитектурного фасада. Внешние
|
|
130
|
+
пользователи получают удобный интерфейс для изучения публичной архитектуры.
|
|
131
|
+
|
|
132
|
+

|
|
133
|
+
|
|
134
|
+
## 5. Mind Map
|
|
135
|
+
Функциональность SEAF.ArchTool можно представить Mind Map:
|
|
136
|
+

|
|
137
|
+
|
|
138
|
+
## 6. Поставка
|
|
139
|
+
SEAF.ArchTool поставляется в составе двух компонентов в открытых исходных кодах:
|
|
140
|
+
1. WEB портал - [https://gitverse.ru/seafteam/seaf-archtool-core](https://gitverse.ru/seafteam/seaf-archtool-core)
|
|
141
|
+
2. Плагин для IDE JetBrains - [https://gitverse.ru/seafteam/seaf-archtool-ideplugin-jetbrains](https://gitverse.ru/seafteam/seaf-archtool-ideplugin-jetbrains)
|
|
142
|
+
|
|
143
|
+
Лицензия использования Apache-2.0 License
|
|
144
|
+
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
@startmindmap
|
|
2
|
+
* [[https://gitverse.ru/seafteam/seaf-archtool-core SEAF.ArchTool]]
|
|
3
|
+
** Управление
|
|
4
|
+
*** Управление архитектурой
|
|
5
|
+
**** [[/docs/archtool.components Манифесты компонентов]]
|
|
6
|
+
***** Инкрементальное развитие
|
|
7
|
+
****** [[https://about.gitlab.com/ GitLab]]
|
|
8
|
+
**** [[/docs/archtool.contexts Манифесты контекстов]]
|
|
9
|
+
***** Инкрементальное развитие
|
|
10
|
+
****** [[https://about.gitlab.com/ GitLab]]
|
|
11
|
+
**** [[/docs/archtool.aspects Манифесты аспектов]]
|
|
12
|
+
***** Инкрементальное развитие
|
|
13
|
+
****** [[https://about.gitlab.com/ GitLab]]
|
|
14
|
+
*** Управление технологиями
|
|
15
|
+
**** [[/docs/archtool.technologies Манифесты технологий]]
|
|
16
|
+
***** Инкрементальное развитие
|
|
17
|
+
****** [[https://about.gitlab.com/ GitLab]]
|
|
18
|
+
*** Управление артефактами
|
|
19
|
+
**** [[/docs/archtool.docs Манифесты артефактов]]
|
|
20
|
+
***** Инкрементальное развитие
|
|
21
|
+
****** [[https://about.gitlab.com/ GitLab]]
|
|
22
|
+
** Интеграция
|
|
23
|
+
*** Внешние манифесты
|
|
24
|
+
**** HTTP
|
|
25
|
+
*** Внешние данные
|
|
26
|
+
**** [[/docs/archtool.tables Источники данных]]
|
|
27
|
+
** Публикация
|
|
28
|
+
*** Автоматическая генерация\nартефактов
|
|
29
|
+
**** [[/docs/archtool.datasets Источники данных]]
|
|
30
|
+
***** [[/docs/archtool.tables Аналитические таблицы]]
|
|
31
|
+
***** [[/docs/archtool.templates Шаблоны]]
|
|
32
|
+
**** [[/docs/archtool.contexts Диаграммы контекстов]]
|
|
33
|
+
***** [[https://plantuml.com/ PlantUML]]
|
|
34
|
+
**** [[/docs/archtool.aspects Диаграммы аспектов]]
|
|
35
|
+
***** [[https://plantuml.com/ PlantUML]]
|
|
36
|
+
*** [[/docs/archtool.docs Пользовательские артефакты]]
|
|
37
|
+
**** [[/docs/archtool.docs#plantuml Диаграммы, схемы и т.д.]]
|
|
38
|
+
***** [[/docs/archtool.plantuml PlantUML]]
|
|
39
|
+
****** [[/docs/archtool.templates Шаблоны]]
|
|
40
|
+
***** [[/docs/archtool.mermaid Mermaid]]
|
|
41
|
+
****** [[/docs/archtool.templates Шаблоны]]
|
|
42
|
+
**** [[/docs/archtool.docs#markdown Документы]]
|
|
43
|
+
***** [[https://ru.wikipedia.org/wiki/Markdown Markdown]]
|
|
44
|
+
****** [[/docs/archtool.docs#markdown Встраивание объектов SEAF.ArchTool]]
|
|
45
|
+
****** [[/docs/archtool.templates#markdown Шаблоны]]
|
|
46
|
+
**** [[/docs/archtool.tables Таблицы]]
|
|
47
|
+
**** [[/docs/archtool.network Сети]]
|
|
48
|
+
**** [[/docs/archtool.docs#swagger Контракты]]
|
|
49
|
+
***** [[https://swagger.io/ Swagger]]
|
|
50
|
+
****** [[/docs/archtool.templates#openapi Шаблоны]]
|
|
51
|
+
***** [[https://www.asyncapi.com/ AsyncAPI]]
|
|
52
|
+
****** [[/docs/archtool.templates#asyncapi Шаблоны]]
|
|
53
|
+
** Расширяемая метамодель
|
|
54
|
+
*** [[/docs/archtool.entities Кастомные сущности]]
|
|
55
|
+
@endmindmap
|