Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update main README.md #1214

Merged
merged 1 commit into from
Mar 30, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,22 @@ for OpenShift Console.

## Local development

### Option 1 (recommended): Docker + VSCode Remote Container
### Option 1 (recommended):

Open two terminals and navigate to the kubevirt-plugin directory in both of them. The first terminal will run a containerized instance of console and the second will run the kubevirt-plugin.

In the first terminal:

1. Log into the OpenShift cluster you are using.
2. Run `yarn start-console` OR `./start-console.sh` OR `./start-console-auth-mode.sh`.

In the second terminal:

1. Run `yarn && yarn dev`

NOTE: `./start-console-auth-mode.sh` is when authentication is needed, `start-console.sh`, ignores authentication.

### Option 2: Docker + VSCode Remote Container

Make sure the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
extension is installed. This method uses Docker Compose where one container is
Expand All @@ -37,7 +52,7 @@ OC_PASS=<password>
2. Navigate to <http://localhost:10000>
3. login with password `kubevirt` (no need for username)

### Option 2:
### Option 3:
avivtur marked this conversation as resolved.
Show resolved Hide resolved

1. Set up [Console](https://github.com/openshift/console) and See the plugin development section in [Console Dynamic Plugins README](https://github.com/openshift/console/blob/master/frontend/packages/console-dynamic-plugin-sdk/README.md) for details on how to run OpenShift console using local plugins.
2. Run bridge with `-plugins kubevirt-plugin=http://localhost:9001`
Expand Down