Add lima provider for macOS

docs/user-quick-start.md

@@ -142,7 +142,7 @@ enough resources:
 1. Install `subctl` tool, See
    [Submariner subctl installation](https://submariner.io/operations/deployment/subctl/)
    for the details.
-   Version v0.17.0 or later is required.
+   Version v0.18.0 or later is required.
 
 1. Install the `velero` tool
 

ramenctl/ramenctl/command.py

@@ -76,8 +76,8 @@ def run(*args):
     return commands.run(*args)
 
 
-def watch(*args, log=log.debug):
-    for line in commands.watch(*args):
+def watch(*args, stderr=None, cwd=None, log=log.debug):
+    for line in commands.watch(*args, stderr=stderr, cwd=cwd):
         log("%s", line)
 
 

ramenctl/ramenctl/deploy.py

@@ -3,9 +3,11 @@
 
 import concurrent.futures
 import os
+import subprocess
 import tempfile
 
 from drenv import kubectl
+
 from . import command
 
 IMAGE = "quay.io/ramendr/ramen-operator:latest"
@@ -33,32 +35,37 @@ def run(args):
     command.info("Preparing resources")
     command.watch("make", "-C", args.source_dir, "resources")
 
-    with tempfile.TemporaryDirectory(prefix="ramenctl-deploy-") as tmpdir:
-        tar = os.path.join(tmpdir, "image.tar")
-        command.info("Saving image '%s'", args.image)
-        command.watch("podman", "save", args.image, "-o", tar)
+    load_image(args)
 
-        with concurrent.futures.ThreadPoolExecutor() as executor:
-            futures = []
+    with concurrent.futures.ThreadPoolExecutor() as executor:
+        futures = []
 
-            if env["hub"]:
-                f = executor.submit(
-                    deploy, args, env["hub"], tar, "hub", platform="k8s"
-                )
-                futures.append(f)
+        if env["hub"]:
+            f = executor.submit(deploy, args, env["hub"], "hub", platform="k8s")
+            futures.append(f)
 
-            for cluster in env["clusters"]:
-                f = executor.submit(deploy, args, cluster, tar, "dr-cluster")
-                futures.append(f)
+        for cluster in env["clusters"]:
+            f = executor.submit(deploy, args, cluster, "dr-cluster")
+            futures.append(f)
 
-            for f in concurrent.futures.as_completed(futures):
-                f.result()
+        for f in concurrent.futures.as_completed(futures):
+            f.result()
 
 
-def deploy(args, cluster, tar, deploy_type, platform="", timeout=120):
-    command.info("Loading image in cluster '%s'", cluster)
-    command.watch("minikube", "--profile", cluster, "image", "load", tar)
+def load_image(args):
+    command.info("Loading image '%s'", args.image)
+    with tempfile.TemporaryDirectory(prefix="ramenctl-deploy-") as tmpdir:
+        tar = os.path.join(tmpdir, "image.tar")
+        command.watch("podman", "save", args.image, "-o", tar)
+        cmd = ["drenv", "load", f"--image={tar}"]
+        if args.name_prefix:
+            cmd.append(f"--name-prefix={args.name_prefix}")
+        cmd.append(os.path.abspath(args.filename))
+        work_dir = os.path.join(args.source_dir, "test") if args.source_dir else None
+        command.watch(*cmd, stderr=subprocess.STDOUT, cwd=work_dir)
+
 
+def deploy(args, cluster, deploy_type, platform="", timeout=120):
     command.info("Deploying ramen operator in cluster '%s'", cluster)
     overlay = os.path.join(args.source_dir, f"config/{deploy_type}/default", platform)
     yaml = kubectl.kustomize(overlay, load_restrictor="LoadRestrictionsNone")

test/README.md

@@ -8,7 +8,7 @@ SPDX-License-Identifier: Apache-2.0
 This directory provides tools and configuration for creating Ramen test
 environment.
 
-## Setup
+## Setup on Linux
 
 1. Setup a development environment as describe in
    [developer quick start guide](../docs/devel-quick-start.md)
@@ -41,7 +41,7 @@ environment.
 1. Install `subctl` tool, See
    [Submariner subctl installation](https://submariner.io/operations/deployment/subctl/)
    for the details.
-   Version v0.17.0 or later is required.
+   Version v0.18.0 or later is required.
 
 1. Install the `velero` tool
 
@@ -110,14 +110,82 @@ environment.
 1. Install the `kubectl-gather` plugin
 
    ```
-   curl -L -o kubectl-gather https://github.com/nirs/kubectl-gather/releases/download/v0.4.1/kubectl-gather-v0.4.1-linux-amd64
+   curl -L -o kubectl-gather https://github.com/nirs/kubectl-gather/releases/download/v0.5.1/kubectl-gather-v0.5.1-linux-amd64
    sudo install kubectl-gather /usr/local/bin
    rm kubectl-gather
    ```
 
    For more info see [kubectl-gather](https://github.com/nirs/kubectl-gather)
 
-### Testing that drenv is healthy
+## Setup on macOS
+
+1. Install the [Homebrew package manager](https://brew.sh/)
+
+1. Install required packages
+
+   ```
+   brew install go kubectl kustomize helm velero virtctl minio-mc argocd
+   ```
+
+1. Install the `clusteradm` tool. See
+   [Install clusteradm CLI tool](https://open-cluster-management.io/getting-started/installation/start-the-control-plane/#install-clusteradm-cli-tool)
+   for the details. Version v0.8.1 or later is required.
+
+1. Install the `subctl` tool, See
+   [Submariner subctl installation](https://submariner.io/operations/deployment/subctl/)
+   for the details. Version v0.18.0 or later is required.
+
+1. Install the `kubectl-gather` plugin
+
+   ```
+   curl -L -o kubectl-gather https://github.com/nirs/kubectl-gather/releases/download/v0.5.1/kubectl-gather-v0.5.1-darwin-arm64
+   sudo install kubectl-gather /usr/local/bin
+   rm kubectl-gather
+   ```
+
+   For more info see [kubectl-gather](https://github.com/nirs/kubectl-gather)
+
+1. Install `lima` from source
+
+   > [!NOTE]
+   > Do not install lima from brew, it is too old.
+
+   Clone and build lima:
+
+   ```
+   git clone https://github.com/lima-vm/lima.git
+   cd lima
+   make
+   ```
+
+   Edit `~/.zshrc` and add `$HOME/lima/_output/bin` directory to the PATH:
+
+   ```
+   PATH="$HOME/lima/_output/bin:$PATH"
+   export PATH
+   ```
+
+   Open a new shell or run this in the current shell:
+
+   ```
+   export PATH="$HOME/lima/_output/bin:$PATH"
+   ```
+
+1. Install `socket_vmnet` from source
+
+   > [!IMPORTANT]
+   > Do not install socket_vmnet from brew, it is insecure.
+
+   ```
+   git clone https://github.com/lima-vm/socket_vmnet.git
+   cd socket_vmnet
+   sudo make PREFIX=/opt/socket_vmnet install.bin
+   sudo make PREFIX=/opt/socket_vmnet install.launchd
+   ```
+
+   For more info see [Installing socket_vmnet from source](https://github.com/lima-vm/socket_vmnet?tab=readme-ov-file#from-source)
+
+## Testing that drenv is healthy
 
 Run this script to make sure `drenv` works:
 

test/addons/external-snapshotter/cache

@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: The RamenDR authors
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+from drenv import cache
+
+os.chdir(os.path.dirname(__file__))
+cache.refresh("crds", "addons/external-snapshotter-crds-8.1.0.yaml")
+cache.refresh("controller", "addons/external-snapshotter-controller-8.1.0.yaml")

test/addons/external-snapshotter/controller/kustomization.yaml

@@ -0,0 +1,4 @@
+---
+resources:
+  - https://github.com/kubernetes-csi/external-snapshotter/deploy/kubernetes/snapshot-controller?ref=v8.1.0
+namespace: kube-system

test/addons/external-snapshotter/crds/kustomization.yaml

@@ -0,0 +1,3 @@
+---
+resources:
+  - https://github.com/kubernetes-csi/external-snapshotter/client/config/crd?ref=v8.1.0

test/addons/external-snapshotter/start

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+
+# SPDX-FileCopyrightText: The RamenDR authors
+# SPDX-License-Identifier: Apache-2.0
+
+import os
+import sys
+
+from drenv import kubectl
+from drenv import cache
+
+
+def deploy(cluster):
+    print("Deploying crds")
+    path = cache.get("crds", "addons/external-snapshotter-crds-8.1.0.yaml")
+    kubectl.apply("--filename", path, context=cluster)
+
+    print("Waiting until crds are established")
+    kubectl.wait("--for=condition=established", "--filename", path, context=cluster)
+
+    print("Deploying snapshot-controller")
+    path = cache.get("controller", "addons/external-snapshotter-controller-8.1.0.yaml")
+    kubectl.apply("--filename", path, context=cluster)
+
+
+def wait(cluster):
+    print("Waiting until snapshot-controller is rolled out")
+    kubectl.rollout(
+        "status",
+        "deploy/snapshot-controller",
+        "--namespace=kube-system",
+        "--timeout=300s",
+        context=cluster,
+    )
+
+
+if len(sys.argv) != 2:
+    print(f"Usage: {sys.argv[0]} cluster")
+    sys.exit(1)
+
+os.chdir(os.path.dirname(__file__))
+cluster = sys.argv[1]
+
+deploy(cluster)
+wait(cluster)

test/addons/minio/minio.yaml

@@ -9,15 +9,31 @@ metadata:
   name: minio
 ---
 apiVersion: v1
+kind: PersistentVolume
+metadata:
+  name: minio-storage-pv
+  labels:
+    component: minio
+spec:
+  storageClassName: manual
+  capacity:
+    storage: 10Gi
+  accessModes:
+    - ReadWriteOnce
+  hostPath:
+    path: /mnt/minio
+---
+apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
   namespace: minio
   name: minio-storage-pvc
   labels:
     component: minio
 spec:
-  accessModes: ["ReadWriteOnce"]
-  storageClassName: "standard"
+  accessModes:
+    - ReadWriteOnce
+  storageClassName: manual
   resources:
     requests:
       storage: 10Gi
@@ -47,7 +63,7 @@ spec:
             readOnly: false
       containers:
         - name: minio
-          image: quay.io/minio/minio:RELEASE.2024-03-15T01-07-19Z
+          image: quay.io/minio/minio:RELEASE.2024-08-29T01-40-52Z
           imagePullPolicy: IfNotPresent
           resources:
             limits:

test/addons/rook-pool/snapshot-class.yaml

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: The RamenDR authors
+# SPDX-License-Identifier: Apache-2.0
+
+# yamllint disable rule:line-length
+# Drived from https://raw.githubusercontent.com/rook/rook/release-1.15/deploy/examples/csi/rbd/snapshotclass.yaml
+---
+apiVersion: snapshot.storage.k8s.io/v1
+kind: VolumeSnapshotClass
+metadata:
+  name: csi-rbdplugin-snapclass
+driver: rook-ceph.rbd.csi.ceph.com
+parameters:
+  clusterID: rook-ceph
+  csi.storage.k8s.io/snapshotter-secret-name: rook-csi-rbd-provisioner
+  csi.storage.k8s.io/snapshotter-secret-namespace: rook-ceph
+deletionPolicy: Delete

test/addons/rook-pool/start

@@ -14,10 +14,11 @@ from drenv import kubectl
 
 
 def deploy(cluster):
-    print("Creating rbd pool and storage class")
+    print("Creating RBD pool and storage/snapshot classes")
     kubectl.apply(
         "--filename=replica-pool.yaml",
         "--filename=storage-class.yaml",
+        "--filename=snapshot-class.yaml",
         context=cluster,
     )
 

test/addons/submariner/base/src/pod.yaml

@@ -17,5 +17,7 @@ spec:
         - -c
         - |
           trap exit TERM
-          sleep 300 &
-          wait
+          while true; do
+            sleep 10 &
+            wait
+          done