Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
gdiaz384 committed Nov 3, 2015
1 parent 15f9e70 commit 837262f
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 108 deletions.
58 changes: 29 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ Currently AriaDeploy supports all Windows 7-10 x86/x64 images (both RTM and cust

The development emphasis is on zero-configuration "just works" software with minimal end-user dependencies.

## Screenshot:
## Screenshots:

![screenshot1](redist/AriaDeploy/docs/AriaDeployPic.png)

![screenshot1](redist/AriaDeploy/docs/AriaSystemLifecycle.png)

## Key Features:

1. Supports extremely simple deployments
2. Supports fully authomated management of drivers/OOBE/hard drive partitioning/booting aspects of deployment "out of the box"
1. Supports both extremely simple and very complicated deployments
2. Supports fully automated management of drivers/OOBE/hard drive partitioning/booting aspects of deployment "out of the box"
3. Supports complicated scenarios via config.ini files and extensibility points
4. Reduces dependencies on fragile and configuration intensive multicasting by switching to P2P technology
5. Minimal external dependencies and configuration required (ADK still required)
Expand All @@ -33,30 +33,30 @@ The development emphasis is on zero-configuration "just works" software with min

## AriaDeploy is/will

1. deploy images in the standard windows imaging and electronic software delivery formats (wim/esd)
2. reformat the main disk on the target systems as specified (normal or minimalistic)
3. automate the installation of drivers
4. make the target systems bootable using the PE boot mode information
5. automate oobe
6. an implementation of the best technology to use when transfering large files over unreliable networks
7. designed to integrate into existing MDT and SCCM workflows, including those involving Active Directory
1. will deploy images in the standard windows imaging and electronic software delivery formats (wim/esd)
2. will reformat the main disk on the target systems as specified (normal or minimalistic)
3. will automate the installation of drivers
4. will make the target systems bootable using the PE boot mode information
5. will automate oobe
6. is an implementation of the best technology to use when transfering large files over unreliable networks
7. is designed to integrate into existing MDT and SCCM workflows, including those involving Active Directory

## AriaDeploy is not/will not

1. capture images or deploy virtual disks (.vhd/vmx files)
1. will not capture images or deploy virtual disks (.vhd/vmx files)
2. will NOT preserve user data on target systems
3. download the correct drivers for you
4. determine that windows version X cannot boot as configured on target system Y due to incompatability Z
5. input the correct product key for you in the unattend.xml templates or autogenerate unattend.xml files (use MDT for that instead)
6. a full deployment solution
7. dependent upon WDS/MDT/SCCM/AD
3. will not download the correct drivers for you
4. will not determine that windows version X cannot boot as configured on target system Y due to incompatability Z
5. will not input the correct product key for you in the unattend.xml templates or autogenerate unattend.xml files (use MDT for that instead)
6. is not a full deployment solution
7. is not dependent upon WDS/MDT/SCCM/Active Directory

## Typical Usage Guide:

![screenshot1](redist/AriaDeploy/docs/AriaDeployWorkflow.png)

1. (optional) Download drivers for your hardware model(s) from [Dell](http://en.community.dell.com/techcenter/enterprise-client/w/wiki/2065.dell-command-deploy-driver-packs-for-enterprise-client-os-deployment), [Lenovo](https://support.lenovo.com/us/en/documents/ht074984) and [HP](http://www8.hp.com/us/en/ads/clientmanagement/drivers-pack.html)
2. (optional) Extrac t to some folder like D:\Drivers\Dell\Optiplex9010\Win7\x64
2. (optional) Extract to some folder like D:\Drivers\Dell\Optiplex9010\Win7\x64
3. Double click on AriaDeploy.exe
4. Select your .wim image created using DISM/MDT
5. (optional) Select the drivers folder from step 2 (D:\Drivers\Dell\Optiplex9010\Win7\x64)
Expand All @@ -74,12 +74,12 @@ Click [here](https://github.com/gdiaz384/AriaDeploy/releases) or on "releases" a

I have bundled most of the dependencies into the installer, but due to the ADK's non-redistributable clause, I cannot provide prebuilt WinPE images (part of the ADK) for use with AriaDeploy. For similar reasons, I also cannot provide full unattend.xml files, only templates for them.

1. So go download and install the [ADK for Windows 10](https://msdn.microsoft.com/en-us/windows/hardware/dn913721.aspx) and/or [Windows 8.1U](https://www.microsoft.com/en-US/download/details.aspx?id=39982). Having both is prefered but just one works. [Win7's AIK] (https://www.microsoft.com/en-us/download/details.aspx?id=5753) and [supplement](https://www.microsoft.com/en-us/download/details.aspx?id=5188) also works.
1. Download and install the [ADK for Windows 10](https://msdn.microsoft.com/en-us/windows/hardware/dn913721.aspx) and/or [Windows 8.1U](https://www.microsoft.com/en-US/download/details.aspx?id=39982). Having both is prefered but just one works. [Win7's AIK] (https://www.microsoft.com/en-us/download/details.aspx?id=5753) and [supplement](https://www.microsoft.com/en-us/download/details.aspx?id=5188) also works.
2. (optional) While waiting for the ADKs to download/install (takes a while), go download drivers for WinPE from [Dell](http://en.community.dell.com/techcenter/enterprise-client/w/wiki/2065.dell-command-deploy-driver-packs-for-enterprise-client-os-deployment), [Lenovo](https://support.lenovo.com/us/en/documents/ht074984) and [HP](http://www8.hp.com/us/en/ads/clientmanagement/drivers-pack.html)
3. (optional) extract the PE drivers to the appropriate folders: AriaDeploy\drivers\WinPE\5_x\x64 or 10_x86
4. After the ADK finishes installing, double click on InstallAriaDeploy.bat
5. (optional) Also get the [generic RTM unattend.xml files](https://github.com/gdiaz384/AriaDeploy/releases) and here for the [MS license keys to use when deploying systems](https://technet.microsoft.com/en-us/library/jj612867.aspx)
6. (optional) Input the MS keys into the unattend.RTM.xml files
4. (optional) Also get the [generic RTM unattend.xml files](https://github.com/gdiaz384/AriaDeploy/releases) and here for the [MS license keys to use when deploying systems](https://technet.microsoft.com/en-us/library/jj612867.aspx)
5. (optional) Input the MS keys into the unattend.RTM.xml files
6. Anytime after the ADK finishes installing, double click on InstallAriaDeploy.bat

## Internal Dependency List:

Expand All @@ -88,7 +88,7 @@ I have bundled most of the dependencies into the installer, but due to the ADK's
3. Aria2 available over at sourceforge [1.19.0](http://aria2.sourceforge.net/)
4. 7zip available here [15.0.9b](http://www.7-zip.org)
5. py3createtorrent [0.9.5](https://py3createtorrent.readthedocs.org/en/latest/user.html)
6. py3bt_tracker [1.0.0-rc.1](https://github.com/gdiaz384/py3bt_tracker)
6. py3bt_tracker [1.0.0](https://github.com/gdiaz384/py3bt_tracker)
7. #5 and #6 and have internal dependencies: TDM-GCC over MingGW, tornado, bencode, pyinstaller, python etc
8. Architectural diagram illustrating these dependencies can be found at redist\AriaDeploy\AriaDeployControlFlow.png

Expand All @@ -97,14 +97,14 @@ I have bundled most of the dependencies into the installer, but due to the ADK's
Note: Anything prior to version 1.0 is alpha/beta quality depending upon release and current focus of development is on architectural imrovements and features not stability/bug fixes.

```
Latest Release: v0.3.1a
In Development: v0.4.0a
Current Version: 0.3.1a
In Development: 0.4.0a
::0.5.0 added partial mac support (no drivers)(?) winpe/dism not licensed for use on non-windows systems,
::2.0.0 added partial mac support (no drivers)(?) winpe/dism not licensed for use on non-windows systems,
::gparted can HFS+, rEFInd can boot, live distros are common, just need to find one that can access NFS/CIFS shares easily
::might need to convert batch script to .sh so maybe AriaDeployForMac
0.4.3 added optional 7z deployment scenario
0.4.2 formalized "deployment on a stick" and installer scenarios by precompiling and bunding software into "WinPE5_x64_AriaDeploy.iso" files
1.1.0 added optional 7z deployment scenario
1.0.0 formalized "deployment on a stick" and installer scenarios
0.4.1 added heterogenous hardware support using WMI, (requires WMI components in PE images however), streamlined installation files
0.4.0 added support for "deployment on a stick" scenarios (by replacing qTorrent with py3bt_tracker), made server architecture agnostic, bug fixed AriaDeploy.exe
0.3.1 refractored code, improved overall reliability, created "installer", switched to FOSS qTorrent over uTorrent for server aspect, and reduced requirements
Expand All @@ -114,6 +114,6 @@ In Development: v0.4.0a
```

## License:
Pick your License: GPL (any) or BSD (any) or MIT/Apache
Pick your License: GPL (any)

If I get any questions, I'm changing this to "beerware" and will refuse to elaborate further. You've been warned.
If I get any questions on licensing, I'm changing this to "beerware" and will refuse to elaborate further.
Binary file added client/resources/py3bt_tracker.exe
Binary file not shown.
Binary file modified redist/py3bt_tracker.zip
Binary file not shown.
8 changes: 4 additions & 4 deletions server/AriaDeploy.bat
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,10 @@ set default_pePathToImages=Y:\images
set default_pePathToDrivers=Y:\updates\drivers

::server-side configuration::
::set default_seederClientPath=C:\Program Files (x86)\uTorrent
::set default_seederClientexe=uTorrent.exe
set default_seederClientPath=resources
set default_seederClientexe=aria2c.exe
::local port used for tracker (use the local port of the seeding client if running an embedded tracker)
set default_trackerPort=9000
set default_trackerPort=6969
set default_unattendfileSource=D:\autodeploy\server\resources\unattendXml

::server-side control flow::
Expand Down Expand Up @@ -114,6 +112,8 @@ set default_serverConfigFile=%~n0.ini
::autodeploy\client\deployClient.ini
::8) Seeding: (startSeeding)

set arch=%processor_architecture%
if /i "%arch%" equ "amd64" set arch=x64

::1) gather enviornment data (autodeploy path and configuration settings)
::default settings (createTorrentExe, related syntax)
Expand All @@ -126,7 +126,7 @@ set pePathToImages=%default_pePathToImages%
set pePathToDrivers=%default_pePathToDrivers%

::server side configuration::
set seederClientPath=%default_seederClientPath%
set seederClientPath=%default_seederClientPath%\%arch%
set seederClientexe=%default_seederClientexe%
set trackerPort=%default_trackerPort%
set unattendfileSource=%default_unattendfileSource%
Expand Down
69 changes: 0 additions & 69 deletions server/AriaDeploy.ini

This file was deleted.

File renamed without changes.
Binary file modified server/resources/x64/py3bt_tracker.exe
Binary file not shown.
Binary file modified server/resources/x86/py3bt_tracker.exe
Binary file not shown.
15 changes: 9 additions & 6 deletions todo.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
VersionHistory/Planning: (anything prior to version 1.0 is alpha/beta quality depending upon release)
::0.5.0 added partial mac support (no drivers)(?) winpe/dism not licensed for use on non-windows systems,
VersionHistory/Planning:

Note: Anything prior to version 1.0 is alpha/beta quality depending upon release and current focus of development is on architectural imrovements and features not stability/bug fixes.

::2.0.0 added partial mac support (no drivers)(?) winpe/dism not licensed for use on non-windows systems,
::gparted can HFS+, rEFInd can boot, live distros are common, just need to find one that can access NFS/CIFS shares easily
::might need to convert batch script to .sh so maybe AriaDeployForMac
0.4.3 added optional 7z deployment scenario
0.4.2 formalized "deployment on a stick" and installer scenarios by precompiling and bunding software into "WinPE5_x64_AriaDeploy.iso" files
1.1.0 added optional 7z deployment scenario
1.0.0 formalized "deployment on a stick" and installer scenarios
0.4.1 added heterogenous hardware support using WMI, (requires WMI components in PE images however), streamlined installation files
0.4.0 added support for "deployment on a stick" scenarios (by replacing qTorrent with py3bt_tracker) and made server architecture agnostic, bug fixed AriaDeploy.exe
0.4.0 added support for "deployment on a stick" scenarios (by replacing qTorrent with py3bt_tracker), made server architecture agnostic, bug fixed AriaDeploy.exe
0.3.1 refractored code, improved overall reliability, created "installer", switched to FOSS qTorrent over uTorrent for server aspect, and reduced requirements
0.3 refractored code, addedUI, improved client side reliability, changed name to "AiraDeploy"
0.2 refractored code, added server components, improved scalability (architecture agnostic using Aria instead of uTorrent3.3)
0.2 refractored code, added server component, improved scalability (architecture agnostic using Aria instead of uTorrent3.3)
0.1 "massDeploy" concept art using uTorrent 3.3/psutils, client side only

Current version: 0.3.1, working on 0.4.0
Expand Down

0 comments on commit 837262f

Please sign in to comment.