├── LICENSE
├── README.md
├── compute.tf
├── drawio.tf
├── env-yc.sh
├── images
├── draw-01.png
├── draw-02.png
├── draw-03.png
├── draw-04.png
├── draw-05.png
├── draw-06.png
├── draw-07.png
├── draw-08.png
├── draw-09.png
├── draw-10.png
├── draw-21.png
├── draw-22.png
├── draw-31.png
├── draw-32.png
├── draw-41.png
├── draw-42.png
├── draw-43.png
└── draw-44.png
├── install.sh
├── providers.tf
├── variables.tf
└── vm-drawio.tpl
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2022-2023 YANDEX LLC
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | # Создание графических схем для Terraform развёртываний с помощью инструмента Draw.io на примере Yandex Cloud.
3 |
4 |
5 | ## Оглавление
6 | * [Основные понятия и определения](#terms)
7 | * [Какую задачу решаем](#target)
8 | * [Методика - порядок действий](#process)
9 | * [Практический пример - развёртывание ВМ в Yandex Cloud:](#ex)
10 | 1. [Загрузить пример развёртывания из репозитория на github](#ex-1)
11 | 2. [Подготовить Terraform развёртывание](#ex-2)
12 | 3. [Подготовить данные в Terraform для графического шаблона (drawio.tf)](#ex-3)
13 | 4. [Подготовить (нарисовать) графический параметризованный шаблон развёртывания в Draw.io](#ex-4)
14 | 5. [Интегрировать Terraform развёртывание с графическим шаблоном Draw.io](#ex-5)
15 | 6. [Выполнить Terraform развёртывание](#ex-6)
16 | 7. [Получить результат - графическое представление развёртывания в формате Draw.io](#ex-7)
17 | 8. [Опционально. Проверить работу атрибутов объектов в графическом шаблоне](#ex-8)
18 |
19 |
20 | ## Основные понятия и определения
21 | * [Draw.io](https://app.diagrams.net/) - инструмент для рисования схем.
22 | * `Terraform развёртывание` - набор .tf файлов, которые определяют целевое состояние развёртываемой системы
23 | * `Атрибуты объектов` - описание переменных для соответствующих объектов в файле [variables.tf](./variables.tf)
24 | * `Графическое представление развёртывания` или `графический шаблон` - графическая параметризованная схема в формате Draw.io. Параметризация заключается в создании для графических объектов в Draw.io специальных атрибутов (переменных).
25 |
26 |
27 | ## Какую задачу решаем
28 | В настоящее время [Terraform](https://terraform.io) является самым известным инструментом для работы с инфраструктурой как с кодом `"Infrastructure as a Code" (IAC)`.
29 |
30 | Типовое развёртывание с помощью Terraform (`Terraform deployment`) обычно состоит из нескольких файлов с расширением `.tf`. Каждый такой файл может описывать свою часть целевого состояния системы, например:
31 | * [providers.tf](./providers.tf) - используемые TF-провайдеры и параметры для них
32 | * [variables.tf](./variables.tf) - описание входных переменных для развёртывания
33 | * [compute.tf](./compute.tf) - описание ресурсов сервиса compute
34 | * `vpc.tf` - описание сетевых ресурсов
35 | * и т.д.
36 |
37 | Степень и структура распределения TF-ресурсов по разным файлам зависит от проекта, здесь нет какого-то одного правильного пути.
38 | Можно описать весь проект в одном единственном большом .tf файле, например, `main.tf`, но управлять таким большими развёртыванием скорее всего будет сложно.
39 |
40 | В результате выполнения Terraform развёртывания в инфраструктуре создаются ресурсы (объекты).
41 | С помощью Terraform CLI можно посмотреть на перечень созданных ресурсов и оценить их состояние (`Terraform state`), однако, в Terraform отсутствуют встроенные инструменты для наглядного графического отображения структуры созданных ресурсов.
42 |
43 | Как правило, Terraform развёртывания статичны, то есть, при выполнении команды `terraform apply` всегда создаётся строго определенный набор объектов. Два разных развёртывания одного типа скорее всего будут отличаться друг от друга лишь значениями атрибутов создаваемых объектов - значениями переменных в файле [variables.tf](./variables.tf).
44 |
45 | Для решения задачи создания графического изображения одной и той же структуры объектов с разными значениями атрибутов (параметров) можно создать обобщённое графическое представление (шаблон), в котором изобразить все элементы структуры развёртывания данного типа (ресурсы и связи между ними) и передавать в этот шаблон значения атрибутов переменных, которые определяют конкретное развёртывание. В подобной логике работают многие известные шаблонизаторы в языках программирования, например, [Jinja](https://jinja.palletsprojects.com/) или [Go Template](https://pkg.go.dev/text/template)
46 |
47 | В нашем случае значения атрибутов (переменных) в такой графический шаблон будут передаваться из файла [variables.tf](./variables.tf). По завершении развёртывания (`terraform apply`) будет сгенерирована графическая схема в формате Draw.io для выполненного развёртывания со значениями атрибутов, которые были заданы в файле `variables.tf`.
48 |
49 |
50 | ## Методика - порядок действий
51 | Для реализации описанного выше подхода по созданию графического представления TF-развёртывания необходимо выполнить следующие действия:
52 | 1. Подготовить Terraform развёртывание (набор .tf файлов) в котором параметризовать все необходимые атрибуты TF-ресурсов в файле `variables.tf`.
53 | 2. Подготовить данные в Terraform для графического шаблона.
54 | 3. Подготовить (нарисовать) параметризованный графический шаблон развёртывания в Draw.io.
55 | 4. Интегрировать Terraform развёртывание с графическим шаблоном Draw.io.
56 | 5. Выполнить Terraform развёртывание.
57 | 6. Получить результат - графическое представление развёртывания в формате Draw.io.
58 |
59 |
60 | ## Практический пример - развёртывание ВМ в Yandex Cloud
61 | Рассмотрим применение вышеописанной методологии на примере создания виртуальной машины (ВМ) в Yandex Cloud.
62 |
63 | Список атрибутов (переменных), которые будут использоваться при развёртывании:
64 | * `cloud_id` - идентификатор облака, в котором будет создаваться ВМ
65 | * `folder_id` - идентификатор каталога, в котором будет создаваться ВМ
66 | * `image_family` - семейство образов из которого будет создаваться ВМ
67 | * `net_name` - идентификатор облачной сети, в которой будет создаваться ВМ
68 | * `subnet_name` - идентификатор облачной подсети, в которой будет создаваться ВМ
69 |
70 | Список атрибутов, которые будем использовать по результатам развёртывания:
71 | * `vm_priv_ip` - приватный IP адрес, который будет выделен ВМ при её создании
72 | * `vm_pub_ip` - публичный IP адрес, который будет выделен ВМ при её создании
73 |
74 | Предполагается, что все ресурсы (net,subnet,image) уже созданы до начала выполнения данного развёртывания.
75 |
76 | ### 1. Загрузить пример развёртывания из репозитория на github
77 | ```bash
78 | curl -s https://raw.githubusercontent.com/yandex-cloud/yc-architect-solution-library/master/drawio-tf-tutorial/install.sh | bash
79 | ```
80 |
81 | ### 2. Подготовить Terraform развёртывание
82 | * [variables.tf](./variables.tf)
83 | * [providers.tf](./providers.tf)
84 | * [compute.tf](./compute.tf)
85 |
86 | Инициализировать Terraform и проверить развёртывание на отсутствие ошибок
87 | ```bash
88 | cd drawio-tf-example
89 | source env-yc.sh
90 | terraform init
91 | terraform plan
92 | ```
93 |
94 | ### 3. Подготовить данные в Terraform для графического шаблона (drawio.tf)
95 | Для использования атрибутов объектов в графическом шаблоне необходимо сначала подготовить их на стороне Terraform. Делается это с помощью использования конструкции Terraform [locals](https://developer.hashicorp.com/terraform/language/values/locals).
96 |
97 | В TF развёртывании создаётся специальный файл [drawio.tf](./drawio.tf) в котором описывается набор атрибутов (параметров), значения которых будут передаваться в графический шаблон. Здесь мы определяем соответствие между названием атрибута и его реальным значением из TF развёртывания.
98 |
99 | При выполнении TF-кода в `drawio.tf` передаются следующие параметры:
100 | * имя файла с графическим шаблоном развёртывания - значение переменной `draw_template_name`
101 | * имя файла в котором будет сохраняться сгенерированная в TF диаграмма развёртывания в формате Draw.io - значение переменной `draw_name`.
102 |
103 | В результате все нужные для графического шаблона данные собираются на стороне TF в переменной `TF_DRAW_DATA`.
104 |
105 | Все вышеперечисленные параметры передаются на стороне Terraform в функцию [templatefile](https://developer.hashicorp.com/terraform/language/functions/templatefile) в которой и выполняется вставка подготовленных данных из переменной `TF_RAW_DATA` в подготовленный графический шаблон (*rendering*).
106 |
107 | Остаётся лишь указать место на диаграмме где нужно использовать тот или иной атрибут. Подробнее об этом в [разделе 5](#ex-5).
108 |
109 |
110 | ### 4. Подготовить (нарисовать) графический параметризованный шаблон развёртывания в Draw.io
111 | Перейти на сайт [Draw.io](https://app.diagrams.net) и нажать на кнопку "`Cоздать новую диаграмму`".
112 |
113 |
114 |
115 |
116 |
117 | При необходимости можно загрузить offline версию `Draw.io` для нужной платформы к себе на компьютер
118 | по [ссылке](https://github.com/jgraph/drawio-desktop/releases).
119 |
120 | Задать имя файла для диаграммы, её тип - `XML` и нажать на кнопку "`Сохранить`".
121 |
122 |
131 |
132 | В открывшейся форме отключить параметр "`Сжато`" (снять галочку), после чего нажать на кнопку "`Применить`". Это укажет Draw.io сохранять файлы в обычном текстовом (XML) виде без использовании ZIP сжатия.
133 |
134 |
135 |
136 |
137 |
138 | Нарисовать с помощью геометрических примитивов нужную нам схему. В примере ниже нарисован прямоугольник со скруглёнными краями, который будет обозначать у нас облако в Yandex Cloud.
139 |
140 | Для добавления на схему значений атрибутов (параметров) для облака нужно выбрать в верхнем меню знак "`+ (плюс)`" и выбрать в выпадающем меню пункт "`Текст`".
141 |
142 |
143 |
144 |
145 |
146 | В области диаграммы синим пунктиром выделится область экрана со значением Text в которую нужно ввести текст. Текст атрибутов объекта можно вводить в формате `[Метка] <%имя-переменной%>`, где
147 | * `метка` - любой поясняющий текст. Использование меток опционально (можно не использовать).
148 | * `%имя-атрибута%` - это имя переменной, определённой в конструкции `locals` файла [drawio.tf](./drawio.tf). Имя переменной всегда должно обрамляться с двух сторон символом `%` (процент).
149 |
150 | В примере ниже метка это текст "`cloud = `", а имя переменной это текст между символами процента, то есть "`cloud_id`".
151 |
152 |
153 |
154 |
155 |
156 | Выбираем объект с ранее написанным текстом "`cloud id = %cloud_id%`", нажимаем правую кнопку мыши, и в открывшемся контекстном меню выбираем "`Редактировать данные`". Для быстрого перехода в этот режим можно также использовать горячие клавиши `Cmd+M/Ctrl+M`.
157 |
158 |
159 |
160 |
161 |
162 | В открывшейся форме внизу нужно поставить галочку в параметре "`Плейсхолдеры (Placeholders)`" и нажать на кнопку "`Применить`".
163 |
164 |
165 |
166 |
167 |
168 | В результате объект облако с атрибутом "`cloud_id`" может выглядеть так:
169 |
170 |
171 |
172 |
173 |
174 | Продолжим рисовать нужную нам графическую структуру Terraform развёртывания на диаграмме и добавлять новые атрибуты объектов. Стоит отметить, что атрибуты объектов всегда следует добавлять на уровне области листа рисования, а не на уровне отдельного объекта на листе. Это позволяет Draw.IO хранить атрибуты всех объектов в одном месте. Результат рисования может выглядеть, например, так:
175 |
176 |
177 |
178 |
179 |
180 | На схеме мы видим следующие объекты и их атрибуты:
181 | * `Cloud` с атрибутом `cloud_id`
182 | * `Folder` с атрибутом `folder_id`
183 | * `VM` с атрибутами:
184 | - `vm_name` - имя виртуальной машины (ВМ)
185 | - `subnet_name` - название подсети к которой подключится ВМ при создании
186 | - `vm_priv_name` - приватный IP адрес, который выделится ВМ при создании
187 | - `vm_pub_name` - публичный IP адрес, который выделится ВМ при создании
188 |
189 |
190 | ### 5. Интегрировать Terraform развёртывание с графическим шаблоном Draw.io
191 | После создания графического шаблона необходимо выполнить его интеграцию с Terraform развёртыванием. Для этого в нужном месте XML файла шаблона нужно добавить ссылку на переменную `TF_RAW_DATA`.
192 |
193 | Для внесения изменений нужно открыть файл с шаблоном в любом текстовом редакторе, и выполнить операцию поиска и замены:
194 | * Ищем строку `
115 | 
124 | 
130 | 
136 | 
144 | 
154 | 
160 | 
166 | 
172 | 
178 |