Skip to content

Latest commit

 

History

History
97 lines (82 loc) · 2.39 KB

links.md

File metadata and controls

97 lines (82 loc) · 2.39 KB

Links

Links are lines that show relationships between resources. Currently supports a straight line between resources.

Link position

The start and end points of the line specify the location as the 16-wind rose of the resource (for example, NNW).

position

Diagrams:
  Resources:
    ALB: ...
    PublicSubnet1Instance: ...
    PublicSubnet2Instance: ...
  Links:
    - Source: ALB # (required)
      SourcePosition: NNW # (required)
      Target: PublicSubnet1Instance # (required)
      TargetPosition: S # (required)
    - Source: ALB # (required)
      SourcePosition: NNE # (required)
      Target: PublicSubnet2Instance # (required)
      TargetPosition: S # (required)
      LineWidth: 1 # (optional)
      LineColor: 'rgba(255,255,255,255)' # (optional)

Link type

Straight

straight link

  Links:
    - Source: StraightLambda
      SourcePosition: N
      Target: StraightBucket
      TargetPosition: W
      TargetArrowHead:
        Type: Open

Orthogonal

orthogonal link

  Links:
      # Orthogonal (single-arm)
    - Source: Orthogonal1Lambda
      SourcePosition: N
      Target: Orthogonal1Bucket
      TargetPosition: W
      TargetArrowHead:
        Type: Open
      Type: orthogonal

      # Orthogonal (double-arm)
    - Source: Orthogonal2Lambda
      SourcePosition: E
      Target: Orthogonal2Bucket
      TargetPosition: W
      TargetArrowHead:
        Type: Open
      Type: orthogonal

      # Orthogonal (double-arm)
    - Source: Orthogonal3Lambda
      SourcePosition: E
      Target: Orthogonal3Bucket
      TargetPosition: E
      TargetArrowHead:
        Type: Open
      Type: orthogonal

Arrow head

Arrows add context and meaning to a diagram by indicating the direction of flow.

arrow head (generated from static/arrows.yaml)

    - Source: ALB
      SourcePosition: NNW
      SourceArrowHead: #(optional)
        Type: Open #(required) Open/Default
        Width: Default #  (optional) Narrow/Default/Wide default="Default"
        Length: 2 # (optional) default=2
      Target: VPCPublicSubnet1Instance
      TargetPosition: SSE
      TargetArrowHead: #(optional)
        Type: Open #(required) Open/Default
        Width: Default #  (optional) Narrow/Default/Wide default="Default"
        Length: 2 # (optional) default=2