Enabling ephemeral agent support

Still need help?

The Atlassian Community is here for you.

Ask the community

Before you can start creating ephemeral agent templates, you'll have to enable support for ephemeral agents so that Bamboo can connect to and authenticate with your Kubernetes cluster.

On this page:

Before you begin

Install the Kubernetes command-line tool, kubectl, on your Bamboo server. Kubectl is not installed by default.

Steps

To enable ephemeral agent support in Bamboo:

  1. In the upper-right corner of the screen, select
    Administration bamboo administration icon
    > Overview.
  2. From the menu on the Bamboo administration page, under Ephemeral agents, select Configuration.

  3. Under General, select the Enabled checkbox.

  4. In the Path to configuration file field, enter the full path to your Kubernetes configuration file relative to the Bamboo [shared] home directory.

  5. In the Resource label field, enter the label that you want to attach to the resources Bamboo creates and manages in your Kubernetes cluster.

    Bamboo can only manage Kubernetes resources identified by the resource label you set here. If you change the resource label later, Bamboo will no longer be able to recognize resources identified by the previous label.

  6. Select Test connection to make sure that the communication between Bamboo and your Kubernetes cluster is working correctly.

  7. Optional: If you want Bamboo to automatically remove pods after ephemeral agents complete their work, enable automatic pod removal.

  8. If the test connection was successful, select Save .

You can now create your first ephemeral agent template and configure its capabilities.

     

I'm getting a "Connection failed" error

The test connection may fail for a number of reasons. Bamboo will display the exact error message coming from Kubernetes that you can use to troubleshoot the connection with the cluster.

Here’s what you can do in the most common situations:

  • An error occurred while loading the configuration file — this may happen either due to an incorrectly configured path to the Kubernetes configuration file (there’s a typo in the path or the file does not exist at the specified location) or a syntax error in the file. Verify that the path you specified is correct and that the file is well-formed.

  • Bamboo can’t connect to the specified IP address or hostnamethis can mean that the Kubernetes cluster is unreachable, the specified authentication details are incorrect, or there is an error in the provided IP address or hostname. Verify that the connection and authentication details specified in your Kubernetes configuration file are correct.

If everything looks alright but the problem persists, contact Atlassian Support.

Related pages

Last modified on Mar 12, 2024

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.