genvid-clusters¶
In This Section
- Positional Arguments
- Named Arguments
- Sub-commands:
- backend-add
- backend-list
- backend-remove
- backend-update
- cluster-create
- cluster-delete
- cluster-list
- cluster-show
- commands-latest
- commands-list
- commands-log
- delete-terraform-providers
- get-terraform-providers
- global-show
- global-tfvars-show
- global-tfvars-update
- global-update
- module-get
- module-list
- repository-add
- repository-clean
- repository-list
- repository-remove
- repository-update
- repository-update-all
- set-terraform-providers
- terraform-apply
- terraform-destroy
- terraform-get
- terraform-import-module
- terraform-init
- terraform-output
- terraform-plan
- terraform-refresh
- terraform-schema
- terraform-status
- terraform-tfvars-default
- terraform-tfvars-show
- terraform-tfvars-update
Manage multiple clusters through bastion-api
usage: genvid-clusters [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}]
[--logformat LOGFORMAT]
{backend-add,backend-list,backend-remove,backend-update,cluster-create,cluster-delete,cluster-list,cluster-show,commands-latest,commands-list,commands-log,delete-terraform-providers,get-terraform-providers,global-show,global-tfvars-show,global-tfvars-update,global-update,module-get,module-list,repository-add,repository-clean,repository-list,repository-remove,repository-update,repository-update-all,set-terraform-providers,terraform-apply,terraform-destroy,terraform-get,terraform-import-module,terraform-init,terraform-output,terraform-plan,terraform-refresh,terraform-schema,terraform-status,terraform-tfvars-default,terraform-tfvars-show,terraform-tfvars-update}
...
Positional Arguments¶
command | Possible choices: backend-add, backend-list, backend-remove, backend-update, cluster-create, cluster-delete, cluster-list, cluster-show, commands-latest, commands-list, commands-log, delete-terraform-providers, get-terraform-providers, global-show, global-tfvars-show, global-tfvars-update, global-update, module-get, module-list, repository-add, repository-clean, repository-list, repository-remove, repository-update, repository-update-all, set-terraform-providers, terraform-apply, terraform-destroy, terraform-get, terraform-import-module, terraform-init, terraform-output, terraform-plan, terraform-refresh, terraform-schema, terraform-status, terraform-tfvars-default, terraform-tfvars-show, terraform-tfvars-update |
Named Arguments¶
--loglevel | Possible choices: DEBUG, INFO, WARNING, ERROR Set the script log level |
--logformat | Set the script log format |
Sub-commands:¶
backend-add¶
Add a new backend.
genvid-clusters backend-add [-h] backend_id config
Positional Arguments¶
backend_id | The backend id |
config | A configuration file, in JSON or HCL format. |
backend-remove¶
Remove a backend.
genvid-clusters backend-remove [-h] backend_id
Positional Arguments¶
backend_id | The backend id |
backend-update¶
Update the backend.
genvid-clusters backend-update [-h] backend_id config
Positional Arguments¶
backend_id | The backend id |
config | A configuration file, in JSON or HCL format. |
cluster-create¶
Create a cluster.
genvid-clusters cluster-create [-h] [-b BACKEND]
[-v [VARIABLE [VARIABLE ...]]] [-c CATEGORY]
[cluster_id]
Positional Arguments¶
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’.The cluster id is limited to 64 characters for technical reasons. See Limitations in documentation for details. Default: “local” |
Named Arguments¶
-b, --backend | The backend id to use. Default: “default” |
-v, --variable | A backend variable in the form <name>=<value> |
-c, --category | The category of the cluster Default: “cluster” |
cluster-delete¶
Delete a cluster.
genvid-clusters cluster-delete [-h] [-f] cluster_id
Positional Arguments¶
cluster_id | The id of the cluster to delete. |
Named Arguments¶
-f, --force | Force the operation even if the cluster is in an invalid state. Default: False |
cluster-show¶
Show a cluster information.
genvid-clusters cluster-show [-h] [cluster_id]
Positional Arguments¶
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’.The cluster id is limited to 64 characters for technical reasons. See Limitations in documentation for details. Default: “local” |
commands-latest¶
Show the current of latest log.
genvid-clusters commands-latest [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
commands-list¶
Show the list of commands.
genvid-clusters commands-list [-h] [-c CLUSTERS] [-g] [--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. |
commands-log¶
Show a command log.
genvid-clusters commands-log [-h] [-c CLUSTERS] [-g] command_id
Positional Arguments¶
command_id | The command id. |
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
delete-terraform-providers¶
Delete the providers configuration for a specific cluster.
genvid-clusters delete-terraform-providers [-h] [-c CLUSTERS]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. |
get-terraform-providers¶
Query the providers configuration for a specific cluster, as JSON.
genvid-clusters get-terraform-providers [-h] [-c CLUSTERS]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. |
global-tfvars-show¶
Show the content of the global terraform.tfvars.json file.
genvid-clusters global-tfvars-show [-h]
global-tfvars-update¶
Update the global tfvars file.
genvid-clusters global-tfvars-update [-h] tffile
Positional Arguments¶
tffile | The source tfvars file. |
global-update¶
Update the global config.
genvid-clusters global-update [-h] bastion_id
Positional Arguments¶
bastion_id | The bastion id. |
module-get¶
Return a module definition.
genvid-clusters module-get [-h] [-j] moduleId
Positional Arguments¶
moduleId | The module id. |
Named Arguments¶
-j, --as-json | Format the output as json Default: False |
module-list¶
Return the list of modules.
genvid-clusters module-list [-h] [-p PREFIX] [-j]
Named Arguments¶
-p, --prefix | The prefix to filter the modules. Default: “” |
-j, --as-json | Format the output as json Default: False |
repository-add¶
Add a new repository.
genvid-clusters repository-add [-h] [-u URL] repository
Positional Arguments¶
repository | The name of the repository |
Named Arguments¶
-u, --url | The URL of the source repository. Only mandatory if no url were set before. |
repository-remove¶
Remove a repository.
genvid-clusters repository-remove [-h] repository
Positional Arguments¶
repository | The name of the repository |
repository-update¶
Update a repository.
genvid-clusters repository-update [-h] [-u URL] repository
Positional Arguments¶
repository | The name of the repository |
Named Arguments¶
-u, --url | The URL of the source repository. Only mandatory if no url were set before. |
set-terraform-providers¶
Customize a cluster with providers data from a JSON-formatted file.
genvid-clusters set-terraform-providers [-h] [-c CLUSTERS] providers_file
Positional Arguments¶
providers_file | JSON-formatted file containing the new providers configuraiton. |
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. |
terraform-apply¶
Execute terraform apply on a cluster.
genvid-clusters terraform-apply [-h] [-c CLUSTERS] [-g] [--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status] [-s]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-s, --silent | Do not print the logs. Default: False |
terraform-destroy¶
Execute terraform destroy on a cluster.
genvid-clusters terraform-destroy [-h] [-c CLUSTERS] [-g]
[--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status]
[-s]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-s, --silent | Do not print the logs. Default: False |
terraform-get¶
Execute terraform get on a cluster.
genvid-clusters terraform-get [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-import-module¶
Import a module and execute terraform init on a cluster.
genvid-clusters terraform-import-module [-h] [-c CLUSTERS] [-g]
[--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status]
[-f]
module_path
Positional Arguments¶
module_path | The module path. Default: “SDK-1.32.0/cluster/default” |
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-f, --force | Force the operation even if the cluster is in an invalid state. Default: False |
terraform-init¶
Execute terraform init on a cluster.
genvid-clusters terraform-init [-h] [-c CLUSTERS] [-g] [--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status] [-s]
[-f] [--all]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-s, --silent | Do not print the logs. Default: False |
-f, --force | Force the operation even if the cluster is in an invalid state. Default: False |
--all | Do it on all clusters Default: False |
terraform-output¶
Execute terraform output on a cluster.
genvid-clusters terraform-output [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-plan¶
Execute terraform plan on a cluster.
genvid-clusters terraform-plan [-h] [-c CLUSTERS] [-g] [--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status] [-s]
[-d]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-s, --silent | Do not print the logs. Default: False |
-d, --destroy | Execute a destroy plan. Default: False |
terraform-refresh¶
Execute terraform refresh on a cluster.
genvid-clusters terraform-refresh [-h] [-c CLUSTERS] [-g]
[--cluster-filter-all]
[--cluster-filter-none]
[--cluster-filter-id-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-id-not-in CLUSTERS [CLUSTERS ...]]
[--cluster-filter-is-static]
[--cluster-filter-is-not-static]
[--cluster-filter-category-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-category-not-in CLUSTER_CATEGORIES [CLUSTER_CATEGORIES ...]]
[--cluster-filter-status-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-status-not-in {VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} [{VOID,ERROR,STATIC,BUSY,EMPTY,CONFIGURED,DOWN,UP} ...]]
[--cluster-filter-is-invalid-status]
[--cluster-filter-is-not-invalid-status]
[-s]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False | |
--cluster-filter-all | |
Select all clusters. | |
--cluster-filter-none | |
Select no cluster. | |
--cluster-filter-id-in | |
Cluster IDs to include in the selection. Default: [] | |
--cluster-filter-id-not-in | |
Cluster IDs to filter out of the selection. Default: [] | |
--cluster-filter-is-static | |
Restrict selection to static clusters. | |
--cluster-filter-is-not-static | |
Restrict selection to non-static clusters. | |
--cluster-filter-category-in | |
Include clusters with the specified categories in the selection. Default: [] | |
--cluster-filter-category-not-in | |
Filter out clusters with the specified categories from the selection. Default: [] | |
--cluster-filter-status-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Include clusters with the specified statuses in the selection. Default: [] | |
--cluster-filter-status-not-in | |
Possible choices: VOID, ERROR, STATIC, BUSY, EMPTY, CONFIGURED, DOWN, UP Filter out clusters with the specified statuses from the selection. Default: [] | |
--cluster-filter-is-invalid-status | |
Restrict selection to clusters with invalid statuses. | |
--cluster-filter-is-not-invalid-status | |
Restrict selection to clusters with valid statuses. | |
-s, --silent | Do not print the logs. Default: False |
terraform-schema¶
Get the terraform OpenAPI schema for the cluster’s variables.
genvid-clusters terraform-schema [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-status¶
Retrieve the status of the cluster.
genvid-clusters terraform-status [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-tfvars-default¶
Show a generated terraform.tfvars file.
genvid-clusters terraform-tfvars-default [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-tfvars-show¶
Show the content of the terraform.tfvars file.
genvid-clusters terraform-tfvars-show [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |
terraform-tfvars-update¶
Update the content of the terraform.tfvars file.
genvid-clusters terraform-tfvars-update [-h] [-c CLUSTERS] [-g] tffile
Positional Arguments¶
tffile | The source tfvars file. |
Named Arguments¶
-c, --clusters | Append the following cluster IDs to the working set of clusters to operate on. If none is specified and the terraform command doesn’t have filters, the GENVID_CLUSTER_ID environment variable will be used. |
-g, --globalcontext | |
Execute the command globally. Default: False |