Merge pull request #36 from devdattakulkarni/cicd-fixes

CICD steps updated

Author: devdattakulkarni

CICD/cicd-steps.txt

@@ -14,10 +14,6 @@ Machine 2 *has* to be a cloud VM (such as a EC2 instance).
 Feel free to choose either a EC2 instance or Google Compute Engine instance
 Make sure you allow TCP traffic to port 8080 on your VM instance.
 
-If using EC2, create a Free tier Ubuntu 16.04 VM
-
-Note: It is fine to use a single VM as Machine 1 and Machine 2. It is up to you.
-
 
 A] Setup your developer workspace/Machine 1:
 --------------------------------------------
@@ -26,7 +22,7 @@ A] Setup your developer workspace/Machine 1:
    - curl https://sdk.cloud.google.com | bash
    - log out and log back in
 
-2) Configure authentication for gcloud CLI
+2) Configure authentication for gcloud CLI. We need this step to create Google Cloud SQL instance and static IP.
    - gcloud auth login --> Follow the prompts (you will have to open browser window and paste the generated link,
        then paste the generated code in the verification field in your console.)
    - Create Project in Google Cloud Console --> Note down the Project ID. Remember that Project ID is different than the Project's Name.
@@ -50,12 +46,15 @@ A] Setup your developer workspace/Machine 1:
 5) Create a static IP address for our application
    - gcloud compute addresses create greetings-ip --global
 
-6) Create your Bitbucket repository named "assignment6"
+6) Create GKE cluster
+   - gcloud container clusters create --machine-type=g1-small --num-nodes=1 testcluster1
+
+
+7) Create your Bitbucket repository named "assignment4"
    - Make it Public
    - Generate a SSH Key pair for your developer workspace VM 
      and add it to your Bitbucket account
      - Account -> Settings -> Add Key
-      - You can either generate an SSH key or add an existing key if you have one
         - ssh-keygen
         - It is fine if you provide an empty passphrase
 	- more ~/.ssh/id_rsa.pub
@@ -64,22 +63,20 @@ A] Setup your developer workspace/Machine 1:
           The pasting operation will unevenly break the key into multiple lines. Find such lines
           and remove any extra spaces by hitting the Backspace key.
 
-7) Download Sample CI/CD project
+8) Download Sample CI/CD project
    - git clone https://github.com/devdattakulkarni/CloudComputing
    - cd CloudComputing/CICD/greetings
    - Edit greetings-deployment.yaml and set the environment variables corresponding to
      the Google Cloud SQL instance
      (Note: In the image tag don't include any version.
-      i.e.: Define your image tag as: "gcr.io/<project-id>/greetings" and NOT as
+      i.e.: Define your image tag as: "gcr.io/<project-id>/greetings:latest" and NOT as
       "gcr.io/<project-id>/greetings:v1")
 
    - Add a remote for your Bitbucket repository and Push the sample CI/CD project to that remote
      - cd ../../
      - git remote add origin1 git@bitbucket.org:<your-bitbucket-username>/assignment6.git
      - git push origin1 master
 
-8) Create GKE cluster
-   - gcloud container clusters create --machine-type=g1-small --num-nodes=1 testcluster1
 
 
 B] Setup your Jenkins Server/Machine 2:
@@ -90,19 +87,20 @@ B] Setup your Jenkins Server/Machine 2:
      - sudo apt-add-repository ppa:openjdk-r/ppa
      - sudo apt-get update
      - sudo apt-get install -y openjdk-8-jre openjdk-8-jdk wget
-   - Install Google Cloud CLI
+   - Install Google Cloud CLI (this is needed for Jenkins Server to authenticate to GCP)
      - sudo apt-get install python
      - curl https://sdk.cloud.google.com | bash
-   - Install Docker
+   - Install Docker (this is needed for Jenkins Server to build container image)
      - git clone https://github.com/devdattakulkarni/CloudComputing.git
      - cd CloudComputing/Containers/Kubernetes-examples/GCP/
      - ./install-docker-ubuntu.sh 
    - Exit from Cloud VM instance
      - SSH back into Cloud VM instance
-   - Install Kubectl
+   - Install Kubectl (this is needed for Jenkins Server to deploy to GKE)
      - gcloud components install kubectl
 
    - Generate a SSH Key pair for the Jenkins Server and add it to your Bitbucket account
+     (this is needed so that Jenkins Server can clone your github repo)
      - Account -> Settings -> Add Key
       - You can either generate an SSH key or add an existing key if you have one
         - ssh-keygen
@@ -113,6 +111,13 @@ B] Setup your Jenkins Server/Machine 2:
           The pasting operation will unevenly break the key into multiple lines. Find such lines
           and remove any extra spaces by hitting the Backspace key.
 
+     - Workaround (If running into SSH host key verification issues, you can disable it as follows):
+       - Disable Host key verification:
+         - create .ssh/config file
+         - Include following lines in it:
+           Host *
+                StrictHostKeyChecking no
+
 2) Configure authentication for gcloud CLI
    - gcloud auth login --> Follow the prompts (you will have to open browser window and paste the generated link,
        then paste the generated code in the verification field in your console.)
@@ -122,43 +127,42 @@ B] Setup your Jenkins Server/Machine 2:
    - export CLOUDSDK_COMPUTE_ZONE=us-central1-b
    - gcloud config set project ${PROJECT_ID}
 
-3) Disable Host key verification:
-   - create .ssh/config file
-   - Include following lines in it:
-     Host *
-         StrictHostKeyChecking no
 
-4) Download and Start Jenkins Server:
+3) Download and Start Jenkins Server:
    - wget http://mirrors.jenkins.io/war-stable/latest/jenkins.war
    - nohup java -jar jenkins.war --httpPort=8080  &
+     -> This will start Jenkins process on port 8080
 
-5) Configure Jenkins Server
+4) Configure Jenkins Server
    - Point your browser to the DNS name of the Jenkins Server at port 8080
      https://<DNS-of-Jenkins-Server>:8080/
    - Enter admin password from $HOME/.jenkins/secrets/initialAdminPassword
    - Choose Install suggested plugins option
 
-6) Once Jenkins starts up do following:
-   4.1) Login as admin user
+5) Once Jenkins starts up do following:
+   5.1) Login as admin user
         - Password is stored in: $HOME/.jenkins/secrets/initialAdminPassword
-   4.2) Set the path in Jenkins for Git
+   5.2) Set the path in Jenkins for Git
         Jenkins -> Manage Jenkins -> Configure System -> Global Properties
         - Check Tool Locations
         - List of tool locations -> Add 
         - Set the path of Git from your VM
           (You can find the path by running 'which git' on VM)
         - Save
-   4.3) Install the Post build task Plugin and Bitbucket Plugin
+   5.3) Install the Post build task Plugin and Bitbucket Plugin
         Jenkins -> Manage Jenkins -> Manage Plugins
 	- In Available tab, search "Post build task" and select
 	- In Available tab, search "Bitbucket" and select
 	  (Note: There are several Bitbucket plugins -- you want to choose whose
            name contains only the word "Bitbucket" and nothing else)
 	- Choose Install without restarting option
+        - Bitbucket plugin will be used to clone Bitbucket repo
+        - Post build task plugin will be used to perform build and deploy tasks
+
 
+C] Add a WebHook to your Bitbucket repository
 
-7) Add a WebHook to your Bitbucket repository
-   5.1) Go to your Bitbucket repository -> Settings -> Webhooks -> Add webhook
+1) Go to your Bitbucket repository -> Settings -> Webhooks -> Add webhook
         - http://<DNS-of-Jenkins-server>:8080/bitbucket-hook/
           (Note: The trailing slash '/' is important. Don't forget that!!)
         - Make Status as "Active"
@@ -168,30 +172,30 @@ B] Setup your Jenkins Server/Machine 2:
             - Repository->Push, Pull Request->Created, Updated, Comment created, Comment updated, Comment deleted
               Issue->Created, Issue->Updated, Issue->Comment Created
 
-8) Set up a Jenkins Job
-   6.1) Make sure your Bitbucket repository ("assignment6") is Public
+2) Set up a Jenkins Job on Jenkins VM
+   2.1) Make sure your Bitbucket repository ("assignment4") is Public
         - This will make it possible to be cloned by Jenkins.
-   6.2) Jenkins -> New Item -> Give name -> Select Freestyle project
+   2.2) Jenkins -> New Item -> Give name -> Select Freestyle project
         -> Source Code Management -> Git -> Give Bitbucket Repository URL (using git protocol)
-	(e.g.: git@bitbucket.org:devdattakulkarni/assignment6.git)
+	(e.g.: git@bitbucket.org:devdattakulkarni/assignment4.git)
         -> Leave Branches to build as empty
-   6.3) Build Triggers
+   2.3) Build Triggers
         -> Choose "Build when a change is pushed to BitBucket"
-   6.4) Buid Section -> Add a build step -> Execute Shell script
+   2.4) Buid Section -> Add a build step -> Execute Shell script
         -> In the Execute shell Command section:
            - Add contents of build-steps.txt 
              - Notes:
                - First modify build-steps.txt to use your GCP Project ID
                - Make sure that the image tag that use here is what you defined 
                  in deployment.yaml (Part A, step 7)
-   6.5) In Post-build Actions
+   2.5) In Post-build Actions
         -> Add post-build action -> Post build task
           -> Log text "SUCCESS" -> Operation "-- OR --"
            -> In the Tasks -> Script section:
 	      - Add contents of deploy-steps.txt (modify the steps as required)
-   6.6) Save
+   2.6) Save
 
-   6.7) Bitbucket host key verification
+   2.7) Bitbucket host key verification
 
 	Once you hit 'Save', you will see a prompt to verify the key for bitbucket server.
         This indicates that Jenkins has received the web hook and wants to clone your repository.
@@ -209,7 +213,7 @@ CI/CD Experiment:
    - git commit
    - git push origin1 master
 
-3) (If Part B step 6.7 was not executed for some reason) On the Jenkins machine, 
+3) If Part C step 2.7 was not executed for some reason, on the Jenkins server,
    you should see a prompt to verify the key for bitbucket server.
    This indicates that Jenkins has received the web hook and wants to clone your repository.
    In order to clone the repo, it needs to first verify the host key. Enter 'yes' to accept
@@ -236,7 +240,7 @@ CI/CD Experiment:
 Kubernetes YAML files:
 ----------------------
 1) greetings-deployment.yaml
-   -> Environment variables need to be set with Google Cloud SQL instance details
+   -> Environment variables need to be set with appropriate Google Cloud SQL instance details
 
 2) greetings-ingress.yaml
    -> Contains configuration for the Global IP address that we create in Part A step 5