Create Environment

Objectives

Add create-environment task to PipelineRun.
Define parameters, workspaces, and tasks within the PipelineRun for building and deploying your application.

Key Results

Successfully create and execute the Tekton PipelineRun using the defined .tekton/pullrequest.yaml file, enabling automated CI/CD processes for your application.
Environment CR is deployed on cluster.

Tutorial

Create PipelineRun with Create Environment Task

You have already created a PipelineRun in the previous tutorial. Let's now add another task create-environment to it. The create environment task utilizes Tronador to create dynamic environments.

Open up the PipelineRun file you created in the previous tutorial.

Now edit the file so the YAML becomes like the one given below.

apiVersion: tekton.dev/v1beta1
kind: PipelineRun
metadata:
  name: pullrequest # pipelineRun name
  annotations:
    pipelinesascode.tekton.dev/on-event: "[push]" # Trigger the pipelineRun on push events on branch main
    pipelinesascode.tekton.dev/on-target-branch: "main"
    pipelinesascode.tekton.dev/task: "[git-clone, 
      https://raw.githubusercontent.com/stakater-tekton-catalog/create-git-tag/0.0.12/task/stakater-create-git-tag/stakater-create-git-tag.yaml,
      https://raw.githubusercontent.com/stakater-tekton-catalog/create-environment/0.0.16/task/stakater-create-environment/stakater-create-environment.yaml]" 
    pipelinesascode.tekton.dev/max-keep-runs: "2" # Only remain 2 latest pipelineRuns on SAAP
spec:
  params:
    - name: repo_url
      value: "git@github.com:<YOUR-ORG>/<YOUR-REPO-NAME>/" # Place your repo SSH URL
    - name: git_revision
      value: {{revision}} # Dynamic variable to fetch branch name of the push event on your repo
    - name: git_branch
      value: {{source_branch}}
    - name: repo_path
      value: {{repo_name}} # Dynamic variable to fetch repo name
    - name: image_registry
      value: "<docker-registry-url>" # Place image registry URL without https:// succeeded by your application name
    - name: helm_registry
      value: "<https://helm-registry-url>" # Place helm registry URL with https://
    - name: pull_request_number
      value: {{pull_request_number}}
    - name: organization
      value: {{YOUR_GIT_ORG}}
  pipelineSpec: # Define what parameters will be used for pipeline
    params:
      - name: repo_url
      - name: git_revision
      - name: repo_path
      - name: image_registry
      - name: helm_registry
      - name: pull_request_number
      - name: organization
      - name: git_branch
    workspaces: # Mention what workspaces will be used by this pipeline to store data and used by data transferring between tasks
      - name: source
      - name: ssh-directory
    tasks: # Mention what tasks will be used by this pipeline
      - name: fetch-repository #Name what you want to call the task
        taskRef:
          name: git-clone # Name of tasks mentioned in tekton-catalog
          kind: Task
        workspaces: # Mention what workspaces will be used by this task
          - name: output
            workspace: source
          - name: ssh-directory
            workspace: ssh-directory
        params: # Parameters will be used by this task
          - name: depth
            value: "0"
          - name: url
            value: $(params.repo_url)
          - name: revision
            value: $(params.git_revision)
      - name: create-git-tag
        runAfter:
          - fetch-repository
        taskRef:
          name: stakater-create-git-tag-0.0.7
          kind: Task
        params:
          - name: PR_NUMBER
            value: $(params.pull_request_number)
          - name: GIT_REVISION
            value: $(params.git_revision)
        workspaces:
          - name: source
            workspace: source
          - name: ssh-directory
            workspace: ssh-directory
      - name: stakater-create-environment
        runAfter:
        - create-git-tag
        taskRef:
          kind: Task
          name: stakater-create-environment
        params:
        - name: CREATE_ON_CLUSTER
          value: "true"
        - name: REPO_NAME
          value: $(params.repo_path)
        - name: PR_NUMBER
          value: $(params.pull_request_number)
        - name: GIT_URL
          value: "<https://github.com/org/app.git>" #Replace with your application repository Url
        - name: GIT_BRANCH
          value: $(params.git_branch)
        - name: IMAGE_TAG
          value: $(tasks.create-git-tag.results.GIT_TAG)
        - name: IMAGE_REPO
          value: $(params.image_registry)
        - name: PULL_REQUEST_COMMITS_API # Replace when not using Git
          value: https://api.github.com/repos/$(params.organization)/$(params.repo_path)/pulls/$(params.pull_request_number)/commits
        workspaces:
        - name: output
          workspace: source
        - name: repo-token
          workspace: repo-token
  workspaces: # Mention Workspaces configuration
    - name: source
      volumeClaimTemplate:
        spec:
          accessModes:
            - ReadWriteOnce
          resources:
            requests:
              storage: 1Gi
    - name: ssh-directory # Using ssh-directory workspace for our task to have better security
      secret:
        secretName: git-ssh-creds # Created this secret earlier
    - name: repo-token
      secret:
        secretName: git-pat-creds

Notice that we added another workspace, repo-token to the pipeline run. This workspace utilizes the git-pat-creds secret that we previously created and mounts it to the create-environment task.

Note

Remember to add the remote task in the annotations create-env

Create a pull request with your changes. This should trigger the pipeline in the build namespace.
Once the task completes, you should be able to see a new project. The name of this project will contain your pr number, application name, and first commit hash of your pr.
Open up the project and navigate to pods, you should be able to see your application running.

Great! Let's add more tasks in our pipelineRun in coming tutorials.