Create local kind cluster install #647

KevinFairise2 · 2024-02-26T16:39:15Z

What does this PR do?

This PR add two new components:

A component to install a local kind cluster, assuming that Kind is installed locally
A component to deploy a Fakeintake in a local kind cluster, The port mapping is made to have the fakeintake accessible from the port 30080 of the local host

The following PR will create a local kind provider on datadog-agent: DataDog/datadog-agent#23153

The PR also creates another API to be able to set the environment variables of all the Agents deployed with helm. Otherwise this is impossible since the env variables used to configure the fakeintake override the ones provided with WithHelmValues

Which scenarios this will impact?

Motivation

The main goal of this PR is to provide things for developers to iterate faster on their e2e tests.
Running Kubernetes tests on a remote host can be long and hard to debug, even when using kind

Additional Notes

components/datadog/fakeintake/component.go

… kfairise/local-kind

KevinFairise2 · 2024-04-04T09:26:34Z

components/kubernetes/kind-cluster.yaml

@@ -2,10 +2,15 @@ kind: Cluster
 apiVersion: kind.x-k8s.io/v1alpha4
 nodes:
 - role: control-plane
+  extraPortMappings:
+  - containerPort: 30080
+    hostPort: 30080


Maybe we could benefit from having it configurable. But for now it uses a port that should not be already bound on the host. And I could not see why we'd want to change it

components/datadog/agent/kubernetes_helm.go

components/datadog/fakeintake/component.go

vboulineau

Code overall LGTM, small comments.

However sharing concern about the use case. This helper assumes host machine is ~Unix + docker (or podman) + kind installed.

For manual tests, I am not sure doing all this to wrap kind create cluster is worth it, however it could argued that re-using manifests defined here to install some apps can be useful. In that case I'd then favor a solution that allows to re-use current in-context cluster instead (gives a lot of flexibility in the manual testing).

For E2E tests, it requires a slightly different provisioning code (hopefully environment and components are designed to have minimal changes) and it breaks the original promise: whether you run it from your laptop or from the CI, the result will be exactly the same.

I also have doubt on the iterate faster. Iterating on Kubernetes E2E usually mean provisioning once with then a lot of updates (but you're not going to update the cluster), the added provisioning time is quite short.

Once provisioned, the difference to the kubectl user is expected to be ~0, so it'd be interesting to have a better understanding of the issues faced.

components/datadog/agent/kubernetes_helm.go

components/datadog/fakeintake/component.go

components/datadog/fakeintake/kubernetes.go

components/kubernetes/kind.go

KevinFairise2 · 2024-04-09T08:09:26Z

For manual tests, I am not sure doing all this to wrap kind create cluster is worth it, however it could argued that re-using manifests defined here to install some apps can be useful. In that case I'd then favor a solution that allows to re-use current in-context cluster instead (gives a lot of flexibility in the manual testing).

Manual testing is not the first goal of this PR, the idea was more to create a provider that provision local resources that can be used when running e2e tests locally.

it breaks the original promise: whether you run it from your laptop or from the CI, the result will be exactly the same.

Yes indeed the environment is not exactly the same as in the CI, that's one of the drawback but I tried to make the local environment as close as the remote one as possible.

I also have doubt on the iterate faster. Iterating on Kubernetes E2E usually mean provisioning once with then a lot of updates (but you're not going to update the cluster), the added provisioning time is quite short.

It's a feedback we often have from users creating tests. Remote resources can be long to create, it often leaks some resources and running the test again can be painful (need to delete resources on AWS) and DevMode is not really helpful because the infra is not cleaned up properly between test runs

This helper assumes host machine is ~Unix + docker (or podman) + kind installed.
Yep we assume kind and docker is installed which should be the case if you want to run e2e with local resources. I could not test but it should also work on Windows since kind create cluster command should work also on windows

…ion that can be used with other local provider

KevinFairise2 · 2024-04-10T16:04:36Z

Updated the PR to take into account the suggestions. I also no longer deploy the fakeintake in Kubernetes, but rather deploy it locally in Docker. As discussed with @pducolin it should make things easier to use it with other local providers

components/datadog/fakeintake/docker.go

Co-authored-by: pducolin <45568537+pducolin@users.noreply.github.com>

components/datadog/fakeintake/docker.go

pducolin · 2024-05-07T14:03:36Z

components/datadog/fakeintake/docker.go

+	// The URL does not need to exist
+	conn, err := net.Dial("udp", "8.8.8.8:80")
+	if err != nil {
+		log.Fatal(err)


❓ question
Should you rather return the error, instead of panicking?

… kfairise/local-kind

KevinFairise2 · 2024-05-13T12:48:45Z

/merge

dd-devflow · 2024-05-13T12:48:59Z

🚂 MergeQueue

Pull request added to the queue.

This build is going to start soon! (estimated merge in less than 24m)

Use /merge -c to cancel this operation!

* Create local kind cluster install * Add API on Kubernetes Agent to be able to set environment variables * Update fakeintake env vars to be able to not use ssl * Local Fakeintake in Kubernetes * Use const for localPort * Fix lint * Do not install the fakeintake in Kubernetes, rather use a docker version that can be used with other local provider * Remove runner interface try * Remove not needed env var configuration * Remove unneeded kubeconfig modif * Remove configureEnvVars * Make linter happy * Remove AMI * Update components/datadog/fakeintake/docker.go Co-authored-by: pducolin <45568537+pducolin@users.noreply.github.com> * Update components/datadog/fakeintake/docker.go * gofmt * gomodtidy * Handle error * Use new Env interface --------- Co-authored-by: pducolin <45568537+pducolin@users.noreply.github.com>

KevinFairise2 added 5 commits February 26, 2024 17:39

Create local kind cluster install

7bfe97f

Merge branch 'main' into kfairise/local-kind

33a1630

Add API on Kubernetes Agent to be able to set environment variables

8e47989

Update fakeintake env vars to be able to not use ssl

b952dac

Local Fakeintake in Kubernetes

0fa8d53

KevinFairise2 commented Apr 4, 2024

View reviewed changes

components/datadog/fakeintake/component.go Outdated Show resolved Hide resolved

KevinFairise2 added 2 commits April 4, 2024 09:58

Use const for localPort

5df1e3c

Merge branch 'main' of github.com:DataDog/test-infra-definitions into…

2d12c95

… kfairise/local-kind

KevinFairise2 marked this pull request as ready for review April 4, 2024 08:59

KevinFairise2 requested a review from a team as a code owner April 4, 2024 08:59

KevinFairise2 mentioned this pull request Apr 4, 2024

ADX-252 Local kubernetes provider DataDog/datadog-agent#23153

Open

KevinFairise2 commented Apr 4, 2024

View reviewed changes

Fix lint

02f7fb0

pducolin reviewed Apr 4, 2024

View reviewed changes

components/datadog/agent/kubernetes_helm.go Show resolved Hide resolved

components/datadog/fakeintake/component.go Outdated Show resolved Hide resolved

vboulineau reviewed Apr 5, 2024

View reviewed changes

KevinFairise2 added 4 commits April 10, 2024 16:44

Do not install the fakeintake in Kubernetes, rather use a docker vers…

fde677b

…ion that can be used with other local provider

Remove runner interface try

29982fd

Remove not needed env var configuration

7804b1e

Remove unneeded kubeconfig modif

2e39a1d

KevinFairise2 requested review from pducolin and vboulineau April 10, 2024 16:03

KevinFairise2 added 3 commits April 10, 2024 18:05

Remove configureEnvVars

a12d6bf

Make linter happy

acafc92

Remove AMI

f77c11b

pducolin reviewed Apr 22, 2024

View reviewed changes

components/datadog/fakeintake/docker.go Outdated Show resolved Hide resolved

components/datadog/fakeintake/docker.go Outdated Show resolved Hide resolved

Update components/datadog/fakeintake/docker.go

5542a3f

Co-authored-by: pducolin <45568537+pducolin@users.noreply.github.com>

KevinFairise2 commented Apr 22, 2024

View reviewed changes

components/datadog/fakeintake/docker.go Outdated Show resolved Hide resolved

Update components/datadog/fakeintake/docker.go

050bab2

KevinFairise2 added 2 commits April 23, 2024 09:45

gofmt

9f6baba

gomodtidy

8d100bc

pducolin approved these changes May 7, 2024

View reviewed changes

pducolin reviewed May 7, 2024

View reviewed changes

KevinFairise2 added 3 commits May 13, 2024 09:32

Handle error

9f6a94e

Merge branch 'main' of github.com:DataDog/test-infra-definitions into…

bfc0096

… kfairise/local-kind

Use new Env interface

df37cf1

dd-devflow bot added mergequeue-status: queued mergequeue-status: in_progress and removed mergequeue-status: queued labels May 13, 2024

dd-mergequeue bot merged commit aac31c9 into main May 13, 2024
8 checks passed

dd-mergequeue bot deleted the kfairise/local-kind branch May 13, 2024 13:11

dd-devflow bot added mergequeue-status: done and removed mergequeue-status: in_progress labels May 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create local kind cluster install #647

Create local kind cluster install #647

KevinFairise2 commented Feb 26, 2024 •

edited

KevinFairise2 Apr 4, 2024

vboulineau left a comment

KevinFairise2 commented Apr 9, 2024 •

edited

KevinFairise2 commented Apr 10, 2024 •

edited

pducolin May 7, 2024

KevinFairise2 commented May 13, 2024

dd-devflow bot commented May 13, 2024

Create local kind cluster install #647

Create local kind cluster install #647

Conversation

KevinFairise2 commented Feb 26, 2024 • edited

What does this PR do?

Which scenarios this will impact?

Motivation

Additional Notes

KevinFairise2 Apr 4, 2024

Choose a reason for hiding this comment

vboulineau left a comment

Choose a reason for hiding this comment

KevinFairise2 commented Apr 9, 2024 • edited

KevinFairise2 commented Apr 10, 2024 • edited

pducolin May 7, 2024

Choose a reason for hiding this comment

KevinFairise2 commented May 13, 2024

dd-devflow bot commented May 13, 2024

KevinFairise2 commented Feb 26, 2024 •

edited

KevinFairise2 commented Apr 9, 2024 •

edited

KevinFairise2 commented Apr 10, 2024 •

edited