ansible/awx

Suggested inventories from scm project filter out yml files that could be plugin configs

Open

#3,491 创建于 2019年3月25日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Python (13,071 star) (3,333 fork)batch import
component:apihelp wantedtype:bug

描述

ISSUE TYPE
  • Bug Report
COMPONENT NAME
  • API
SUMMARY

Inventory plugins are configured via .yml or .yaml files. The UI hits the api/v2/projects/<id>/inventories/ endpoint and this offers a filtered down list of files that could be used for inventories. While in the past it may have made sense to filter out yaml files, now it does not because that is how one uses inventory plugins.

ENVIRONMENT
  • AWX version: devel
STEPS TO REPRODUCE

Create project with .yml inventory plugin config files. Create an inventory source that uses the project as SCM source.

EXPECTED RESULTS

The inventory plugin config files show up when you make a scm sourced inventory source.

ACTUAL RESULTS

Files did not show up in UI.

While you can specify it via source_path on the inventory source with a POST to the API, this file not showing up in the list prevents users from specifying it through UI.

ADDITIONAL INFORMATION

@AlanCoding says we need to clarify what we want to do. Hypothetically we could only accept files that match the core distributed inventory plugins, but this would prevent users from using cusom plugins, which we want them to be able to do. Seems like we might have to just let .yml and .yaml files through.

贡献者指南

技术栈
pythonrest apidjango
领域
backendapi
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonDjango REST frameworkFamiliarity with Ansible inventory plugins
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
The issue is about the API endpoint `api/v2/projects/<id>/inventories/` filtering out `.yml` and `.yaml` files that could be inventory plugin configs. The current filter likely excludes YAML files based on extension. To fix, locate the view or serializer handling this endpoint in the awx project (likely in the API app). Modify the file extension whitelist to include `.yml` and `.yaml`. Check the discussion with @AlanCoding in the comments for any additional considerations about custom plugins. The change is localized and well scoped.