ReviewAppOperator

Deploy review apps for pull request

build_app

• Delete the existing Job resource, if any
• Create a Job to build the review app
• Update the review app's status info with
  • appStatus: status.appStatus || "building"
  • buildStatus: "building"
  • buildJobName: "build-{SHA}"
  • image: "whatever"
  • buildStartedAt: 1552453453
  • buildCommit: {SHA}

ADD

• build_app
• Generate the resources and CREATE them, but use a 0 in the deployment replicas (The deployment resource builder can do ^ based on the status info on the ReviewApp)

MODIFY

• Exit if the commitHash == status.buildCommit (b/c we trigger our own events)
• build_app

RECONCILE

• Exit unless status.buildStatus == "building"
• check the job's status
  • If still building, exit
  • If error
    • set status.buildStatus = "error"
    • just stop
  • If done
    • Update the deployment based on the latest in the ReviewApp, this time with 1 replica and the new image tag
    • Set status.buildStatus = "success"
    • Set status.appStatus = "deployed"

(I believe this gets called every 30s by default)

DELETE

Tear down all of the resources, including the current build job specified on the review app

Requirements from the Probot side

1. Upload the tarball to S3 (so the operator doesn't need GitHub access)
2. Provide review app config from the repo's yaml file
3. Provide branch, repoOwner, repo, PR # (as a string), commit hash, tarballUrl
4. Update the commitHash, tarballUrl, and review app config when the PR is updated

Config Requirements

1. Sort out the k8s permissions required and annotate the controller
2. I believe the AWS and Harbor permissions are already in the builder namespace and the same build jobs should work w/o any changes there

List of resources

• Build jobs
• TLS secret
• env secret
• kubedb init secret
• kubedb (postgres)
• deployment
• service
• ingress