search

saltstack / salt

Software to automate the management and configuration of any infrastructure or application at scale. Get access to the Salt software package repository here:
https://repo.saltproject.io/
Apache License 2.0
14.15k stars 5.48k forks source link

[BUG] --help text does not contain what values --out accepts #62822

Open matthewsht opened 2 years ago

matthewsht commented 2 years ago

Description salt --help output documents the --out option. However, it does not list what values are acceptable to --out.

Also affects salt-call, salt-cloud, salt-cp, salt-key, salt-run

Setup Any setup. We are on:

salt --version

salt 3005

Steps to Reproduce the behavior salt --help [.... text elided ... ] --out=OUTPUT, --output=OUTPUT Print the output from the 'salt' command using the specified outputter. [.... text elided ... ]

Expected behavior --out=OUTPUT, --output=OUTPUT Print the output from the 'salt' command using the specified outputter. Accepted outputters are 'txt', 'json', 'raw', 'foo', 'bar', 'mumble' (I don't know the exact list from memory)

My apologies if I've misfiled this against code instead of DOC - to me DOC is the website stuff.

OrangeDog commented 2 years ago

As custom or extension outputters can be installed, there is no fixed list.

matthewsht commented 2 years ago

Can we list the ones included with salt by default? This option is useless without knowing how to use it...

-- Hunter Matthews Scientific System Engineer [C] NIH/National Human Genome Research Institute @.**@.> | (919) 491-2124

On Oct 6, 2022, at 11:22 AM, James Howe @.**@.>> wrote:

As custom or extension outputters can be installed, there is no fixed list.

— Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsaltstack%2Fsalt%2Fissues%2F62822%23issuecomment-1270257394&data=05%7C01%7Chunter.matthews%40nih.gov%7C403e5180754c4452d18608daa7ae89f2%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006665321397706%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=bRDO%2FZKamb%2F5yi7boXbVQHH8XHshatnJFM5fh01jf4E%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FATFEQQ5BGDXJ3WHQW4YJI53WB3VB5ANCNFSM6AAAAAAQ57H3RM&data=05%7C01%7Chunter.matthews%40nih.gov%7C403e5180754c4452d18608daa7ae89f2%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006665321397706%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=mEjpqmL%2BRWs19Biw203lQ9UKekVOeSPsYcMOTHXbeA8%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>

CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and are confident the content is safe.

OrangeDog commented 2 years ago

That's the same as all the options. It also doesn't list all the default returners, modules, runners, etc.

matthewsht commented 2 years ago

Then those should be filled in as well - please consider the new user(s) to salt - wondering what those are for and how to use them.

I'd also consider an URL (maybe at the bottom) with the reference docs for all these. Just some bread crumbs to tell the newer members of my team where to look for answers.

-- Hunter Matthews Scientific System Engineer [C] NIH/National Human Genome Research Institute @.**@.> | (919) 491-2124

On Oct 6, 2022, at 11:27 AM, James Howe @.**@.>> wrote:

That's the same as all the options. It also doesn't list all the default returners, modules, runners, etc.

— Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsaltstack%2Fsalt%2Fissues%2F62822%23issuecomment-1270268085&data=05%7C01%7Chunter.matthews%40nih.gov%7Cb8da134b6a72448b98ee08daa7af46b5%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006668491553866%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=UfD512xRQGs0P47emIisQ2nynBxiV%2FRLaQZkLoSokyg%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FATFEQQ3JF67UFUXKADHKSNLWB3VVZANCNFSM6AAAAAAQ57H3RM&data=05%7C01%7Chunter.matthews%40nih.gov%7Cb8da134b6a72448b98ee08daa7af46b5%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006668491553866%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=mSYsqOyPLzhs2dWyDk7NOUzvYq0hNUDzkjfqjsfwHII%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>

CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and are confident the content is safe.

OrangeDog commented 2 years ago

There are rather a lot of them, and which are available depends on environment and configuration. https://docs.saltproject.io/en/latest/py-modindex.html

matthewsht commented 2 years ago

Rather fewer of them are relevant to output though, yes?

https://docs.saltproject.io/en/latest/ref/output/all/index.html

I believe the man pages, recently re-added to the rpm packages, also include at least the basic out-putters.

-- Hunter Matthews Scientific System Engineer [C] NIH/National Human Genome Research Institute @.**@.> | (919) 491-2124

On Oct 6, 2022, at 11:38 AM, James Howe @.**@.>> wrote:

There are rather a lot of them, and which are available depends on environment and configuration. https://docs.saltproject.io/en/latest/py-modindex.htmlhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocs.saltproject.io%2Fen%2Flatest%2Fpy-modindex.html&data=05%7C01%7Chunter.matthews%40nih.gov%7C4bb2d113fe46493168e608daa7b0dde9%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006675321394576%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=20EL8icsmZr4136exMnZgsGxQzKO5tSHJnuLTGoQE6E%3D&reserved=0

— Reply to this email directly, view it on GitHubhttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fsaltstack%2Fsalt%2Fissues%2F62822%23issuecomment-1270287261&data=05%7C01%7Chunter.matthews%40nih.gov%7C4bb2d113fe46493168e608daa7b0dde9%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006675321394576%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=c6J3%2F28HvjOQVFqL5JqKt9hp9m8ztW5SFiEsJt1it4o%3D&reserved=0, or unsubscribehttps://gcc02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FATFEQQYJ3MU6YLCMTVD7B73WB3W7LANCNFSM6AAAAAAQ57H3RM&data=05%7C01%7Chunter.matthews%40nih.gov%7C4bb2d113fe46493168e608daa7b0dde9%7C14b77578977342d58507251ca2dc2b06%7C0%7C0%7C638006675321394576%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=FLBlSIqneh3gaZIVyPH%2FJu2gkCYxRxQl6RkZj6CdfqI%3D&reserved=0. You are receiving this because you authored the thread.Message ID: @.***>

CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and are confident the content is safe.

whytewolf commented 1 year ago

so, this shouldn't be in the man page. however the sys module and the doc runner should be updated to include outputters.

these are dynamic ways of reading the docs for different modules that are loaded in the system

https://docs.saltproject.io/en/latest/ref/modules/all/salt.modules.sysmod.html#module-salt.modules.sysmod https://docs.saltproject.io/en/latest/ref/runners/all/salt.runners.doc.html#module-salt.runners.doc