Rename ramenctl to ramendev for future debugging tool

Signed-off-by: Oded Viner <[email protected]>

.github/workflows/e2e.yaml

@@ -64,7 +64,7 @@ jobs:
     - name: Deploy ramen
       run: |
         source venv
-        ramenctl deploy test/envs/regional-dr.yaml
+        ramendev deploy test/envs/regional-dr.yaml
 
     - name: Configure ramen
       uses: nick-fields/retry@v3
@@ -73,7 +73,7 @@ jobs:
         max_attempts: 3
         command: |
           source venv
-          ramenctl config test/envs/regional-dr.yaml
+          ramendev config test/envs/regional-dr.yaml
 
     - name: Run e2e tests
       run: |

.github/workflows/tools.yaml

@@ -145,8 +145,8 @@ jobs:
         run: make coverage
         working-directory: test
 
-  ramenctl:
-    name: ramenctl
+  ramendev:
+    name: ramendev
     strategy:
       matrix:
         os:
@@ -179,12 +179,12 @@ jobs:
 
       - name: Run flake8
         run: make flake8
-        working-directory: ramenctl
+        working-directory: ramendev
 
       - name: Run pylint
         run: make pylint
-        working-directory: ramenctl
+        working-directory: ramendev
 
       - name: Run black
         run: make black
-        working-directory: ramenctl
+        working-directory: ramendev

.gitignore

@@ -48,7 +48,7 @@ test/addons/kubevirt/vm/id_rsa.pub
 *.egg-info/
 __pycache__/
 test/build
-ramenctl/build
+ramendev/build
 
 # Generated disk images
 *.qcow2

Makefile

@@ -203,8 +203,8 @@ test-cephfs-cg: generate manifests envtest ## Run util-pvc tests.
 test-drenv: ## Run drenv tests.
 	$(MAKE) -C test
 
-test-ramenctl: ## Run ramenctl tests.
-	$(MAKE) -C ramenctl
+test-ramendev: ## Run ramendev tests.
+	$(MAKE) -C ramendev
 
 e2e-rdr: generate manifests ## Run rdr-e2e tests.
 	cd e2e && ./run.sh

docs/devel-quick-start.md

@@ -101,24 +101,24 @@ This builds the image `quay.io/ramendr/ramen-operator:latest`
 ## Deploying the ramen operator
 
 You can either deploy the *Ramen* operator using the make targets or use the
-`ramenctl` tool. For more info on the `ramenctl` tool see
-[ramenctl/README.md](../ramenctl/README.md).
+`ramendev` tool. For more info on the `ramendev` tool see
+[ramendev/README.md](../ramendev/README.md).
 
-- Using `ramenctl`
+- Using `ramendev`
 
-    Ensure python virtual environment is active as `ramenctl` is a python tool.
+    Ensure python virtual environment is active as `ramendev` is a python tool.
 
-    - Deploy the *Ramen* operator in the environment using `ramenctl`.
+    - Deploy the *Ramen* operator in the environment using `ramendev`.
 
      ```sh
-     ramenctl deploy test/envs/regional-dr.yaml
+     ramendev deploy test/envs/regional-dr.yaml
      ```
 
     - Ramen needs to be configured to know about the managed clusters and the s3
    endpoints. Configure the ramen operator for environment.
 
     ```sh
-    ramenctl config test/envs/regional-dr.yaml
+    ramendev config test/envs/regional-dr.yaml
     ```
 
 ## Testing Ramen
@@ -131,6 +131,6 @@ If you want to clean up your environment, you can unconfigure *Ramen* and
 undeploy it.
 
 ```sh
-ramenctl unconfig test/envs/regional-dr.yaml
-ramenctl undeploy test/envs/regional-dr.yaml
+ramendev unconfig test/envs/regional-dr.yaml
+ramendev undeploy test/envs/regional-dr.yaml
 ```

docs/user-quick-start.md

@@ -356,17 +356,17 @@ This builds the image `quay.io/ramendr/ramen-operator:latest`
 To deploy the *Ramen* operator in the test environment:
 
 ```
-ramenctl deploy test/envs/regional-dr.yaml
+ramendev deploy test/envs/regional-dr.yaml
 ```
 
-For more info on the `ramenctl` tool see
-[ramenctl/README.md](../ramenctl/README.md).
+For more info on the `ramendev` tool see
+[ramendev/README.md](../ramendev/README.md).
 
 Ramen now needs to be configured to know about the managed clusters and the
 s3 endpoints. To configure the ramen operator for test environment:
 
 ```
-ramenctl config test/envs/regional-dr.yaml
+ramendev config test/envs/regional-dr.yaml
 ```
 
 ## Running system tests

hack/make-venv

@@ -15,8 +15,8 @@ $venv/bin/pip install --upgrade pip
 echo "Installing drenv..."
 $venv/bin/pip install -e test
 
-echo "Installing ramenctl..."
-$venv/bin/pip install -e ./ramenctl
+echo "Installing ramendev..."
+$venv/bin/pip install -e ./ramendev
 
 echo "Installing development tools"
 $venv/bin/pip install -r requirements.txt

ramendev/MANIFEST.in

@@ -0,0 +1 @@
+recursive-include ramendev/resources *

ramenctl/Makefile → ramendev/Makefile

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 sources := $(wildcard \
-	ramenctl \
+	ramendev \
 	*.py \
 )
 

ramenctl/README.md → ramendev/README.md

@@ -1,11 +1,11 @@
-# The ramenctl tool
+# The ramendev tool
 
-The `ramenctl` tool deploys and configures *ramen* on your development
+The `ramendev` tool deploys and configures *ramen* on your development
 clusters.
 
 ## Installing
 
-The ramenctl tool is installed when creating the python virtual
+The ramendev tool is installed when creating the python virtual
 environment.
 
 To update existing virtual environment run this in the root directory:
@@ -20,7 +20,7 @@ Deploy *ramen* from source using `quay.io/ramendr/ramen-operator:latest`
 on the hub and managed clusters specified in FILENAME.
 
 ```
-ramenctl deploy FILENAME
+ramendev deploy FILENAME
 ```
 
 ## Configure ramen hub operator
@@ -29,34 +29,34 @@ After deploying *ramen* we need to configure it for the environment. The
 configuration depends on the topology specified in the environment file.
 
 ```
-ramenctl config FILENAME
+ramendev config FILENAME
 ```
 
 ## Unconfigure ramen hub operator
 
 Before undeploying *ramen* unconfigure it so undo the changes made by
-`ramenctl config`.
+`ramendev config`.
 
 ```
-ramenctl unconfig FILENAME
+ramendev unconfig FILENAME
 ```
 
 ## Undeploying ramen on the hub and managed clusters
 
-Delete resources deployed by `ramenctl deploy` on the hub and managed
+Delete resources deployed by `ramendev deploy` on the hub and managed
 clusters.
 
 ```
-ramenctl undeploy FILENAME
+ramendev undeploy FILENAME
 ```
 
 ## Using isolated environments
 
 If we started a `drenv` environment using `--name-prefix` we must use
-the same argument when using `ramenctl`:
+the same argument when using `ramendev`:
 
 ```
 drenv start --name-prefix test- envs/regional-dr.yaml
-ramenctl deploy --name-prefix test- envs/regional-dr.yaml
-ramenctl config --name-prefix test- envs/regional-dr.yaml
+ramendev deploy --name-prefix test- envs/regional-dr.yaml
+ramendev config --name-prefix test- envs/regional-dr.yaml
 ```

ramenctl/ramenctl/__main__.py → ramendev/ramendev/__main__.py

@@ -22,12 +22,12 @@
     unconfig,
 ]
 
-log = logging.getLogger("ramenctl")
+log = logging.getLogger("ramendev")
 
 
 def main():
     parser = argparse.ArgumentParser(
-        prog="ramenctl",
+        prog="ramendev",
         description="Control ramen clusters",
     )
 

ramenctl/ramenctl/command.py → ramendev/ramendev/command.py

@@ -10,7 +10,7 @@
 RAMEN_NAMESPACE = "ramen-system"
 SOURCE_DIR = "."
 
-log = logging.getLogger("ramenctl")
+log = logging.getLogger("ramendev")
 
 
 def resource(name):

ramenctl/ramenctl/deploy.py → ramendev/ramendev/deploy.py

@@ -54,7 +54,7 @@ def run(args):
 
 def load_image(args):
     command.info("Loading image '%s'", args.image)
-    with tempfile.TemporaryDirectory(prefix="ramenctl-deploy-") as tmpdir:
+    with tempfile.TemporaryDirectory(prefix="ramendev-deploy-") as tmpdir:
         tar = os.path.join(tmpdir, "image.tar")
         command.watch("podman", "save", args.image, "-o", tar)
         cmd = ["drenv", "load", f"--image={tar}"]

ramenctl/setup.py → ramendev/setup.py

@@ -9,15 +9,15 @@
     long_description = f.read()
 
 setuptools.setup(
-    name="ramenctl",
+    name="ramendev",
     version="0.1.0",
     author="Nir Soffer",
     author_email="[email protected]",
     description="Tool for developing ramen",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/RamenDR/ramen/ramenctl",
-    packages=["ramenctl", "ramenctl.resources"],
+    url="https://github.com/RamenDR/ramen/ramendev",
+    packages=["ramendev", "ramendev.resources"],
     include_package_data=True,
     install_requires=[
         "PyYAML",
@@ -33,6 +33,6 @@
         "Topic :: Software Development :: Testing",
     ],
     entry_points={
-        "console_scripts": ["ramenctl=ramenctl.__main__:main"],
+        "console_scripts": ["ramendev=ramendev.__main__:main"],
     },
 )