Skip to content

Latest commit

 

History

History
182 lines (118 loc) · 9.25 KB

lab_1.md

File metadata and controls

182 lines (118 loc) · 9.25 KB
Raw

Lab 1 - Connectivity

Create Repo From Template

  1. Access the source repo url: https://github.com/softchoice-corp/DevOpsBootcamp

  2. Click the green Use this template button. This will copy all of the content from the source repo into a new repo under your GitHub account.

  3. Provide a new repository name and description. The repo can be left as Public, and leave the Include all branches option unselected. Click the green Create repository from template button.

  4. Once the repository creation is completed you should see that your new repo is in your account, and was generated from softchoice-corp/DevOpsBootcamp.

lab_1_template_01

Create Azure Service Principal

We need to create a service principal in Azure that GitHub Actions will use to authenticate and deploy resources. This service principal is similar to a traditional service account. The clientId or appId represent the username, the clientSecret represents the password, and the tenantId/subscriptionId represent the domain. When creating a new service principal all of these values are guids.

  1. Open the Azure Portal using https://portal.azure.com.

  2. Access Cloud Shell from the Azure Portal by clicking the icon in the upper right toolbar.

Note: If this is the first time you have used Azure Cloud Shell you will be prompted to create a storage account to enable Cloud Shell.

lab_1_cloudshell_01

  1. Use Azure CLI to create a new service principal for use with GitHub Actions. Az Cli is installed in both PowerShell and Bash within Azure Cloud Shell.
az ad sp create-for-rbac --name GitHubActions

Azure will generate a strong password for the service principal and return it in Cloud Shell. We need to capture this information for use in our GitHub secret storage. Example Azure Cloud Shell service principal response:

sp_01

  1. When creating the new service principal the Subscription Id is not a value that is returned, but we will need it for our connection later. Run the following command to display the Subscription Id.
az account show --query "id"

Create GitHub Credential Variable

We need to provide our GitHub repo the service principal credentials we just created in our Azure subscription. GitHub will need the credentials supplied in a specifically formatted block of JSON. Copy this example into a text editor like Notepad. Then we will substitute our actual values for the service principal before saving it in GitHub.

  1. Open Notepad and paste the following JSON code block:
{
  "clientId": "GUID",
  "clientSecret": "GUID",
  "subscriptionId": "GUID",
  "tenantId": "GUID"
}
  1. For each property replace "GUID" with the actual guid for the Azure Service Principal. You may notice that property names that GitHub requires do not exactly match the property names that Azure outputed when we created the service principal. This is expected, use the table below to map the property name required by GitHub to the Azure CLI property name that was outputted when the service principal was created.
GitHub Property Name Where do I get it? Az CLI Property Name
clientId Output from Azure Service Principal creation appId
clientSecret Output from Azure Service Principal creation password
subscriptionId Output from az account show --query "id" guid is only data returned
tenantId Output from Azure Service Principal creation tenant
  1. In your GitHub Repo navigate to Settings > Secrets, and click Add a new Secret. Name the secret AZURE_CREDENTIALS, paste your JSON object in the Value, and click Add Secret. secret_01

Note: Once you add the secret you cannot retrieve the values in clear text from GitHub.

Configure GitHub Actions

  1. It your GitHub repo navigate to Code, then browse to the workflow-templates directory and open the lab_1_connectivity.yml file and copy all of the text.

lab_1_workflow_01

  1. Navigate to Actions and click Set up a workflow yourself. If prompted to start with a sample workflow click the Set up a workflow yourself button in the top right.

  2. Replace all of the sample workflow code in the editor by pasting all the code you copied from workflows-templates/lab_1_connectivity.yml.

  3. GitHub Actions files must be saved in a directory in your repo named .github/workflows/. The directory structure .github/workflows/ should already exist in the path, name your workflow file lab_1_connectivity.yml and click Start Commit.

  4. Add a short commit message and click Commit new file

lab_1_workflow_02

Navigate to Code, open the .github/workflows directory, and open the lab_1_connectivity.yml file. Let's explore this file.

The on: section describes what event will cause the workflow to execute. This code configures the workflow to only execute when files are modified in the lab_1/ directory, and when the changes are pushed to the master branch.

on:
  push:
    branches:
      - master
    paths:
      - "lab_1/**"

The name: section gives the workflow a name, visible in the Actions area of the repo. This code names the workflow Lab_1_VerifyConnectivity.

name: Lab_1_VerifyConnectivity

The jobs: section instructs the workflow on what to actually do. Each job is made up of one or more steps that are executed sequentially. This code starts a single job named connect-to-azure running on a Ubuntu Linux instance. The job performs 3 steps:

  • Azure Login: Login to Azure using the credentials stored in the secret AZURE_CREDENTIALS
  • Checkout Code: This performs a git clone to copy all of the repo code into the Ubuntu Linux instance.
  • Azure CLI Script: Execute the Azure CLI script lab_1/list_resourcegroups.sh
jobs:
  connect-to-azure:
    runs-on: ubuntu-latest
    steps:
      - name: Azure Login
        uses: azure/login@v1
        with:
          creds: ${{ secrets.AZURE_CREDENTIALS }}

      - name: Checkout Code
        uses: actions/checkout@v2

      - name: Azure CLI Script
        uses: azure/CLI@v1
        with:
          inlineScript: |
            chmod +x ./lab_1/list_resourcegroups.sh
            ./lab_1/list_resourcegroups.sh

Navigate to the lab_1/list_resourcegroups.sh and we can examine what the script being executed by the action will actually do. We can see this script will simply show the account which is authenticated to Azure (this will be the service principal), and list the Resource Groups in the Azure subscription in a table format.

# show the logged in account
az account show

# list all resource groups
az group list -o table

Run GitHub Actions

The workflow we just created is triggered by changes made to the files in the lab_1/ directory. Let's make a change here to kick off the workflow. The readme.txt can be modified by simply adding a new line or some text. The act of committing this change to the master branch will instruct GitHub Actions to kick off our workflow.

  1. Navigate to Code, and browse to the lab_1/readme.txt file. Click the pencil icon to edit the file, and add a new line. Provide a commit message and commit your change.

  2. Navigate to Actions and you should see your Lab_1_VerifyConnectivity workflow executing.

lab_1_workflow_06

  1. Click the instance of the workflow and you can explore the results of this execution. Within the Lab_1_VerifyConnectivity workflow you can click the connect-to-azure job. In the right-hand pane you can view the output of the individual steps (Azure Login, Checkout Code, Azure CLI Script) within this job.

lab_1_workflow_07

End of Lab 1

Links to more learning:

professortocat