Skip to content

docs: update Jenkins integration guide with Kubernetes and VM examples#533

Open
caiomede-tk wants to merge 4 commits intomainfrom
docs/update-jenkins-integration-guide
Open

docs: update Jenkins integration guide with Kubernetes and VM examples#533
caiomede-tk wants to merge 4 commits intomainfrom
docs/update-jenkins-integration-guide

Conversation

@caiomede-tk
Copy link
Copy Markdown
Collaborator

Summary

Restructures the Jenkins integration documentation to cover multiple deployment scenarios and prioritize the Docker image approach over the Jenkins plugin.

Changes

  • Jenkins on Kubernetes (new, primary approach): Uses the kubeshop/testkube-cli Docker image directly in a Kubernetes pod template, with examples for both Cloud and Self-Hosted Testkube. Includes important notes about securityContext.runAsUser and HOME env var requirements.
  • Jenkins on VMs (new): Installs the CLI via curl -sSLf https://get.testkube.io | sh directly on Jenkins agents, with examples for Cloud, EKS, and GKE.
  • Jenkins CLI Plugin: Moved to last section as an alternative option, preserving existing setupTestkube() examples.

Why

The previous docs only covered the Jenkins plugin approach (setupTestkube()). Users running Jenkins on Kubernetes can avoid binary download issues entirely by using the kubeshop/testkube-cli image, and VM users benefit from a straightforward CLI install script.

@caiomede-tk caiomede-tk requested a review from a team as a code owner April 15, 2026 20:00
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 15, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
testkube-docs Ready Ready Preview, Comment Apr 17, 2026 4:49pm

Request Review

@olensmar
Copy link
Copy Markdown
Member

thanks @caiomede-tk - should https://docs.testkube.io/articles/jenkins-ui be updated also/accordingly? Perhaps add tip at the top pointing to the non-ui approach as preferred?

Comment thread docs/articles/jenkins-ui.mdx Outdated

:::warning

Testkube CLI Jenkins Plugin is only compatible with Testkube Control Plane SaaS or Cloud, because there is no property or environment variable to override Control Plane API URI, please use the Groovy scripts as it's recommended above.
Copy link
Copy Markdown
Member

@olensmar olensmar Apr 17, 2026

Choose a reason for hiding this comment

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

wordsmithing:

  • change "..is only compatible with Testkube Control Plane SaaS or Cloud.." -> "only works with the Cloud-hosted Testkube Control Plane"
  • change ".. Control Plane API URI,.." -> ".. Control Plane API URI. If you are hosting the Control Plane yourself, please use.."

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Improvements applied, please check

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.

2 participants