ansible/awx

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

Open

#3,491 opened on 2019年3月25日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.