Skip to content

DNS filters/actions/UTs develop #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

DNS filters/actions/UTs develop #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
9ac72d1
Add files via upload
franklwy Apr 3, 2025
beb1663
merge branch '04171849'
Apr 7, 2025
8489ee1
Changes set-config
Apr 8, 2025
21dfe62
Merge pull request #7 from franklwy/feature/Kakfa
franklwy Apr 8, 2025
9a55fea
delete import
Apr 8, 2025
ee771ff
rename set_config
Apr 8, 2025
b08de7c
Merge pull request #8 from franklwy/feature/Kakfa
franklwy Apr 8, 2025
bd03d66
Feature/dns (#9)
franklwy Apr 11, 2025
e1d7b42
Merge branch 'main' of github.com:huaweicloud/cloud-custodian
Apr 11, 2025
f9b5a61
Merge branch 'huaweicloud:main' into main
franklwy Apr 17, 2025
b6e58ad
Feature/dns (#10)
franklwy Apr 17, 2025
fd6807e
Merge branch 'main' into main
franklwy Apr 22, 2025
16d6dbc
Create readme_dns.md
franklwy Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 97 additions & 0 deletions readme_dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
# 华为云DNS服务适配Cloud Custodian文档

## 1. 华为云DNS资源类型

华为云DNS服务主要涉及以下资源类型，对应AWS Route53的相关资源：

- `huaweicloud.dns-publiczone`: 公网DNS托管区域。对应AWS的`aws.hostedzone`公共区域。
- `huaweicloud.dns-privatezone`: 内网DNS托管区域。对应AWS的`aws.hostedzone`私有区域。
- `huaweicloud.dns-recordset`: DNS记录集。对应AWS的`aws.rrset`。

## 2. 通用Filters (适用于所有DNS资源)

| Filter | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :----------------- | :------------------------- | :-------------------- |:-----| :------------------------------------------------------------------------------------------- | :------------------------------------------- |
| value | 基于资源属性值的通用过滤器 | 可复用 | 已复用 | 不适用 | 无 |
| list-item | 列表元素过滤器 | 可复用 | 已复用 | 不适用 | 无 |
| event | 事件过滤器 | 可复用 | 已复用 | 不适用 | LTS (日志流服务) / CTS (云审计服务) |
| reduce | 聚合过滤器 | 可复用 | 已复用 | 不适用 | 无 |
| marked-for-op | 标记操作过滤器 | 可复用 | 已复用 | 不适用 | 无 |
| tag-count | 标签数量过滤器 | 可复用 | 已复用 | 不适用 | 无 |
| tms | 标签过滤器 | 可复用 `tms.py` | 已复用 | [查询指定实例的标签信息](https://support.huaweicloud.com/api-dns/ShowResourceTag.html) | TMS (标签管理服务) |
| finding | 安全发现过滤器 | 需要适配 | 不开发 | 不适用 | AWR (应用风险感知) / Config (配置审计服务) |
| ops-item | 运维项过滤器 | 需要适配 | 不开发 | 不适用 | O&M (运维管理) |
| config-compliance | 配置合规性过滤器 | 需要适配 | 不开发 | 不适用 | Config (配置审计服务) |

## 3. DNS PublicZone特定Filters (`huaweicloud.dns-publiczone`)

| Filter | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :----- |:-------------------------------| :--------- | :--------- | :-------------------------------------------------------------------------------------- | :----------- |

## 4. DNS PrivateZone特定Filters (`huaweicloud.dns-privatezone`)

| Filter | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
|:---------------|:-------------------------------| :--------- | :--------- |:--------------------------------------------------------------------------------------------------------|:------|
| vpc-associated | 关联VPC过滤器 | 需要开发 | 已完成 | [查询内网Zone列表](https://support.huaweicloud.com/api-dns/dns_api_63006.html) | VPC (虚拟私有云) |

## 5. DNS RecordSet特定Filters (`huaweicloud.dns-recordset`)

| Filter | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :---------- | :-------------------------------------- | :--------- | :--------- | :------------------------------------------------------------------------------------------------ | :----------- |
| record-type | 记录类型过滤器 (A, CNAME, MX等) | 需要开发 | 已完成 | [查询租户Record Set资源列表](https://support.huaweicloud.com/api-dns/dns_api_64003.html) | 无 |
| zone-id | 所属Zone ID过滤器 | 需要开发 | 已完成 | [查询租户Record Set资源列表](https://support.huaweicloud.com/api-dns/dns_api_64003.html) | 无 |
| line-id | 线路ID过滤器 (用于区分智能解析线路) | 需要开发 | 已完成 | [查询租户Record Set资源列表](https://support.huaweicloud.com/api-dns/dns_api_64003.html) | 无 |

## 6. 通用Actions (适用于所有DNS资源)

| Action | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :--------------- | :------------------ | :-------------------- |:-----| :------------------------------------------------------------------------------------------------ | :------------------------------------------------------------ |
| tag | 添加标签 | 可复用 `tms.py` | 已复用 | [为指定实例添加标签](https://support.huaweicloud.com/api-dns/CreateTag.html) | TMS |
| remove-tag | 删除标签 | 可复用 `tms.py` | 已复用 | [删除资源标签](https://support.huaweicloud.com/api-dns/DeleteTag.html) | TMS |
| rename-tag | 重命名标签键 | 需要适配 (基于删+添) | 需要开发 | [为指定实例批量添加或删除标签](https://support.huaweicloud.com/api-dns/BatchCreateTag.html) | TMS |
| mark-for-op | 标记待操作 | 可复用 | 已复用 | 不适用 | 无 |
| auto-tag-user | 自动标记创建者 | 可复用 `autotag.py` | 已复用 | [为指定实例添加标签](https://support.huaweicloud.com/api-dns/CreateTag.html) | TMS, IAM |
| copy-related-tag | 复制相关标签 | 需要适配 | 不开发 | [为指定实例批量添加或删除标签](https://support.huaweicloud.com/api-dns/BatchCreateTag.html) | TMS |
| notify | 发送通知 | 可复用 | 不开发 | 不适用 | SMN (消息通知服务) / 第三方通知渠道 |
| webhook | 调用Webhook | 可复用 | 不开发 | 不适用 | 无 |
| put-metric | 发布监控指标 | 需要适配 | 不开发 | 不适用 | CES (云监控服务) |
| invoke-lambda | 调用函数 | 需要适配 | 不开发 | 不适用 | FunctionGraph (函数工作流) |
| invoke-sfn | 调用状态机 | 需要适配 | 不开发 | 不适用 | FunctionGraph (函数工作流) / DMS (分布式消息服务) |
| post-finding | 推送安全发现 | 需要适配 | 不开发 | 不适用 | AWR / Config |
| post-item | 推送运维项 | 需要适配 | 不开发 | 不适用 | O&M |

## 7. DNS PublicZone特定Actions (`huaweicloud.dns-publiczone`)

| Action | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :--------- |:---------| :--------- | :--------- | :------------------------------------------------------------------------------------------- | :----------- |
| delete | 删除公网域名 | 需要开发 | 已完成 | [删除单个公网Zone](https://support.huaweicloud.com/api-dns/dns_api_62005.html) | 无 |
| update | 更新公网域名属性 | 需要开发 | 已完成 | [修改单个公网Zone](https://support.huaweicloud.com/api-dns/UpdatePublicZone.html) | 无 |
| set-status | 设置公网域名状态 | 需要开发 | 已完成 | [设置单个公网Zone状态](https://support.huaweicloud.com/api-dns/UpdatePublicZoneStatus.html), [批量设置Zone状态](https://support.huaweicloud.com/api-dns/BatchSetZonesStatus.html) | 无 |

## 8. DNS PrivateZone特定Actions (`huaweicloud.dns-privatezone`)

| Action | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :--------------- | :---------------------- | :--------- | :--------- | :-------------------------------------------------------------------------------------------- | :----------- |
| delete | 删除内网区域 | 需要开发 | 已完成 | [删除单个内网Zone](https://support.huaweicloud.com/api-dns/dns_api_63008.html) | 无 |
| update | 更新内网区域属性 | 需要开发 | 已完成 | [修改单个内网Zone](https://support.huaweicloud.com/api-dns/UpdatePrivateZone.html) | 无 |
| associate-vpc | 关联VPC | 需要开发 | 已完成 | [在内网Zone上关联VPC](https://support.huaweicloud.com/api-dns/dns_api_63003.html) | VPC |
| disassociate-vpc | 解关联VPC | 需要开发 | 已完成 | [在内网Zone上解关联VPC](https://support.huaweicloud.com/api-dns/dns_api_63004.html) | VPC |

## 9. DNS RecordSet特定Actions (`huaweicloud.dns-recordset`)

| Action | 说明 | 是否可复用 | 开发状态 | 华为云API链接 | 涉及其他服务 |
| :--------- | :------------------------------- | :--------- | :--------- | :------------------------------------------------------------------------------------------------------------- | :----------- |
| delete | 删除记录集 | 需要开发 | 已完成 | [删除单个Record Set](https://support.huaweicloud.com/api-dns/dns_api_64005.html), [批量删除Record Set](https://support.huaweicloud.com/api-dns/BatchDeleteRecordSets.html) | 无 |
| update | 更新记录集 (如TTL、记录值) | 需要开发 | 已完成 | [修改单个Record Set](https://support.huaweicloud.com/api-dns/UpdateRecordSet.html), [批量修改RecordSet](https://support.huaweicloud.com/api-dns/BatchUpdateRecordSetWithLine.html) | 无 |
| set-status | 设置状态 (启用/禁用) | 需要开发 | 已完成 | [设置Record Set状态](https://support.huaweicloud.com/api-dns/SetRecordSetsStatus.html), [批量设置Record Set状态](https://support.huaweicloud.com/api-dns/BatchSetRecordSetsStatus.html) | 无 |

## 11. 开发建议

1. **资源定义**: 分别创建三个主要资源类: `huaweicloud.dns-publiczone`, `huaweicloud.dns-privatezone`, `huaweicloud.dns-recordset`。由于公网Zone和内网Zone使用完全不同的API，应**分别实现**而非合并。
2. **复用与适配**: 优先复用通用filters和actions（如`value`, `list-item`, `tms`等）。对于标签相关功能，可复用`tms.py`中的实现。对于自动标记功能，可复用`autotag.py`中的实现。需要适配的功能需根据华为云对应服务进行实现。
3. **开发新功能**: 针对不同资源类型的特定操作和过滤条件，开发对应的filters和actions，调用相应的公网/内网Zone、RecordSet或PTR的华为云DNS SDK。
4. **特别考虑**:
* **批量操作**: 华为云DNS提供多种批量API，可提高操作效率，在实现相关Actions时应考虑使用。
* **线路管理**: 华为云支持复杂的线路管理功能，RecordSet相关的filters和actions需要能处理线路ID (`line-id`)。
* **公私网分离**: 严格区分公网Zone和内网Zone的API调用。
5. **其他服务集成**: 明确各filters和actions依赖的华为云服务（VPC, EIP, TMS, CES, SMN, FunctionGraph, IAM, LTS, CTS, Config, AWR, O&M等），确保开发和使用时有正确的配置和权限。
22 changes: 21 additions & 1 deletion tools/c7n_huaweicloud/c7n_huaweicloud/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,13 @@
SearchResourceShareAssociationsReqBody,
)
from huaweicloudsdkram.v1.region.ram_region import RamRegion
from huaweicloudsdkdns.v2 import (
ListPublicZonesRequest,
ListPrivateZonesRequest,
ListRecordSetsWithLineRequest,
DnsClient
)
from huaweicloudsdkdns.v2.region.dns_region import DnsRegion


log = logging.getLogger("custodian.huaweicloud.client")
Expand Down Expand Up @@ -394,6 +401,13 @@ def client(self, service):
.with_region(KafkaRegion.value_of(self.region))
.build()
)
elif service in ['dns-publiczone', 'dns-privatezone', 'dns-recordset']:
client = (
DnsClient.new_builder()
.with_credentials(credentials)
.with_region(DnsRegion.value_of(self.region))
.build()
)

return client

Expand Down Expand Up @@ -500,5 +514,11 @@ def request(self, service):
request = ListDDosStatusRequest()
elif service == 'kafka':
request = ListInstancesRequest()

elif service == 'dns-publiczone':
request = ListPublicZonesRequest()
elif service == 'dns-privatezone':
request = ListPrivateZonesRequest()
request.type = "private"
elif service == 'dns-recordset':
request = ListRecordSetsWithLineRequest()
return request
Loading