snapctl 0.43.1__tar.gz → 0.44.1__tar.gz

{snapctl-0.43.1 → snapctl-0.44.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.43.1
+Version: 0.44.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -365,10 +365,10 @@ snapctl byosnap publish-version --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
-# $path = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
+# $byosnapProfilePath = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
 # Example:
 # snapctl byosnap publish-version byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $path
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $byosnapProfilePath
 ```
 
 ### BYO Game Server - Bring your own Game Server

{snapctl-0.43.1 → snapctl-0.44.1}/README.md

@@ -346,10 +346,10 @@ snapctl byosnap publish-version --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
-# $path = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
+# $byosnapProfilePath = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
 # Example:
 # snapctl byosnap publish-version byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $path
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $byosnapProfilePath
 ```
 
 ### BYO Game Server - Bring your own Game Server

{snapctl-0.43.1 → snapctl-0.44.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.43.1"
+version = "0.44.1"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"

{snapctl-0.43.1 → snapctl-0.44.1}/snapctl/commands/byogs.py

@@ -4,6 +4,7 @@
 import base64
 from binascii import Error as BinasciiError
 import os
+import json
 import subprocess
 import time
 import platform as sys_platform
@@ -130,6 +131,24 @@ class ByoGs:
         try:
             # Login to Snapser Registry
             if platform == 'win32':
+                # Start: Hack for Windows               
+                data = {
+                    "auths": {
+                        "https://index.docker.io/v1/": {}
+                    }
+                }
+
+                # Path to the Docker config file, adjust the path as necessary
+                docker_config_path = os.path.expanduser('~\\.docker\\config.json')
+
+                # Ensure the directory exists
+                os.makedirs(os.path.dirname(docker_config_path), exist_ok=True)
+
+                # Write the data to the file
+                with open(docker_config_path, 'w', encoding='utf-8') as file:
+                    json.dump(data, file)
+                info("Updated the docker config for docker login")
+                # End: Hack for Windows
                 response = subprocess.run([
                     'docker', 'login', '--username', ecr_repo_username,
                     '--password', ecr_repo_token, ecr_repo_url

{snapctl-0.43.1 → snapctl-0.44.1}/snapctl/commands/byosnap.py

@@ -91,7 +91,8 @@ class ByoSnap:
         self.blocking: bool = blocking
         # Override
         self.prefix: Union[str, None] = None
-        self.http_port: Union[int, None] = None
+        self.ingress_external_port: Union[dict, None] = None
+        self.ingress_internal_ports: Union[list, None] = None
         self.readiness_path: Union[str, None] = None
         self.readiness_delay: Union[str, None] = None
         if self.subcommand in ['publish', 'publish-version']:
@@ -190,14 +191,15 @@ class ByoSnap:
                 )
         if 'name' not in profile_data or 'description' not in profile_data or \
             'platform' not in profile_data or 'language' not in profile_data or \
-                'prefix' not in profile_data or 'http_port' not in profile_data or \
-            'readiness_probe_config' not in profile_data or \
+                'prefix' not in profile_data or \
+            ('http_port' not in profile_data and 'ingress' not in profile_data) or \
+                'readiness_probe_config' not in profile_data or \
                 'initial_delay_seconds' not in profile_data['readiness_probe_config'] or \
                 'path' not in profile_data['readiness_probe_config']:
             snapctl_error(
                 message='BYOSnap profile now requires name, description, platform, ' +
-                'language, prefix http_port, and readiness_probe_config fields. Please use ' +
-                'the following command: ' +
+                'language, prefix, ingress, and readiness_probe_config fields. ' +
+                'Please use the following command: ' +
                 '`snapctl generate profile --category byosnap --out-path $output_path` ' +
                 'to generate a new profile',
                 code=SNAPCTL_INPUT_ERROR
@@ -227,7 +229,26 @@ class ByoSnap:
         self.platform_type = profile_data['platform']
         self.language = profile_data['language']
         self.prefix = profile_data['prefix']
-        self.http_port = profile_data['http_port']
+        # Setup the final ingress external port
+        final_ingress_external_port = {
+            'name': 'http',
+            'port': None
+        }
+        if 'http_port' in profile_data:
+            final_ingress_external_port = {
+                'name': 'http',
+                'port': profile_data['http_port']
+            }
+            warning('http_port is deprecated. Please use ingress.external_port. ' +
+                    'You can generate a new BYOSnap profile via the `generate` command.')
+        elif 'ingress' in profile_data and 'external_port' in profile_data['ingress']:
+            final_ingress_external_port = profile_data['ingress']['external_port']
+        self.ingress_external_port = final_ingress_external_port
+        # Setup the final ingress internal ports
+        final_ingress_internal_ports = []
+        if 'ingress' in profile_data and 'internal_ports' in profile_data['ingress']:
+            final_ingress_internal_ports = profile_data['ingress']['internal_ports']
+        self.ingress_internal_ports = final_ingress_internal_ports
         self.readiness_path = profile_data['readiness_probe_config']['path']
         self.readiness_delay = \
             profile_data['readiness_probe_config']['initial_delay_seconds']
@@ -240,18 +261,58 @@ class ByoSnap:
         if self.prefix.endswith('/'):
             snapctl_error("Prefix should not end with a forward slash (/)",
                           SNAPCTL_INPUT_ERROR)
+        # check that prefix does not contain multiple slashes
+        if self.prefix.count('/') > 1:
+            snapctl_error("Prefix should not contain multiple path segments",
+                          SNAPCTL_INPUT_ERROR)
         if not self.version:
             snapctl_error("Missing version", SNAPCTL_INPUT_ERROR)
         pattern = r'^v\d+\.\d+\.\d+$'
         if not re.match(pattern, self.version):
             snapctl_error("Version should be in the format vX.X.X",
                           SNAPCTL_INPUT_ERROR)
-        if not self.http_port:
+        if not self.ingress_external_port['port']:
             snapctl_error("Missing Ingress HTTP Port",
                           SNAPCTL_INPUT_ERROR)
-        if not isinstance(self.http_port, int):
-            snapctl_error("Ingress HTTP Port should be a number",
+        if not isinstance(self.ingress_external_port['port'], int):
+            snapctl_error("Ingress external port should be a number",
                           SNAPCTL_INPUT_ERROR)
+        # Check internal ports
+        duplicate_name = {}
+        duplicate_port = {}
+        index = 0
+        for internal_port in self.ingress_internal_ports:
+            if 'name' not in internal_port or 'port' not in internal_port:
+                snapctl_error("Internal ports need a name and a port. Check internal port " +
+                              f"number {index}.",
+                              SNAPCTL_INPUT_ERROR)
+            # Confirm the name does not collide with the external port
+            if internal_port['name'] == self.ingress_external_port['name']:
+                snapctl_error("Internal port name should not be the same as " +
+                              "the external port name", SNAPCTL_INPUT_ERROR)
+            # Confirm the port does not collide with the external port
+            if internal_port['port'] == self.ingress_external_port['port']:
+                snapctl_error("Internal port number should not be the same as " +
+                              "the external port number", SNAPCTL_INPUT_ERROR)
+            index += 1
+            if not internal_port['port']:
+                snapctl_error("Missing internal port. Check internal port " +
+                              f"number {index}",
+                              SNAPCTL_INPUT_ERROR)
+            if not isinstance(internal_port['port'], int):
+                snapctl_error("Internal port should be a number. Check internal port " +
+                              f"number {index}",
+                              SNAPCTL_INPUT_ERROR)
+            if internal_port['name'] in duplicate_name:
+                snapctl_error("Duplicate internal port name. Check internal port " +
+                              f"number {index}",
+                              SNAPCTL_INPUT_ERROR)
+            if internal_port['port'] in duplicate_port:
+                snapctl_error("Duplicate internal port number. Check internal port " +
+                              f"number {index}",
+                              SNAPCTL_INPUT_ERROR)
+            duplicate_name[internal_port['name']] = True
+            duplicate_port[internal_port['port']] = True
         if self.readiness_path is not None:
             if self.readiness_path.strip() == '':
                 snapctl_error("Readiness path cannot be empty",
@@ -315,6 +376,25 @@ class ByoSnap:
         try:
             # Login to Snapser Registry
             if platform == 'win32':
+                # Start: Hack for Windows
+                data = {
+                    "auths": {
+                        "https://index.docker.io/v1/": {}
+                    }
+                }
+
+                # Path to the Docker config file, adjust the path as necessary
+                docker_config_path = os.path.expanduser(
+                    '~\\.docker\\config.json')
+
+                # Ensure the directory exists
+                os.makedirs(os.path.dirname(docker_config_path), exist_ok=True)
+
+                # Write the data to the file
+                with open(docker_config_path, 'w', encoding='utf-8') as file:
+                    json.dump(data, file)
+                info("Updated the docker config for docker login")
+                # End: Hack for Windows
                 response = subprocess.run([
                     'docker', 'login', '--username', ecr_repo_username,
                     '--password', ecr_repo_token, ecr_repo_url
@@ -583,6 +663,15 @@ class ByoSnap:
             if self.path is None and self.resources_path is None:
                 snapctl_error(
                     "Missing one of: path or resources-path parameter", SNAPCTL_INPUT_ERROR)
+            if not self.tag:
+                snapctl_error("Missing tag", SNAPCTL_INPUT_ERROR)
+            if len(self.tag.split()) > 1 or \
+                    len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                snapctl_error(
+                    "Tag should be a single word with maximum of " +
+                    f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
+                    SNAPCTL_INPUT_ERROR
+                )
         elif self.subcommand == 'publish-version':
             if self.token_parts is None:
                 snapctl_error('Invalid token. Please reach out to your support team.',
@@ -918,14 +1007,19 @@ class ByoSnap:
                 "version": self.version,
                 "image_tag": self.tag,
                 "base_url": f"{self.prefix}/{self.sid}",
-                "http_port": self.http_port,
+                "ingress": {
+                    "external_port": self.ingress_external_port,
+                    "internal_ports": self.ingress_internal_ports
+                },
                 "readiness_probe_config": {
                     "path": self.readiness_path,
                     "initial_delay_seconds": self.readiness_delay
                 },
                 "dev_template": profile_data['dev_template'],
                 "stage_template": profile_data['stage_template'],
-                "prod_template": profile_data['prod_template']
+                "prod_template": profile_data['prod_template'],
+                # Currently not supported so we are just hardcoding an empty list
+                "egress": {"ports": []},
             }
             res = requests.post(
                 f"{self.base_url}/v1/snapser-api/byosnaps/{self.sid}/versions",

{snapctl-0.43.1 → snapctl-0.44.1}/snapctl/config/constants.py

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.43.1'
+VERSION = '0.44.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 

{snapctl-0.43.1 → snapctl-0.44.1}/snapctl/config/hashes.py

@@ -188,15 +188,24 @@ DEFAULT_BYOSNAP_PROD_TEMPLATE: Dict[str, object] = {
 }
 
 BYOSNAP_TEMPLATE: Dict[str, Dict[str, object]] = {
-    "name": "TODO: Add your BYOSnap name here. Name has to start with byosnap-. This is to ensure we avoid any collisions.",
+    'name': "TODO: Add your BYOSnap name here. Name has to start with byosnap-. This is to ensure we avoid any collisions.",
     'description': "TODO: Add your BYOSnap description here",
     'platform': "TODO: Add your platform here. Options are 'linux/arm64' or 'linux/amd64'",
     'language': "TODO: Add your language here. Options are 'go', 'node', 'python', 'java', 'csharp', 'cpp', 'rust', 'ruby', 'php', 'perl', 'clojure', 'lua', 'ts', 'js', 'kotlin', 'c'",
-    'prefix': "TODO: Add your prefix here. Prefix should start with /. Eg: '/v1'",
-    'http_port': 'TODO: Add your HTTP Port. Eg: 8080',
+    'prefix': "TODO: Add your prefix here. Prefix should start with / and only contain one path segment. Eg: '/v1'",
+    'ingress': {
+        'external_port': {
+            'name': 'http',
+            'port': "TODO: Enter your external port here. Eg: 5003. Make sure it is a number and not a string."
+        },
+        'internal_ports': [{
+            'name': 'TODO: Optionally add your internal port name here. Eg: grpc. Names should be unique across the `ingress` dict. IMPORTANT: If you are not adding any internal ports, just keep `internal_ports: []`",',
+            'port': "TODO: Optionally add your internal port here. Eg: 5004. Make sure it is a number and not a string. Port numbers should be unique across the `ingress` dict."
+        }]
+    },
     'readiness_probe_config': {
-        'initial_delay_seconds': "TODO: Add your readiness delay in seconds here. Eg: 5 or use null",
-        'path': "TODO: Add your readiness path here. Eg: '/health' or use null",
+        'initial_delay_seconds': "TODO: Optionally add your readiness delay in seconds here. Eg: 5 or use null. Make sure it is a number and not a string.",
+        'path': "TODO: Optionally add your readiness path here. Eg: '/health' or use null",
     },
     'dev_template': DEFAULT_BYOSNAP_DEV_TEMPLATE,
     'stage_template': DEFAULT_BYOSNAP_STAGE_TEMPLATE,

{snapctl-0.43.1 → snapctl-0.44.1}/snapctl/main.py

@@ -361,7 +361,7 @@ def byosnap(
     # publish-image and publish-version
     tag: str = typer.Option(
         None, "--tag", help=(
-            "(req: publish-image, publish-version) Tag for your snap"
+            "(req: publish-image, publish-version, upload-docs) Tag for your snap"
         )
     ),
     # overrides