Skip to content

Commit

Permalink
Update README details
Browse files Browse the repository at this point in the history
Signed-off-by: Shirly Radco <[email protected]>
  • Loading branch information
sradco committed Mar 21, 2024
1 parent 7807e15 commit d950a9c
Showing 1 changed file with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,18 @@ information and custom configurations about the lvctl command, head to the
$ mv tools/lvctl/bin/lvctl /usr/local/bin/
```


### Create an instance of the LogsViewer

```bash
# To deploy LogsViewer in the current namespace with default configuration
./lvctl setup

# Or if you want to import a must-gather file into the LogsViewer during the setup
./lvctl setup-import -file <path-to/must-gather-file.tar.gz>
./lvctl setup-import -namespace <namespace> -id <instance-id> -file <path-to/must-gather-file.tar.gz>
```

This commands will log the instance id and the route created to access the
LogsViewer UI.
This commands will log the the route created to access the LogsViewer UI.

> **Warning**
> By default, the instance will be deleted 48 hours after the last must-gather
> file was imported. Or after creation time if no must-gather file was imported.
> Check the '-deletion-condition' and '-deletion-delay' flags for more details.
### Import a new must-gather file into an instance of the LogsViewer

```bash
./lvctl setup-import -namespace <namespace> -id <customer-case-id> -file <path-to/must-gather-file.tar.gz>
```
*Note:* It is possible to import the files manually through the UI after the instance was created.

### Import Additional Must Gather files to the same Logsviewer instance
```bash
Expand All @@ -61,18 +49,17 @@ LogsViewer UI.
*Note:*
- You can upload more than one Must Gather to the same Logsviewer instance for the same cluster.
- You can upload both OpenShift and other Must gathers for the same cluster.
- No need to worry about deleting the pods - They will be deleted after 48 hours automatically.
- By default, the instance will be deleted 48 hours after the last must-gather file was imported. Or after creation time if no must-gather file was imported. Check the '-deletion-condition' and '-deletion-delay' flags for more details.

### Manually delete an instance of the LogsViewer

```bash
./lvctl delete -namespace <namespace> -id <customer-case-id>

./lvctl delete -namespace <namespace> -id <instance-id>
```

### Log into the Logsviewer Pod UI
The UI link would be:
http://logsviewer-<namespace><instance-id>.apps.cnv2.engineering.redhat.com/
http://logsviewer-<namespace><instance-id>.example.com


## Demo
Expand Down

0 comments on commit d950a9c

Please sign in to comment.