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

Windows documentation and related code changes #754

Open
wants to merge 46 commits into
base: develop
Choose a base branch
from

Conversation

triggers
Copy link
Member

  • Reorganized scripts and resources into separate directories
  • Added Windows documentation: docs/content/usage/windows-machine-images.md
    • (building, installing, configuring, and using Windows images)
  • Major refactoring of the Window build scripts
    • Flattened build steps into one layer
    • Made new distinction between easy-to-automate and manual build steps
    • Added manual actions as explicit build steps
    • Renamed build steps to less ad-hoc and maybe more-readable
    • Replaced supernext.sh with (refactored) auto-windows-image-build.sh
  • Added code to help in recording VNC streams for KVM UI automation
  • Fixed intermittent but with extra mouse click to raise PowerShell window
  • Added code to generate vdc-manage commands for registering a specific Windows image
  • Moved *.ps1 files to wakame-init directory
  • Fixed unrelated typo :-)

@Metallion
Copy link
Contributor

The first thing that I see is that the example build log was added to the Usage menu on the left. I think an example log is a great idea but it shouldn't be in that menu. It should be a link in the Windows Machine Images guide.

Full disclosure: I write this before having reviewed the actual Windows Machine Images guide itself.

@Metallion
Copy link
Contributor

The Usage menu on the left currently has Custom Machine Images and Windows Machine Images. That's a little confusing.

Perhaps it would be a better idea to make a new section called Custom Machine Images. We can then move the old Centos image guide there along with the new Windows image guide.

@@ -0,0 +1,383 @@
## Overview

Wakame has functionality
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In official documentation like this, we should always refer to Wakame as Wakame-vdc. This of course goes for the rest of the guide too.

Starting a newline after functionality is probably a mistake too although it seems to show up as one paragraph in mkdocs.

@Metallion
Copy link
Contributor

When using specific terms like instance or seed image, you should make them links to the jargon dictionary. Of course if you use the word instance ten times in a paragraph, you don't need to make ten links. I'll leave the correct amount of links to common sense. :)


For creating seed images, certain steps are necessary to make installations of Windows compatible with Wakame-vdc. The main requirement is that virtio drivers must be installed, because Windows instances are always run in KVM virtual machines. To make working with multiple instances possible, a special initialization script must also be installed, so that Wakame-vdc can coordinate with the Windows OS.

When launching new instances, Microsoft requires that its Windows sysprep utility be used. This requirement affects both seed image creation and how instances are launched and backed up. In addition, there are various configuration options that can be set when starting Windows instances, such as initial passwords, firewall options, product keys, and automatic activation.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants