Skip to content

Commit

Permalink
fix: add instructions to create a must-gather image
Browse files Browse the repository at this point in the history
Adding instructions to create a must-gather image.

Signed-off-by: Mudit Agarwal <[email protected]>
  • Loading branch information
agarwal-mudit committed Mar 30, 2022
1 parent 7b22f7a commit 06306ad
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions must-gather/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
OCS must-gather
LVM must-gather
=================

`lvm-must-gather` is a tool built on top of [OpenShift must-gather](https://github.com/openshift/must-gather)
that expands its capabilities to gather LVM Operator information.

### Usage
```sh
oc adm must-gather --image=quay.io/ocs-dev/lvm-must-gather
oc adm must-gather --image=quay.io/ocs-dev/lvm-must-gather:latest
```

The command above will create a local directory with a dump of the lvm state.
Expand All @@ -31,6 +31,11 @@ Developers must follow these steps to make a change:
7. Work with the community to make any necessary changes through the code
review process (effectively repeating steps 3-7 as needed).

To test the changes in must-gather follow these steps:
1. Run `make lvm-must-gather`
2. It will create an image named `quay.io/ocs-dev/lvm-must-gather:latest`
3. Tag it and push it to your image repository to use it with the `oc adm` command

#### Commit and Pull Request Messages

- Follow the standards mentioned in [LVM-Operator How to Contribute](./../CONTRIBUTING.md)
Expand Down

0 comments on commit 06306ad

Please sign in to comment.