genvid-clusters¶
Manage multiple clusters through bastion-api
usage: genvid-clusters [-h] [--loglevel {DEBUG,INFO,WARNING,ERROR}]
[--logformat LOGFORMAT]
{terraform-plan,cluster-create,module-list,terraform-tfvars-default,repository-clean,repository-add,terraform-status,global-update,repository-update,global-tfvars-update,terraform-schema,terraform-output,terraform-import-module,terraform-apply,commands-latest,repository-list,module-get,terraform-refresh,cluster-list,backend-add,cluster-show,terraform-destroy,commands-list,terraform-apply-plan,terraform-get,backend-update,backend-remove,terraform-tfvars-show,repository-update-all,global-tfvars-show,global-show,repository-remove,terraform-init,terraform-tfvars-update,backend-list,cluster-delete,commands-log}
...
Positional Arguments¶
command | Possible choices: terraform-plan, cluster-create, module-list, terraform-tfvars-default, repository-clean, repository-add, terraform-status, global-update, repository-update, global-tfvars-update, terraform-schema, terraform-output, terraform-import-module, terraform-apply, commands-latest, repository-list, module-get, terraform-refresh, cluster-list, backend-add, cluster-show, terraform-destroy, commands-list, terraform-apply-plan, terraform-get, backend-update, backend-remove, terraform-tfvars-show, repository-update-all, global-tfvars-show, global-show, repository-remove, terraform-init, terraform-tfvars-update, backend-list, cluster-delete, commands-log |
Named Arguments¶
--loglevel | Possible choices: DEBUG, INFO, WARNING, ERROR Set the script log level |
--logformat | Set the script log format |
Sub-commands:¶
terraform-plan¶
Execute terraform plan on a cluster.
genvid-clusters terraform-plan [-h] [-c CLUSTERS] [-g] [-s] [-d]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-s, --silent | Do not print the logs. Default: False |
-d, --destroy | Execute a destroy plan. Default: False |
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. |
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” |
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 |
terraform-tfvars-default¶
Show a generated terraform.tfvars file.
genvid-clusters terraform-tfvars-default [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. 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. |
terraform-status¶
Retrieve the status of the cluster.
genvid-clusters terraform-status [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
global-update¶
Update the global config.
genvid-clusters global-update [-h] bastion_id
Positional Arguments¶
bastion_id | The bastion id. |
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. |
global-tfvars-update¶
Update the global tfvars file.
genvid-clusters global-tfvars-update [-h] tffile
Positional Arguments¶
tffile | The source tfvars file. |
terraform-schema¶
Get the terraform OpenAPI schema for the cluster’s variables.
genvid-clusters terraform-schema [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
terraform-output¶
Execute terraform output on a cluster.
genvid-clusters terraform-output [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
terraform-import-module¶
Import a module and execute terraform init on a cluster.
genvid-clusters terraform-import-module [-h] [-c CLUSTERS] [-g] [-f]
module_path
Positional Arguments¶
module_path | The module path. Default: “SDK-1.20.0/cluster/default” |
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-f, --force | Force the operation even if the cluster is in an invalid state. Default: False |
terraform-apply¶
Execute terraform apply on a cluster.
genvid-clusters terraform-apply [-h] [-c CLUSTERS] [-g] [-s]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-s, --silent | Do not print the logs. Default: False |
commands-latest¶
Show the current of latest log.
genvid-clusters commands-latest [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
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 |
terraform-refresh¶
Execute terraform refresh on a cluster.
genvid-clusters terraform-refresh [-h] [-c CLUSTERS] [-g] [-s]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-s, --silent | Do not print the logs. Default: False |
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. |
cluster-show¶
Show a cluster information.
genvid-clusters cluster-show [-h] cluster_id
Positional Arguments¶
cluster_id | The cluster id. |
terraform-destroy¶
Execute terraform destroy on a cluster.
genvid-clusters terraform-destroy [-h] [-c CLUSTERS] [-g] [-s]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-s, --silent | Do not print the logs. Default: False |
commands-list¶
Show the list of commands.
genvid-clusters commands-list [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
terraform-apply-plan¶
Execute terraform Apply a plan on a cluster.
genvid-clusters terraform-apply-plan [-h] [-c CLUSTERS] [-g] [-s] [-p PLANS]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-s, --silent | Do not print the logs. Default: False |
-p, --plans | The plan file to execute (same order as the clusters). |
terraform-get¶
Execute terraform get on a cluster.
genvid-clusters terraform-get [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
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. |
backend-remove¶
Remove a backend
genvid-clusters backend-remove [-h] backend_id
Positional Arguments¶
backend_id | The backend id |
terraform-tfvars-show¶
Show the content of the terraform.tfvars file.
genvid-clusters terraform-tfvars-show [-h] [-c CLUSTERS] [-g]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |
global-tfvars-show¶
Show the content of the global terraform.tfvars.json file.
genvid-clusters global-tfvars-show [-h]
repository-remove¶
Remove a repository.
genvid-clusters repository-remove [-h] repository
Positional Arguments¶
repository | The name of the repository |
terraform-init¶
Execute terraform init on a cluster.
genvid-clusters terraform-init [-h] [-c CLUSTERS] [-g] [-s] [-f] [--all]
Named Arguments¶
-c, --clusters | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False | |
-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-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 | The cluster id. |
-g, --globalcontext | |
Global operation. Default: False |