Merge pull request #194 from gabriel-samfira/remove-lxd-provider

Remove the LXD internal provider

Dockerfile

@@ -10,6 +10,9 @@ ADD . /build/garm
 RUN cd /build/garm && git checkout ${GARM_REF}
 RUN git clone https://github.com/cloudbase/garm-provider-azure /build/garm-provider-azure
 RUN git clone https://github.com/cloudbase/garm-provider-openstack /build/garm-provider-openstack
+RUN git clone https://github.com/cloudbase/garm-provider-lxd /build/garm-provider-lxd
+RUN git clone https://github.com/cloudbase/garm-provider-incus /build/garm-provider-incus
+RUN git clone https://github.com/mercedes-benz/garm-provider-k8s /build/garm-provider-k8s
 
 RUN cd /build/garm && go build -o /bin/garm \
     -tags osusergo,netgo,sqlite_omit_load_extension \
@@ -18,11 +21,17 @@ RUN cd /build/garm && go build -o /bin/garm \
 RUN mkdir -p /opt/garm/providers.d
 RUN cd /build/garm-provider-azure && go build -ldflags="-extldflags '-static' -s -w" -o /opt/garm/providers.d/garm-provider-azure .
 RUN cd /build/garm-provider-openstack && go build -ldflags="-extldflags '-static' -s -w" -o /opt/garm/providers.d/garm-provider-openstack .
+RUN cd /build/garm-provider-lxd && go build -ldflags="-extldflags '-static' -s -w" -o /opt/garm/providers.d/garm-provider-lxd .
+RUN cd /build/garm-provider-incus && go build -ldflags="-extldflags '-static' -s -w" -o /opt/garm/providers.d/garm-provider-incus .
+RUN cd /build/garm-provider-k8s/cmd/garm-provider-k8s && go build -ldflags="-extldflags '-static' -s -w" -o /opt/garm/providers.d/garm-provider-k8s .
 
 FROM scratch
 
 COPY --from=builder /bin/garm /bin/garm
 COPY --from=builder /opt/garm/providers.d/garm-provider-openstack /opt/garm/providers.d/garm-provider-openstack
+COPY --from=builder /opt/garm/providers.d/garm-provider-lxd /opt/garm/providers.d/garm-provider-lxd
+COPY --from=builder /opt/garm/providers.d/garm-provider-incus /opt/garm/providers.d/garm-provider-incus
+COPY --from=builder /opt/garm/providers.d/garm-provider-k8s /opt/garm/providers.d/garm-provider-k8s
 COPY --from=builder /opt/garm/providers.d/garm-provider-azure /opt/garm/providers.d/garm-provider-azure
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 

README.md

@@ -30,17 +30,17 @@ Thanks to the efforts of the amazing folks at @mercedes-benz, GARM can now be in
 
 ## Supported providers
 
-GARM has a built-in LXD provider that you can use out of the box to spin up runners on any machine that runs either a stand-alone LXD instance, or an LXD cluster. The quick start guide mentioned above will get you up and running with the LXD provider.
-
-GARM also supports external providers for a variety of other targets.
+GARM uses providers to create runners in a particular IaaS. The providers are external executables that GARM calls into to create runners. Before you can create runners, you'll need to install at least one provider.
 
 ## Installing external providers
 
-External providers are binaries that GARM calls into to create runners in a particular IaaS. There are currently two external providers available:
+External providers are binaries that GARM calls into to create runners in a particular IaaS. There are several external providers available:
 
 * [OpenStack](https://github.com/cloudbase/garm-provider-openstack)
 * [Azure](https://github.com/cloudbase/garm-provider-azure)
 * [Kubernetes](https://github.com/mercedes-benz/garm-provider-k8s) - Thanks to the amazing folks at @mercedes-benz for sharing their awesome provider!
+* [LXD](https://github.com/cloudbase/garm-provider-lxd)
+* [Incus](https://github.com/cloudbase/garm-provider-incus)
 
 Follow the instructions in the README of each provider to install them. 
 
@@ -62,10 +62,4 @@ If you would like to optimize the startup time of new instance, take a look at t
 
 ## Write your own provider
 
-The providers are interfaces between ```GARM``` and a particular IaaS in which we spin up GitHub Runners. These providers can be either **native** or **external**. The **native** providers are written in ```Go```, and must implement [the interface defined here](https://github.com/cloudbase/garm/blob/main/runner/common/provider.go#L22-L39). **External** providers can be written in any language, as they are in the form of an external executable that ```GARM``` calls into.
-
-There is currently one **native** provider for [LXD](https://linuxcontainers.org/lxd/) and several **external** providers linked above.
-
-If you want to write your own provider, you can choose to write a native one, or implement an **external** one. I encourage you to opt for an **external** provider, as those are the easiest to write and you don't need to merge it in GARM itself to be able to use. Faster to write, faster to iterate. The LXD provider may at some point be split from GARM into it's own external project, at which point we will remove the native provider interface and only support external providers.
-
-Please see the [Writing an external provider](/doc/external_provider.md) document for details. Also, feel free to inspect the two available sample external providers in this repository.
+The providers are interfaces between ```GARM``` and a particular IaaS in which we spin up GitHub Runners. **External** providers can be written in any language, as they are in the form of an external executable that ```GARM``` calls into. Please see the [Writing an external provider](/doc/external_provider.md) document for details. Also, feel free to inspect the two available sample external providers in this repository.

config/config.go

@@ -223,7 +223,6 @@ type Provider struct {
 	// tokens to be used. This may happen if a provider has not yet been updated to support
 	// JIT configuration.
 	DisableJITConfig bool     `toml:"disable_jit_config" json:"disable-jit-config"`
-	LXD              LXD      `toml:"lxd" json:"lxd"`
 	External         External `toml:"external" json:"external"`
 }
 
@@ -233,10 +232,6 @@ func (p *Provider) Validate() error {
 	}
 
 	switch p.ProviderType {
-	case params.LXDProvider:
-		if err := p.LXD.Validate(); err != nil {
-			return errors.Wrap(err, "validating LXD provider info")
-		}
 	case params.ExternalProvider:
 		if err := p.External.Validate(); err != nil {
 			return errors.Wrap(err, "validating external provider info")

config/config_test.go

@@ -20,7 +20,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/cloudbase/garm/params"
 	"github.com/cloudbase/garm/util/appdefaults"
 	"github.com/stretchr/testify/require"
 )
@@ -76,15 +75,7 @@ func getDefaultDatabaseConfig(dir string) Database {
 }
 
 func getDefaultProvidersConfig() []Provider {
-	lxdConfig := getDefaultLXDConfig()
-	return []Provider{
-		{
-			Name:         "test_lxd",
-			ProviderType: params.LXDProvider,
-			Description:  "test LXD provider",
-			LXD:          lxdConfig,
-		},
-	}
+	return []Provider{}
 }
 
 func getDefaultGithubConfig() []Github {