README.md

Getting started with GitHub Actions and the VDC toolkit

GitHub Actions are apart of an automation workflow that can integrate with your CI/CD pipeline. Developers can build, test and deploy upon code pushes and pulls to GitHub.

To Learn more about GitHub actions visit the GitHub Action Documentation

GitHub Actions with the VDC toolkit quickstart

The GitHub action in this repository will create the Shared Services Environment and the MS-VDI environment all from a "push" to the GitHub repository.

To change the environment being deployed you will need to manipulate the "entrypoint.ps1" file in the root directory.

Get started on setting up the action below:

1. Ensure you have the latest code when setting up your action pipeline

   • Files you need before proceeding with your actions

     • 'dockerfile' in your root repository
     • 'action.yml' in your root repository
     • 'entrypoint.ps1' in your root repository
     • 'dockerimage.yml' under the "vdc/.GitHub/workflows" directory

2. Create Service Pricipal

   Follow for creating the service principal and note the object id and password during creation. The service principal will require owner permissions.

• Create SPN via PowerShell for password based authentication
• Create SPN via Azure Cli
• Verify & add roles/permissions

3. You will also need to setup your GitHub secrets for the pipeline to use

   • You will need the following secrets

     • SERVICE_PRINCIPAL
     • SERVICE_PRINCIPAL_PASS
     • DEVOPS_SERVICE_PRINCIPAL_USER_ID
     • ADMIN_USER_NAME
     • ADMIN_USER_PWD
     • DOMAIN_ADMIN_USERNAME
     • DOMAIN_ADMIN_USER_PWD
     • TENANT_ID
     • SUBSCRIPTION_ID
     • KEYVAULT_MANAGEMENT_USER_ID
     • ADMIN_USER_SSH

   • To add these secrets in your GitHub repository navigate to

     • "Settings" -> "Secrets"
       • Then add each secret value with exactly the corresponding name above
     • For more information visit the GitHub link for adding new Secrets.
     • You do not need "" around your secret values. Enter them with raw data.

4. In your dockerimage.yml file you will need to change the following values that suit your need

   • ORGANIZATION_NAME
   • AZURE_LOCATION
   • Update "uses" to your GitHub repo name.
     • uses: [YOUR_GITHUB_NAME]/vdc@master
   • Please keep the AZURE_DISCOVERY_URL as is

5. Once you have all these changes and updated your GitHub secrets you can push the changes to your repository.

6. Upon the "push" you will kick off an action which will deploy the shared services and ms-vdi resources.