Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ task documentation:ci # Run documentation CI
task documentation:spellcheck # Run spellcheck

# Integration testing
task integration:devenv # Create ephemeral development environment
task integration:e2e # Run e2e tests (requires KIND_CLUSTER_NAME)

# Cleanup
Expand Down Expand Up @@ -70,6 +69,14 @@ task core:go-test
cd operator && go test ./... -v
```

The operator controller tests use envtest. Running them directly (outside
`task operator:go-test`) requires the envtest binaries in `operator/bin/k8s`:

```bash
go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
cd operator && setup-envtest use --bin-dir bin
```

#### Running a Single Test
```bash
# Core module
Expand Down
10 changes: 0 additions & 10 deletions Taskfile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1593,16 +1593,6 @@ tasks:
sources:
- integration/tests/machinery/**/*.go

integration:devenv:
desc: Create and connect to an ephemeral development environment
interactive: true
deps:
- core:containerize-snapshot
- operator:containerize-snapshot
- operator:helm-chart
cmds:
- dagger call -m integration/dagger/devenv kubernetes --source .

integration:deploy-to-kind:
desc: Deploy the operator on a kind cluster generated by the CNPG hack setup script
summary: |
Expand Down
26 changes: 0 additions & 26 deletions documentation/web/docs/developer/developers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,6 @@ sidebar_position: 1

* A [dagger](https://dagger.io/) installation

## How to get an ephemeral development environment

For a quick and convenient development experience, you can create an ephemeral
development environment using the `integration:devenv` task from the Taskfile:

```sh
task integration:devenv
```

This command creates and connects you to an ephemeral development environment
with all the necessary components pre-configured, making it easier to test and
develop Klio features without affecting your local setup.

Here are the instructions to deploy the Klio server and the CNPG cluster with
the Klio plugin, using manifests under `operator/config/samples`.
The following commands are executed inside the dagger container created from
the previous step:

```sh
# Deploy the Klio server with the related resources
dagger /apps $ kubectl apply -f ../operator/config/samples/klio_v1alpha1_server.yaml

# Deploy the CNPG Cluster with a patch for the plugin and the related PluginConfiguration CR
dagger /apps $ kubectl apply -f ../operator/config/samples/cluster-example-plugin.yaml
```

## How to test Klio in a kind cluster during development

During the development phase, it is recommended to test any changes in a test
Expand Down
4 changes: 0 additions & 4 deletions integration/dagger/devenv/.gitattributes

This file was deleted.

5 changes: 0 additions & 5 deletions integration/dagger/devenv/.gitignore

This file was deleted.

20 changes: 0 additions & 20 deletions integration/dagger/devenv/dagger.json

This file was deleted.

56 changes: 0 additions & 56 deletions integration/dagger/devenv/go.mod

This file was deleted.

97 changes: 0 additions & 97 deletions integration/dagger/devenv/go.sum

This file was deleted.

Loading
Loading