Skip to content

Commit af08c2e

Browse files
Update readme with correct commands
1 parent d7cc1b2 commit af08c2e

1 file changed

Lines changed: 13 additions & 19 deletions

File tree

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ helm upgrade -i troubleshooting-panel-console-plugin charts/openshift-console-pl
5858
1. [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
5959
2. [oc](https://mirror.openshift.com/pub/openshift-v4/clients/oc/4.4/)
6060
3. [podman 3.2.0+](https://podman.io) or [Docker](https://www.docker.com)
61-
4. An OpenShift 4.16 cluster
61+
4. An OpenShift 4.16+ cluster
6262
5. [Korrel8r](https://korrel8r.github.io/korrel8r) instance running in the cluster.
6363

6464
#### TP (Troubleshooting Panel) Development Server
@@ -69,18 +69,20 @@ The development server of the troubleshooting panel can either be ran as a nodej
6969

7070
In one terminal window, run:
7171

72-
1. `make install-frontend`
73-
2. `make start-frontend`
72+
1. `oc login` (requires [oc](https://console.redhat.com/openshift/downloads) and an [OpenShift cluster](https://console.redhat.com/openshift/create))
73+
2. `make install-frontend`
74+
3. `make start-frontend`
7475
The plugin HTTP server runs on port 9002 with CORS enabled.
7576

7677
##### Go Server
7778

7879
In one terminal window, run:
7980

80-
1. `make build-frontend`
81-
2. `make start-backend`
81+
1. `oc login` (requires [oc](https://console.redhat.com/openshift/downloads) and an [OpenShift cluster](https://console.redhat.com/openshift/create))
82+
2. `make build-frontend`
83+
3. `make start-backend`
8284
Or for hot reloading of the go backend you can use [gow](https://github.com/mitranim/gow)
83-
3. `gow run ./cmd/plugin-backend.go -port='9002' -config-path='./web/dist' -static-path='./web/dist'`
85+
4. `gow run ./cmd/plugin-backend.go -port='9002' -config-path='./web/dist' -static-path='./web/dist'`
8486
Gow will restart when any changes are saved to go files in any subdirectories.
8587

8688
#### Monitoring Plugin Development Server
@@ -89,13 +91,13 @@ In another terminal window:
8991
Clone https://github.com/openshift/monitoring-plugin into a new directory.
9092
Then run:
9193

92-
1. `yarn install`
93-
2. `yarn run start`
94+
1. `make install`
95+
2. `make start-frontend`
9496
The plugin HTTP server runs on port 9001 with CORS enabled.
9597

9698
#### Connect to Korrel8r
9799

98-
##### Setting up Korrel8r
100+
##### Setting up Korrel8r [OUTDATED]
99101

100102
The following steps are suggested for setting up Korrel8r within your cluster to test the plugin. These steps are accurate as of the time of writing, and both Korrel8r and this plugin are subject to change.
101103

@@ -105,13 +107,6 @@ The following steps are suggested for setting up Korrel8r within your cluster to
105107
4. Run `make resources`
106108
5. Install the **korrel8r** operator into your cluster
107109
6. Create a `korrel8r` namespace in your cluster
108-
a. If installing in 4.15 or later, there is a permission issue which can be tracked here: https://issues.redhat.com/browse/OU-304. To solve this follow the instructions detailed in the [docs](https://korrel8r.github.io/korrel8r/#troubleshooting-ocp-415-errors)
109-
110-
```bash
111-
kubectl label ns/korrel8r pod-security.kubernetes.io/enforce=privileged --overwrite
112-
kubectl label ns/korrel8r pod-security.kubernetes.io/warn=privileged --overwrite
113-
```
114-
115110
7. Create a korrel8r instance in the `korrel8r` namespace with the name `korrel8r`
116111
8. Follow the instructions [here](https://korrel8r.github.io/korrel8r/#troubleshooting-no-related-logs) to create a failing deployment to create alerts which link to other items using korrel8r
117112

@@ -127,8 +122,7 @@ In a another terminal window, run:
127122

128123
In another terminal window, run:
129124

130-
1. `oc login` (requires [oc](https://console.redhat.com/openshift/downloads) and an [OpenShift cluster](https://console.redhat.com/openshift/create))
131-
2. `npm run start-console` (requires [Docker](https://www.docker.com) or [podman 3.2.0+](https://podman.io))
125+
1. `make start-console` (requires [Docker](https://www.docker.com) or [podman 3.2.0+](https://podman.io))
132126

133127
This will run the OpenShift console in a container connected to the cluster
134128
you've logged into. Navigate to <http://localhost:9000/observe/alerts> and select an alert to see the running plugin.
@@ -198,4 +192,4 @@ break console styles!
198192

199193
### Local Development Troubleshooting
200194
1. Disable cache. Select 'disable cache' in your browser's DevTools > Network > 'disable cache'. Or use private/incognito mode in your browser.
201-
2. Enable higher log verbosity by setting `-log-level=trace` when starting the plugin backend. For more options to set log level see [logrus documentation](https://github.com/sirupsen/logrus?tab=readme-ov-file#level-logging).
195+
2. Enable higher log verbosity by setting `-log-level=trace` when starting the plugin backend. For more options to set log level see [logrus documentation](https://github.com/sirupsen/logrus?tab=readme-ov-file#level-logging).

0 commit comments

Comments
 (0)