Giter VIP home page Giter VIP logo

forklift-documentation's Introduction

Logo

Forklift documentation

Forklift is an upstream project for migrating virtual machines from VMware or oVirt to KubeVirt.

Contributing to Forklift documentation

This project is Apache 2.0 licensed and accepts contributions via GitHub pull requests.

See CONTRIBUTING for details.

Building a document preview

You can build a document preview by running a Jekyll container.

You must have Podman installed.

  1. Clone the repository:
$ git clone -b source https://github.com/konveyor/forklift-documentation.git && cd forklift-documentation
  1. Create .jekyll-cache and _site directories:
$ for i in .jekyll-cache _site; do mkdir ${i} && chmod 777 ${i}; done
  1. Create a Gemfile.lock file:
$ for i in Gemfile.lock; do touch ${i} && chmod 777 ${i}; done
  1. Run a Jekyll container:
  • If your operating system is SELinux-enabled:

    $ podman run -it --rm --name jekyll -p 4000:4000 -v $(pwd):/srv/jekyll:Z jekyll/jekyll jekyll serve --watch --future

    Note: The Z at the end of the volume (-v) relabels the contents so that they can be written from within the container, like running chcon -Rt svirt_sandbox_file_t -l s0:c1,c2 yourself. You must run this command in the cloned directory.

  • If your operating system is not SELinux-enabled:

    $ podman run -it --rm --name jekyll -p 4000:4000 -v $(pwd):/srv/jekyll jekyll/jekyll jekyll serve --watch --future
  1. Navigate to http://<localhost>:4000 in a web browser to view the preview.

Code of conduct

Contributor Covenant

PR preview rendering

forklift-documentation's People

Contributors

ahadas avatar anarnold97 avatar apinnick avatar carmiwisemon avatar fabiendupont avatar hagayvider1 avatar iranzo avatar jameslabocki avatar liranr23 avatar raoradhika avatar richardhoch avatar sbeskin-redhat avatar sgratch avatar stoobie avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

forklift-documentation's Issues

Preview procedure on README needs to be updated.

Describe the bug

Podman command for preview build no longer works because of a new Git security feature. The podman container fails with a "fatal: unsafe repository" error and the workaround in the error message does not appear to work.

Solution

Provide instructions for installing Asciidoctor, running "$ asciidoctor master.adoc" in the document directory, and then opening the master.html file in a browser. Delete the master.html file so that it is not included in a PR.

It would also be a good idea to add "master.html" to the gitignore file.

The new plan still can be shown and started on plans page when plan creation is failed

When creating a new plan is failed because of following error:
Screenshot from 2023-02-07 11-49-30

The new plan still can be shown on the plans page, migration can be started, VM could be imported successfully.

If creating a new plan is failed, the plan shouldn't be shown on the plans page.

Steps to reproduce:

  1. Create a non cluster admin user

  2. Create a role with following rules:
    Screenshot from 2023-02-07 12-03-28
    Note that there is no 'delete' verb on networkmaps

  3. Bind the user with the role

  4. Log into cluster with the user, and create a new plan

jekyll cache folder is already present in repo

Describe the bug

A clear and concise description of the bug. If there is an error in the published documentation, include the section number and the release version or provide a link to the section.

https://github.com/kubev2v/forklift-documentation#building-a-document-preview

`Create .jekyll-cache and _site directories:
for i in .jekyll-cache _site; do mkdir ${i} && chmod 777 ${i}; done`

Solution

Remove .jekyll-cache folder from repo or add command to check and delete it prior to creating the folder

A clear and concise description of the solution. Does it apply to older releases or only to the current release?

Screenshots

If applicable, add screenshots to help explain your problem.

The openshift source provider is missing from the list of providers mentioned in the CL migrating vms section

Describe the bug

Under this doc section https://access.redhat.com/documentation/en-us/migration_toolkit_for_virtualization/2.5/html-single/installing_and_using_the_migration_toolkit_for_virtualization/index#migrating-virtual-machines-cli_mtv, in the procedure section, step no. 1.2, (Secret manifest )the following text:
Specify the type of source provider. Allowed values are ovirt, vsphere, openstack, and ova. This label is needed to verify the credentials are correct when the remote system is accessible and, for RHV, to retrieve the Manager CA certificate when a third-party certificate is specified.

Should be rephrased with the following:
Specify the type of source provider. Allowed values are ovirt, vsphere, openstack, **openshift** and ova. This label is needed to verify the credentials are correct when the remote system is accessible and, for RHV, to retrieve the Manager CA certificate when a third-party certificate is specified.

The fix includes adding openshift as a source provider.

We added supporting OpenShift as a source provider in 2.5, so this fix is relevant for 2.5 version.

Notes:

  1. This same text is also displayed in the console plugin UI: https://github.com/kubev2v/forklift-console-plugin/blob/7ac736db94a33c1efe4ce26e6e[โ€ฆ]-console-plugin/locales/en/plugin__forklift-console-plugin.json

  2. Going over this whole CLI doc section, it seems that openshift (and ova) as source providers are missing in other places where type is mentioned (e.g Provider manifest ), so maybe worth adding it as well.

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.