Snippet for creating users when provisioning vm

Hecate · September 2, 2019, 8:13am

Problem:

Hello.
I’m a bit new to foreman and I don’t understand how to create a specific user when provisionning a linux os .

I want to create a user “ansible” with a specifi dsa key and uid/gid
But how to create a snippet /user isn’t very clear for me

Expected outcome:

Foreman and Proxy versions:
1.22.1-1.el7
Foreman and Proxy plugin versions:
1.22.1-1.el7
Other relevant data:
[e.g. logs from Foreman and/or the Proxy, modified templates, commands issued, etc]
(for logs, surround with three back-ticks to get proper formatting, e.g.)

logs

Dirk · September 2, 2019, 9:14am

There are already two snippets you can utilize or use as inspiration.

create_users creates user based on the owner of the host.

github.com

theforeman/community-templates/blob/develop/provisioning_templates/snippet/create_users.erb

<%#
name: create_users
model: ProvisioningTemplate
kind: snippet
snippet: true
-%>
<%- users = @host.owner_type == 'Usergroup' ? @host.owner.all_users : [@host.owner] -%>
<%- users.each do |user| -%>
<%=   "useradd #{user.login}" %>
<%-   if user.respond_to?(:ssh_authorized_keys) && user.ssh_authorized_keys.any? -%>
<%=     "mkdir -p -m 0700 ~#{user.login}/.ssh" %>
<%=     "cat >> ~#{user.login}/.ssh/authorized_keys <<EOF" %>
<%-     index = 0 -%>
<%-     user.ssh_keys.each do |key| -%>
<%-       if index == 0 -%>
<%=        "#{key.type} #{key.ssh_key} #{key.comment}" %>
<%-       else -%>
<%=        "#{key.type} #{key.ssh_key} #{key.comment} - #{index}" %>
<%-       end -%>
<%-       index += 1 -%>

This file has been truncated. show original

remote_execution_ssh_keys creates a user based on the settings for the Remote Execution / Ansible Plugin including sudo rules.

github.com

theforeman/community-templates/blob/develop/provisioning_templates/snippet/remote_execution_ssh_keys.erb

<%#
kind: snippet
name: remote_execution_ssh_keys
model: ProvisioningTemplate
snippet: true
%>
# SSH keys setup snippet for Remote Execution plugin
#
# Parameters:
#
# remote_execution_ssh_keys: public keys to be put in ~/.ssh/authorized_keys
#
# remote_execution_ssh_user: user for which remote_execution_ssh_keys will be
#                            authorized
#
# remote_execution_create_user: create user if it not already existing
#
# remote_execution_effective_user_method: method to switch from ssh user to
#                                         effective user
#

This file has been truncated. show original

In the most cases the last one is enough and you only have to adjust the settings in Foreman, but for the specific uid/gid you will have to adjust it.

Best way to do this would be upstream , but to change it only locally copy the snippet and the template which should include it and in the template change the name of the snippet accordingly.

Hecate · November 6, 2019, 9:58am

I’m not really a ruby dev, so it’s a bit difficult for me