OpenShift Hands-On Lab - Creating an OpenShift Application from Source

OpenShift Hands-On Lab - Creating an OpenShift Application from Source

OpenShift Learning Path for Cloud and DevOps Engineers

📝Introduction

We will create a new OpenShift application from a Source in this lab. The new application will run a simple Apache Web page built from a Git repo.

These are the objectives of this lab:

  • Create the New Project

📌Note: The section to create a new project only applies to students using CodeReady Containers. Skip this section if you are using Red Hat OpenShift sandbox.

  • Create the New Application

  • Create a New Route

  • Test the Web Page

📌Note: Due to resource limitations in my Cloud Playground environment, I used the below Red Hat free online resources available for this lab.

  1. To complete this lab, you must first register for a Red Hat Developer login on theRed Hat login page.

  2. Once registered, you may complete the lab steps usingRed Hat's CodeReady Containers or the Red Hat-provided OpenShift sandbox.

Solutions for CodeReady Containers and the Red Hat OpenShift sandbox can be used in this lab. However, I decided to use the free Red Hat-provided OpenShift sandbox available for 30 days.

📝Set Up CodeReady Containers (For those who choose to run it locally)

📌Note: CodeReady Containers has specific hardware and operating system requirements. To ensure your environment is compatible, see Red Hat's minimum system requirements for CodeReady Containers.

  1. Navigate and log in to your Red Hat Developer account.

  2. Under the Local tab, select your OS and click Download CodeReady Containers.

  3. Click Copy Pull Secret for later use.

  4. Install CodeReady Containers.

    📌*Note:For OS-specific installation instructions, see [Red Hat's CodeReady Containers installation guide](access.redhat.com/documentation/en-us/red_h..).*

  5. Open a terminal session and set up CodeReady Containers:

     crc setup
    
  6. When prompted, enter yes to enable telemetry data collection or no to disable telemetry data collection.

  7. Start the VM:

     crc start
    

    📌Note: The cluster takes a minimum of 4 minutes to start before serving a request.

  8. When prompted, paste in the previously copied pull request and press Enter.

  9. Print the command needed to add the cached oc executable to your $PATH:

     crc oc-env
    
  10. Run the printed command.

  11. Log in as the developer user:

    oc login -u developer https://api.crc.testing:6443
    

📝Set Up an OpenShift Sandbox (This was my choice).

  1. To log in through the web UI directly, navigate to the Red Hat CodeReady Containers page and log in to your Red Hat Developer account with the credentials you created.

  2. Select Try OpenShift in our free sandbox.

  3. Click Launch your Developer Sandbox for Red Hat OpenShift.

  4. Confirm your account, enter a valid phone number and click Send Code.

  5. Enter the verification code you received and click Verify Code.

  6. Click Start using your sandbox.

  7. Under Log in with, click DevSandbox.

  8. Select the I have read and agree to the Red Hat OpenShift Online Services Agreement and click SUBMIT.

  9. At the top right, click the shell icon (>_).

  10. Leave the default project selected and click Start.

    📌Note1: You will not be able to create new projects in the Sandbox. For any steps in the lab stating you need to create a new project, skip that step and ensure you use one of the existing projects: <username>-dev, or <username>-stage.

    📌Note2: Type q to exit a menu or log.

📝Log In to the Cluster (Option 1)

📌Note: This section only applies to students using CodeReady Containers. Otherwise, skip to the next objective.

  1. Log in to the cluster:

     oc login -u developer https://api.crc.testing:6443
    
  2. Open a browser, and log in to the cluster using the console URL.

  3. Use thedeveloper credentials to log in.

📝Log In to the Cluster (Option 2)

📌Note: To complete a login using oc in the OpenShift sandbox, click on the shell (>_) icon. Alternatively, you can download the binary and log in from a remote system (e.g. VSCode). Please review the  Using Red Hat OpenShift Sandbox  video detailing the necessary steps for that process.

📝Create a New Application

  1. Create a new application named appdemotest using the httpd image stream and GitHub repository for the HTML file:

     oc new-app --name=<app_name> httpd~https://github.com/fjblsouza/simple-html-file.git -l app="<app_name>"
     #Note: It may take several minutes for the app building process to complete.
    
  2. Check the app status:

     oc status
    

📝Create a New Route

  1. Create a new route to the application by exposing the new service:

     oc expose service <app_name>
    
  2. Look up the new route:

     oc get routes
    
  3. Copy the hostname of the route for later use.

📝Test the Web page

  1. To view the web page, use a curl command and paste in the previously copied hostname:

     curl -s <ROUTE_HOSTNAME>
    

    You should now see the HTML of the Web page, also you can try to open it on your browser.

📝Checking the resources

  1. List all the resources on the System, please run the command:

     oc get all
    

  2. List all pods in ps output format with more information (such as node name), please run the command:

     oc get pods -o wide
    

  3. Return a snapshot of appdemotest logs from pod appdemotest-6d94679f5b-zfz4n

     oc logs <pod_name> -c <container_name>
    

  4. Start streaming of appdemotest logs from pod appdemotest-6d94679f5b-zfz4n

     oc logs -f pod/<pod_name> -c <container_name>
    

  5. Open a Shell session on the Pod, please run the command:

     oc rsh <pod_name>
    

📝View of the OpenShift Console

📌Note - At the end of each hands-on Lab, always clean up all previous resources created to avoid being charged if you used a Cloud Provider to provision them.

Congratulations — you have completed this hands-on lab covering the basics of Creating an OpenShift application from a Source(GitHub) repo.

Thank you for reading. I hope you understood and learned something helpful from my blog.

Please follow me on CloudDevOpsToLearn and LinkedIn, franciscojblsouza