Skip to content

Update troubleshooting-runners.md#1687

Merged
fdevans merged 1 commit intorundeck:4.0.xfrom
brmdias:patch-16
Aug 7, 2025
Merged

Update troubleshooting-runners.md#1687
fdevans merged 1 commit intorundeck:4.0.xfrom
brmdias:patch-16

Conversation

@brmdias
Copy link
Contributor

@brmdias brmdias commented Aug 6, 2025

Adding instructions on how to fix SSL Handshake error on the Runner startup.

Adding instructions on how to fix SSL Handshake error on the Runner startup.
Copilot AI review requested due to automatic review settings August 6, 2025 15:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds troubleshooting documentation for SSL handshake errors that occur during Runner startup. The new section provides administrators with a comprehensive guide to diagnose and resolve certificate trust issues between Runners and Rundeck clusters.

Key changes:

  • Added a new troubleshooting section for SSL handshake errors
  • Included error message examples, root cause explanations, and step-by-step resolution instructions
  • Provided practical keytool commands for importing certificates into Java truststore
Comments suppressed due to low confidence (1)

docs/administration/runner/runner-troubleshooting/troubleshooting-runners.md:20

  • [nitpick] The tone is too informal for technical documentation. Consider rephrasing to: 'This commonly occurs with internal CAs or self-signed certificates when administrators add them to the OS trust store but not to Java's truststore.'
- This is super common with **internal CAs** or **self-signed certs**—admins often add these to the OS trust store, but forget about Java’s.


### **Error message**
```
08-06-2025 14:23:47.445 [main] ERROR io.micronaut.retry.intercept.RecoveryInterceptor - Type [com.rundeck.sidecar.agent.server.RESClient$Intercepted] executed with error: javax.net.ssl.SSLHandshakeException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target reactor.core.Exceptions$ReactiveException: javax.net.ssl.SSLHandshakeException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target
Copy link

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error message example should use a generic date rather than a specific future date (08-06-2025). Consider using a placeholder like 'YYYY-MM-DD' or a past date to avoid confusion and maintain documentation longevity.

Copilot generated this review using guidance from repository custom instructions.
Example command:

```
keytool -import -alias rundeck-ca -file /path/to/ca.crt -keystore $JAVA_HOME/lib/security/cacerts
Copy link

Copilot AI Aug 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The code block should specify 'bash' for proper syntax highlighting and include the missing closing backticks on line 42.

Copilot generated this review using guidance from repository custom instructions.
@fdevans fdevans self-requested a review August 7, 2025 14:18
@fdevans fdevans added this to the 5.15.0 milestone Aug 7, 2025
@fdevans fdevans merged commit fb6c452 into rundeck:4.0.x Aug 7, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants