gitlab-ci-k8s.yml

# =========================================================================================
# Copyright (C) 2021 Orange & contributors
#
# This program is free software; you can redistribute it and/or modify it under the terms
# of the GNU Lesser General Public License as published by the Free Software Foundation;
# either version 3 of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
# without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public License along with this
# program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
# Floor, Boston, MA  02110-1301, USA.
# =========================================================================================
spec:
  inputs:
    kubectl-image:
      description: The Docker image used to run Kubernetes `kubectl` commands - **set the version required by your Kubernetes server**
      default: registry.hub.docker.com/bitnami/kubectl:latest
    url:
      description: Global Kubernetes API url (only define if using exploded kubeconfig parameters)
      default: ''
    base-app-name:
      description: Base application name
      default: $CI_PROJECT_NAME
    environment-url:
      description: |-
        The default environments url _(only define for static environment URLs declaration)_

        _supports late variable expansion (ex: `https://%{environment_name}.k8s.acme.com`)_
      default: ''
    scripts-dir:
      description: directory where Kubernetes scripts (templates, hook scripts) are located
      default: .
    kustomize-enabled:
      description: Set to `true` to enable [Kustomize](https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/)
      type: boolean
      default: false
    kustomize-args:
      description: |-
        Additional [`kubectl kustomize` options](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#kustomize)

        _For example: `--enable-helm`_
      default: ''
    create-namespace-enabled:
      description: Creates the namespace, if it doesn't exist
      type: boolean
      default: false
    score-disabled:
      description: Disable kube-score
      type: boolean
      default: false
    kube-score-image:
      description: Docker image to run [kube-score](https://github.com/zegl/kube-score)
      default: registry.hub.docker.com/zegl/kube-score:latest
    score-extra-opts:
      description: Additional [kube-score options](https://github.com/zegl/kube-score#configuration)
      default: ''
    review-space:
      description: Kubernetes namespace for review env
      default: ''
    review-app-name:
      description: The application name for review env (only define to override default)
      default: ''
    review-autostop-duration:
      description: The amount of time before GitLab will automatically stop `review` environments
      default: 4 hours
    review-environment-url:
      description: The review environments url _(only define for static environment URLs declaration and if different from default)_