Class: Chef::Knife::UserCreate

Inherits:
Chef::Knife show all
Defined in:
lib/chef/knife/user_create.rb

Constant Summary

Constants inherited from Chef::Knife

OFFICIAL_PLUGINS

Instance Attribute Summary collapse

Attributes inherited from Chef::Knife

#name_args, #ui

Instance Method Summary collapse

Methods inherited from Chef::Knife

#api_key, #apply_computed_config, category, chef_config_dir, #cli_keys, common_name, #config_file_settings, config_loader, #configure_chef, #create_object, #delete_object, dependency_loaders, deps, #format_rest_error, guess_category, #humanize_exception, #humanize_http_exception, inherited, #initialize, list_commands, load_commands, load_config, load_deps, #maybe_setup_fips, #merge_configs, msg, #noauth_rest, #parse_options, reset_config_loader!, reset_subcommands!, #rest, run, #run_with_pretty_exceptions, #server_url, #show_usage, snake_case_name, subcommand_category, subcommand_class_from, subcommand_files, subcommand_loader, subcommands, subcommands_by_category, #test_mandatory_field, ui, unnamed?, use_separate_defaults?, #username

Methods included from Mixin::ConvertToClassName

#constantize, #convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #normalize_snake_case_name, #snake_case_basename

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Attribute Details

#user_fieldObject

Returns the value of attribute user_field


27
28
29
# File 'lib/chef/knife/user_create.rb', line 27

def user_field
  @user_field
end

Instance Method Details

#create_user_from_hash(hash) ⇒ Object


67
68
69
# File 'lib/chef/knife/user_create.rb', line 67

def create_user_from_hash(hash)
  Chef::UserV1.from_hash(hash).create
end

#osc_11_warningObject


71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/chef/knife/user_create.rb', line 71

def osc_11_warning
  <<-EOF
IF YOU ARE USING CHEF SERVER 12+, PLEASE FOLLOW THE INSTRUCTIONS UNDER knife user create --help.
You only passed a single argument to knife user create.
For backwards compatibility, when only a single argument is passed,
knife user create assumes you want Open Source 11 Server user creation.
knife user create for Open Source 11 Server is being deprecated.
Open Source 11 Server user commands now live under the knife osc_user namespace.
For backwards compatibility, we will forward this request to knife osc_user create.
If you are using an Open Source 11 Server, please use that command to avoid this warning.
EOF
end

#runObject


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'lib/chef/knife/user_create.rb', line 91

def run
  # DEPRECATION NOTE
  # Remove this if statement and corrosponding code post OSC 11 support.
  #
  # If only 1 arg is passed, assume OSC 11 case.
  if @name_args.length == 1
    ui.warn(osc_11_warning)
    run_osc_11_user_create
  else # EC / CS 12 user create

    test_mandatory_field(@name_args[0], "username")
    user.username @name_args[0]

    test_mandatory_field(@name_args[1], "display name")
    user.display_name @name_args[1]

    test_mandatory_field(@name_args[2], "first name")
    user.first_name @name_args[2]

    test_mandatory_field(@name_args[3], "last name")
    user.last_name @name_args[3]

    test_mandatory_field(@name_args[4], "email")
    user.email @name_args[4]

    test_mandatory_field(@name_args[5], "password")
    user.password @name_args[5]

    if config[:user_key] && config[:prevent_keygen]
      show_usage
      ui.fatal("You cannot pass --user-key and --prevent-keygen")
      exit 1
    end

    if !config[:prevent_keygen] && !config[:user_key]
      user.create_key(true)
    end

    if config[:user_key]
      user.public_key File.read(File.expand_path(config[:user_key]))
    end

    output = edit_hash(user)
    final_user = create_user_from_hash(output)

    ui.info("Created #{user}")
    if final_user.private_key
      if config[:file]
        File.open(config[:file], "w") do |f|
          f.print(final_user.private_key)
        end
      else
        ui.msg final_user.private_key
      end
    end
  end
end

#run_osc_11_user_createObject


84
85
86
87
88
89
# File 'lib/chef/knife/user_create.rb', line 84

def run_osc_11_user_create
  # run osc_user_create with our input
  ARGV.delete("user")
  ARGV.unshift("osc_user")
  Chef::Knife.run(ARGV, Chef::Application::Knife.options)
end

#userObject


63
64
65
# File 'lib/chef/knife/user_create.rb', line 63

def user
  @user_field ||= Chef::UserV1.new
end