kurtosis-tech / kurtosis

A platform for packaging and launching ephemeral backend stacks with a focus on approachability for the average developer.
https://docs.kurtosistech.com/
Apache License 2.0
360 stars 53 forks source link

FR: support Kurtosis packages in private repositories #1269

Open leeederek opened 1 year ago

leeederek commented 1 year ago

Background & motivation

This feature request captures the need to support Kurtosis packages published to private Github repositories. This may be a blocker for some folks.

Desired behaviour

I can run Kurtosis packages that are published to private Github repositories.

How important is this to you?

Painful; the lack of this feature makes using Kurtosis frictionful.

mieubrisse commented 1 year ago

Did some design-thinking about this last night. In order to access private repos, we need a Github read token that allows us to get access to the private repo. And specifically, the APIC needs a secret (Github token or SSH key) for accessing the repo.

However, we of course only want the user to need to give access once, which means that we'd want to store the token in the engine (and then pass the token to all created APICs so they can get access).

So, my suggestion:

The above is a lot of work, but IF we do this then we get a couple neat things for free:

leeederek commented 1 year ago

Current use cases from Ava Labs and Merkle.io are for users who want Kurtosis to be installed & used to spin up environments as part of CI. Currently, if a user does this in their CI environment, then private images will work fine because the CI environment has access to the image tags required. Bumping this down a bit in priority because we have workarounds for the known use cases we've encountered so far.