Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-24613

SSH Credentials should document the file names considered for UsersPrivateKeySource

    XMLWordPrintable

    Details

    • Similar Issues:

      Description

      There's no integrated help for the option "Use ~/.ssh on Jenkins master", leading users to believe everything in there may be considered, while it's only a handful of files.

      The PrivateKeySources, especially UsersPrivateKeySource, need user documentation for their behavior.

        Attachments

        1. Screenshot1.png
          Screenshot1.png
          151 kB
        2. Screenshot2.png
          Screenshot2.png
          295 kB
        3. Screenshot3.png
          Screenshot3.png
          153 kB
        4. Screenshot4.png
          Screenshot4.png
          159 kB

          Activity

          Hide
          danielbeck Daniel Beck added a comment -

          Could you add some more information on what exactly the problem is, in which plugin or part of Jenkins it occurs, what versions of Jenkins and involved plugins you're using,...?

          Show
          danielbeck Daniel Beck added a comment - Could you add some more information on what exactly the problem is, in which plugin or part of Jenkins it occurs, what versions of Jenkins and involved plugins you're using,...?
          Hide
          danielbeck Daniel Beck added a comment -

          'Jenkins master ~/.ssh' only considers a handful of predefined filenames:
          https://github.com/jenkinsci/ssh-credentials-plugin/blob/master/src/main/java/com/cloudbees/jenkins/plugins/sshcredentials/impl/BasicSSHUserPrivateKey.java#L516

          For everything else, you need e.g. 'file on Jenkins master' instead.

          Is this the problem?

          Show
          danielbeck Daniel Beck added a comment - 'Jenkins master ~/.ssh' only considers a handful of predefined filenames: https://github.com/jenkinsci/ssh-credentials-plugin/blob/master/src/main/java/com/cloudbees/jenkins/plugins/sshcredentials/impl/BasicSSHUserPrivateKey.java#L516 For everything else, you need e.g. 'file on Jenkins master' instead. Is this the problem?
          Hide
          stripcode Eugene Nekrasov added a comment -

          Yes. Success. Thank you. My key have "wrong" name jenkins. Have a nice day! I did not know about this limitation.

          Show
          stripcode Eugene Nekrasov added a comment - Yes. Success. Thank you. My key have "wrong" name jenkins. Have a nice day! I did not know about this limitation.
          Hide
          danielbeck Daniel Beck added a comment -

          Rewrote the issue as a request to improve documentation.

          Show
          danielbeck Daniel Beck added a comment - Rewrote the issue as a request to improve documentation.
          Hide
          stephenconnolly Stephen Connolly added a comment -

          Will be in the next release

          Show
          stephenconnolly Stephen Connolly added a comment - Will be in the next release

            People

            Assignee:
            stephenconnolly Stephen Connolly
            Reporter:
            stripcode Eugene Nekrasov
            Votes:
            1 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved: