saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Open

#64,520 建立於 2023年6月21日

在 GitHub 查看
 (2 留言) (0 反應) (0 負責人)Python (13,710 star) (5,508 fork)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

描述

Description If you look at the function reference for salt.cloud.clouds.opennebula at the Create function it suggests syntax of:

salt-cloud -p my-opennebula-profile vm_name memory=16384 cpu=2.5 vcpu=16

This appears to be incorrect, if you were to run such syntax you would end up creating 4 virtual machines called:

  1. vm_name
  2. memory=16384
  3. cpu=2.5
  4. vcpu=16

inside of OpenNebula, not a single VM with 16GB memory, 2.5 physical CPU cores and 16 virtual ones as you might expect.

Suggested Fix Remove this syntax from the documentation.

Type of documentation Salt module

Location or format of documentation https://docs.saltproject.io/en/latest/ref/clouds/all/salt.cloud.clouds.opennebula.html#salt.cloud.clouds.opennebula.create

Additional context None

貢獻者指南

技術棧
pythonshell
領域
documentationcli
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
The issue identifies incorrect CLI syntax in the OpenNebula function reference documentation. The fix involves removing the erroneous example from the Salt documentation. The relevant file is likely `salt/cloud/clouds/opennebula.rst` or a similar file in the `doc/` directory. No linked pull request or assignee exists, so this is available for a first time contributor. The specific location is the 'create' function section of the OpenNebula cloud module.