peerd 项目教程

peerd 项目教程

peerd peerd is an AWS VPC Peering Connection management tool. It creates full-meshes of VPCs from a yaml file, and manages the full lifecycle of creation, deletion and route table updates needed to make VPC peerings useful across accounts and regions. Contributions welcome. 项目地址: https://gitcode.com/gh_mirrors/pe/peerd

1. 项目的目录结构及介绍

peerd/
├── config/
│   └── config.yaml
├── peerd/
│   └── peerd.py
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

• config/: 存放项目的配置文件 config.yaml。
• peerd/: 存放项目的主要代码文件 peerd.py。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

peerd/peerd.py 是项目的启动文件，负责管理 AWS VPC 对等连接的创建、删除和路由表更新。以下是该文件的主要功能：

• 命令行参数解析: 支持 --debug、--config、--environment 等参数。
• VPC 对等连接管理: 根据配置文件创建和管理 VPC 对等连接。
• 路由表更新: 自动更新 VPC 路由表以确保对等连接的有效性。

使用示例：

python3 peerd/peerd.py --config /path/to/config.yaml --environment myfirstenvironment

3. 项目的配置文件介绍

config/config.yaml 是项目的主要配置文件，用于定义 VPC 对等连接的配置。以下是配置文件的主要结构：

metadata:
  resource_owner: "myname"
  business_unit: "PaaS"
  service_name: "peerd"
  support: "network-team@acme.org"
  common_principal_name: "peerd-bot"
  role_session_name: "peerd"

environments:
  myfirstenvironment:
    - account_id: "415433457294"
      vpc_id: "vpc-bi37c2c47"
      region: "ap-southeast-2"
      note: "peerd test vpc1"
      cidr_overrides:
        - "192.168.4.0/24"
      peering_tags:
        my_custom_taga: "0"
    - account_id: "415433457294"
      vpc_id: "vpc-vb787854"
      region: "ap-southeast-2"
      note: "peerd test vpc2"
      cidr_overrides:
        - "10.53.101.32/27"
        - "10.53.128.128/25"
        - "192.168.2.0/24"
        - "2.2.2.0/24"
      peering_tags:
        my_custom_tagb: "1"

• metadata: 包含项目的元数据，如 resource_owner、business_unit 等。
• environments: 定义不同的环境配置，每个环境包含多个 VPC 配置。
  • account_id: VPC 所在的 AWS 账户 ID。
  • vpc_id: VPC 的 ID。
  • region: VPC 所在的 AWS 区域。
  • note: 自由格式的备注信息。
  • cidr_overrides: 覆盖 VPC 的 CIDR 范围。
  • peering_tags: 应用于 VPC 对等连接的自定义标签。

通过配置文件，peerd 可以管理多个 AWS 账户和区域中的 VPC 对等连接，确保网络的连通性和安全性。

peerd peerd is an AWS VPC Peering Connection management tool. It creates full-meshes of VPCs from a yaml file, and manages the full lifecycle of creation, deletion and route table updates needed to make VPC peerings useful across accounts and regions. Contributions welcome. 项目地址: https://gitcode.com/gh_mirrors/pe/peerd