terravision

تيرافيجن

TerraVision هي أداة CLI تقوم بتحويل كود Terraform إلى مخططات احترافية للهندسة السحابية وتحل مشكلة الحفاظ على أهم مستند في المشاريع السحابية، وهو مستند الهندسة، محدثًا. مع إطلاق السرعة العالية كالمعتاد الآن، أصبحت المخططات المعمارية المولدة آليًا أكثر دقة من الاعتماد على المخطط الحر الذي رسمه مهندس السحابة والذي لم يعد يتطابق مع الواقع. تعمل Terravision بشكل آمن على جانب العميل بنسبة 100% دون أي اعتماد على Terraform أو الوصول إلى البيئة السحابية الخاصة بك، لتحليل الموارد والمتغيرات التي تم إنشاؤها بشكل مشروط ديناميكيًا وإنشاء صورة مرئية تلقائية للبنية الخاصة بك. تم تصميم Terravision لتكون أداة "Docs as Code" (DaC) التي يمكن تضمينها في مسار CI/CD الخاص بك لتحديث المخططات المعمارية بعد مراحل مسار الإنشاء/الاختبار/الإصدار وتكملة مولدات المستندات الأخرى مثل readthedocs.io بجانبها. وهو يدعم حاليًا AWS وقريبًا Google وAzure cloud.

تحويل هذا...

في هذا...

لا يزال هذا البرنامج في اختبار ألفا ويتم مشاركة التعليمات البرمجية "كما هي"، دون ضمانات أو شروط من أي نوع ، سواء كانت صريحة أو ضمنية. استخدم على مسؤوليتك الخاصة.

فوائد Terravision

1. يكلف
   • حفظ تراخيص برامج Visio/الرسم - Terravision مجاني ومفتوح المصدر
   • لا يتطلب تشغيل الموارد السحابية أي تكلفة، فهو يعمل على الفور من جهازك المحلي
   • لا يعد التحديث المنتظم للمخططات ومحاذاة النقاط وربط النقاط ووضع الأيقونات أفضل استخدام لتكاليف موظفي المهندس المعماري لديك
2. تسريع وأتمتة
   • استخدم ملفات TF المتغيرة كمدخلات لإنشاء مخططات متغيرة متعددة من نفس كود TF
   • أتمتة إنشاء الرسوم البيانية للهندسة المعمارية عن طريق تشغيل terravision كجزء من خطوط أنابيب CI/CD
   • تتيح لك المخططات المستندة إلى YAML كرمز إضافة تعليقات توضيحية إلى المخططات التي تم إنشاؤها باستخدام تسميات وموارد مخصصة إضافية، على سبيل المثال الموارد غير المُدارة أو الأنظمة الخارجية التي لم يتم التقاطها في كود TF
3. الاتساق عبر المنظمة
   • يقوم تلقائيًا بتنزيل الوحدات التنظيمية / الخارجية الخاصة بك لضمان أحدث عرض لوحدات Terraform النهائية
   • تصميم متسق للمخططات المعمارية باستخدام الرموز القياسية الصناعية وأسلوب AWS/GCP/Azure المعتمد عبر الفرق
4. رؤية دقيقة
   • تُظهر حالة الرسم البياني في الوقت الفعلي البنية التحتية الحالية التي تتطابق تمامًا مع ما يتم نشره في الإنتاج اليوم
   • يساعد في مراجعات بنية الطرف الثالث، والتدقيق، والمراقبة، وإعداد التقارير، وتصحيح الأخطاء للمكدس بطريقة مرئية
   • يمكن وضع كود الرسم التخطيطي المخصص وصور الإخراج في التحكم في المصدر/الإصدار لتحسين قابلية الصيانة والاكتشاف
5. حماية
   • لا تحتاج إلى منح حق الوصول إلى حساب AWS الخاص بك أو واجهة سطر الأوامر (CLI) لرسم المخطط
   • لا يُنشئ موارد سحابية متطفلة، مثل مثيلات المسح أو جداول البيانات التعريفية التي ستحتاج المؤسسات إلى الموافقة عليها
   • تظل جميع التعليمات البرمجية المصدر في بيئتك المحلية، ويتم إنشاء الرسوم البيانية على أجهزتك دون استدعاء واجهات برمجة التطبيقات الخارجية

التثبيت والاستخدام

التبعيات الخارجية لجميع الإصدارات

• جراففيز https://graphviz.org/download/
• جيت https://git-scm.com/downloads
• تيرافورم https://developer.hashicorp.com/terraform/downloads

بداية سريعة

1. قم بتثبيت كافة التبعيات الخارجية كما هو مذكور أعلاه
2. استنساخ الريبو git clone https://github.com/patrickchugh/terravision.git
3. احصل على دليل العمل (المسار الكامل) عن طريق القيام cd terravision والقيام بـ pwd .
4. أضف مجلد terravision إلى قيمة PATH الخاصة بك، على سبيل المثال، export PATH=$PATH:/Users/<PATH TO TERRAVISION> حتى تتمكن من تشغيله من أي مكان. <PATH TO TERRAVISION> سيكون الناتج من السطر 3.
5. تثبيت متطلبات بايثون cd terravision && pip install -r requirements.txt
6. تأكد من أن البرنامج النصي terravision python الخاص بك قابل للتنفيذ باستخدام chmod +x terravision
7. قم بتشغيل terravision وحدد ملفات مصدر Terraform بالتنسيق:

$ terravision draw --source ~ /src/my-terraform-code

بالنسبة لحزم Terraform التي تحتوي على مساحات عمل، يمكنك استخدام المعلمة --workspace :

$ terraform draw --source ~ /src/my-terraform-code --workspace development

بالنسبة إلى كود مصدر Terraform في Git repo، يمكنك أيضًا استخدام النموذج:

$ terravision draw --source https://github.com/your-repo/terraform-examples.git

استخدم الحرف // للمجلدات الفرعية داخل Git repos إذا كان الكود الذي تريده موجودًا ضمن التسلسل الهرمي للمجلدات.

$ terravision draw --source https://github.com/your-repo/terraform-examples.git//mysubfolder/secondfolder/

شرح الرسوم البيانية التي تم إنشاؤها

لن يحتوي أي مخطط تم إنشاؤه تلقائيًا على كل التفاصيل التي تحتاجها، وفي أفضل الأحوال سيوصلك إلى 80-90% من الطريق إلى هناك. لإضافة تعليقات توضيحية مخصصة مثل عنوان الرسم التخطيطي الرئيسي أو تسميات إضافية على الأسهم أو موارد إضافية تم إنشاؤها خارج Terraform، قم بتضمين ملف terravision.yml في مجلد التعليمات البرمجية المصدر وسيتم تحميله تلقائيًا. وبدلاً من ذلك، حدد مسارًا لملف التعليقات التوضيحية كمعلمة للمراقبة.

terravision --source https://github.com/your-repo/terraform-examples.git --annotate /Users/me/MyDocuments/annotations.yml

ملف .yml هو ملف تكوين YAML قياسي يشبه المثال أدناه مع عنوان واحد أو أكثر يسمى title أو connect أو disconnect أو add remove أو update . تتبع أسماء العقد نفس الاصطلاحات مثل أسماء موارد Terraform https://registry.terraform.io/providers/hashicorp/aws/latest/docs وتدعم أحرف البدل. يمكنك إضافة تسمية مخصصة إلى أي مورد TF عن طريق تعديل سمات المورد وإضافة سمة label (غير موجودة في Terraform). بالنسبة للخطوط/الاتصالات، يمكنك تعديل سمات المورد عن طريق إضافة edge_labels محددة للمنطقة لإضافة نص إلى خط الاتصال إلى عقدة مورد محددة. انظر المثال أدناه:

 format : 0.1
# Main Diagram heading
title : Serverless Wordpress Site
# Draw new connection lines that are not apparent from the Terraforms
connect :
  aws_rds_cluster.this :
    - aws_ssm_parameter.db_master_user : Retrieve credentials from SSM
# Remove connections between nodes that are currently shown
disconnect :
  # Wildcards mean these disconnections apply to any cloudwatch type resource called logs
  aws_cloudwatch*.logs :
    - aws_ecs_service.this
    - aws_ecs_cluster.this
# Delete the following nodes
remove :
  - aws_iam_role.task_execution_role
# Add the following nodes
add :
  aws_subnet.another_one :
    # Specify Terraform attributes for a resource like this 
    cidr_block : " 123.123.1.1 "
# Modify attributes of existing node
update :
  aws_ecs_service.this :
    # Add custom labels to the connection lines that already exist between ECS->RDS
    edge_labels :
      - aws_rds_cluster.this : Database Queries
  # Wildcards save you listing multiple resources of the same type. This edge label is added to all CF->ACM connections.
  aws_cloudfront* :
    edge_labels :
      - aws_acm_certificate.this : SSL Cert
 # Add a custom label to a resource node. Overrides default label
  aws_ecs_service.this :
   label : " My Custom Label "

مساعدة مفصلة

اكتب terravision --help للحصول على قائمة الأوامر الكاملة أو للمساعدة في أمر محدد