Skip to content

chef_user resource docs not clear for source_key related attributes #77

@poliva83

Description

@poliva83

I found the documentation was unclear on how to set users key on :create action. The use in conjunction phrase is very misleading. After reviewing the code it seems you either specify source_key or source_key_pass_phrase and source_key_path. You can not use all three in combination as the documentation implies.

https://docs.chef.io/resource_chef_user.html


source_key Use to copy a public or private key, but apply a different format and password. Use in conjunction with source_key_pass_phrase` and source_key_path.


source_key_pass_phrase The pass phrase for the public key. Use in conjunction with source_key` and source_key_path.


source_key_path The path to the public key. Use in conjunction with source_key` and source_key_pass_phrase.


Related code links:
https://github.com/chef/cheffish/blob/master/lib/cheffish/actor_provider_base.rb#L25
https://github.com/chef/cheffish/blob/master/lib/cheffish/actor_provider_base.rb#L73

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions