Giter Club home page Giter Club logo

forklift-console-plugin's Introduction

Logo

OpenShift Console Plugin For Forklift

Operator Repository on Quay Quality Gate Status

forklift-console-plugin is an open source project providing Openshift web console plugin for Migration Toolkit for Virtualization. The plugin adds a web based user interface for Migration Toolkit for Virtualization inside Openshift web console.

Migration Toolkit for Virtualization (Forklift) is a suite of migration tools that facilitate the import of virtualization workloads from oVirt, VMware and OpenStack to OpenShift Virtualization.

Forklift console plugin is managed by Migration Toolkit for Virtualization operator, when installing the operator on Openshift cluster, the plugin will be installed automatically, and the Migration menu item will be added to the Openshift web console.

Prerequisites

Installation

To get started, clone the repo to your development workstation and install the required dependencies locally with NPM.

git clone --recurse-submodules https://github.com/kubev2v/forklift-console-plugin.git
cd forklift-console-plugin
npm install

Quick start

With a user logged in to existing Kubernetes or Openshift environment with Forklift operator available, one can start a locally served forklift-console-plugin instance ( running on http://localhost:9000 ) with:

# Start a local Openshift console server on the background.
# - The console will be available in http://localhost:9000
# - The inventory URL can be set using an enviorment variable,
#   ( default value for INVENTORY_SERVER_HOST is https://localhost:30444 )
#   for example:
#     export INVENTORY_SERVER_HOST=https://virt-konveyor-forklift.apps.example.com
# - To close the console server run:
#   npm run console:stop
export INVENTORY_SERVER_HOST=https://virt-konveyor-forklift.apps.<your caluster address>
npm run console:background

# If this is the first time running, npm run build will build the required dependencies
npm run build

# Start the plugin in development mode
npm run start

Setup a local cluster for development

Forklift console plugin requires the user to be logged into an openshift or kubernetes cluster, if you do not have access to one, you can setup your own using Openshift local or use the CI script to build a local KinD cluster.

# Example: setup a local KinD cluster with ovirt mock provider
#          [ options: --with-all-providers --with-ovirt-provider, --with-vmware-provider, --with-openstack-provider]
#
# Note: openstack-provider requires NFS server running, look at forkliftci documentation for more details.
npm run cluster:up -- --with-ovirt-provider

# run cleanup to stop and delete the cluster.
npm run cluster:delete

Learn more

More documentation is available in the docs directory.

Reference
Forklift Migration toolkit for virtualization
Openshift web console Openshift web console is a web based user interface for Openshift.
OpenShift Dynamic Plugin SDK Dynamic plugin SDK for Openshift user interfaces.
Forklift documentation Usage documentation for the migration toolkit for viertualization.
Forklict CI Collection of scripts and tools used in forklict development.
Patternfly Open source design system used for Openshift user interfaces development.

forklift-console-plugin's People

Contributors

ahadas avatar bkhizgiy avatar dependabot[bot] avatar fabiendupont avatar fbladilo avatar gildub avatar ibolton336 avatar ibragins avatar imsamuel avatar kpunwatk avatar mmartinv avatar mnecas avatar mturley avatar nachandr avatar nyoxi avatar rayfordj avatar rszwajko avatar seanforyou23 avatar sgratch avatar sjd78 avatar yaacov avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.