terravision 다운로드 - terravision 소스 코드 다운로드

terravision

기타 소스코드

1.0.0

다운로드

테라비전

TerraVision은 Terraform 코드를 전문 클라우드 아키텍처 다이어그램으로 변환하고 클라우드 프로젝트에서 가장 중요한 문서인 아키텍처 문서를 최신 상태로 유지하는 문제를 해결하는 CLI 도구입니다. 이제 고속 릴리스가 표준이 되면서 기계 생성 아키텍처 다이어그램은 더 이상 현실과 일치하지 않는 클라우드 설계자가 그린 자유형 다이어그램에 의존하는 것보다 더 정확합니다. Terravision은 Terraform에 대한 의존성이나 클라우드 환경에 대한 액세스 없이 100% 클라이언트측을 안전하게 실행하여 조건에 따라 생성된 리소스와 변수를 동적으로 구문 분석하고 아키텍처의 자동 시각화를 생성합니다. Terravision은 빌드/테스트/릴리스 파이프라인 단계 후 아키텍처 다이어그램을 업데이트하고 readthedocs.io와 같은 다른 문서 생성기를 함께 보완하기 위해 CI/CD 파이프라인에 포함될 수 있는 'Docs as Code'(DaC) 도구로 설계되었습니다. 현재 AWS를 지원하고 곧 Google 및 Azure 클라우드를 지원합니다.

이걸 돌려...

Terraform Code

이것에...

이 소프트웨어는 아직 알파 테스트 중이며 코드는 명시적이든 묵시적이든 어떠한 종류의 보증이나 조건도 없이 "있는 그대로" 공유됩니다 . 자신의 책임하에 사용하십시오.

테라비전의 장점

비용
- Visio/드로잉 소프트웨어 라이선스 저장 - Terravision은 무료이며 오픈 소스입니다.
- 클라우드 리소스를 가동하는 데 비용이 발생하지 않으며 로컬 시스템에서 즉시 작동합니다.
- 다이어그램을 정렬하고, 점을 연결하고, 아이콘을 배치하는 작업을 정기적으로 업데이트하는 것은 건축가 직원 비용을 최대한 활용하는 것이 아닙니다.
가속화 및 자동화
- TF 변수 파일을 입력으로 사용하여 동일한 TF 코드에서 여러 변형 다이어그램 만들기
- CI/CD 파이프라인의 일부로 Terravision을 실행하여 아키텍처 다이어그램 생성을 자동화합니다.
- YAML 기반 다이어그램을 코드로 사용하면 생성된 다이어그램에 추가 사용자 지정 레이블 및 리소스(예: 관리되지 않는 리소스 또는 TF 코드에 캡처되지 않은 외부 시스템)로 주석을 달 수 있습니다.
조직 전체의 일관성
- 다운스트림 Terraform 모듈의 최신 보기를 보장하기 위해 조직/외부 모듈을 자동으로 다운로드합니다.
- 팀 전체에서 업계 표준 아이콘과 AWS/GCP/Azure 승인 스타일을 사용하여 아키텍처 다이어그램의 일관된 디자인
정확한 가시성
- 다이어그램의 실시간 상태는 현재 프로덕션에 배포된 것과 정확히 일치하는 현재 인프라를 보여줍니다.
- 시각적인 방식으로 스택의 타사 아키텍처 검토, 감사, 모니터링, 보고 및 디버깅을 지원합니다.
- 더 나은 유지 관리 및 검색 가능성을 위해 사용자 정의 다이어그램 코드 및 출력 이미지를 소스/버전 제어에 넣을 수 있습니다.
보안
- 다이어그램을 그리기 위해 AWS 계정이나 CLI에 대한 액세스 권한을 부여할 필요가 없습니다.
- 기업이 승인해야 하는 인스턴스나 메타데이터 테이블을 스캔하는 등 침입적인 클라우드 리소스를 생성하지 않습니다.
- 모든 소스 코드는 로컬 환경에 유지되며 외부 API를 호출하지 않고도 시스템에서 다이어그램이 생성됩니다.

설치 및 사용법

모든 버전에 대한 외부 종속성

그래프비즈 https://graphviz.org/download/
자식 https://git-scm.com/downloads
테라폼 https://developer.hashicorp.com/terraform/downloads

빠른 시작

위에 나열된 대로 모든 외부 종속성을 설치합니다.
저장소 git clone https://github.com/patrickchugh/terravision.git 복제
cd terravision 및 pwd 수행하여 작업 디렉터리(전체 경로)를 가져옵니다.
PATH 값에 terravision 폴더를 추가하세요(예: export PATH=$PATH:/Users/<PATH TO TERRAVISION> . 그러면 어디에서나 실행할 수 있습니다. <PATH TO TERRAVISION> 은 3행의 출력입니다.
Python 요구 사항 설치 cd terravision && pip install -r requirements.txt
chmod +x terravision 사용하여 Terravision Python 스크립트를 실행할 수 있는지 확인하세요.
terravision 실행하고 Terraform 소스 파일을 다음 형식으로 지정합니다.

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

작업공간이 있는 Terraform 스택의 경우 --workspace 매개변수를 사용할 수 있습니다.

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

Git 저장소의 Terraform 소스 코드의 경우 다음 형식을 사용할 수도 있습니다.

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

원하는 코드가 폴더 계층 구조 아래에 있는 경우 Git 저장소 내의 하위 폴더에 // 문자를 사용하세요.

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

생성된 다이어그램에 주석 달기

자동으로 생성된 다이어그램에는 필요한 모든 세부 정보가 포함되어 있지 않으며 기껏해야 80-90% 정도만 얻을 수 있습니다. 기본 다이어그램 제목, 화살표의 추가 레이블 또는 Terraform 외부에서 생성된 추가 리소스와 같은 사용자 정의 주석을 추가하려면 소스 코드 폴더에 terravision.yml 파일을 포함하면 자동으로 로드됩니다. 또는 주석 파일의 경로를 terravision에 대한 매개변수로 지정합니다.

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

.yml 파일은 title , connect , disconnect , add , remove 또는 update 라는 제목이 하나 이상 포함된 아래 예제와 유사한 표준 YAML 구성 파일입니다. 노드 이름은 Terraform 리소스 이름(https://registry.terraform.io/providers/hashicorp/aws/latest/docs)과 동일한 규칙을 따르고 와일드카드를 지원합니다. 리소스 속성을 수정하고 label 속성(Terraform에는 없음)을 추가하여 모든 TF 리소스에 사용자 지정 레이블을 추가할 수 있습니다. 라인/연결의 경우 특정 리소스 노드에 대한 연결 라인에 텍스트를 추가하기 위해 terravision 특정 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 "