terravision

TerraVision

TerraVision adalah alat CLI yang mengubah kode Terraform menjadi Diagram Arsitektur Cloud Profesional dan memecahkan masalah dalam menjaga dokumen terpenting dalam proyek cloud, dokumen arsitektur, tetap mutakhir. Dengan rilis kecepatan tinggi yang menjadi norma sekarang, diagram arsitektur yang dihasilkan mesin lebih akurat daripada mengandalkan diagram gaya bebas yang digambar oleh arsitek cloud yang tidak lagi sesuai dengan kenyataan. Terravision dengan aman menjalankan 100% Sisi Klien tanpa ketergantungan apa pun pada Terraform atau akses ke lingkungan Cloud Anda, untuk secara dinamis mengurai sumber daya dan variabel yang dibuat secara kondisional dan menghasilkan visual otomatis arsitektur Anda. Terravision dirancang untuk menjadi alat 'Docs as Code' (DaC) yang dapat disertakan dalam pipeline CI/CD Anda untuk memperbarui diagram arsitektur setelah fase pipeline build/test/release dan melengkapi pembuat dokumen lain seperti readthedocs.io di sampingnya. Saat ini Mendukung AWS dan segera Google dan Azure cloud.

Putar ini...

ke dalam ini...

Perangkat lunak ini masih dalam pengujian alfa dan kode dibagikan "APA ADANYA", TANPA JAMINAN ATAU KETENTUAN APAPUN , baik tersurat maupun tersirat. Gunakan dengan risiko Anda sendiri.

Manfaat Terravision

1. Biaya
   • Simpan lisensi perangkat lunak Visio/Gambar - Terravision gratis dan open source
   • Tidak memerlukan biaya apa pun yang menimbulkan sumber daya cloud untuk dijalankan, ini berfungsi langsung dari mesin lokal Anda
   • Memperbarui diagram penyelarasan, menghubungkan titik-titik, dan menata ikon secara teratur bukanlah penggunaan terbaik dari biaya staf arsitek Anda
2. Mempercepat dan Mengotomatiskan
   • Gunakan file variabel TF sebagai input untuk membuat beberapa diagram varian dari kode TF yang sama
   • Otomatiskan pembuatan diagram arsitektur dengan menjalankan terravision sebagai bagian dari pipeline CI/CD
   • Diagram berbasis YAML sebagai kode memungkinkan Anda memberi anotasi pada diagram yang dihasilkan dengan label dan sumber daya khusus tambahan, misalnya sumber daya yang tidak dikelola atau sistem eksternal yang tidak ditangkap dalam kode TF
3. Konsistensi di seluruh organisasi
   • Unduh otomatis modul organisasi/eksternal Anda untuk memastikan tampilan terbaru modul Terraform hilir
   • Desain diagram arsitektur yang konsisten menggunakan ikon standar industri dan gaya yang disetujui AWS/GCP/Azure di seluruh tim
4. Visibilitas Akurat
   • Diagram keadaan waktu nyata menunjukkan infrastruktur saat ini yang sama persis dengan apa yang diterapkan dalam produksi saat ini
   • Membantu dalam peninjauan arsitektur pihak ketiga, audit, pemantauan, pelaporan, dan debugging tumpukan secara visual
   • Kode Diagram Kustom dan gambar keluaran dapat dimasukkan ke dalam kontrol sumber/versi untuk kemudahan pemeliharaan dan penemuan yang lebih baik
5. Keamanan
   • Tidak perlu memberikan akses ke akun AWS atau CLI Anda untuk menggambar diagram
   • Tidak membuat sumber daya cloud yang mengganggu, misalnya instans pemindaian atau tabel metadata yang perlu disetujui oleh perusahaan
   • Semua kode sumber tetap berada di lingkungan lokal Anda, diagram dibuat di mesin Anda tanpa memanggil API eksternal

Instalasi dan Penggunaan

Ketergantungan Eksternal untuk semua versi

• graphviz https://graphviz.org/download/
• git https://git-scm.com/downloads
• terraform https://developer.hashicorp.com/terraform/downloads

Mulai cepat

1. Instal semua dependensi eksternal seperti yang tercantum di atas
2. Kloning repo git clone https://github.com/patrickchugh/terravision.git
3. Dapatkan direktori kerja (path lengkap) dengan melakukan cd terravision dan melakukan pwd .
4. Tambahkan folder terravision ke nilai PATH Anda misalnya export PATH=$PATH:/Users/<PATH TO TERRAVISION> sehingga Anda dapat menjalankannya dari mana saja. <PATH TO TERRAVISION> akan menjadi output dari baris 3.
5. Instal persyaratan python cd terravision && pip install -r requirements.txt
6. Pastikan skrip python terravision Anda dapat dieksekusi dengan chmod +x terravision
7. Jalankan terravision dan tentukan file sumber Terraform Anda dalam format:

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

Untuk tumpukan Terraform dengan ruang kerja, Anda dapat menggunakan parameter --workspace :

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

Untuk kode sumber Terraform di repo Git Anda juga dapat menggunakan formulir:

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

Gunakan karakter // untuk subfolder dalam repo Git jika kode yang Anda inginkan berada di bawah hierarki folder.

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

Menganotasi diagram yang dihasilkan

Tidak ada diagram yang dibuat secara otomatis yang memiliki semua detail yang Anda butuhkan, paling banter diagram tersebut akan membantu Anda mencapai 80-90%. Untuk menambahkan anotasi khusus seperti judul diagram utama, label tambahan pada panah, atau sumber daya tambahan yang dibuat di luar Terraform Anda, sertakan file terravision.yml di folder kode sumber dan file tersebut akan dimuat secara otomatis. Alternatifnya, tentukan jalur ke file anotasi sebagai parameter terravision.

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

File .yml adalah file konfigurasi YAML standar yang mirip dengan contoh di bawah ini dengan satu atau lebih judul yang disebut title , connect , disconnect , add , remove atau update . Nama node mengikuti konvensi yang sama dengan nama sumber daya Terraform https://registry.terraform.io/providers/hashicorp/aws/latest/docs dan mendukung wildcard. Anda dapat menambahkan label khusus ke sumber daya TF apa pun dengan mengubah atribut sumber daya dan menambahkan atribut label (tidak ada di Terraform). Untuk jalur/koneksi, Anda dapat mengubah atribut sumber daya dengan menambahkan edge_labels khusus terravision untuk menambahkan teks ke jalur koneksi ke node sumber daya tertentu. Lihat contoh di bawah ini:

 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 "

Bantuan terperinci

Ketik terravision --help untuk daftar perintah lengkap atau untuk bantuan dengan perintah tertentu