snapctl 0.22.0__tar.gz → 0.22.1__tar.gz

{snapctl-0.22.0 → snapctl-0.22.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.22.0
+Version: 0.22.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -81,8 +81,26 @@ You can generate up to 3 API Keys per user account.
 
 ### Setup a local config
 
+You have three ways to pass the API key to Snapctl
+1. Pass it via a command line argument with every command
+2. Pass it via an environment variable
+3. Pass it via a config file
+
+#### Command line argument
+
+Every Snapser command can take a command line argument `--api-key <your_key>`. This will take precedence over
+other methods.
+
+#### Environment Variable
+
+You can set an Environment variable `SNAPSER_API_KEY=<your_key>` and then run your snapctl commands. This will
+be evaluated after verifying if there is any command line argument.
+
+#### Config file
+
 Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace with your
-personal Snapser Access key. Save the file.
+personal Snapser Access key. Save the file. Advantage of using this method is you can use the `--profile`
+argument with your snapctl command to use different API keys.
 
 ```
 [default]
@@ -165,7 +183,8 @@ snapctl byosnap --help
 
 #### 2. byosnap create
 
-Ability to create a custom snap.
+Create a custom snap. Note that you will have to build, push and publish your snap image, for it to be useable
+in a Snapend.
 
 ```
 # Help for the byosnap command
@@ -183,45 +202,42 @@ snapctl byosnap create --help
 snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byosnap publish-image
+### 3. byosnap build
 
-Ability to publish a custom snap code image.
+Build your snap image
 
 ```
 # Help for the byosnap command
-snapctl byosnap publish-image --help
+snapctl byosnap build --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+# snapctl byosnap build byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byosnap publish-version
+### 4. byosnap push
 
-Ability to publish a new version for your Snap.
+Push your snap image to Snapser
 
 ```
 # Help for the byosnap command
-snapctl byosnap publish-version --help
+snapctl byosnap push --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+# snapctl byosnap push byosnap-jinks-flask --tag my-first-image
+snapctl byosnap push $byosnap_sid --tag $image_tag
 ```
 
 #### 5. byosnap upload-docs
 
-Ability to upload swagger.json and README.md for you Snap
+Upload swagger.json and README.md for you Snap
 
 ```
 # Help for the byogs command
@@ -236,6 +252,44 @@ snapctl byosnap upload-docs --help
 snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
+#### 6. byosnap publish-image
+
+Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
+after the other.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-image --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+```
+
+#### 7. byosnap publish-version
+
+Publish a new version for your Snap. Only after your Snap version is published, you will be able
+to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-version --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $prefix = Prefix for your snap Eg: /v1
+# $version = Semantic version for your snap Eg: v0.0.1
+# $ingress_port = Ingress port for your snap Eg: 5003
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+```
+
 ### BYO Game Server - Bring your own Game Server
 
 #### 1. byogs help
@@ -249,7 +303,8 @@ snapctl byogs --help
 
 #### 2. byogs create
 
-Ability to create a custom game server.
+Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
+in a Snapend fleet.
 
 ```
 # Help for the byosnap command
@@ -267,9 +322,42 @@ snapctl byogs create --help
 snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byogs publish-image
+#### 3. byogs build
+
+Build your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs build --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+```
+
+#### 4. byogs push
+
+Push your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs push --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# Example:
+# snapctl byogs push byosnap-jinks-gs --tag my-first-image
+snapctl byogs push $byogs_sid --tag $image_tag
+```
+
+#### 5. byogs publish-image
 
-Ability to publish your custom game server image.
+Publish your custom game server image. This command executes, `build` and `push` one after the other.
 
 ```
 # Help for the byogs command
@@ -284,9 +372,10 @@ snapctl byogs publish-image --help
 snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs publish-version
+#### 6. byogs publish-version
 
-Ability to publish a new version for your Game server.
+Publish a new version for your game server. Only after your game server version is published, you will be able
+to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
 
 ```
 # Help for the byogs command

{snapctl-0.22.0 → snapctl-0.22.1}/README.md

@@ -65,8 +65,26 @@ You can generate up to 3 API Keys per user account.
 
 ### Setup a local config
 
+You have three ways to pass the API key to Snapctl
+1. Pass it via a command line argument with every command
+2. Pass it via an environment variable
+3. Pass it via a config file
+
+#### Command line argument
+
+Every Snapser command can take a command line argument `--api-key <your_key>`. This will take precedence over
+other methods.
+
+#### Environment Variable
+
+You can set an Environment variable `SNAPSER_API_KEY=<your_key>` and then run your snapctl commands. This will
+be evaluated after verifying if there is any command line argument.
+
+#### Config file
+
 Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace with your
-personal Snapser Access key. Save the file.
+personal Snapser Access key. Save the file. Advantage of using this method is you can use the `--profile`
+argument with your snapctl command to use different API keys.
 
 ```
 [default]
@@ -149,7 +167,8 @@ snapctl byosnap --help
 
 #### 2. byosnap create
 
-Ability to create a custom snap.
+Create a custom snap. Note that you will have to build, push and publish your snap image, for it to be useable
+in a Snapend.
 
 ```
 # Help for the byosnap command
@@ -167,45 +186,42 @@ snapctl byosnap create --help
 snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byosnap publish-image
+### 3. byosnap build
 
-Ability to publish a custom snap code image.
+Build your snap image
 
 ```
 # Help for the byosnap command
-snapctl byosnap publish-image --help
+snapctl byosnap build --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+# snapctl byosnap build byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byosnap publish-version
+### 4. byosnap push
 
-Ability to publish a new version for your Snap.
+Push your snap image to Snapser
 
 ```
 # Help for the byosnap command
-snapctl byosnap publish-version --help
+snapctl byosnap push --help
 
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+# snapctl byosnap push byosnap-jinks-flask --tag my-first-image
+snapctl byosnap push $byosnap_sid --tag $image_tag
 ```
 
 #### 5. byosnap upload-docs
 
-Ability to upload swagger.json and README.md for you Snap
+Upload swagger.json and README.md for you Snap
 
 ```
 # Help for the byogs command
@@ -220,6 +236,44 @@ snapctl byosnap upload-docs --help
 snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
+#### 6. byosnap publish-image
+
+Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
+after the other.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-image --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+```
+
+#### 7. byosnap publish-version
+
+Publish a new version for your Snap. Only after your Snap version is published, you will be able
+to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish-version --help
+
+# Publish a new image
+# $byosnap_sid = Snap ID for your snap
+# $image_tag = An image tag for your snap
+# $prefix = Prefix for your snap Eg: /v1
+# $version = Semantic version for your snap Eg: v0.0.1
+# $ingress_port = Ingress port for your snap Eg: 5003
+# Example:
+# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+```
+
 ### BYO Game Server - Bring your own Game Server
 
 #### 1. byogs help
@@ -233,7 +287,8 @@ snapctl byogs --help
 
 #### 2. byogs create
 
-Ability to create a custom game server.
+Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
+in a Snapend fleet.
 
 ```
 # Help for the byosnap command
@@ -251,9 +306,42 @@ snapctl byogs create --help
 snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byogs publish-image
+#### 3. byogs build
+
+Build your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs build --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+```
+
+#### 4. byogs push
+
+Push your custom game server image.
+
+```
+# Help for the byogs command
+snapctl byogs push --help
+
+# Publish a new image
+# $byogs_sid = Game server ID for your snap
+# $image_tag = An image tag for your snap
+# Example:
+# snapctl byogs push byosnap-jinks-gs --tag my-first-image
+snapctl byogs push $byogs_sid --tag $image_tag
+```
+
+#### 5. byogs publish-image
 
-Ability to publish your custom game server image.
+Publish your custom game server image. This command executes, `build` and `push` one after the other.
 
 ```
 # Help for the byogs command
@@ -268,9 +356,10 @@ snapctl byogs publish-image --help
 snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs publish-version
+#### 6. byogs publish-version
 
-Ability to publish a new version for your Game server.
+Publish a new version for your game server. Only after your game server version is published, you will be able
+to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
 
 ```
 # Help for the byogs command

{snapctl-0.22.0 → snapctl-0.22.1}/pyproject.toml

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