saltstack/salt

[DOCS] OpenNebula Function Reference - Suggests wrong CLI syntax

Closed

#64,520 opened on Jun 21, 2023

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)Python (5,508 forks)batch import
documentationgood first issuehelp-wantedmodule doc standardsseverity-mediumtime-estimate-quick-fix

Repository metrics

Stars
 (13,710 stars)
PR merge metrics
 (Avg merge 72d 6h) (221 merged PRs in 30d)

Description

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

Contributor guide

Research direction
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.
Tech stack
pythonshell
Domain
documentationcli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85