snapctl 0.39.3__tar.gz → 0.41.1__tar.gz

{snapctl-0.39.3 → snapctl-0.41.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.39.3
+Version: 0.41.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -310,6 +310,33 @@ snapctl byosnap publish-version --help
 snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port --byosnap-profile $byosnap_profile
 ```
 
+#### 8. byosnap sync
+
+This command is for development purposes. It allows developers to rapidly build, update and push their
+BYOSnap to a dev Snapend. Simply, make changes to your code locally, and then run this command to deploy
+your BYOSnap straight to your development Snapend.
+
+IMPORTANT: This command will only work for Dev Snapends. Additionally if the tag you are using in this
+command happens to be used by a staging or a production snapend then `sync` will not work. We do this to
+ensure that your staging and production BYOSnap images do not get impacted.
+
+```
+# Help for the byosnap command
+snapctl byosnap sync --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
+# $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
+# $version = Semantic version for your snap Eg: v0.0.1
+# $snapend_id = Dev Snapend Id
+# Example:
+snapctl byosnap sync byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --tag my-first-image --version "v0.0.11" --snapend-id "jxmmfryo"
+snapctl byosnap sync $byosnap_sid --path $code_root_path --tag $image_tag --version $version --snapend-id $snapend_id
+```
+
 ### BYO Game Server - Bring your own Game Server
 Snapctl commands for your custom game server
 
@@ -378,6 +405,25 @@ snapctl byogs publish --tag $image_tag --path $code_root_path --resources-path $
 snapctl byogs publish --tag $image_tag --skip-build
 ```
 
+#### 5. byogs sync
+
+This command allows developers to rapidly build, update and push their BYOGs out to a Snapend fleet. Simply, make changes to your code locally, and then run this command to deploy your BYOGs straight to your Snapend fleet.
+
+```
+# Help for the byogs command
+snapctl byogs sync --help
+
+# Publish a new image
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
+# $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
+# $snapend_id = Snapend Id
+# $fleet_name = Fleet Name
+# Example:
+snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-name "my-fleet"
+snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-name $fleet_name
+```
 
 ### Game
 Snapctl commands for your game
@@ -460,11 +506,12 @@ snapctl snapend download --help
 # $protos-category = messages or services (only with --type protos)
 # $auth-type = user or app (only with --type server-sdk)
 # Example:
-# snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
-# snapctl snapend download gx5x6bc0 --category client-sdk --type unity
-# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
-# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
-snapctl snapend download $snapend_id --category $category --type $type
+# snapctl snapend download --snapend-id gx5x6bc0 --category snapend-manifest --type yaml --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type cpp --sdk-access-type internal --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category protos --type raw --protos-category messages --out-path .
+snapctl snapend download $snapend_id --category $category --type $type --sdk-access-type $sdk_access_type --sdk-auth-type $sdk_auth_type --out-path $out_path
+
 ```
 
 #### 3. Clone Snapend
@@ -540,15 +587,14 @@ snapctl snapend state $snapend_id
 
 ## Error codes
 ### CLI Return Codes
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 0          | Operation completed successfully                         |
 | 1          | General error                                            |
 | 2          | Input error                                              |
+| 3          | Resource not found                                       |
 
 ### Configuration Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 10         | Configuration incorrect                                  |
@@ -556,9 +602,9 @@ snapctl snapend state $snapend_id
 | 12         | Dependency missing                                       |
 
 ### BYOGS Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | BYOGs resource not found                                 |
 | 20         | Generic BYOGS error                                      |
 | 21         | BYOGS dependency missing                                 |
 | 22         | BYOGS ECR login error                                    |
@@ -569,9 +615,9 @@ snapctl snapend state $snapend_id
 | 27         | BYOGS publish duplicate tag error                        |
 
 ### BYOSNAP Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | BYOSnap resource not found                               |
 | 30         | Generic BYOSNAP error                                    |
 | 31         | BYOSNAP dependency missing                               |
 | 32         | BYOSNAP ECR login error                                  |
@@ -587,21 +633,27 @@ snapctl snapend state $snapend_id
 | 42         | BYOSNAP publish version permission error                 |
 | 43         | BYOSNAP publish version duplicate version error          |
 | 44         | BYOSNAP publish version duplicate tag error              |
+| 45         | BYOSNAP update version error                             |
+| 46         | BYOSNAP update version service in use                    |
+| 47         | BYOSNAP update version tag error                         |
+| 48         | BYOSNAP update version invalid version error             |
 
-### Game Errors
 
+### Game Errors
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | Game resource not found                                  |
 | 50         | Generic game error                                       |
 | 51         | Game create error                                        |
 | 52         | Game create permission error                             |
-| 53         | Game create duplicate name error                         |
-| 54         | Game enumerate error                                     |
+| 53         | Game create limit error                                  |
+| 54         | Game create duplicate name error                         |
+| 55         | Game enumerate error                                     |
 
 ### Snapend Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | Snapend resource not found                               |
 | 60         | Generic snapend error                                    |
 | 61         | Snapend enumerate error                                  |
 | 62         | Snapend clone error                                      |
@@ -620,7 +672,6 @@ snapctl snapend state $snapend_id
 | 75         | Snapend state error                                      |
 
 ### Generate Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 80         | Generic generate error                                   |

{snapctl-0.39.3 → snapctl-0.41.1}/README.md

@@ -291,6 +291,33 @@ snapctl byosnap publish-version --help
 snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port --byosnap-profile $byosnap_profile
 ```
 
+#### 8. byosnap sync
+
+This command is for development purposes. It allows developers to rapidly build, update and push their
+BYOSnap to a dev Snapend. Simply, make changes to your code locally, and then run this command to deploy
+your BYOSnap straight to your development Snapend.
+
+IMPORTANT: This command will only work for Dev Snapends. Additionally if the tag you are using in this
+command happens to be used by a staging or a production snapend then `sync` will not work. We do this to
+ensure that your staging and production BYOSnap images do not get impacted.
+
+```
+# Help for the byosnap command
+snapctl byosnap sync --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
+# $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
+# $version = Semantic version for your snap Eg: v0.0.1
+# $snapend_id = Dev Snapend Id
+# Example:
+snapctl byosnap sync byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --tag my-first-image --version "v0.0.11" --snapend-id "jxmmfryo"
+snapctl byosnap sync $byosnap_sid --path $code_root_path --tag $image_tag --version $version --snapend-id $snapend_id
+```
+
 ### BYO Game Server - Bring your own Game Server
 Snapctl commands for your custom game server
 
@@ -359,6 +386,25 @@ snapctl byogs publish --tag $image_tag --path $code_root_path --resources-path $
 snapctl byogs publish --tag $image_tag --skip-build
 ```
 
+#### 5. byogs sync
+
+This command allows developers to rapidly build, update and push their BYOGs out to a Snapend fleet. Simply, make changes to your code locally, and then run this command to deploy your BYOGs straight to your Snapend fleet.
+
+```
+# Help for the byogs command
+snapctl byogs sync --help
+
+# Publish a new image
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
+# $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
+# $snapend_id = Snapend Id
+# $fleet_name = Fleet Name
+# Example:
+snapctl byogs sync --path /Users/DevName/Development/SnapserEngine/game_server --tag my-first-image --snapend-id "jxmmfryo" --fleet-name "my-fleet"
+snapctl byosnap sync --path $code_root_path --tag $image_tag --snapend-id $snapend_id --fleet-name $fleet_name
+```
 
 ### Game
 Snapctl commands for your game
@@ -441,11 +487,12 @@ snapctl snapend download --help
 # $protos-category = messages or services (only with --type protos)
 # $auth-type = user or app (only with --type server-sdk)
 # Example:
-# snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
-# snapctl snapend download gx5x6bc0 --category client-sdk --type unity
-# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
-# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
-snapctl snapend download $snapend_id --category $category --type $type
+# snapctl snapend download --snapend-id gx5x6bc0 --category snapend-manifest --type yaml --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type cpp --sdk-access-type internal --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category protos --type raw --protos-category messages --out-path .
+snapctl snapend download $snapend_id --category $category --type $type --sdk-access-type $sdk_access_type --sdk-auth-type $sdk_auth_type --out-path $out_path
+
 ```
 
 #### 3. Clone Snapend
@@ -521,15 +568,14 @@ snapctl snapend state $snapend_id
 
 ## Error codes
 ### CLI Return Codes
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 0          | Operation completed successfully                         |
 | 1          | General error                                            |
 | 2          | Input error                                              |
+| 3          | Resource not found                                       |
 
 ### Configuration Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 10         | Configuration incorrect                                  |
@@ -537,9 +583,9 @@ snapctl snapend state $snapend_id
 | 12         | Dependency missing                                       |
 
 ### BYOGS Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | BYOGs resource not found                                 |
 | 20         | Generic BYOGS error                                      |
 | 21         | BYOGS dependency missing                                 |
 | 22         | BYOGS ECR login error                                    |
@@ -550,9 +596,9 @@ snapctl snapend state $snapend_id
 | 27         | BYOGS publish duplicate tag error                        |
 
 ### BYOSNAP Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | BYOSnap resource not found                               |
 | 30         | Generic BYOSNAP error                                    |
 | 31         | BYOSNAP dependency missing                               |
 | 32         | BYOSNAP ECR login error                                  |
@@ -568,21 +614,27 @@ snapctl snapend state $snapend_id
 | 42         | BYOSNAP publish version permission error                 |
 | 43         | BYOSNAP publish version duplicate version error          |
 | 44         | BYOSNAP publish version duplicate tag error              |
+| 45         | BYOSNAP update version error                             |
+| 46         | BYOSNAP update version service in use                    |
+| 47         | BYOSNAP update version tag error                         |
+| 48         | BYOSNAP update version invalid version error             |
 
-### Game Errors
 
+### Game Errors
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | Game resource not found                                  |
 | 50         | Generic game error                                       |
 | 51         | Game create error                                        |
 | 52         | Game create permission error                             |
-| 53         | Game create duplicate name error                         |
-| 54         | Game enumerate error                                     |
+| 53         | Game create limit error                                  |
+| 54         | Game create duplicate name error                         |
+| 55         | Game enumerate error                                     |
 
 ### Snapend Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
+| 3          | Snapend resource not found                               |
 | 60         | Generic snapend error                                    |
 | 61         | Snapend enumerate error                                  |
 | 62         | Snapend clone error                                      |
@@ -601,7 +653,6 @@ snapctl snapend state $snapend_id
 | 75         | Snapend state error                                      |
 
 ### Generate Errors
-
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 80         | Generic generate error                                   |

{snapctl-0.39.3 → snapctl-0.41.1}/pyproject.toml

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