template.yaml

---
kind: "Template"
apiVersion: "template.openshift.io/v1"
metadata:
  name: "docs-openshift-com"
  annotations:
    openshift.io/display-name: "docs.openshift.com/docs.okd.io websites"
    description: "Packages up public documentation from https://github.com/openshift/openshift-docs and serves the website content"
    tags: "ruby,asciibinder"
    iconClass: "icon-shadowman"
    template.openshift.io/provider-display-name: "Red Hat, Inc."
message: "The following service(s) have been created in your project: ${NAME}."
labels:
  template: "docs-openshift-com"
objects:
  - kind: "Service"
    apiVersion: "v1"
    metadata:
      name: "${NAME}"
      annotations:
        description: "Exposes and load balances the frontend application pods for the deployment"
      labels:
        app: "${NAME}"
    spec:
      ports:
        - name: "http"
          port: 8080
          targetPort: 8080
      selector:
        name: "${NAME}"

  - kind: "Route"
    apiVersion: "route.openshift.io/v1"
    metadata:
      annotations:
        kubernetes.io/tls-acme: "true"
      name: "${NAME}"
      labels:
        app: "${NAME}"
    spec:
      host: "${APPLICATION_DOMAIN}"
      to:
        kind: "Service"
        name: "${NAME}"
        weight: 1
      port:
        targetPort: "http"

  - kind: "ImageStream"
    apiVersion: "image.openshift.io/v1"
    metadata:
      name: "${NAME}"
      annotations:
        description: "Keeps track of changes in the ${NAME} application image"
      labels:
        app: "${NAME}"
    spec:
      lookupPolicy:
        local: true

  - kind: "BuildConfig"
    apiVersion: "build.openshift.io/v1"
    metadata:
      name: "${NAME}"
      annotations:
        description: "Defines how to build ${NAME}"
      labels:
        app: "${NAME}"
    spec:
      nodeSelector:
      source:
        type: "Git"
        git:
          uri: "${SOURCE_REPO}"
          ref: "main"
      strategy:
        type: "Source"
        sourceStrategy:
          from:
            kind: DockerImage
            name: '${BUILDER_IMAGE}'
      output:
        to:
          kind: "ImageStreamTag"
          name: "${NAME}:latest"
      triggers:
        - type: "ImageChange"
        - type: "ConfigChange"
        - type: "Generic"
          generic:
            secret: "${GENERIC_WEBHOOK_SECRET}"

  - kind: "DeploymentConfig"
    apiVersion: "apps.openshift.io/v1"
    metadata:
      name: "${NAME}"
      annotations:
        description: "Defines how to deploy the ${APPLICATION_DOMAIN} domain"
        alpha.image.policy.openshift.io/resolve-names: '*'
      labels:
        app: "${NAME}"
    spec:
      strategy:
        type: "Rolling"
        rollingParams:
          updatePeriodSeconds: 1
          intervalSeconds: 1
          timeoutSeconds: 1800
          maxUnavailable: 0%
          maxSurge: 100%
        resources: {}
        activeDeadlineSeconds: 3600
      triggers:
        - type: "ConfigChange"
      replicas: 3
      test: false
      selector:
        name: "${NAME}"
      template:
        metadata:
          name: "${NAME}"
          labels:
            name: "${NAME}"
            app: "${NAME}"
        spec:
          containers:
            - name: "${NAME}"
              image: "${NAME}:latest"
              imagePullPolicy: Always
              ports:
                - containerPort: 8080
              readinessProbe:
                timeoutSeconds: 5
                initialDelaySeconds: ${{READINESS_DELAY}}
                httpGet:
                  path: "/${HEALTHCHECK_PATH}"
                  port: 8080
              env:
                - name: PACKAGE
                  value: "${PACKAGE}"
                - name: REPO
                  value: "${BUILD_REPO}"
                - name: BRANCH
                  value: "${BUILD_BRANCH}"
              livenessProbe:
                timeoutSeconds: 10
                initialDelaySeconds: ${{READINESS_DELAY}}
                periodSeconds: 30
                failureThreshold: 20
                httpGet:
                  path: "/${HEALTHCHECK_PATH}"
                  port: 8080
              resources:
                requests:
                  cpu: "${CPU_REQUEST}"
                  memory: "${MEMORY_REQUEST}"
                limits:
                  cpu: "${CPU_LIMIT}"
                  memory: "${MEMORY_LIMIT}"

  - kind: Role
    apiVersion: rbac.authorization.k8s.io/v1
    metadata:
      name: "${NAME}-rollout-role"
    rules:
    - apiGroups:
      - ""
      - apps.openshift.io
      resources:
      - deploymentconfigs
      - deploymentconfigs/scale
      verbs:
      - create
      - delete
      - deletecollection
      - get
      - list
      - patch
      - update
      - watch
    - apiGroups:
      - ""
      - apps.openshift.io
      resources:
      - deploymentconfigs/log
      - deploymentconfigs/status
      verbs:
      - get
      - list
      - watch
    - apiGroups:
      - ""
      resources:
      - replicationcontrollers
      - replicationcontrollers/scale
      - replicationcontrollers/status
      verbs:
      - get
      - list
      - watch
    - apiGroups:
      - ""
      resources:
      - replicationcontrollers
      - replicationcontrollers/scale
      verbs:
      - create
      - delete
      - deletecollection
      - get
      - list
      - patch
      - update
      - watch

  - kind: ServiceAccount
    apiVersion: v1
    metadata:
      name: "${NAME}-rollout-sa"

  - kind: RoleBinding
    apiVersion: rbac.authorization.k8s.io/v1
    metadata:
      name: "${NAME}-rollout-binding"
    roleRef:
      apiGroup: rbac.authorization.k8s.io
      kind: Role
      name: "${NAME}-rollout-role"
    subjects:
    - kind: ServiceAccount
      name: "${NAME}-rollout-sa"

  - kind: "CronJob"
    apiVersion: "batch/v1"
    metadata:
      name: "${NAME}-build-trigger"
      annotations:
        description: "CronJob used to trigger ${APPLICATION_DOMAIN} builds periodically"
      labels:
        app: "${NAME}"
    spec:
      failedJobsHistoryLimit: 5
      successfulJobsHistoryLimit: 3
      concurrencyPolicy: Forbid
      schedule: "${DEPLOY_SCHEDULE}"
      jobTemplate:
        spec:
          activeDeadlineSeconds: 900
          template:
            spec:
              serviceAccountName: "${NAME}-rollout-sa"
              restartPolicy: Never
              containers:
              - name: "${NAME}-build-trigger"
                image: image-registry.openshift-image-registry.svc:5000/openshift/cli:latest
                imagePullPolicy: Always
                env:
                  - name: DEPLOYMENT_TARGET
                    value: "${NAME}"
                command:
                - /bin/bash
                - -c
                - |
                  # ensure we fail if something exits non-zero
                  set -o errexit
                  set -o nounset

                  oc rollout latest dc/$DEPLOYMENT_TARGET

                  exit 0

parameters:
  - name: "NAME"
    displayName: "Application name"
    description: "The name assigned to all of the application components defined in this template."
    required: true
    value: "docs-openshift-com"

  - name: "PACKAGE"
    displayName: "Package Name (community|commercial)"
    description: "The type of documents to build (commercial vs community)."
    required: true
    value: "commercial"

  - name: "APPLICATION_DOMAIN"
    displayName: "Application Hostname"
    description: "The exposed hostname that will route to the httpd service for content."
    value: ""

  - name: "HEALTHCHECK_PATH"
    displayName: "URI path to a known, working web page"
    description: "The URI path to a known, working web page for testing liveness and readiness probes. Exclude leading '/'"
    required: true
    value: "index.html"

  - name: "READINESS_DELAY"
    displayName: "Readiness Delay Seconds"
    description: "The number of seconds to wait for the pod to become ready (10m default). MUST stay < 20m"
    required: true
    value: "600"

  - name: "SOURCE_REPO"
    displayName: "Git Repository URL for the build scripts"
    description: "The URL of the repository with your application source code."
    required: true
    value: "https://github.com/openshift-cs/docs-builder.git"

  - name: "BUILD_REPO"
    displayName: "Git Repository URL for the upstream documentation content"
    description: "The URL of the repository with your application source code."
    required: true
    value: "https://github.com/openshift/openshift-docs.git"

  - name: "BUILD_BRANCH"
    displayName: "Git Repository branch for the upstream documentation content"
    description: "The branch name of the repository with your application source code."
    required: true
    value: "main"

  - name: "BUILDER_IMAGE"
    displayName: "The s2i builder image used for deploying documentation"
    description: "The URL for an s2i builder image used for deployment documentation."
    required: true
    value: "quay.io/openshift-cs/docs-builder:latest"

  - name: "DEPLOY_SCHEDULE"
    displayName: "Deployment cronjob schedule"
    description: "A CronTab formatted frequency to specify how often a new deployment will rollout (defaults to 0 and 30 of each hour)"
    required: true
    value: "0,30 * * * *"

  - name: "CPU_REQUEST"
    displayName: "CPU Request"
    description: "Requested amount of CPU the httpd container will use."
    required: true
    value: "50m"

  - name: "CPU_LIMIT"
    displayName: "CPU Limit"
    description: "Maximum amount of CPU the httpd container can use."
    required: true
    value: "1"

  - name: "MEMORY_REQUEST"
    displayName: "Memory Request"
    description: "Requested amount of memory the httpd container will use."
    required: true
    value: "100Mi"

  - name: "MEMORY_LIMIT"
    displayName: "Memory Limit"
    description: "Maximum amount of memory the httpd container can use."
    required: true
    value: "512Mi"

  - name: "GENERIC_WEBHOOK_SECRET"
    displayName: "Generic Webhook Secret"
    description: "A secret string used to configure the Generic webhook."
    generate: "expression"
    from: "[a-zA-Z0-9]{40}"