Andrew's repo (#347)

Co-authored-by: Andrew Conniff <[email protected]>

Author: DariuszPorowski

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+    "default": true,
+    "MD013": false,
+    "MD033": false,
+    "MD007": { "indent": 4 }
+}

FAQ.md

@@ -6,19 +6,12 @@ Find information for common problems or questions.
 
 ## Common Questions / Problems
 
-1. The deploy ingress dns script errors out with this message:
-
-    ```bash
-    5-Deploy ingress  (bash ./deploy_ingress_dns.sh -s ./test_fetch_build -l westus2 -n teamdcaro04)
-    Upgrading tiller (helm server) to match client version.
-    $HELM_HOME has been configured at /home/azureuser/.helm.
-    Error: tiller was not found. polling deadline exceeded
-    ```
-
-    There are a number of steps in this script to try and ensure tiller is available, but sometime it still times out.  Please refer to Common Resolution #1 for the solution.
+1. A team deployment times out failures due to quotas or constraints on your Azure subscription.
 
 ## Common Resolution
 
 1. Delete & Recreate environment
 
-    Instead of manually hacking the setup script and trying to re-run the steps, sometimes it is easier to simply delete the resource groups where the failure occurred and recreate the resources via the setup script using the same team number since it is fully automated.
+    Instead of manually hacking the setup script and trying to re-run the steps, sometimes it is easier to simply delete the resource group where the failure occurred and recreate the resources via the setup script using the same team number since it is fully automated.
+
+2. Review the guidance for resource quotas included in provisioning [README](./provision-team/README.md)

README.md

@@ -5,37 +5,34 @@ languages:
 - sql
 products:
 - azure
-description: "This repo contains the code for the provisioning of the resources necessary to execute a DevOps openhack event."
+description: "This repo contains the code for the provisioning of the resources necessary to execute a DevOps OpenHack event."
 ---
 
-# DevOps Openhack Proctor Repository
+# DevOps OpenHack Proctor Repository
 
-This repo contains the code for the provisioning of the resources necessary to execute a DevOps openhack event.  The relevant code individual teams use (i.e. the APIs) to complete their challenges can be found in the [DevOps Openhack Team repository](https://github.com/Azure-Samples/openhack-devops-team/).
+This repo contains the code for the provisioning of the resources necessary to execute a DevOps OpenHack event.  The relevant code individual teams use (i.e. the APIs) to complete their challenges can be found in the [DevOps OpenHack Team repository](https://github.com/Azure-Samples/openhack-devops-team/).
 
 ## Components
 
 The components are organized by folders which contain the following:
 
-* **leaderboard** - visualizes the uptime for the teams' APIs and contains an Azure Functions API which connects to CosmosDB, Sentinel (pods to query the APIs and report status), and a web front end.
-* **provision-proctor** - code to support the provisioning of a complete proctor environment (1 needed per event).
 * **provision-team** - code to support the provisioning of a complete team environment.
-* **provision-vm** - automates the provisioning of an Ubuntu 16.04 VM used as the foundation for provisioning the team and proctor environments.
 * **simulator** - simulates traffic to the SQL database the APIs use for every team's environment.
+* **tripviewer** - the team website that your customers are using to review their driving scores and trips which are being simulated against the APIs.
 
 Go to the root of these folders to see a readme with deeper information on each component.
 
 ## Getting Started
 
 ### Prerequisites
 
-The first step is to create a virtual machine which has the necessary software installed required to provision the teams and proctor environments.  In order to create the VM, only the following needs to be installed
-
-* Azure PowerShell
+* Bash Shell
+* Azure CLI
 * An Azure Subscription
 
 ### High-Level Installation Flow
 
- [Deploy a team environment](./provision-vm) using the Azure Resource Manager template.
+ Deploy a team environment using the `deploy.sh` script and the guidance included in the  [provision-team](./provision-team) directory.
 
 ## Resources
 

provision-team/Dockerfile

@@ -0,0 +1,34 @@
+# SQL Server Command Line Tools
+FROM ubuntu:16.04
+LABEL maintainer="Opsgility"
+
+# apt-get and system utilities
+RUN apt-get update && apt-get install -y \
+	curl apt-transport-https debconf-utils \
+    && rm -rf /var/lib/apt/lists/*
+
+# adding custom MS repository
+RUN curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
+RUN curl https://packages.microsoft.com/config/ubuntu/16.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
+
+# install SQL Server drivers and tools
+RUN apt-get update && ACCEPT_EULA=Y apt-get install -y msodbcsql mssql-tools
+RUN echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bashrc
+RUN /bin/bash -c "source ~/.bashrc"
+
+RUN apt-get -y install locales
+RUN locale-gen en_US.UTF-8
+RUN update-locale LANG=en_US.UTF-8
+
+# install dig (dnstools)
+RUN apt-get update && apt-get -y install dnsutils
+
+# install git
+RUN apt-get update && apt-get -y install git
+
+# install azure cli
+RUN curl -sL https://aka.ms/InstallAzureCLIDeb | bash
+
+COPY deploy.sh /deploy/
+COPY azuredeploy.json /deploy/
+COPY jenkins/* /deploy/jenkins/

provision-team/README.md

@@ -1,48 +1,70 @@
-# Team Infrastructure script
+# DevOps OpenHack Deployment
 
-## Description
+To initiate a deployment, download both the ARM template (`azuredeploy.json`), the bash script (`deploy.sh`), and the `jenkins/` folder to the same directory in a bash shell.
 
-This script is used to install the Openhack team environment for the DevOps OpenHack.  This script will deploy all the necessary resources and configure the environment for a team to participate in the OpenHack.
+You can download these manually or using `git clone`. For example:
 
-## Pre-requisites
+```sh
+git clone https://github.com/Azure-Samples/openhack-devops-proctor.git
+```
 
-The required pre-requisites for installing a team environment are installed as part of proctor VM Setup.  The [setup script](https://raw.githubusercontent.com/Azure-Samples/openhack-devops-proctor/master/provision-vm/proctorVMSetup.sh) lists all pre-reqs along with required versions.
+> **Note:** [Azure Cloud Shell](https://docs.microsoft.com/azure/cloud-shell/overview) will be the easiest to use as it has all of the required tooling (az/sqlcmd/bcp/dig/etc.) installed already.
 
-## Usage
+## Execute Deployment
 
-    `nohup ./setup.sh -i <subscriptionId> -l <resourceGroupLocation> -n <teamName> -e <teamNumber> ><teamName><teamNumber>.out &`
+***You must be logged in to Azure already using `az login`. The deployment script as shown in the example will not perform a login for you.***
 
-**NOTE: You must login against the target subscription, if you have not already done so using the azure cli, prior to executing the setup script for a team.**
+To execute a deployment, you can run deploy.sh with a single parameter (`-l` for location). *e.g.* To deploy into `eastus`:
 
-### Parameters
+```sh
+bash deploy.sh -l eastus
+```
 
-- SubscriptionId - id of the subscription to deploy the team infrastructure to
-- resourceGroupLocation - Azure region to deploy to.  **_Must be a region that supports ACR, AKS, and KeyVault._**
-- teamName - name of the team.  This value is used for the base name of all of the resources provisioned in Azure.  **_Must be all lowercase alphanumeric characters_**
-- teamNumber (optional) - specific number for a team to provision.  If this is not specified, a random (3 character + 1 number) will be auto-generated.
+> **Note:** Some Azure services are not available in all locations. A list of known locations will need to be built out over time.
 
-An example command to provision with a random team number:
+### Optional container-based deployment
 
-`nohup ./setup.sh -i <subscriptionId> -l eastus -n devopsoh >devopoh-random.out &`
+An optional container deployment is available if you wish to create your environment by supplying a username and password to the deployment script.
 
-An example command to provision with a specific team number:
+> **Note:** This method does not support MFA-enabled logins. Please clone the repository and use the deployment script manually after executing `az login`.
 
-`nohup ./setup.sh -i <subscriptionId> -l eastus -n devopsoh -e 1 >devopsoh1.out &`
+1. To execute a container deployment, build a container using the [Dockerfile](Dockerfile) located in the [provision-team](/provision-team/) directory.
 
-**Important** - The specific team number format should be used when provisioning an event with sequential numbers starting at 1 in order for the sentinels in the proctor environment to work properly. For example:
+    ```sh
+    docker build -f Dockerfile . -t devopsohdeploy:latest
+    ```
 
-```bash
-nohup ./setup.sh -i <subscriptionId> -l eastus -n devopsohseawa -e 1 >devopsohseawa1.out &
-nohup ./setup.sh -i <subscriptionId> -l eastus -n devopsohseawa -e 2 >devopsohseawa2.out &
-nohup ./setup.sh -i <subscriptionId> -l eastus -n devopsohseawa -e 3 >devopsohseawa3.out &
-```
+2. Run the container, replacing the tokens `<AZURE_USERNAME>`, `<AZURE_PASSWORD>`, and `<LOCATION>` with a username and password that have the required permissions and a location which can accommodate the required resources.
 
-The `nohup` command prevents the long running script (`setup.sh`) from being aborted when you exit the shell or logout.
-The `&` indicates to run the script in the background to not block your current session.
+    ```sh
+    docker run -i -t devopsohdeploy:latest /bin/bash -c "export PATH="$PATH:/opt/mssql-tools/bin" && cd /deploy && bash deploy.sh -l <LOCATION> -u '<AZURE_USERNAME>' -p '<AZURE_PASSWORD>'"
+    ```
 
-The standard out of the script is written to the file indicated after the sign `>`.
-Use the `tail` command to from the same path where you ran the setup script to monitor in real time what is written to the file:
+## Requirements
 
-```bash
-tail -f devopsoh1.out
-```
+### Software requirements
+
+The current deployment stack requires the following tooling and versions:
+
+- Azure CLI v2.3.0 (or higher) ([Installation instructions](https://docs.microsoft.com/cli/azure/install-azure-cli))
+- sqlcmd v17.5.0001.2 Linux (or higher) ([Installaton instructions](https://docs.microsoft.com/sql/linux/sql-server-linux-setup-tools))
+    - bcp
+- dig v9.10.3 (or higher)
+- git
+
+### Azure permissions
+
+- You must be a Contributor or an Owner on the subscription where you would like to deploy.
+
+    > **Note**: If you are using a custom role, you must have `write` permissions to create all the resources required for this OpenHack.
+
+### Azure resource requirements
+
+| Azure resource           | Pricing tier/SKU       | Purpose                                 |
+| ------------------------ | ---------------------- | --------------------------------------- |
+| Azure SQL Database       | Standard S3: 100 DTUs  | mydrivingDB                             |
+| Azure Container Registry | Basic                  | Private container registry              |
+| Azure Container Instance | 1 CPU core/1.5 GiB RAM | Jenkins container                       |
+| Azure Key Vault          | Standard               | Key vault for database secrets          |
+| App Service Plan         | Standard S2            | App Service Plan for all Azure Web Apps |
+| Azure Container Instance | 1 CPU core/1.5 GiB RAM | Simulator                               |