genvid-sdk¶
In This Section
- Positional Arguments
- Named Arguments
- Sub-commands:
- clean
- clean-config
- clean-images
- clean-images-sdk
- consul-template
- docker-package
- list-nodes
- load-config
- load-config-sdk
- log
- monitor
- open
- open-link
- package
- set-taskgroup-count
- setup
- setup-nomad
- setup-vault
- show-config
- show-config-sdk
- show-jobs
- start
- stop
- update-images
- upload-images
- upload-images-sdk
- version
Tool for manipulating the SDK.
usage: genvid-sdk [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}]
[--logformat LOGFORMAT] [-c CLUSTER_ID]
{clean,clean-config,clean-images,clean-images-sdk,consul-template,docker-package,list-nodes,load-config,load-config-sdk,log,monitor,open,open-link,package,set-taskgroup-count,setup,setup-nomad,setup-vault,show-config,show-config-sdk,show-jobs,start,stop,update-images,upload-images,upload-images-sdk,version}
...
Positional Arguments¶
command | Possible choices: clean, clean-config, clean-images, clean-images-sdk, consul-template, docker-package, list-nodes, load-config, load-config-sdk, log, monitor, open, open-link, package, set-taskgroup-count, setup, setup-nomad, setup-vault, show-config, show-config-sdk, show-jobs, start, stop, update-images, upload-images, upload-images-sdk, version |
Named Arguments¶
--loglevel | Possible choices: DEBUG, INFO, WARNING, ERROR Set the script log level |
--logformat | Set the script log format |
-c, --cluster_id | |
The cluster id. If not set with the command line, uses the environment variable GENVID_CLUSTER_ID if it exists. Otherwise defaults to ‘local’ |
Sub-commands:¶
clean-config¶
Clean the whole configuration.
genvid-sdk clean-config [-h] [source]
Positional Arguments¶
source | The configuration file that you want to remove. |
clean-images¶
Delete all uploaded images.
genvid-sdk clean-images [-h] [-b BUCKET] [-p PATH] [-u]
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/custom”). |
-u, --update-config | |
Upload configuration in the current cluster. |
clean-images-sdk¶
Clean uploaded SDK images.
New in version 1.20.0.
genvid-sdk clean-images-sdk [-h] [-b BUCKET] [-p PATH] [-u]
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/sdk-1.24.0.177”). |
-u, --update-config | |
Upload configuration in the current cluster. |
consul-template¶
Apply a Consul template.
genvid-sdk consul-template [-h] template
Positional Arguments¶
template | The template to load. |
docker-package¶
Docker Package of form ImageName_Version_Id.zip
New in version 1.22.0.
genvid-sdk docker-package [-h] [-v VERSION] [-d DESTINATION] docker_image
Positional Arguments¶
docker_image | Name of docker image to be packaged |
list-nodes¶
List the registered nodes.
New in version 1.18.0.
genvid-sdk list-nodes [-h] [-t TEMPLATE] [-s SORTEDBY]
Named Arguments¶
-t, --template | The template for displaying the nodes. default: “{Name:15} ({NodeClass:^10}): {Status}” |
-s, --sortedby | The property to sort the nodes. |
load-config¶
Append specified configuration to current configuration.
genvid-sdk load-config [-h] [--with-consul-template]
[--job-template-dir JOB_TEMPLATE_DIR]
source
Positional Arguments¶
source | The Nomad template to load. |
Named Arguments¶
--with-consul-template | |
Use consul-template to resolve the template. | |
--job-template-dir | |
Directory containing nomad job templates to load |
log¶
Show a log.
genvid-sdk log [-h] [-t] [-n LINES] [-f] task
Positional Arguments¶
task | The name of the log. |
Named Arguments¶
-t, --tail | Only show the last line. |
-n, --lines | The number of lines to tail (10). |
-f, --follow | Wait for additional content at the end of file. |
open¶
Open a GUI to the specified service
genvid-sdk open [-h] [link]
Positional Arguments¶
link | The name of the link. |
open-link¶
Open a link or show the list of links.
genvid-sdk open-link [-h] [link]
Positional Arguments¶
link | The name of the link. |
package¶
Create a package of the form <NAME>_<VERSION>_<CHECKSUM>.zip
New in version 1.22.0.
genvid-sdk package [-h] [-n NAME] [-v VERSION] [-d DESTINATION]
directory_or_file
Positional Arguments¶
directory_or_file | |
Path to a file or directory to be packaged |
set-taskgroup-count¶
Set the group count of a task group.
New in version 1.23.0.
genvid-sdk set-taskgroup-count [-h] [-j JOB] [-s STEP] [-i INTERVAL]
taskgroup count
Positional Arguments¶
taskgroup | The name of the task group to change. |
count | The target number to set. |
Named Arguments¶
-j, --job | The name of the job if different from the task group. |
-s, --step | The size of the increment or decrement between interval. If 0, directly set the value. |
-i, --interval | The interval in seconds between each increment (default: 1.00 s). |
setup¶
Set up the services.
Changed in version 1.20.0: Fixed the default key for the SDK images.
genvid-sdk setup [-h] [-b BUCKET] [-p PATH]
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/sdk-1.24.0.177”). |
setup-nomad¶
Setup nomad-server token on nomad server.
New in version 1.15.0.
genvid-sdk setup-nomad [-h]
start¶
Start jobs.
genvid-sdk start [-h] [jobs [jobs ...]]
Positional Arguments¶
jobs | The jobs to start. |
stop¶
Stop jobs.
genvid-sdk stop [-h] [jobs [jobs ...]]
Positional Arguments¶
jobs | The jobs to start. |
update-images¶
Update images from a specific bucket.
New in version 1.20.0.
genvid-sdk update-images [-h] [-b BUCKET] [-p PATH] [-s] [-n] [-j JSFILE] [-q]
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/custom”). |
-s, --sdk | Use SDK default configuration |
-n, --dryrun | Only print the configuration. Do not update. |
-j, --jsfile | Use this configuration instead of fetching it from the bucket. |
-q, --quiet | Don’t print the configuration on standard output. |
upload-images¶
Upload the specified images prefix.
genvid-sdk upload-images [-h] [-b BUCKET] [-p PATH] [-u] [-d BASEDIR]
[--cloud-provider {aws,azure}]
[prefixes [prefixes ...]]
Positional Arguments¶
prefixes | The prefixes of the images to upload. |
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/custom”). |
-u, --update-config | |
Upload configuration in the current cluster. | |
-d, --basedir | The basedir where to find the images to upload (default: “ROOTDIR /images”). |
--cloud-provider | |
Possible choices: aws, azure Cloud Provider to use, default: “aws” |
upload-images-sdk¶
Upload the SDK images.
genvid-sdk upload-images-sdk [-h] [-b BUCKET] [-p PATH] [-u]
[--cloud-provider {aws,azure}]
Named Arguments¶
-b, --bucket | Name of the bucket to use. Default is a combination of AWS account and bastion ids. |
-p, --path | The path in the bucket (default: “/images/sdk-1.24.0.177”). |
-u, --update-config | |
Upload configuration in the current cluster. | |
--cloud-provider | |
Possible choices: aws, azure Cloud Provider to use, default: “aws” |