Skip to main content

Terraform 状态

在本例中，您将创建一个 terraformResource 和 tarraformOutput 蓝图，该蓝图将使用 Port'sAPI 和webhook functionality 的组合来引用 terraform.tfstate 文件中的所有资源和输出。

要将资源引用到 Port，需要使用一个脚本，根据 webhook 配置发送资源信息并输出。

先决条件​

创建以下蓝图定义和 webhook 配置:

Terraform resources blueprint
{
  "identifier": "terraformResource",
  "description": "This blueprint represents a Terraform resource in our software catalog",
  "title": "Terraform Resources",
  "icon": "Terraform",
  "schema": {
    "properties": {
      "mode": {
        "type": "string",
        "title": "Mode",
        "default": "data",
        "enum": ["data", "managed", "module", "import", "state"]
      },
      "module": {
        "type": "string",
        "title": "Module"
      },
      "type": {
        "title": "Type",
        "type": "string"
      },
      "provider": {
        "title": "Provider",
        "type": "string"
      },
      "instances": {
        "title": "Instances",
        "type": "array"
      },
      "lineage": {
        "title": "Lineage",
        "type": "string"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "relations": {}
}
Terraform outputs blueprint
{
  "identifier": "terraformOutput",
  "title": "Terraform Output",
  "description": "This blueprint represents a Terraform output in our software catalog",
  "icon": "Terraform",
  "schema": {
    "properties": {
      "type": {
        "title": "Type",
        "type": "string"
      },
      "value": {
        "title": "Value",
        "type": "string"
      },
      "sensitive": {
        "title": "Sensitive",
        "type": "boolean",
        "default": false
      },
      "description": {
        "title": "Description",
        "type": "string"
      },
      "lineage": {
        "title": "Lineage",
        "type": "string"
      }
    },
    "required": []
  },
  "mirrorProperties": {},
  "calculationProperties": {},
  "aggregationProperties": {},
  "relations": {}
}
Terraform resources webhook configuration
{
  "identifier": "terraformResourceMapper",
  "title": "Terraform Resources Mapper",
  "description": "A webhook configuration to map Terraform tfstate file",
  "icon": "Terraform",
  "mappings": [
    {
      "blueprint": "terraformOutput",
      "filter": ".body | has(\"outputs\")",
      "itemsToParse": ".body.outputs",
      "entity": {
        "identifier": ".item.name | tostring",
        "title": ".item.name | tostring",
        "properties": {
          "description": ".item.description",
          "sensitive": ".item.sensitive",
          "type": ".item.type",
          "value": ".item.value",
          "lineage": ".body.lineage"
        }
      }
    },
    {
      "blueprint": "terraformResource",
      "filter": ".body | has(\"resources\")",
      "itemsToParse": ".body.resources",
      "entity": {
        "identifier": ".item.id",
        "title": ".item.name",
        "properties": {
          "mode": ".item.mode",
          "module": ".item.module",
          "type": ".item.type",
          "provider": ".item.provider",
          "instances": ".item.instances",
          "lineage": ".body.lineage"
        }
      }
    }
  ],
  "enabled": true,
  "security": {}
}

使用 Port 的 API 和 Bash 脚本​

下面的示例片段展示了如何使用 Python 和 Bash 将 Port 的 API 和 Webhook 与现有管道集成:

在版本库中创建以下 Python 脚本，以创建或更新 Port 实体，作为管道的一部分:

Python script example 
import requests
import json
import os

# Get environment variables using the config object or os.environ["KEY"]
WEBHOOK_URL = os.environ['WEBHOOK_URL'] ## the value of the URL you receive after creating the Port webhook
PATH_TO_TERRAFORM_TFSTATE_FILE = os.environ['PATH_TO_TERRAFORM_TFSTATE_FILE']

def add_entity_to_port(entity_object):
    """A function to create the passed entity in Port using the webhook URL

    Params
    --------------
    entity_object: dict
        The entity to add in your Port catalog

    Returns
    --------------
    response: dict
        The response object after calling the webhook
    """
    headers = {"Accept": "application/json"}
    response = requests.post(WEBHOOK_URL, json=entity_object, headers=headers)
    return response.json()

def parse_tf_outputs(output_data):
    tf_outputs = []
    for output_name, output_info in output_data.items():
        output_type = type(output_info.get("value")).__name__
        tf_outputs.append({
            'name': output_name,
            'description': output_info.get("description"),
            'type': output_type,
            'sensitive': output_info.get('sensitive'),
            'value': str(output_info.get('value'))
        })
    return tf_outputs

def parse_tf_resources(resources):
    tf_resources = []
    index = 1
    for resource in resources:
        resource_id = f"tf-rs-{index}"
        tf_resources.append({
            'name': resource.get('name'),
            'mode': resource.get('mode'),
            'module': resource.get('module'),
            'type': resource.get('type'),
            'provider': resource.get('provider'),
            'instances': resource.get('instances'),
            'id': resource_id
        })
        index+=1
    return tf_resources

def read_tfstate_file(tfstate_json_path):
    """This function takes a tfstate_json_path file path, converts the resources and outputs property into a
    JSON array and then sends the data to Port

    Params
    --------------
    tfstate_json_path: str
        The path to the terraform.tfstate file relative to the project's root folder

    Returns
    --------------
    response: dict
        The response object after calling the webhook
    """
    with open(tfstate_json_path) as file:
        data = json.load(file)

    resources = data.get('resources', [])
    outputs = data.get('outputs', {})
    lineage = data.get('lineage')

    tf_resources = parse_tf_resources(resources)
    tf_outputs = parse_tf_outputs(outputs)

    entity_object = {
        "resources": tf_resources,
        "outputs": tf_outputs,
        "lineage": lineage
    }
    webhook_response = add_entity_to_port(entity_object)
    return webhook_response

response = read_tfstate_file(PATH_TO_TERRAFORM_TFSTATE_FILE)
print(response)