saltstack / saltstack/salt

[DOCS] Inconsistent documentation of cloud options

Open
#65,063 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-param-missing documentation help-wanted Salt-Cloud severity-medium time-estimate-sprint
Dominant language
Python
Stars
15.7k
Forks
5.6k
Avg merge
2d 44m
Merged PRs (30d)
80

Description

Description
"Salt Cloud Doc" describe ssh_interface as option to use public or private IP for deploy script, while "Salt Cloud Code" check bootstrap_interface option to create a windows-like VM. Moreover, this option is not documented!

So, what's the difference between bootstrap_interface, ssh_interface, and win_interface?

Suggested Fix
Find out the truth and correct them.

Type of documentation
Salt documentation

Location or format of documentation
https://docs.saltproject.io/en/latest/topics/cloud
https://github.com/saltstack/salt/blob/3006.x/salt/cloud/clouds/azurearm.py

Additional context

---
wazr:
  - w2k19:
      allocate_public_ip: false
      dns_servers:
        - redacted
        - redacted
        - redacted
      grains:
        application: dc
        billing_entity: redacted
        creator: salt
        domain_name: unknown
        domain_join: false
        environment: staging
        eotp: redacted
        host_name: w2k19
        operational_entity: redacted
        referent: unknown
      image: MicrosoftWindowsServer|WindowsServer|2019-Datacenter|latest
      make_master: false
      minion:
        master: 10.0.0.4
        startup_states: highstate
      size: Standard_D2s_v3
      tag:
        application: dc
        billing_entity: redacted
        creator: salt
        domain_name: unknown
        domain_join: "false"
        environment: staging
        eotp: redacted
        host_name: w2k19
        operational_entity: redacted
      use_winrm: false
      volumes:
        - caching: ReadWrite
          disk_size_gb: 20
          managed_disk:
            storage_account_type: Standard_LRS
      win_deploy_auth_retries: 10
      win_deploy_auth_retry_delay: 1

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Salt Cloud documentation at docs.saltproject.io/en/latest/topics/cloud and inspect salt/cloud/clouds/azurearm.py, focusing on bootstrap_interface, ssh_interface, and win_interface. Trace how each option is used, then update the cloud documentation so their purposes and differences are accurate and complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, python
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.