Forklift is an upstream project for migrating VMware virtual machines to KubeVirt.
The downstream project is the Migration Toolkit for Virtualization.
Read the Guidelines for Red Hat Documentation before opening a pull request.
This document uses the following variables to ensure that upstream and downstream product names and versions are rendered correctly.
Variable | Upstream value | Downstream value |
---|---|---|
project-full | Forklift | Migration Toolkit for Virtualization |
project-short | Forklift | MTV |
project-version | 2.0-beta | 2.0-beta |
virt | KubeVirt | OpenShift Virtualization |
ocp | OKD | Red Hat OpenShift Container Platform |
ocp-version | 4.7 | 4.7 |
ocp-short | OKD | OCP |
Variables cannot be used in CLI commands or code blocks unless you include the "attributes" keyword:
[options="nowrap" subs="+quotes,+attributes"]
----
# ls {VariableName}
----
You can hide or show specific blocks, paragraphs, warnings or chapters with the build
variable. Its value can be set to "downstream" or "upstream":
ifeval::["build" == "upstream"]
This content is only relevant for Forklift.
endif::[]
You can build a document preview by running a Jekyll container.
You must have Podman installed.
- Clone the repository:
$ git clone -b source https://github.com/konveyor/forklift-documentation.git && cd forklift-documentation
- Create
.jekyll-cache
and_site
directories:
$ for i in .jekyll-cache _site; do mkdir ${i} && chmod 777 ${i}; done
- Create a
Gemfile.lock
file:
$ for i in Gemfile.lock; do touch ${i} && chmod 777 ${i}; done
- 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 runningchcon -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
- Navigate to
http://<localhost>:4000
in a web browser to view the preview.