start of work to add podman support

Signed-off-by: vsoch <[email protected]>

Author: vsoch

CHANGELOG.md

@@ -13,7 +13,8 @@ and **Merged pull requests**. Critical items to know are:
 
 The versions coincide with releases on pip. Only major versions will be released as tags on Github.
 
-## [0.0.x](https://github.com/singularityhub/singularity-hpc/tree/master) (0.0.x)
+## [0.0.x](https://github.scom/singularityhub/singularity-hpc/tree/master) (0.0.x)
+ - Podman support (0.0.25)
  - adding namespaces to make module install, show, inspect easier (0.0.24)
  - added support for env section to render to bound environment file
  - added support for container features like gpu

README.md

@@ -4,11 +4,16 @@
 
 ![https://raw.githubusercontent.com/singularityhub/singularity-hpc/main/docs/assets/img/shpc.png](https://raw.githubusercontent.com/singularityhub/singularity-hpc/main/docs/assets/img/shpc.png)
 
-Singularity HPC is based off of the [Singularity Registry Client](https://github.com/singularityhub/sregistry-cli), but instead of
-being intended for general interaction with Singularity containers and a local database, it's optimized for managing containers
-in an HPC environment. Currently, this includes:
+Singularity HPC is optimized for managing containers in an HPC environment. Currently, this includes
+module technologies:
 
  - [LMOD](https://lmod.readthedocs.io/en/latest/)
+ - [Environment Modules](http://modules.sourceforge.net/)
+
+And container technologies:
+
+ - [Singularity](https://github.com/sylabs/singularity)
+ - [Podman](https://podman.io)
 
 You can use shpc if you are:
 
@@ -29,11 +34,6 @@ There are other tools that you might be interested in!
  - [Community Collections](https://github.com/community-collections/community-collections)
  - [Spack](https://spack.readthedocs.io/en/latest/module_file_support.html) installs modules for software built from source (not containers).
 
-## TODOS
- 
- - add other registry containers
- - the admin that runs shpc should have an easier way to see commands (other than lmod)
- - ensure that we print columns to shpc list
 
 ## License
 

shpc/client/__init__.py

@@ -210,7 +210,7 @@ def get_parser():
             "--container_tech",
             dest="container_tech",
             help="container technology to use to override settings.yaml",
-            choices=["singularity"],
+            choices=["singularity", "podman"],
             default=None,
         )
 

shpc/main/__init__.py

@@ -40,9 +40,12 @@ def get_client(quiet=False, **kwargs):
     # Add the container operator
     if container == "singularity":
         from .container import SingularityContainer
-
         Client._container = SingularityContainer()
 
+    elif container == "podman"
+        from .container import PodmanContainer
+        Client._container = PodmanContainer()
+
     # Give the user a warning:
     if not check_install():
         logger.warning("Singularity is not installed, functionality might be limited.")

shpc/main/container.py

@@ -140,6 +140,95 @@ def _pull_github(self, uri, dest=None):
         return self.client.pull(url, name=name, pull_folder=os.path.dirname(dest))
 
 
+class PodmanContainer(ContainerTechnology):
+    """
+    A Podman container controleer.
+    """
+
+    # The module technology adds extensions here
+    templatefile = "podman"
+
+    # TODO: how to define gpu for podman
+    features = {"gpu": {"nvidia": "", "amd": ""}}
+
+    def __init__(self):
+        print("INIT")
+        import IPython
+        IPython.embed()
+        try:
+            from spython.main import Client
+
+            self.client = Client
+        except:
+            logger.exit("podman (pip install podman) is required to use podman.")
+
+    def shell(self, image):
+        """
+        Interactive shell into a container image.
+        """
+        print("SHELL")
+        import IPython
+        IPython.embed()
+        self.client.shell(image)
+
+    def pull(self, uri, dest):
+        """
+        Pull a container to a destination
+        """
+        print("PULL")
+        import IPython
+        IPython.embed()
+
+        if re.search("^(docker|shub|https)", uri):
+            return self._pull(uri, dest)
+        elif uri.startswith("gh://"):
+            return self._pull_github(uri, dest)
+
+    def _pull(self, uri, dest):
+        """
+        Pull a URI that Singularity recognizes
+        """
+        pull_folder = os.path.dirname(dest)
+        name = os.path.basename(dest)
+        return self.client.pull(uri, name=name, pull_folder=pull_folder)
+
+    def inspect(self, image):
+        """
+        Inspect an image and return metadata.
+        """
+        return self.client.inspect(image)
+
+    def _pull_github(self, uri, dest=None):
+        """
+        Pull a singularity-deploy container to a destination
+        """
+        # Assemble the url based on the container uri
+        uri = uri.replace("gh://", "", 1)
+
+        # repository name and image prefix
+        repo = "/".join(uri.split("/")[0:2])
+        prefix = repo.replace("/", "-")
+
+        # The tag includes release and contianer tag (e.g., 0.0.1:latest)
+        tag = uri.replace(repo, "", 1).strip("/")
+        github_tag, container_tag = tag.split(":", 1)
+
+        # Assemble the artifact url
+        url = "https://github.com/%s/releases/download/%s/%s.%s.sif" % (
+            repo,
+            github_tag,
+            prefix,
+            container_tag,
+        )
+
+        # If no destination, default to present working directory
+        if not dest:
+            dest = os.path.basename(url)
+        name = os.path.basename(dest)
+        return self.client.pull(url, name=name, pull_folder=os.path.dirname(dest))
+
+
+
 class Tags:
     """Make it easy to interact with tags (name and version)"""
 

shpc/main/schemas.py

@@ -112,7 +112,7 @@
     "bindpaths": {"type": ["string", "null"]},
     "updated_at": {"type": "string"},
     "environment_file": {"type": "string"},
-    "container_tech": {"type": "string", "enum": ["singularity"]},
+    "container_tech": {"type": "string", "enum": ["singularity", "podman"]},
     "singularity_shell": {"type": "string", "enum": ["/bin/bash", "/bin/sh"]},
     "module_sys": {"type": "string", "enum": ["lmod", "tcl", None]},
     "container_features": container_features,

shpc/settings.yml

@@ -7,7 +7,7 @@
 # please open an issue https://github.com/singularityhub/singularity-hpc
 module_sys: lmod
 
-# set a default container technology (currently only singularity supported)
+# set a default container technology (singularity or podman)
 container_tech: singularity
 
 # Registry Recipes (currently we support just one path)