proximl 0.5.5__tar.gz → 0.5.7__tar.gz

{proximl-0.5.5/proximl.egg-info → proximl-0.5.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: proximl
-Version: 0.5.5
+Version: 0.5.7
 Summary: proxiML client SDK and command line utilities
 Home-page: https://github.com/proxiML/python-sdk
 Author: proxiML

{proximl-0.5.5 → proximl-0.5.7}/proximl/__init__.py

@@ -13,5 +13,5 @@ logging.basicConfig(
 logger = logging.getLogger(__name__)
 
 
-__version__ = "0.5.5"
+__version__ = "0.5.7"
 __all__ = "ProxiML"

{proximl-0.5.5 → proximl-0.5.7}/proximl/checkpoints.py

@@ -23,9 +23,7 @@ class Checkpoints(object):
 
     async def list(self, **kwargs):
         resp = await self.proximl._query(f"/checkpoint", "GET", kwargs)
-        checkpoints = [
-            Checkpoint(self.proximl, **checkpoint) for checkpoint in resp
-        ]
+        checkpoints = [Checkpoint(self.proximl, **checkpoint) for checkpoint in resp]
         return checkpoints
 
     async def list_public(self, **kwargs):
@@ -39,8 +37,7 @@ class Checkpoints(object):
             source_type=source_type,
             source_uri=source_uri,
             source_options=kwargs.get("source_options"),
-            project_uuid=kwargs.get("project_uuid")
-            or self.proximl.active_project,
+            project_uuid=kwargs.get("project_uuid") or self.proximl.active_project,
         )
         payload = {k: v for k, v in data.items() if v is not None}
         logging.info(f"Creating Checkpoint {name}")
@@ -60,9 +57,7 @@ class Checkpoint:
     def __init__(self, proximl, **kwargs):
         self.proximl = proximl
         self._checkpoint = kwargs
-        self._id = self._checkpoint.get(
-            "id", self._checkpoint.get("checkpoint_uuid")
-        )
+        self._id = self._checkpoint.get("id", self._checkpoint.get("checkpoint_uuid"))
         self._status = self._checkpoint.get("status")
         self._name = self._checkpoint.get("name")
         self._size = self._checkpoint.get("size")
@@ -123,15 +118,17 @@ class Checkpoint:
                 entity_type="checkpoint",
                 project_uuid=self._checkpoint.get("project_uuid"),
                 cidr=self._checkpoint.get("vpn").get("cidr"),
-                ssh_port=self._checkpoint.get("vpn")
-                .get("client")
-                .get("ssh_port"),
-                input_path=self._checkpoint.get("source_uri")
-                if self.status in ["new", "downloading"]
-                else None,
-                output_path=self._checkpoint.get("output_uri")
-                if self.status == "exporting"
-                else None,
+                ssh_port=self._checkpoint.get("vpn").get("client").get("ssh_port"),
+                input_path=(
+                    self._checkpoint.get("source_uri")
+                    if self.status in ["new", "downloading"]
+                    else None
+                ),
+                output_path=(
+                    self._checkpoint.get("output_uri")
+                    if self.status == "exporting"
+                    else None
+                ),
             )
         else:
             details = dict()
@@ -195,9 +192,7 @@ class Checkpoint:
                 if msg_handler:
                     msg_handler(data)
                 else:
-                    timestamp = datetime.fromtimestamp(
-                        int(data.get("time")) / 1000
-                    )
+                    timestamp = datetime.fromtimestamp(int(data.get("time")) / 1000)
                     print(
                         f"{timestamp.strftime('%m/%d/%Y, %H:%M:%S')}: {data.get('msg').rstrip()}"
                     )
@@ -224,19 +219,24 @@ class Checkpoint:
         return self
 
     async def wait_for(self, status, timeout=300):
+        if self.status == status:
+            return
         valid_statuses = ["downloading", "ready", "archived"]
         if not status in valid_statuses:
             raise SpecificationError(
                 "status",
                 f"Invalid wait_for status {status}.  Valid statuses are: {valid_statuses}",
             )
-        if self.status == status:
-            return
+
+        MAX_TIMEOUT = 24 * 60 * 60
+        if timeout > MAX_TIMEOUT:
+            raise SpecificationError(
+                "timeout",
+                f"timeout must be less than {MAX_TIMEOUT} seconds.",
+            )
         POLL_INTERVAL_MIN = 5
         POLL_INTERVAL_MAX = 60
-        POLL_INTERVAL = max(
-            min(timeout / 60, POLL_INTERVAL_MAX), POLL_INTERVAL_MIN
-        )
+        POLL_INTERVAL = max(min(timeout / 60, POLL_INTERVAL_MAX), POLL_INTERVAL_MIN)
         retry_count = math.ceil(timeout / POLL_INTERVAL)
         count = 0
         while count < retry_count:

{proximl-0.5.5 → proximl-0.5.7}/proximl/cli/cloudbender/__init__.py

@@ -15,4 +15,5 @@ from proximl.cli.cloudbender.region import region
 from proximl.cli.cloudbender.node import node
 from proximl.cli.cloudbender.device import device
 from proximl.cli.cloudbender.datastore import datastore
-from proximl.cli.cloudbender.reservation import reservation
+from proximl.cli.cloudbender.data_connector import data_connector
+from proximl.cli.cloudbender.service import service

proximl-0.5.5/proximl/cli/cloudbender/reservation.py → proximl-0.5.7/proximl/cli/cloudbender/data_connector.py

@@ -5,12 +5,12 @@ from proximl.cli.cloudbender import cloudbender
 
 @cloudbender.group()
 @pass_config
-def reservation(config):
-    """proxiML CloudBender reservation commands."""
+def data_connector(config):
+    """proxiML CloudBender data connector commands."""
     pass
 
 
-@reservation.command()
+@data_connector.command()
 @click.option(
     "--provider",
     "-p",
@@ -23,48 +23,43 @@ def reservation(config):
     "-r",
     type=click.STRING,
     required=True,
-    help="The region ID to list reservations for.",
+    help="The region ID to list data connectors for.",
 )
 @pass_config
 def list(config, provider, region):
-    """List reservations."""
+    """List data connectors."""
     data = [
-        ["ID", "NAME", "TYPE", "RESOURCE", "HOSTNAME"],
+        ["ID", "NAME", "TYPE"],
         [
             "-" * 80,
             "-" * 80,
             "-" * 80,
-            "-" * 80,
-            "-" * 80,
         ],
     ]
 
-    reservations = config.proximl.run(
-        config.proximl.client.cloudbender.reservations.list(
+    data_connectors = config.proximl.run(
+        config.proximl.client.cloudbender.data_connectors.list(
             provider_uuid=provider, region_uuid=region
         )
     )
 
-    for reservation in reservations:
+    for data_connector in data_connectors:
         data.append(
             [
-                reservation.id,
-                reservation.name,
-                reservation.type,
-                reservation.resource,
-                reservation.hostname,
+                data_connector.id,
+                data_connector.name,
+                data_connector.type,
             ]
         )
 
     for row in data:
         click.echo(
-            "{: >37.36} {: >29.28} {: >9.8} {: >9.8} {: >29.28}"
-            "".format(*row),
+            "{: >37.36} {: >29.28} {: >9.8}" "".format(*row),
             file=config.stdout,
         )
 
 
-@reservation.command()
+@data_connector.command()
 @click.option(
     "--provider",
     "-p",
@@ -77,53 +72,58 @@ def list(config, provider, region):
     "-r",
     type=click.STRING,
     required=True,
-    help="The region ID to create the reservation in.",
+    help="The region ID to create the data_connector in.",
 )
 @click.option(
     "--type",
     "-t",
     type=click.Choice(
         [
-            "port",
+            "custom",
         ],
         case_sensitive=False,
     ),
     required=True,
-    help="The type of reservation to create.",
+    help="The type of data connector to create.",
 )
 @click.option(
-    "--hostname",
-    "-h",
+    "--protocol",
+    "-r",
     type=click.STRING,
-    required=True,
-    help="The hostname to make the reservation on",
+    help="The transport protocol of the data connector",
 )
 @click.option(
-    "--resource",
-    "-r",
+    "--port-range",
+    "-p",
     type=click.STRING,
-    required=True,
-    help="The resource to reserve",
+    help="The port range of the data connector",
+)
+@click.option(
+    "--cidr",
+    "-i",
+    type=click.STRING,
+    help="The IP range to allow in CIDR notation",
 )
 @click.argument("name", type=click.STRING, required=True)
 @pass_config
-def create(config, provider, region, type, hostname, resource, name):
+def create(config, provider, region, type, protocol, port_range, cidr, name):
     """
-    Creates a reservation.
+    Creates a data_connector.
     """
     return config.proximl.run(
-        config.proximl.client.cloudbender.reservations.create(
+        config.proximl.client.cloudbender.data_connectors.create(
             provider_uuid=provider,
             region_uuid=region,
             name=name,
-            hostname=hostname,
-            resource=resource,
             type=type,
+            protocol=protocol,
+            port_range=port_range,
+            cidr=cidr,
         )
     )
 
 
-@reservation.command()
+@data_connector.command()
 @click.option(
     "--provider",
     "-p",
@@ -136,24 +136,24 @@ def create(config, provider, region, type, hostname, resource, name):
     "-r",
     type=click.STRING,
     required=True,
-    help="The region ID to remove the reservation from.",
+    help="The region ID to remove the data_connector from.",
 )
-@click.argument("reservation", type=click.STRING)
+@click.argument("data_connector", type=click.STRING)
 @pass_config
-def remove(config, provider, region, reservation):
+def remove(config, provider, region, data_connector):
     """
-    Remove a reservation.
+    Remove a data_connector.
 
-    RESERVATION may be specified by name or ID, but ID is preferred.
+    DATASTORE may be specified by name or ID, but ID is preferred.
     """
-    reservations = config.proximl.run(
-        config.proximl.client.cloudbender.reservations.list(
+    data_connectors = config.proximl.run(
+        config.proximl.client.cloudbender.data_connectors.list(
             provider_uuid=provider, region_uuid=region
         )
     )
 
-    found = search_by_id_name(reservation, reservations)
+    found = search_by_id_name(data_connector, data_connectors)
     if None is found:
-        raise click.UsageError("Cannot find specified reservation.")
+        raise click.UsageError("Cannot find specified data_connector.")
 
     return config.proximl.run(found.remove())

proximl-0.5.7/proximl/cli/cloudbender/service.py

@@ -0,0 +1,146 @@
+import click
+from proximl.cli import cli, pass_config, search_by_id_name
+from proximl.cli.cloudbender import cloudbender
+
+
+@cloudbender.group()
+@pass_config
+def service(config):
+    """proxiML CloudBender service commands."""
+    pass
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to list services for.",
+)
+@pass_config
+def list(config, provider, region):
+    """List services."""
+    data = [
+        ["ID", "NAME", "HOSTNAME"],
+        [
+            "-" * 80,
+            "-" * 80,
+            "-" * 80,
+        ],
+    ]
+
+    services = config.proximl.run(
+        config.proximl.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    for service in services:
+        data.append(
+            [
+                service.id,
+                service.name,
+                service.hostname,
+            ]
+        )
+
+    for row in data:
+        click.echo(
+            "{: >25.24} {: >29.28} {: >40.39}" "".format(*row),
+            file=config.stdout,
+        )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to create the service in.",
+)
+@click.option(
+    "--type",
+    "-t",
+    type=click.Choice(
+        [
+            "https",
+            "tcp",
+            "udp",
+        ],
+    ),
+    required=True,
+    help="The type of regional service.",
+)
+@click.option(
+    "--public/--no-public",
+    default=True,
+    show_default=True,
+    help="Service should be accessible from the public internet.",
+)
+@click.argument("name", type=click.STRING, required=True)
+@pass_config
+def create(config, provider, region, type, public, name):
+    """
+    Creates a service.
+    """
+    return config.proximl.run(
+        config.proximl.client.cloudbender.services.create(
+            provider_uuid=provider,
+            region_uuid=region,
+            name=name,
+            type=type,
+            public=public,
+        )
+    )
+
+
+@service.command()
+@click.option(
+    "--provider",
+    "-p",
+    type=click.STRING,
+    required=True,
+    help="The provider ID of the region.",
+)
+@click.option(
+    "--region",
+    "-r",
+    type=click.STRING,
+    required=True,
+    help="The region ID to remove the service from.",
+)
+@click.argument("service", type=click.STRING)
+@pass_config
+def remove(config, provider, region, service):
+    """
+    Remove a service.
+
+    RESERVATION may be specified by name or ID, but ID is preferred.
+    """
+    services = config.proximl.run(
+        config.proximl.client.cloudbender.services.list(
+            provider_uuid=provider, region_uuid=region
+        )
+    )
+
+    found = search_by_id_name(service, services)
+    if None is found:
+        raise click.UsageError("Cannot find specified service.")
+
+    return config.proximl.run(found.remove())

{proximl-0.5.5 → proximl-0.5.7}/proximl/cli/project.py

@@ -115,40 +115,35 @@ def list_datastores(config):
 
 @project.command()
 @pass_config
-def list_reservations(config):
-    """List project reservations."""
+def list_services(config):
+    """List project services."""
     data = [
-        ["ID", "NAME", "TYPE", "RESOURCE", "HOSTNAME", "REGION_UUID"],
+        ["ID", "NAME", "HOSTNAME", "REGION_UUID"],
         [
             "-" * 80,
             "-" * 80,
             "-" * 80,
             "-" * 80,
-            "-" * 80,
-            "-" * 80,
         ],
     ]
     project = config.proximl.run(
         config.proximl.client.projects.get(config.proximl.client.project)
     )
 
-    reservations = config.proximl.run(project.list_reservations())
+    services = config.proximl.run(project.list_services())
 
-    for reservation in reservations:
+    for service in services:
         data.append(
             [
-                reservation.id,
-                reservation.name,
-                reservation.type,
-                reservation.resource,
-                reservation.hostname,
-                reservation.region_uuid,
+                service.id,
+                service.name,
+                service.hostname,
+                service.region_uuid,
             ]
         )
 
     for row in data:
         click.echo(
-            "{: >38.36} {: >30.28} {: >8.6} {: >15.13} {: >30.28} {: >38.36}"
-            "".format(*row),
+            "{: >38.36} {: >30.28} {: >30.28} {: >38.36}" "".format(*row),
             file=config.stdout,
         )

{proximl-0.5.5 → proximl-0.5.7}/proximl/cloudbender/cloudbender.py

@@ -3,7 +3,8 @@ from .regions import Regions
 from .nodes import Nodes
 from .devices import Devices
 from .datastores import Datastores
-from .reservations import Reservations
+from .data_connectors import DataConnectors
+from .services import Services
 from .device_configs import DeviceConfigs
 
 
@@ -15,5 +16,6 @@ class Cloudbender(object):
         self.nodes = Nodes(proximl)
         self.devices = Devices(proximl)
         self.datastores = Datastores(proximl)
-        self.reservations = Reservations(proximl)
+        self.data_connectors = DataConnectors(proximl)
+        self.services = Services(proximl)
         self.device_configs = DeviceConfigs(proximl)

proximl-0.5.5/proximl/cloudbender/reservations.py → proximl-0.5.7/proximl/cloudbender/data_connectors.py

@@ -2,28 +2,28 @@ import json
 import logging
 
 
-class Reservations(object):
+class DataConnectors(object):
     def __init__(self, proximl):
         self.proximl = proximl
 
     async def get(self, provider_uuid, region_uuid, id, **kwargs):
         resp = await self.proximl._query(
-            f"/provider/{provider_uuid}/region/{region_uuid}/reservation/{id}",
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector/{id}",
             "GET",
             kwargs,
         )
-        return Reservation(self.proximl, **resp)
+        return DataConnector(self.proximl, **resp)
 
     async def list(self, provider_uuid, region_uuid, **kwargs):
         resp = await self.proximl._query(
-            f"/provider/{provider_uuid}/region/{region_uuid}/reservation",
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector",
             "GET",
             kwargs,
         )
-        reservations = [
-            Reservation(self.proximl, **reservation) for reservation in resp
+        data_connectors = [
+            DataConnector(self.proximl, **data_connector) for data_connector in resp
         ]
-        return reservations
+        return data_connectors
 
     async def create(
         self,
@@ -31,48 +31,42 @@ class Reservations(object):
         region_uuid,
         name,
         type,
-        resource,
-        hostname,
         **kwargs,
     ):
-        logging.info(f"Creating Reservation {name}")
+        logging.info(f"Creating Data Connector {name}")
         data = dict(
             name=name,
             type=type,
-            resource=resource,
-            hostname=hostname,
             **kwargs,
         )
         payload = {k: v for k, v in data.items() if v is not None}
         resp = await self.proximl._query(
-            f"/provider/{provider_uuid}/region/{region_uuid}/reservation",
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector",
             "POST",
             None,
             payload,
         )
-        reservation = Reservation(self.proximl, **resp)
-        logging.info(f"Created Reservation {name} with id {reservation.id}")
-        return reservation
+        data_connector = DataConnector(self.proximl, **resp)
+        logging.info(f"Created Data Connector {name} with id {data_connector.id}")
+        return data_connector
 
     async def remove(self, provider_uuid, region_uuid, id, **kwargs):
         await self.proximl._query(
-            f"/provider/{provider_uuid}/region/{region_uuid}/reservation/{id}",
+            f"/provider/{provider_uuid}/region/{region_uuid}/data_connector/{id}",
             "DELETE",
             kwargs,
         )
 
 
-class Reservation:
+class DataConnector:
     def __init__(self, proximl, **kwargs):
         self.proximl = proximl
-        self._reservation = kwargs
-        self._id = self._reservation.get("reservation_id")
-        self._provider_uuid = self._reservation.get("provider_uuid")
-        self._region_uuid = self._reservation.get("region_uuid")
-        self._type = self._reservation.get("type")
-        self._name = self._reservation.get("name")
-        self._resource = self._reservation.get("resource")
-        self._hostname = self._reservation.get("hostname")
+        self._data_connector = kwargs
+        self._id = self._data_connector.get("connector_id")
+        self._provider_uuid = self._data_connector.get("provider_uuid")
+        self._region_uuid = self._data_connector.get("region_uuid")
+        self._type = self._data_connector.get("type")
+        self._name = self._data_connector.get("name")
 
     @property
     def id(self) -> str:
@@ -94,32 +88,24 @@ class Reservation:
     def name(self) -> str:
         return self._name
 
-    @property
-    def resource(self) -> str:
-        return self._resource
-
-    @property
-    def hostname(self) -> str:
-        return self._hostname
-
     def __str__(self):
-        return json.dumps({k: v for k, v in self._reservation.items()})
+        return json.dumps({k: v for k, v in self._data_connector.items()})
 
     def __repr__(self):
-        return f"Reservation( proximl , **{self._reservation.__repr__()})"
+        return f"DataConnector( proximl , **{self._data_connector.__repr__()})"
 
     def __bool__(self):
         return bool(self._id)
 
     async def remove(self):
         await self.proximl._query(
-            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/reservation/{self._id}",
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/data_connector/{self._id}",
             "DELETE",
         )
 
     async def refresh(self):
         resp = await self.proximl._query(
-            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/reservation/{self._id}",
+            f"/provider/{self._provider_uuid}/region/{self._region_uuid}/data_connector/{self._id}",
             "GET",
         )
         self.__init__(self.proximl, **resp)