Simp/SSH Puppet Module Documentation Suggestion

[silug]

Received via email:

I recently discovered a documentation error with the Simp “readthedocs”, section 4.8.2.2 , Service Account: https://simp.readthedocs.io/en/master/user_guide/User_Management/Local_Users.html

Error:
“$_svc_account_ssh_private_key = ssh_autokey($_svc_account_user, '2048', true)”
“ $_svc_account_ssh_public_key = ssh_autokey($_svc_account_user, '2048')”

Using the function calls will result in an “Error 500 unknown function call”.

Suggested fix:
$_svc_account_ssh_private_key = ssh::autokey($_svc_account_user, 2048, true)
$_svc_account_ssh_public_key = ssh::autokey($_svc_account_user, 2048)

According to the CHANGELOG provided with the module, it states that “ssh_autokey should be replaced with ssh::autokey”

I did not discover this until trying to search for any mention of the function call in the source module’s directory by using “grep -ri ssh_autokey” and resulted in a parsed line from the CHANGELOG, and there is no reflection of this change in any of the Simp branches of documentation from what I could tell.

I hope this may be of assistance to other developers.

This is referencing the following lines:

simp-doc/docs/user_guide/User_Management/Local_Users.rst

Lines 108 to 109 in 09620d6

	$_svc_account_ssh_private_key = ssh_autokey($_svc_account_user, '2048', true)
	$_svc_account_ssh_public_key = ssh_autokey($_svc_account_user, '2048')