win preview 1 docs

POFerro · May 13, 2016 · 1ee7c30 · 1ee7c30
1 parent 830d477
commit 1ee7c30
Show file tree

Hide file tree

Showing 7 changed files with 75 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -2,46 +2,32 @@
 
 ## Overview
 
-A cross platform build and release agent for Visual Studio Team Services and Team Foundation Server 2015 and beyond.  This will be replacing/combining the existing closed source windows build agent and the existing [xplat agent](https://github.com/Microsoft/vso-agent)
+The cross platform build and release agent for Microsoft Team Services and Team Foundation Server 2015 and beyond.  This will be replacing/combining the existing closed source windows build agent and the existing [xplat agent](https://github.com/Microsoft/vso-agent)
 
-Supported on Windows, OSX and Linux.  Written for the .NET Core CLR as one code base in C#.
-
-Will run all existing tasks (typescript/javascript and powershell) including [our in the box](https://github.com/Microsoft/vso-agent-tasks) and your custom tasks written with our [vsts task SDK](https://github.com/Microsoft/vsts-task-lib). 
+Supported on Windows, OSX, Ubuntu and Red Hat.  Written for the .NET Core CLR as one code base in C#.
 
 
 ## Status
 
 A preview is available for Ubuntu, RedHat and OSX for VSTS.  The current preview is more feature complete than the node agent bringing Auto Update, Cancellation, Run as a svc on OSX and Linux, and Gated support.
 
-What's missing from the preview? On-prem NTLM support is in the works so preview with VSTS.  Windows preview in days.
+What's missing from the preview? On-prem NTLM support is in the works so preview with VSTS. 
 
 |   | Build & Test | Preview | Release |
 |---|:-----:|:-----:|:-----:|
-|![Apple](docs/apple_med.png) **OSX**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/3080/badge?branch=master)| [Release 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
-|![Ubuntu](docs/ubuntu_med.png) **Ubuntu**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/2853/badge?branch=master)| [Release 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
-|![RedHat](docs/redhat_med.png) **RedHat**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/3418/badge?branch=master)| [Release 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
-|![Win](docs/win_med.png) **Windows**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/2850/badge?branch=master)| Preview 1 This Week | |
-
-## Configure Account
-
-VSTS only for now.  On-prem coming with NTLM support in the works.
-
-Create a PAT token.  [Step by Step here](http://roadtoalm.com/2015/07/22/using-personal-access-tokens-to-access-visual-studio-online/)
+|![Apple](docs/apple_med.png) **OSX**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/3080/badge?branch=master)| [Preview 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
+|![Ubuntu](docs/ubuntu_med.png) **Ubuntu**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/2853/badge?branch=master)| [Preview 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
+|![RedHat](docs/redhat_med.png) **RedHat**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/3418/badge?branch=master)| [Preview 4 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | June |
+|![Win](docs/win_med.png) **Windows**|![Build & Test](https://mseng.visualstudio.com/_apis/public/build/definitions/b924d696-3eae-4116-8443-9a18392d8544/2850/badge?branch=master)| [Preview 1 v2.100.1](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1) | |
 
-Add the user you created the PAT token for to *both*:
+## Configure Account and Roles
 
-  1. Agent Pool Administrators (allows to register)
-  2. Agent Pool Service Accounts (allows listening to build queue)
-
-![Agent Roles](docs/roles.png "Agent Roles")
-
->> TIPS:
->> You can add to roles for a specific pool or select "All Pools" on the left and grant for all pools.  This allows the account owner to delegate build administration globally or for specific pools.  [More here](https://msdn.microsoft.com/en-us/Library/vs/alm/Build/agents/admin)
->> The PAT token is only used to listen to the message queue for a build job
->> When a build is run, it will generate an OAuth token for the scoped identity selected on the general tab of the build definition.  That token is short lived and will be used to access resource in VSTS
+Add the build account to the proper roles.  [Read Here](docs/roles.md)
 
 ## Get Started
 
+![win](docs/win_sm.png)  [Start Windows](docs/start/startwin.md)  
+
 ![osx](docs/apple_sm.png)  [Start OSX](docs/start/startosx.md)  
 
 ![ubuntu](docs/ubuntu_sm.png)  [Start Ubuntu](docs/start/startubuntu.md)  

diff --git a/docs/preview/latebreaking.md b/docs/preview/latebreaking.md
@@ -1,5 +1,11 @@
 # VSTS Agent Preview - Late breaking instructions
 
+## Windows
+
+Preview 1 on tested on Windows 10 so far.
+
+Even though the agent has no pre-requisites, many of the tasks we run require Visual Studio 2015
+
 ## OSX
 
 Tested on 10.10 (Yosemite) and 11.11 (El Capitan)

diff --git a/docs/roles.md b/docs/roles.md
@@ -0,0 +1,17 @@
+# Configure Account and Roles
+
+VSTS only for now.  On-prem coming with NTLM support in the works.
+
+Create a PAT token.  [Step by Step here](http://roadtoalm.com/2015/07/22/using-personal-access-tokens-to-access-visual-studio-online/)
+
+Add the user you created the PAT token for to *both*:
+
+  1. Agent Pool Administrators (allows to register)
+  2. Agent Pool Service Accounts (allows listening to build queue)
+
+![Agent Roles](roles.png "Agent Roles")
+
+>> TIPS:
+>> You can add to roles for a specific pool or select "All Pools" on the left and grant for all pools.  This allows the account owner to delegate build administration globally or for specific pools.  [More here](https://msdn.microsoft.com/en-us/Library/vs/alm/Build/agents/admin)
+>> The PAT token is only used to listen to the message queue for a build job
+>> When a build is run, it will generate an OAuth token for the scoped identity selected on the general tab of the build definition.  That token is short lived and will be used to access resource in VSTS
diff --git a/docs/start/startosx.md b/docs/start/startosx.md
@@ -1,20 +1,20 @@
 # ![osx](../apple_med.png) OSX Agent
 
-## System Information
+## Step 1: System Requirements
 
 [Read here](../preview/latebreaking.md) to ensure system packages are installed
 
-## Step 1: Download from Releases
+## Step 2: Download from Releases
 
 Download the agent from [github releases](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1)
 
-## Step 2: Create the agent
+## Step 3: Create the agent
 
 ```bash
 ~/$ mkdir myagent && cd myagent
 ~/myagent$ tar xzf ~/Downloads/vsts-agent-osx.10.11-x64-2.100.1.tar.gz
 ```
-## Step 3: Configure
+## Step 4: Configure
 
 ```bash
 ~/myagent$ ./config.sh
@@ -23,7 +23,7 @@ Download the agent from [github releases](https://github.com/Microsoft/vsts-agen
 
 > NOTE: running as a service [details here](nixsvc.md)
 
-## Step 4: Optionally run the agent interactively
+## Step 5: Optionally run the agent interactively
 
 If you didn't run as a service above:
 

diff --git a/docs/start/startredhat.md b/docs/start/startredhat.md
@@ -1,20 +1,20 @@
 # ![redhat](../redhat_med.png) Red Hat Agent
 
-## System Information
+## Step 1: System Requirements
 
 [Read here](../preview/latebreaking.md) to ensure system packages are installed
 
-## Step 1: Download from Releases
+## Step 2: Download from Releases
 
 Download the agent from [github releases](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1)
 
-## Step 2: Create the agent
+## Step 3: Create the agent
 
 ```bash
 ~/$ mkdir myagent && cd myagent
 ~/myagent$ tar xzf ~/Downloads/vsts-agent-rhel.7.2-x64-2.100.1.tar.gz
 ```
-## Step 3: Configure
+## Step 4: Configure
 
 ```bash
 ~/myagent$ ./config.sh
@@ -23,7 +23,7 @@ Download the agent from [github releases](https://github.com/Microsoft/vsts-agen
 
 > NOTE: running as a service [details here](nixsvc.md)
 
-## Step 4: Optionally run the agent interactively
+## Step 5: Optionally run the agent interactively
 
 If you didn't run as a service above:
 

diff --git a/docs/start/startubuntu.md b/docs/start/startubuntu.md
@@ -1,20 +1,20 @@
 # ![ubuntu](../ubuntu_med.png) Ubuntu Agent
 
-## System Information
+## Step 1: System Requirements
 
 [Read here](../preview/latebreaking.md) to ensure system packages are installed
 
-## Step 1: Download from Releases
+## Step 2: Download from Releases
 
 Download the agent from [github releases](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1)
 
-## Step 2: Create the agent
+## Step 3: Create the agent
 
 ```bash
 ~/$ mkdir myagent && cd myagent
 ~/myagent$ tar xzf ~/Downloads/vsts-agent-ubuntu.14.04-x64-2.100.1.tar.gz
 ```
-## Step 3: Configure
+## Step 4: Configure
 
 ```bash
 ~/myagent$ ./config.sh
@@ -23,7 +23,7 @@ Download the agent from [github releases](https://github.com/Microsoft/vsts-agen
 
 > NOTE: running as a service [details here](nixsvc.md)
 
-## Step 4: Optionally run the agent interactively
+## Step 5: Optionally run the agent interactively
 
 If you didn't run as a service above:
 

diff --git a/docs/start/startwin.md b/docs/start/startwin.md
@@ -0,0 +1,26 @@
+# ![win](../win_med.png) Windows Agent
+
+> NOTE: Preview 1 only has git support.  TFSVC support is in progress for the next preview.
+
+## Step 1: System Requirements
+
+[Read here](../preview/latebreaking.md) to ensure system packages are installed
+
+## Step 2: Download from Releases
+
+Download the agent from [github releases](https://github.com/Microsoft/vsts-agent/releases/tag/v2.100.1)
+
+## Step 3: Create the agent
+
+```bash
+c:\ mkdir myagent && cd myagent
+C:\myagent> Add-Type -AssemblyName System.IO.Compression.FileSystem ; [System.IO.Compression.ZipFile]::ExtractToDirectory("$HOME\Downloads\vsts-agent-win7-x64-2.100.1.zip", "$PWD")
+```
+## Step 4: Configure and Run
+
+```bash
+c:\myagent> run.cmd
+
+```
+
+**That's It!**