Skip to main contentIBM Cloud Patterns

Deploy First Application

Create a sample application and deploy it with a CI pipeline


The Developer Environment supports end-to-end development and deployment of an application. The instructions below will show you how to do it.

You can create a new app using one of the Code Patterns. These have been created to include all the key components, configuration, and frameworks to get you started on creating the code you need for your solutions. The approach for getting started is exactly the same for an environment based on Kubernetes or Red Hat OpenShift.

This video demonstrates how to work through the steps to create an application and use a deployment pipeline to install it into your development cluster.


1. Log into your Development Cluster from the command line

  • This example will be using kubectl and is assuming Kubernetes cluster with Jenkins. You can us oc with and OpenShift cluster with the same set of commands.

  • Make sure you have installed all the Prerequisite Dev Tools before continuing this includes the Tools CLI

    • This will install a number of alias functions into kubectl and oc CLI tools including sync,pipeline and endpoints
  • Log in to the development cluster’s CLI (Kubernetes or Red Hat OpenShift)

    To do so, navigate to your cluster in the IBM Cloud console, click on the Access tab, and follow the instructions in After your cluster provisions, gain access section to log in to the cluster from the command line

  • You can test that you’re connected to the cluster with the following simple command:

    kubectl get pods -n tools

2. Create the development namespace

  • Before getting started, the development namespace/project needs to be created and prepared for the DevOps pipelines.

  • This is something that would typically happen once at the beginning of a project as a development team is formed and assigned to the cluster.

    kubectl sync {DEV_NAMESPACE} --dev

3. Open the Developer Dashboard

The Developer Dashboard makes it easy for you to navigate to the tools, including a section that allows you to select a set of preconfigured Code Patterns that make seeding your development project very easy.

  • If you are logged into the OpenShift console you can select the tools menu and select Developer Dashboard

  • If you are logged into Kubernetes run the following command, this will open the Development Dashboard installed into the Kubernetes clusters.

    kubectl dashboard
  • If you are on a laptop/desktop Open a browser and make sure you are logged into Github

4. Create your app in Git

  • From the Developer Dashboard, click on Code Patterns tab

  • Pick one of the templates that is a good architectural fit for your application and the language and framework that you prefer to work with. For your first application select the Typescript Microservice. This works well in the Cloud Shell as well.

    Click on a Code Pattern Tile to create your app github repository from the template repository selected. You can also click on the Git Icon to browse the source template repository and click on the Template to create the template

  • Owner: Select a valid GitHub organization that you are authorized to create repositories within or the one you were given for the shared cluster (See warning above)

    Repository name: Enter a valid name for you repo, GitHub will help with showing a green tick if it is valid (See warning above)

    Description: Describe your app

    Press Create repository from template


  • The new repository will be created in your selected organization.

5. Clone your code

  • Next, clone it to your local machine.

  • Click on Clone or download

  • Copy the clone HTTPS link, and use the git clone command to clone it to your terminal.

    git clone
  • You will be required to enter your GitHub User ID and use your Git Hub Personal Access Token as your password. This will complete the clone of your git repository.

  • Change into the cloned directory

    cd stockbffnode-mjp
  • You must rename the app to match your git repo or to a unique name for your solution. Then applications move into a test environment they need to unique names.

  • Edit package.json and edit the name: field and change it from its template name to your chosen name.

  • Save the edits

  • Push the changes back to your repository

    git add .
    git commit -m "Update application name"
    git push
  • You will be required to enter your GitHub User ID and use your Git Hub Personal Access Token as your password. This will push your changes back to the repository.

Running the Application

6. Run the application

Most developers like to run the code natively in local development environment. To do so, follow the instructions listed in the file to run the code locally.

  • For the inside the folder for the code cloned from GitHub, run the following command to install the Node.js dependencies.

    npm install
  • Then you can run the app from inside your cloud shell.

    npm run start
  • To view the running app click on the Eye Icon on the top right and select the port 3000 this will open a browser tab and display the running app on that port.

    View App

  • You can try out the sample API that is provided with this Code Pattern

  • You can now add new features and function from inside the Cloud Shell and experiment with your code before you push you changes back to git.

7. Set the namespace context

Before running these remainder of the instructions commands it is important to set the namespace/project context. (Notes: The kubernetes command will work for both openshift and kubernetes.)

kubectl config set-context --current --namespace={DEV_NAMESPACE}

8. Register the App in a DevOps Pipeline

Up to this point you have the code in a GitHub repository and have cloned it to you local development environment. You now need to register the repository with the continuous integration pipeline. The Developer Environment supports both Tekton and Jenkins for continuous integration.

  • Start the process to create a pipeline

    kubectl pipeline
  • For the deployment of your first app with Kubenetes select Jenkins as the chosen CI engine. If you are developing on OpenShift 4.3 select Tekton for your CI engine.

  • The first time a pipeline is registered in the namespace, the CLI will ask for a username and Personal Access Token for the Git repository that will be stored in a secret named git-credentials. It will also ask for the branch that should be used for the pipeline.

    • Username: Enter your GitHub user id

    • Personal Access Token: Paste your GitHub personal access token

    • Branch: Press enter for the default git branch or type in another branch you want to register

      $ kubectl pipeline
      ? Select the type of pipeline that should be run? Jenkins
      Creating pipeline on kubernetes cluster in dev-mjp namespace
      Creating secret(s) with git credentials
      Project git repo:
      ? Provide the git username: <userid>
      ? Provide the git personal access token: [hidden]
      ? Provide the git branch that should be used: master
      Setting up Jenkins environment
  • When using Jenkins pipeline the kubectl pipeline command will complete with the setup and registration of a webhook.

    Note: if the webhook registration step fails it is likely because the Git credentials are incorrect or do not have enough permission in the repository or you have register a WebHook already

  • When registering a Tekton pipeline, you will be prompted to select which pipeline you want to use for your application. If you selected Node based Code Pattern select the Node pipeline. If you selected Java select the Gradle pipeline.

  • For the first app select the igc-nodejs-v1.x.0 version of the pipeline. This will use the Node based CI pipeline with Tekton.

    ? Select the Pipeline to use in the PipelineRun: (Use arrow keys)❯
    Skip PipelineRun creation
  • The pipeline will be registered in your development cluster.

9. View your application pipeline

The steps to view your registered pipeline will vary based on type of pipeline (Jenkins or Tekton) and container platform version (IKS, OCP 3.11, or OCP 4.3).

  1. Run the command kubectl dashboard in your terminal to open your Developer Dashboard.
  2. Select the Jenkins tool to open the Jenkins dashboard
  3. Run the command kubectl credentials in your terminal to get the list of logins for the tools
  4. Use the Jenkins userid and password to log into the Jenkins dashboard

Wait for the pipeline stages to start building. Once the stages have completed, you will see a view similar to the one below.

Jenkins Pipeline

10. Access the running app

Once the pipeline has completed successfully, the app will be deployed into the namespace used when registering the pipeline. To validate the app is running follow these steps:

Note: Be sure the namespace context is set correctly before running the following commands - set the namespace context

  • Retrieve the app ingress endpoint using commands below in your terminal.

    kubectl endpoints
  • From the endpoints listed, select the URL for the repo that was just deployed and press Enter to open that URL in a web browser and validate the application is working as expected

11. Locate the app in the web console

The build pipeline is configured to build the source code from the Git repository into a container image. This image is stored in the Image Registry. After that the image is deployed into the same namespace/project within development cluster where the pipeline ran and validated for its health. The steps below will walk through locating the installed application within the Web Console.

  • Open the Kubernetes Dashboard
  • Change to the namespace from default to either dev or the namespace you used to deploy your app
  • Click on Deployments
  • You should see the deployment of your application
  • Click on your application , and the corresponding Replica Set
  • Try scaling the application, click on Scale in the header, change number of pods to 2 and click OK
  • Click on one of the pod instances
  • Click on Logs
  • You can see the running state of your application
  • Navigate around the console to understand where your deployment, service and pods are running
Pods on IKS

Having reached this point, we recommend you repeat the process a few more times using different Code Patterns templates.