saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Install Salt from the Salt package repositories here:
https://docs.saltproject.io/salt/install-guide/en/latest/
Apache License 2.0
14.21k stars 5.48k forks source link

[DOCS] Testing Packages needs further elaboration #65253

Open dmurphy18 opened 1 year ago

dmurphy18 commented 1 year ago

Description Using the instructions provided for 'Testing Packages' https://docs.saltproject.io/en/latest/topics/packaging/testing.html Do not contain sufficient information to allow for an external to Salt Team (VMware internal basically) utilize the instructions fully. For example: tools ts setup uses a --slug whose values relate to Golden AMI's which are not available to external users, but this is in documentation for external users.

The documentation also assumes use of tools which some options are not available to external users, and those users will go exploring the other options on tools and wonder what and how to use them.

Further the tools ts setup specifics a slug, but no key-name to access it later via tools vm ssh, so just how does one access that presumed VM that was setup. If the tool is for installing locally, then it clearly needs to be stated, and then it may prove to be destructive to the local machine depending on the tests run.

Section 'Running Tests' needs elaboration as to access the VM that was setup and clear steps on running existing package tests, or on how to write new package tests.

If no VM is setup, then why provide a slug, when platform information can be obtained from the local machine, and error issued if the local platform is not one of the supported slugs.

If errors occur during setup, need instructions or better error messaging to note the next steps, or inform the user that the setup failed, at the end of the script too, not just when the error occurred.

Suggested Fix Documentation needs updating for use by external user, without access to internal tools, and tools ts setup needs to allow for external user specified VM.

Type of documentation Salt documentation, Salt modules, the Salt Repo or the Getting Started guide.

Location or format of documentation https://docs.saltproject.io/en/latest/topics/packaging/testing.html

Additional context Road testing the instructions, while developing new package test.

MKLeb commented 1 year ago

Tasklist: