Skip to content

Commit

Permalink
added zulip link now that zulip is ready (microsoft#382)
Browse files Browse the repository at this point in the history
added zulip link now that zulip is ready, also fixed missing enter
before image in hyperv guide for openhcl
  • Loading branch information
cperezvargas authored Nov 25, 2024
1 parent ea70d1f commit 7b228ba
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 18 deletions.
25 changes: 19 additions & 6 deletions CONTRIBUTE.MD
Original file line number Diff line number Diff line change
@@ -1,15 +1,28 @@
By participating in this project, you agree to abide by the [CODE OF CONDUCT](./CODE_OF_CONDUCT.md).

OpenVMM uses the “fork-and-pull” development model. See [GitHub forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks) for more information on forks. Please follow these steps to merge your changes to OpenVMM:
OpenVMM uses the “fork-and-pull” development model.
See [GitHub forks](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks)
for more information on forks. Please follow these steps to merge your changes to OpenVMM:
1. [Fork and clone](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo#forking-a-repository) the OpenVMM repo.
2. Create a branch for your changes, develop your code and push your changes.
3. Create a PR against the main branch of the OpenVMM repository [from your fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
3. Create a PR against the main branch of the OpenVMM repository
[from your fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).
4. Go through the PR review process.

Following our [coding conventions](.\guide\src\dev_guide\contrib\code.md) and writing a descriptive commit message will increase the chance that a PR is accepted.
Following our [coding conventions](.\guide\src\dev_guide\contrib\code.md) and
writing a descriptive commit message will increase the chance that a PR is accepted.

We strongly suggest asking for feedback before starting to work on a new feature, functionality, etc. so that we can provide feedback and discuss how we can collaborate on this and support contributors.
We strongly suggest asking for feedback before starting to work on a new feature,
functionality, etc. so that we can provide feedback and discuss how we can
collaborate on this and support contributors.

To engage with project maintainers, contributors can reach out on Zulip (link coming soon) and then start drafting a [GitHub issue](https://github.com/microsoft/openvmm/issues/new?template=Blank+issue) after getting some preliminary feedback on Zulip, or they can open a GitHub issue to get preliminary feedback on GitHub and then reach out to us on Zulip to get some more synchronous support.
To engage with project maintainers, contributors can reach out on
[Zulip](https://openvmm.zulipchat.com/) and then start drafting a
[GitHub issue](https://github.com/microsoft/openvmm/issues/new?template=Blank+issue)
after getting some preliminary feedback on Zulip, or they can open a GitHub issue
to get preliminary feedback on GitHub and then reach out to us on Zulip to get
some more synchronous support.

We normally use Zulip for more informal conversations and GitHub Issues for more formal, auditable, public discussion and progress tracking. We encourage contributors to use both in either order based on preference.
We normally use Zulip for more informal conversations and GitHub Issues for more
formal, auditable, public discussion and progress tracking. We encourage contributors
to use both in either order based on preference.
45 changes: 34 additions & 11 deletions Guide/src/user_guide/openhcl/run/hyperv.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,34 @@
# Windows - Hyper-V
Hyper-V has support for running with OpenHCL when running on Windows.
This is the closest configuration to what Microsoft ships in Azure VMs, the only difference being that Azure uses Azure Host OS (as opposed to Windows Client or Windows Server).
Hyper-V has support for running with OpenHCL when running on Windows. This is the
closest configuration to what Microsoft ships in Azure VMs, the only difference
being that Azure uses Azure Host OS (as opposed to Windows Client or Windows Server).

## Get a Windows version that has development support for OpenHCL

Note that Windows Client and Windows Server do not have production support for OpenHCL VMs (Microsoft does not support production workloads on OpenHCL VMs on Windows Client and Windows Server), but certain versions have development support for OpenHCL VMs (they can be used as developer platforms for the purposes of using/testing/developing OpenHCL).
Note that Windows Client and Windows Server do not have production support for OpenHCL VMs
(Microsoft does not support production workloads on OpenHCL VMs on Windows Client and
Windows Server), but certain versions have development support for OpenHCL VMs (they
can be used as developer platforms for the purposes of using/testing/developing OpenHCL).

### Windows Client

You can use the Windows 11 2024 Update (AKA version 24H2), the third and new major update to Windows 11, as this is the first Windows version to have development support for OpenHCL VMs.
You can use the Windows 11 2024 Update (AKA version 24H2), the third and new major
update to Windows 11, as this is the first Windows version to have development
support for OpenHCL VMs.

As of October 1, 2024, the Windows 11 2024 Update is available. Microsoft is taking a
phased approach with its rollout. If the update is available for your device, it
will [download and install automatically](https://learn.microsoft.com/en-us/windows/release-health/status-windows-11-24h2).

Otherwise, you can get it via [Windows Insider](https://www.microsoft.com/en-us/windowsinsider)
by [registering](https://www.microsoft.com/en-us/windowsinsider/register)
with your Microsoft account and following these [instructions](https://www.microsoft.com/en-us/windowsinsider/for-business-getting-started#flight)
(you can choose the "Release Preview Channel"). You may have to click the
"Check for updates" button to download the latest Insider Preview build
twice, and this update may take over an hour. Finally go to Settings > About
to check you are on Windows 11, version 24H2 (Build 26100.1586).

As of October 1, 2024, the Windows 11 2024 Update is available. Microsoft is taking a phased approach with its rollout. If the update is available for your device, it will [download and install automatically](https://learn.microsoft.com/en-us/windows/release-health/status-windows-11-24h2).

Otherwise, you can get it via [Windows Insider](https://www.microsoft.com/en-us/windowsinsider) by [registering](https://www.microsoft.com/en-us/windowsinsider/register) with your Microsoft account and following these [instructions](https://www.microsoft.com/en-us/windowsinsider/for-business-getting-started#flight) (you can choose the “Release Preview Channel”). You may have to click the Check for updates button to download the latest Insider Preview build twice, and this update may take over an hour. Finally go to Settings > About to check you are on Windows 11, version 24H2 (Build 26100.1586).
![alt text](./_images/exampleWindows.png)

### Windows Server
Expand All @@ -24,18 +40,22 @@ Instructions coming soon.
Enbable [Hyper-V](https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v) on your machine.

### Enable loading from developer file
Once you get the right Windows Version, run the following command once before starting your VM. Note that this enabled loading unsigned images, and must be done as administrator.
Once you get the right Windows Version, run the following command once before starting
your VM. Note that this enabled loading unsigned images, and must be done as administrator.

```powershell
Set-ItemProperty "HKLM:/Software/Microsoft/Windows NT/CurrentVersion/Virtualization" -Name "AllowFirmwareLoadFromFile" -Value 1 -Type DWORD | Out-Null
```

### File access
Ensure that your OpenHCL .bin is located somewhere that vmwp.exe in your Windows host has permissions to read it (that can be in windows\system32, or another directory with wide read access).
Ensure that your OpenHCL .bin is located somewhere that vmwp.exe in your Windows
host has permissions to read it (that can be in windows\system32, or another
directory with wide read access).

## Create a VM

Save the path of the OpenHCL .bin in a var named $Path and save the VM name you want to use in a var named $VmName.
Save the path of the OpenHCL .bin in a var named $Path and save the VM name
you want to use in a var named $VmName.

For example:

Expand All @@ -57,9 +77,12 @@ $vm = new-vm $VmName -generation 2 -GuestStateIsolationType TrustedLaunch
Instructions coming soon.

### Set up guest OS VHD
Running a VM will be more useful if you have a guest OS image. Given that OpenHCL is a compatibility layer, the goal is to support the same set of guest OS images that Hyper-V currently supports without a paravisor.
Running a VM will be more useful if you have a guest OS image. Given that OpenHCL
is a compatibility layer, the goal is to support the same set of guest OS images
that Hyper-V currently supports without a paravisor.

You can pick any existing image that you have or download one from the web, such as from Ubuntu, or any other distro that is currently supported in Hyper-V.
You can pick any existing image that you have or download one from the web, such
as from Ubuntu, or any other distro that is currently supported in Hyper-V.

```powershell
`Add-VMHardDiskDrive -VMName $VmName -Path "<VHDX path>"-ControllerType SCSI -ControllerNumber 0 -ControllerLocation 1`
Expand Down
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This project uses GitHub Issues to track bugs and feature requests. Please searc
issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.

For help and questions about using this project, please reach out to us on Zulip (link coming soon).
For help and questions about using this project, please reach out to us on [Zulip](https://openvmm.zulipchat.com/).

## Microsoft Support Policy

Expand Down

0 comments on commit 7b228ba

Please sign in to comment.