SSH Documentation should mention "Host Key"

Bug #1827021 reported by Nils Meyer on 2019-04-30
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Medium
Unassigned

Bug Description

The documentation for the SSH module should mention that it is working with SSH *Host* Keys, since many people will commonly understand the term "SSH Key" to mean a key being used for User Authentication. This is somewhat ambiguous, I ended up building my own solution to replace host keys.

The wording could be:
Summary: configure ssh and ssh host keys

This module handles most configuration for ssh and ssh host keys. Many images have default ssh host keys, which can be removed using ssh_deletekeys. This prevents re-use of a private key from an image on multiple machines. Since removing default keys is usually the desired behavior this option is enabled by default.

Dan Watkins (daniel-thewatkins) wrote :

Hi Nils,

Thanks for the bug report! I agree that the wording currently is misleading. It is worth noting that the SSH module does handle _both_ SSH host keys and user authorised keys; any new summary should probably make that clear (I was going to write "clearer" but it isn't at all clear at the moment!).

Would this be a change you would be interested in contributing to the project?

Thanks again!

Dan

Changed in cloud-init:
status: New → Triaged
importance: Undecided → Medium
Nils Meyer (nils-nm) wrote :

Hi Dan,

I'd be happy to contribute the changes, I assume you need a signed CLA for that?

- Nils

On Fri, May 03, 2019 at 08:29:28AM -0000, Nils Meyer wrote:
> I'd be happy to contribute the changes, I assume you need a signed CLA
> for that?

Great to hear! Yep, you'll need to sign the CLA. Details on how to do
that (and other guidance on how to contribute) can be found here:
https://cloudinit.readthedocs.io/en/latest/topics/hacking.html

Thanks!

Dan

do3meli (d-info-e) on 2019-05-16
tags: added: docs
Joshua Powers (powersj) wrote :

My apologies, I put the wrong merge link. It is actually https://github.com/canonical/cloud-init/pull/110

Joshua Powers (powersj) wrote :

This was merged as is live, so marking fix released.

Changed in cloud-init:
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers