Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add infrastructure for testing environment #559

Merged
merged 13 commits into from
Nov 2, 2022
Merged

Add infrastructure for testing environment #559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
f220f59
Add the drenv tool and library
nirs Sep 29, 2022
10bf22a
Start regional DR environment
nirs Sep 29, 2022
7b440f1
Install OCM
nirs Sep 29, 2022
3ec0b78
Install rook on managed clusters
nirs Sep 29, 2022
258004c
Install minio on the managed clusters
nirs Sep 29, 2022
0b962eb
Configure rbd mirroring
nirs Sep 29, 2022
2abcc50
Log rbd mirror image status in the self test
nirs Oct 25, 2022
8b439ed
Fix issue with old env version
nirs Oct 28, 2022
70bf690
Return the value of wait_for()
nirs Oct 31, 2022
40149a0
Use current cluster manager csv
nirs Oct 31, 2022
f499cc2
Use current klusterlet version
nirs Oct 31, 2022
01ffdff
Fix hardcoded cluster-manager images versions
nirs Oct 31, 2022
5b7f6fd
Fix klusterlet hard coded versions
nirs Oct 31, 2022
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
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,7 @@ config/hub/bundle
*.swo
*~
.vscode

# Test enviromemnt generated files
test/drenv.egg-info/
test/*/__pycache__/
297 changes: 297 additions & 0 deletions test/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
<!--
SPDX-FileCopyrightText: The RamenDR authors
nirs marked this conversation as resolved.
Show resolved Hide resolved
SPDX-License-Identifier: Apache-2.0
-->

# Ramen test environment

This directory provides tools and configuration for creating Ramen test
environment.

## Setup

1. Add yourself to the libvirt group (required for minikube kvm2 driver).

```
sudo usermod -a -G libvirt $(whoami)
```

1. Logout and login again for the change above to be in effect.

1. Install minikube, for example on RHEL/CentOS/Fedora:

```
sudo dnf install https://storage.googleapis.com/minikube/releases/latest/minikube-latest.x86_64.rpm
```

You need `minikube` version supporting the `--extra-disks` option.
The tool was tested with `minikube` v1.26.1.

1. Install the `drenv` package in a virtual environment:

Run this once in the root of the source tree:

```
python3 -m venv ~/.venv/ramen
source ~/.venv/ramen/bin/activate
pip install --upgrade pip
pip install -e ./test
```

You can create the virtual environment anywhere, but keeping the
environment outside of the source tree is good practice.

This installs a link file in the virtual environment:

```
$ cat /home/nsoffer/.venv/ramen/lib/python3.10/site-packages/drenv.egg-link
/home/nsoffer/src/ramen/test
```

So changes in the `test/drenv` package are available immediately
without installing the package again.

## Using the drenv tool

Before running the `drenv` tool you need to activate the virtual
environment:

```
source ~/.venv/ramen/bin/activate
```

The shell prompt will change to reflect that the `ramen` virtual
environment is active:

```
(ramen) [user@host test]$
```

Change directory to the test directory where the environment yamls and
scripts are:

```
cd test
```

To start the environment:

```
drenv start example.yaml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Older version of minikube will complain that --extra-disk option does not exist. A new version of minikube is needed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And after that it failed with this:

2022-10-28 15:02:16,610 ERROR   [ex1] Cluster failed
Traceback (most recent call last):
  File "/home/user1/projects/github/ramen/test/drenv/__main__.py", line 120, in execute
    f.result()
  File "/usr/lib64/python3.6/concurrent/futures/_base.py", line 425, in result
    return self.__get_result()
  File "/usr/lib64/python3.6/concurrent/futures/_base.py", line 384, in __get_result
    raise self._exception
  File "/usr/lib64/python3.6/concurrent/futures/thread.py", line 56, in run
    result = self.fn(*self.args, **self.kwargs)
  File "/home/user1/projects/github/ramen/test/drenv/__main__.py", line 147, in start_cluster
    run_script(script, name=profile["name"])
  File "/home/user1/projects/github/ramen/test/drenv/__main__.py", line 178, in run_script
    run(script["file"], *script["args"], name=name)
  File "/home/user1/projects/github/ramen/test/drenv/__main__.py", line 201, in run
    f"[{name}] Command {cmd} failed rc={p.returncode}\n"
RuntimeError: [ex1] Command ('example/start', 'ex1') failed rc=125

Last messages:
  /usr/bin/env: invalid option -- 'S'
  Try '/usr/bin/env --help' for more information.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add a note about minimal minkube version.

Which OS are you running? this was tested on Fedora 36, which has:

$ env --version
env (GNU coreutils) 9.0

But we the -S argument is needed only for the using unbuffered output, and we can solve
this in a better way.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am using CentOS 7.
The patch you posted fixed the problem.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using Centos 7 (8 years old now?) is a bit extreme for development tool, I think it will
be hard to support it.

I think supporting current Fedora (and maybe current Ubuntu/Debian) is good enough.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Older version of minikube will complain that --extra-disk option does not exist. A new version of minikube is needed.

Current version mention --extra-disk and the minikube version that I tested with.

```

To stop the environment:

```
drenv stop example.yaml
```

To delete the environment:

```
drenv delete example.yaml
```

Useful options:

- `-v`, `--verbose`: Show verbose logs
- `-h`, `--help`: Show online help

When you are done you can deactivate the virtual environment:

```
deactivate
```

## The environment file

To create an environment you need an yaml file describing the
clusters and how to deploy them.

### Example environment file

```
# Example environment.

profiles:
- name: "ex1"
scripts:
- file: example/start
- name: "ex2"
scripts:
- file: example/start
scripts:
- file: example/test
args: ["ex1", "ex2"]
```

### Experimenting with the example environment

You can play with the example environment to understand how the `drenv`
tool works and how to write scripts.

Starting the example environment:

```
$ drenv start example.yaml
2022-09-22 20:47:32,368 INFO [env] Using example.yaml
2022-09-22 20:47:32,371 INFO [ex1] Starting cluster
2022-09-22 20:47:32,371 INFO [ex2] Starting cluster
2022-09-22 20:48:10,538 INFO [ex2] Cluster started in 38.17 seconds
2022-09-22 20:48:10,538 INFO [ex2] Starting example/start
2022-09-22 20:48:10,754 INFO [ex2] example/start completed in 0.22 seconds
2022-09-22 20:48:27,509 INFO [ex1] Cluster started in 55.14 seconds
2022-09-22 20:48:27,509 INFO [ex1] Starting example/start
2022-09-22 20:48:27,915 INFO [ex1] example/start completed in 0.41 seconds
2022-09-22 20:48:27,915 INFO [env] Starting example/test
2022-09-22 20:48:51,202 INFO [env] example/test completed in 23.29 seconds
2022-09-22 20:48:51,203 INFO [env] Started in 78.83 seconds
```

We have 2 minikube profiles:

```
$ minikube profile list
|---------|-----------|------------|----------------|------|---------|---------|-------|--------|
| Profile | VM Driver | Runtime | IP | Port | Version | Status | Nodes | Active |
|---------|-----------|------------|----------------|------|---------|---------|-------|--------|
| ex1 | kvm2 | containerd | 192.168.50.136 | 8443 | v1.24.3 | Running | 1 | |
| ex2 | kvm2 | containerd | 192.168.39.240 | 8443 | v1.24.3 | Running | 1 | |
|---------|-----------|------------|----------------|------|---------|---------|-------|--------|
```

ngix was deployed on both clusters:

```
$ minikube kubectl -p ex1 -- get pods
NAME READY STATUS RESTARTS AGE
nginx-deployment-6595874d85-sr5nt 1/1 Running 0 3m32s

$ minikube kubectl -p ex2 -- get pods
NAME READY STATUS RESTARTS AGE
nginx-deployment-6595874d85-bq7lq 1/1 Running 0 4m19s
```

After starting both clusters, we run the `example/test` script. We can
run the script manually again to test the clusters:

```
$ example/test ex1 ex2
* Testing example deploymnet on cluster ex1
deployment "nginx-deployment" successfully rolled out
* Testing example deploymnet on cluster ex2
deployment "nginx-deployment" successfully rolled out
```

If something failed while starting, we can run start again. This is
typically much faster:

```
$ drenv start example.yaml
2022-09-22 20:51:41,309 INFO [env] Using example.yaml
2022-09-22 20:51:41,311 INFO [ex1] Starting cluster
2022-09-22 20:51:41,311 INFO [ex2] Starting cluster
2022-09-22 20:51:55,456 INFO [ex2] Cluster started in 14.14 seconds
2022-09-22 20:51:55,456 INFO [ex2] Starting example/start
2022-09-22 20:51:55,671 INFO [ex1] Cluster started in 14.36 seconds
2022-09-22 20:51:55,671 INFO [ex1] Starting example/start
2022-09-22 20:51:55,678 INFO [ex2] example/start completed in 0.22 seconds
2022-09-22 20:51:55,868 INFO [ex1] example/start completed in 0.20 seconds
2022-09-22 20:51:55,868 INFO [env] Starting example/test
2022-09-22 20:51:56,089 INFO [env] example/test completed in 0.22 seconds
2022-09-22 20:51:56,089 INFO [env] Started in 14.78 seconds
```

While debugging it is useful to use the `--verbose` option to see much
more details from scripts:

```
$ drenv start example.yaml -v
2022-09-22 20:52:20,518 INFO [env] Using example.yaml
2022-09-22 20:52:20,520 INFO [ex1] Starting cluster
2022-09-22 20:52:20,520 INFO [ex2] Starting cluster
2022-09-22 20:52:20,573 DEBUG [ex1] * [ex1] minikube v1.26.1 on Fedora 36
2022-09-22 20:52:20,573 DEBUG [ex2] * [ex2] minikube v1.26.1 on Fedora 36
2022-09-22 20:52:20,574 DEBUG [ex2] - MINIKUBE_HOME=/data/minikube
2022-09-22 20:52:20,574 DEBUG [ex1] - MINIKUBE_HOME=/data/minikube
2022-09-22 20:52:21,073 DEBUG [ex2] * Using the kvm2 driver based on existing profile
2022-09-22 20:52:21,082 DEBUG [ex1] * Using the kvm2 driver based on existing profile
2022-09-22 20:52:21,091 DEBUG [ex2] * Starting control plane node ex2 in cluster ex2
2022-09-22 20:52:21,109 DEBUG [ex1] * Starting control plane node ex1 in cluster ex1
2022-09-22 20:52:21,159 DEBUG [ex2] * Updating the running kvm2 "ex2" VM ...
2022-09-22 20:52:22,542 DEBUG [ex1] * Updating the running kvm2 "ex1" VM ...
2022-09-22 20:52:26,852 DEBUG [ex2] * Preparing Kubernetes v1.24.3 on containerd 1.6.6 ...
2022-09-22 20:52:27,986 DEBUG [ex1] * Preparing Kubernetes v1.24.3 on containerd 1.6.6 ...
2022-09-22 20:52:37,553 DEBUG [ex2] * Configuring bridge CNI (Container Networking Interface) ...
2022-09-22 20:52:37,811 DEBUG [ex2] * Verifying Kubernetes components...
2022-09-22 20:52:37,889 DEBUG [ex2] - Using image gcr.io/k8s-minikube/storage-provisioner:v5
2022-09-22 20:52:38,661 DEBUG [ex2] * Enabled addons: storage-provisioner, default-storageclass
2022-09-22 20:52:38,664 DEBUG [ex2] * kubectl not found. If you need it, try: 'minikube kubectl -- get pods -A'
2022-09-22 20:52:38,665 DEBUG [ex2] * Done! kubectl is now configured to use "ex2" cluster and "default" namespace by default
2022-09-22 20:52:38,687 INFO [ex2] Cluster started in 18.17 seconds
2022-09-22 20:52:38,687 INFO [ex2] Starting example/start
2022-09-22 20:52:38,715 DEBUG [ex2] * Deploying nginx on cluster ex2
2022-09-22 20:52:38,786 DEBUG [ex1] * Configuring bridge CNI (Container Networking Interface) ...
2022-09-22 20:52:38,888 DEBUG [ex2] deployment.apps/nginx-deployment unchanged
2022-09-22 20:52:38,892 INFO [ex2] example/start completed in 0.20 seconds
2022-09-22 20:52:38,999 DEBUG [ex1] * Verifying Kubernetes components...
2022-09-22 20:52:39,073 DEBUG [ex1] - Using image gcr.io/k8s-minikube/storage-provisioner:v5
2022-09-22 20:52:39,990 DEBUG [ex1] * Enabled addons: storage-provisioner, default-storageclass
2022-09-22 20:52:39,992 DEBUG [ex1] * kubectl not found. If you need it, try: 'minikube kubectl -- get pods -A'
2022-09-22 20:52:39,994 DEBUG [ex1] * Done! kubectl is now configured to use "ex1" cluster and "default" namespace by default
2022-09-22 20:52:40,014 INFO [ex1] Cluster started in 19.49 seconds
2022-09-22 20:52:40,014 INFO [ex1] Starting example/start
2022-09-22 20:52:40,041 DEBUG [ex1] * Deploying nginx on cluster ex1
2022-09-22 20:52:40,207 DEBUG [ex1] deployment.apps/nginx-deployment unchanged
2022-09-22 20:52:40,211 INFO [ex1] example/start completed in 0.20 seconds
2022-09-22 20:52:40,211 INFO [env] Starting example/test
2022-09-22 20:52:40,234 DEBUG [env] * Testing example deploymnet on cluster ex1
2022-09-22 20:52:40,339 DEBUG [env] deployment "nginx-deployment" successfully rolled out
2022-09-22 20:52:40,339 DEBUG [env] * Testing example deploymnet on cluster ex2
2022-09-22 20:52:40,444 DEBUG [env] deployment "nginx-deployment" successfully rolled out
2022-09-22 20:52:40,448 INFO [env] example/test completed in 0.24 seconds
2022-09-22 20:52:40,448 INFO [env] Started in 19.93 seconds
```

We can stop the environment and start it later. This can be faster than
recreating it from scratch, but tends to be flaky.

To delete the environment:

```
$ drenv delete example.yaml
2022-09-22 20:54:05,106 INFO [env] Using example.yaml
2022-09-22 20:54:05,108 INFO [ex1] Deleting cluster
2022-09-22 20:54:05,109 INFO [ex2] Deleting cluster
2022-09-22 20:54:05,863 INFO [ex2] Cluster deleted in 0.75 seconds
2022-09-22 20:54:05,906 INFO [ex1] Cluster deleted in 0.80 seconds
2022-09-22 20:54:05,906 INFO [env] Deleted in 0.80 seconds
```

### The environment file format

- `profiles`: list of profiles.
- `name`: profile name.
- `container_runtime`: The container runtime to be used. Valid
options: "docker", "cri-o", "containerd" (default: "containerd")
- `network`: The network to run minikube with. If left empty,
minikube will create a new isolated network.
- `extra_disks`: Number of extra disks (default 0)
- `disk_size`: Disk size string (default "50g")
- `nodes`: Number of cluster nodes (default 1)
- `cni`: Network plugin (default "auto")
- `cpus`: Number of CPUs per VM (default 2)
- `memory`: Memory per VM (default 4g)
- `scripts`: Optional list of scripts to run during start.
- `file`: Script filename
- `args`: Optional argument to the script. If not specified the
script is run without any arguments.
- `scripts`: Optional list of scripts to run after the profile scripts.
- `file`: Script filename
- `args`: Optional argument to the script. If not specified the
script is run without any arguments.

## The regional-dr environment

This is a configuration for testing regional DR using a hub cluster and
2 managed clusters.
18 changes: 18 additions & 0 deletions test/cluster-manager/cluster-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# SPDX-FileCopyrightText: The RamenDR authors
# SPDX-License-Identifier: Apache-2.0

---
apiVersion: operator.open-cluster-management.io/v1
kind: ClusterManager
metadata:
name: cluster-manager
spec:
deployOption:
mode: Default
placementImagePullSpec: 'quay.io/open-cluster-management/placement:v0.9.0'
registrationConfiguration:
featureGates:
- feature: DefaultClusterSet
mode: Enable
registrationImagePullSpec: 'quay.io/open-cluster-management/registration:v0.9.0'
workImagePullSpec: 'quay.io/open-cluster-management/work:v0.9.0'
Copy link
Member Author

@nirs nirs Oct 31, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This yaml looks exactly like the alm example - can we drop it and use the example from
the csv?

$ minikube kubectl -p hub -- get csv -n operators cluster-manager.v0.9.1 -o jsonpath='{.metadata.annotations.alm-examples}' | jq
[
  {
    "apiVersion": "operator.open-cluster-management.io/v1",
    "kind": "ClusterManager",
    "metadata": {
      "name": "cluster-manager"
    },
    "spec": {
      "deployOption": {
        "mode": "Default"
      },
      "placementImagePullSpec": "quay.io/open-cluster-management/placement:v0.9.0",
      "registrationConfiguration": {
        "featureGates": [
          {
            "feature": "DefaultClusterSet",
            "mode": "Enable"
          }
        ]
      },
      "registrationImagePullSpec": "quay.io/open-cluster-management/registration:v0.9.0",
      "workImagePullSpec": "quay.io/open-cluster-management/work:v0.9.0"
    }
  },
  {
    "apiVersion": "operator.open-cluster-management.io/v1",
    "kind": "ClusterManager",
    "metadata": {
      "name": "cluster-manager"
    },
    "spec": {
      "deployOption": {
        "hosted": {
          "registrationWebhookConfiguration": {
            "address": "management-control-plane",
            "port": 30443
          },
          "workWebhookConfiguration": {
            "address": "management-control-plane",
            "port": 31443
          }
        },
        "mode": "Hosted"
      },
      "placementImagePullSpec": "quay.io/open-cluster-management/placement:v0.9.0",
      "registrationImagePullSpec": "quay.io/open-cluster-management/registration:v0.9.0",
      "workImagePullSpec": "quay.io/open-cluster-management/work:v0.9.0"
    }
  }
]

Loading