Bamboo Specs BitbucketServerRepository and SSH Keys

Question

I'm trying to create a build plan using Bamboo Java Specs using the stored specs feature storing the specs in my Bitbucket Server repo (our Bitbucket Server and Bamboo instances are linked correctly). I have got Bamboo picking up the specs file but it fails with this exception:

java.lang.IllegalArgumentException: 
com.atlassian.bamboo.specs.api.exceptions.PropertiesValidationException: Clone url or ssh key pair is not valid

My plan looks something like this:

new Plan(project(), "name", "key")
...
.planRepositories(new BitbucketServerRepository() 
   .name(PROJECTNAME) 
   .oid(new BambooOid(BAMBOOOID)) 
   .repositoryViewer(new BitbucketServerRepositoryViewer()) 
   .server(new ApplicationLink() 
   .name("Bitbucket") 
   .id(BITBUCKETSERVERID)) 
   .projectKey(PROJECTKEY) 
   .repositorySlug(REPOSLUG) 
   .sshPublicKey(PUBLICKEY) 
   .sshPrivateKey(PRIVATEKEY) 
   .sshCloneUrl(CLONEURL) 
   .branch("main") 
   .remoteAgentCacheEnabled(false) 
   .fetchWholeRepository(true) 
   .changeDetection(new VcsChangeDetection()))

I initially just tried using the public key and private key from an existing build we created in the UI, but it was always a long-shot and didn't work. From reading this page on the API - https://docs.atlassian.com/bamboo-specs/6.5.0/com/atlassian/bamboo/specs/builders/repository/bitbucket/server/BitbucketServerRepository.html - it seems like I need to specify these rather than letting Bamboo create its own.

So my question is, do I need to create a user in Bitbucket for Bamboo (using one of our Bitbucket licences) and then generate SSH keys on the Bamboo host as if it were a normal user and use these or am I missing something here?

Jonny Carter_3nm6du · Answer

Okay, the thing that finally got this fixed for me was to use

.linkedRepositories("my-linked-repo-id")

instead of

.planRepositories( new BitbucketServerRepository() 
/...
)

Then there is no need to specify an ssh key pair, or any of the repo configuration.

Of course, specifying the linked repo seems to be a manual affair:

https://confluence.atlassian.com/bamboo/linking-to-source-code-repositories-671089223.html

This guide on creating a linked repo indicates that you need to publish the repository separately from the planspec: https://confluence.atlassian.com/bamkb/create-linked-repository-with-bamboo-java-specs-1014269419.html

Jonny Carter_3nm6du · Answer

I have this same basic problem. If I comment out the `sshPrivateKey()` and `sshPublicKey` method calls on my `BitbucketServerRepository`, I can run the plan spec locally. Those properties are required for use with repository-hosted specs, though.

Tom Allen_ah1fw9 · Answer

Update 2: created a private SSH key for the account running Bamboo on the box its hosted on. Put that into the spec file along with the public access key for the repo and still getting

Clone url or ssh key pair is not valid

Running out of ideas fast