Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit 3a76f2d

Browse files
mvalliathmvalliath
authored
Update README
1 parent 648d491 commit 3a76f2d

File tree

1 file changed

+99
-26
lines changed

1 file changed

+99
-26
lines changed

‎README.md‎

Lines changed: 99 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
# Stembuild
22

3-
The stembuild binary is used to build BOSH stemcells for **Windows 2012R2**,**Windows Server, version v1709** and **Windows Server, version 1803** on **vSphere**. See [here](https://github.com/cloudfoundry-incubator/bosh-windows-stemcell-builder/wiki/Creating-a-vSphere-Stemcell-by-Hand) for instructions to build Windows stemcells for vSphere.
3+
The stembuild binary is used to build BOSH stemcells for **Windows 2012R2**,**Windows Server, version v1709**, **Windows Server, version 1803**, **Windows Server 2019** on **vSphere**.
44

5-
It can convert a prepared .vmdk into a stemcell with the appropriate metadata.
6-
7-
Download the latest stembuild from the [Releases page](https://github.com/cloudfoundry-incubator/stembuild/releases).
8-
9-
## Dependencies
10-
The VMware 'ovftool' binary must be on your path or Fusion/Workstation must be installed (both include the 'ovftool').
5+
**Instructions**: See [here](https://bosh.io/docs/windows-stemcell-create/) for instructions to build Windows stemcells for vSphere.
116

127
## Installation
8+
Download the latest stembuild from the [Releases page](https://github.com/cloudfoundry-incubator/stembuild/releases) that corresponds to the operating system of your local host and the stemcell version that you want to build
139

14-
To install `stembuild` go to [Releases](https://github.com/cloudfoundry-incubator/stembuild/releases)
10+
## Dependencies
11+
[LGPO](https://www.microsoft.com/en-us/download/details.aspx?id=55319) must be downloaded in the same folder as your `stembuild`
1512

1613
## Current Commands
1714
```
18-
stembuild version 0.21.45, Windows Stemcell Building Tool
15+
stembuild version <STEMCELL-VERSION>, Windows Stemcell Building Tool
1916
20-
Usage: stembuild <global options> <command> <command args>
17+
Usage: stembuild <global options> <command> <command flags>
2118
2219
Commands:
2320
help Describe commands and their syntax
24-
package Create a BOSH Stemcell from a VMDK file
21+
package Create a BOSH Stemcell from a VMDK file or a provisioned vCenter VM
22+
construct Provisions and syspreps an existing VM on vCenter, ready to be packaged into a stemcell
2523
2624
Global Options:
2725
-color Colorize debug output
@@ -30,37 +28,112 @@ Global Options:
3028
-version Show Stembuild version
3129
3230
```
33-
## Create a Windows Stemcell from a VMDK
31+
## `stembuild construct`
32+
33+
This command provisions and syspreps an existing VM on vCenter. It prepares a VM to be used by `stembuild package`.
3434

35-
This command converts a VMDK into a bosh-deployable Windows Stemcell
3635
```
37-
stembuild package -vmdk <path-to-vmdk>
36+
stembuild construct -vm-ip <IP of VM> -vm-username <vm username> -vm-password <vm password> -vcenter-url <vCenter URL> -vcenter-username <vCenter username> -vcenter-password <vCenter password> -vm-inventory-path <vCenter VM inventory path>
37+
```
3838

39-
Create a BOSH Stemcell from a VMDK file
39+
*Requirements*:
40+
- LGPO.zip in current working directory
41+
- Running Windows VM with:
42+
- Up to date Operating System
43+
- Reachable by IP
44+
- Username and password with Administrator privileges
45+
- vCenter URL, username and password
46+
- vCenter Inventory Path
47+
- The `vm-ip`, `vm-username`, `vm-password`, `vcenter-url`, `vcenter-username`, `vcenter-password`, `vm-inventory-path` must be specified
4048

41-
The [vmdk], [stemcellVersion], and [os] flags must be specified. If the [output] flag is
42-
not specified the stemcell will be created in the current working directory.
49+
```
50+
Example:
51+
stembuild construct -vm-ip '10.0.0.5' -vm-username Admin -vm-password 'password' -vcenter-url vcenter.example.com -vcenter-username root -vcenter-password 'password' -vm-inventory-path '/datacenter/vm/folder/vm-name'
4352
44-
Requirements:
45-
The VMware 'ovftool' binary must be on your path or Fusion/Workstation
46-
must be installed (both include the 'ovftool').
53+
Flags:
54+
-vcenter-ca-certs string
55+
filepath for custom ca certs
56+
-vcenter-password string
57+
vCenter password
58+
-vcenter-url string
59+
vCenter url
60+
-vcenter-username string
61+
vCenter username
62+
-vm-inventory-path string
63+
vCenter VM inventory path. (e.g: <datacenter>/vm/<vm-folder>/<vm-name>)
64+
-vm-ip string
65+
IP of target machine
66+
-vm-password string
67+
Password of target machine. Needs to be wrapped in single quotations.
68+
-vm-username string
69+
Username of target machine
70+
71+
```
72+
73+
## `stembuild package`
4774

48-
Examples:
49-
stembuild package -vmdk disk.vmdk
75+
This command creates a BOSH Stemcell from a provisioned vCenter VM
5076

51-
Will create an Windows 1803 stemcell using [vmdk] 'disk.vmdk', and set the stemcell version to 1.2.
77+
```
78+
stembuild package -vcenter-url <vCenter URL> -vcenter-username <vCenter username> -vcenter-password <vCenter password> -vm-inventory-path <vCenter VM inventory path>
79+
```
80+
81+
*Requirements*:
82+
- VM provisioned using the stembuild construct command
83+
- Access to vCenter environment
84+
- The `vcenter-url`, `vcenter-username`, `vcenter-password`, and `vm-inventory-path` flags must be specified.
85+
- **NOTE**: The 'vm' keyword must be included between the datacenter name and folder name for the vm-inventory-path (e.g: <datacenter>/vm/<vm-folder>/<vm-name>)
86+
87+
```
88+
Example:
89+
stembuild package -vcenter-url vcenter.example.com -vcenter-username root -vcenter-password 'password' -vm-inventory-path '/my-datacenter/vm/my-folder/my-vm'
90+
91+
Flags:
92+
-o string
93+
Output directory (shorthand)
94+
-outputDir string
95+
Output directory, default is the current working directory.
96+
-vcenter-ca-certs string
97+
filepath for custom ca certs
98+
-vcenter-password string
99+
vCenter password
100+
-vcenter-url string
101+
vCenter url
102+
-vcenter-username string
103+
vCenter username
104+
-vm-inventory-path string
105+
vCenter VM inventory path. (e.g: <datacenter>/vm/<vm-folder>/<vm-name>)
106+
```
107+
108+
## [DEPRECATED] Package a Windows Stemcell from a VMDK using `stembuild package`
109+
110+
This command converts a VMDK into a bosh-deployable Windows Stemcell
111+
112+
The VMware 'ovftool' binary must be on your path or Fusion/Workstation must be installed (both include the 'ovftool').
113+
114+
```
115+
stembuild package -vmdk <path-to-vmdk>
116+
```
117+
118+
*Requirements*
119+
- The VMware 'ovftool' binary must be on your path or Fusion/Workstation must be installed (both include the 'ovftool').
120+
- The `vmdk` flag must be specified. If the `output` flag is not specified the stemcell will be created in the current working directory.
121+
122+
```
123+
Example:
124+
stembuild package -vmdk my-1803-vmdk.vmdk
125+
126+
Will create an Windows 1803 stemcell using [vmdk] 'my-1803-vmdk.vmdk'
52127
The final stemcell will be found in the current working directory.
53128
54129
Flags:
55130
-o string
56131
Output directory (shorthand)
57132
-outputDir string
58133
Output directory, default is the current working directory.
59-
-s string
60-
Stemcell version (shorthand)
61134
-vmdk string
62135
VMDK file to create stemcell from
63-
136+
64137
```
65138

66139
Process can take between 10 and 20 minutes. See Progress with `-debug` flag.

0 commit comments

Comments
 (0)