tfe-run-wait
Command line utility to poll for a Terraform Enterprise run state change and apply a planned run.
Usage
tfe-run-wait [-h] \
--token TOKEN \
--organization ORGANIZATION \
--clone-url CLONE_URL \
--commit-sha COMMIT_SHA \
[--branch BRANCH ] \
[--workspace WORKSPACE] \
[--wait-for-status WAIT_FOR_STATUS] \
[--maximum-wait-time MAXIMUM_WAIT_TIME]
tfe-run-apply [-h] \
--token TOKEN \
--organization ORGANIZATION \
--clone-url CLONE_URL \
--commit-sha COMMIT_SHA \
[--branch BRANCH ] \
--comment COMMENT \
[--confirm] \
[--workspace WORKSPACE] \
[--maximum-wait-time MAXIMUM_WAIT_TIME]
Options
--token TOKEN Terraform Enterprise access token, default from TFE_API_TOKEN
--organization ORGANIZATION
of the workspace
--workspace WORKSPACE
to inspect runs for. if not specified apply to all workspaces associated with the source repo.
--clone-url CLONE_URL
of source repository for the run
--commit-sha COMMIT_SHA
of commit which initiated the run
--branch BRANCH
of commit which initiated the run
--wait-for-status WAIT_FOR_STATUS
wait state to reach, defaults to 'applied' and 'planned_and_finished'
--maximum-wait-time MAXIMUM_WAIT_TIME
for state to be reached in minutes, default 45
--confirm requests confirmation after showing the plan. you will have to type `yes`
--comment to use in the apply of the planned run.
-h, --help show this help message and exit
Description
Finds a Terraform Enterpise run initiated for the specified git commit and either polls for a specific state change or apply the planned changes.
tfe-run-wait will wait until the specified status is reached. By default it will wait for
the status applied or planned_and_finished. When the run reaches a non specified final state,
it will exit with an error.
tfe-run-apply will request terraform to apply to plan for the run. If the status of the run is
already applied or planned_and_finished, it will exit without an error. It will not check
whether the run is in the correct state. Depending on the configuration the run should be in
the state planned, cost_estimated or policy_checked.
If no workspace is specified, you have to specify a branch; the utility will search for all workspaces associated with the specified source repository and branch.
CAVEATS
- the wait and apply is single threaded.
1 maintainer
Metadata
1 maintainer
Release files for tfe-run-wait 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| tfe-run-wait-0.7.0.tar.gz | 12.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| tfe_run_wait-0.7.0-py3.9.egg | Legacy Egg format | - | - | Details |
Total release size: 29.2 kB
Release files / tfe-run-wait-0.7.0.tar.gz
| Download URL | tfe-run-wait-0.7.0.tar.gz |
|---|---|
| Size | 12.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
58f615d5cf9387fe41e1a7bbbea142c06261bf3787e1750909f493eb6bc6b81d
|
|
BLAKE2b-256 checksum How to use checksums |
3b99b629ced25ba0962292ab0cefbcf5371825f41b6f2902251374311b4162e1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
Release files / tfe_run_wait-0.7.0-py3.9.egg
| Download URL | tfe_run_wait-0.7.0-py3.9.egg |
|---|---|
| Size | 16.8 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
d7dd5157fd81cd622b94813688d7fcff3e15d8b2ecef7c6908c02f17fca3175d
|
|
BLAKE2b-256 checksum How to use checksums |
2a49b8d22f9a00c97d90786bf0bd7c680fec35b3cbe6298ea5918c8cb90d3cac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.7.13
|
