genvid-sdk¶
clean-images-sdk
New in version 1.20.0.
setup
Changed in version 1.20.0: Fixed the default key for the SDK images.
setup-vault
New in version 1.15.0.
setup-nomad
New in version 1.15.0.
update-images
New in version 1.20.0.
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,list-nodes,load-config,load-config-sdk,log,monitor,open,open-link,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, list-nodes, load-config, load-config-sdk, log, monitor, open, open-link, 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. Default local Default: “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”). Default: “/images/custom” |
| -u, --update-config | |
Upload configuration in the current cluster. Default: False | |
clean-images-sdk¶
Clean uploaded SDK images.
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.20.1.86”). Default: “/images/sdk-1.20.1.86” |
| -u, --update-config | |
Upload configuration in the current cluster. Default: False | |
consul-template¶
Apply a Consul template.
genvid-sdk consul-template [-h] template
Positional Arguments¶
| template | The template to load. |
list-nodes¶
List the registered nodes
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}” Default: “{Name:15} ({NodeClass:^10}): {Status}” |
| -s, --sortedby | The property to sort the nodes. Default: “Name” |
load-config¶
Append to the configuration.
genvid-sdk load-config [-h] source
Positional Arguments¶
| source | The configuration file 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. Default: False |
| -n, --lines | The number of lines to tail (10). Default: 10 |
| -f, --follow | Wait for additional content at the end of file. Default: False |
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. |
setup¶
Set up the services.
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.20.1.86”). Default: “/images/sdk-1.20.1.86” |
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
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”). Default: “/images/custom” |
| -s, --sdk | Use SDK default configuration Default: False |
| -n, --dryrun | Only print the configuration. Do not update. Default: False |
| -j, --jsfile | Use this configuration instead of fetching it from the bucket. |
| -q, --quiet | Don’t print the configuration on standard output. Default: False |
upload-images¶
Upload the specified images prefix.
genvid-sdk upload-images [-h] [-b BUCKET] [-p PATH] [-u] [-d BASEDIR]
[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”). Default: “/images/custom” |
| -u, --update-config | |
Upload configuration in the current cluster. Default: False | |
| -d, --basedir | The basedir where to find the images to upload (default: “d:Jenkinsworkspacemain-rcmainimages”). Default: “d:Jenkinsworkspacemain-rcmainimages” |
upload-images-sdk¶
Upload the SDK images.
genvid-sdk upload-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.20.1.86”). Default: “/images/sdk-1.20.1.86” |
| -u, --update-config | |
Upload configuration in the current cluster. Default: False | |