Skip to content

Commit

Permalink
Merge pull request #5311 from werf/en-doc-usage-add-information-about…
Browse files Browse the repository at this point in the history
…-deploy-report

doc(usage): EN - add info about the deploy report
  • Loading branch information
ilya-lesikov committed Feb 16, 2023
2 parents 6be3ba5 + d5dd38c commit 37f7bf2
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions docs/pages_en/usage/deploy/deployment_scenarios.md
Expand Up @@ -205,10 +205,39 @@ werf build --repo example.org/mycompany/myapp
werf bundle publish --skip-build --tag latest --repo example.org/mycompany/myapp
```

## Saving a deployment report

The `werf converge` and `werf bundle apply` commands come with the `-save-deploy-report` parameter. You can use it to save a report about the deployment to a file. The report contains the release name, Namespace, deployment status, and some other data. Here is a usage example:

```shell
werf converge --save-deploy-report
```

Running the command above will create a `.werf-deploy-report.json` file containing information about the latest release once the deployment is complete.

The custom path to the deployment report can be set with the `--deploy-report-path` parameter.

## Deleting a deployed application

You can delete a deployed application using the `werf dismiss` command run from the application's Git repository, for example:

```shell
werf dismiss --env staging
```

You can explicitly specify the release name and Namespace if there is no access to the application's Git repository:

```shell
werf dismiss --release myapp-staging --namespace myapp-staging
```

... or you can use a previous deployment report which contains the release name and Namespace. You can enable saving this report by using the `-save-deploy-report` flag of the `werf converge` or `werf bundle apply` commands.

```shell
werf converge --save-deploy-report
cp .werf-deploy-report.json /anywhere
cd /anywhere
werf dismiss --use-deploy-report
```

The custom path to the deployment report can be set with the `--deploy-report-path` parameter.

0 comments on commit 37f7bf2

Please sign in to comment.