Skip to content

Validate gitpod config patch, rendered gitpod installer YAML in preflight checks #12015

Closed
@adrienthebo

Description

@adrienthebo

The gitpod config patch provides a very low level interface to modify Gitpod's installation configuration. A malformed config patch can produce invalid YAML, or valid YAML that doesn't follow the gitpod-installer config schema.

Malformed configuration should be caught at the preflight check and should ideally provide some level of diagnostics about what's failing and how to fix it.

  • The gitpod config patch file is valid YAML
  • The merge result of the gitpod config patch and the gitpod installer config is valid YAML
  • The final gitpod config YAML follows the gitpod-installer schema (as validated with /app/installer validate)

Steps to reproduce

The following YAML patch will fail on current versions of gitpod:

experimental:
  webapp:
    proxy:
      # allowed values are "ClusterIP", "LoadBalancer", "NodePort", "ExternalName" consistent with https://pkg.go.dev/k8s.io/api/core/v1#ServiceType
      serviceType: "NodePort"
# /app/installer validate config -c config.yaml 
{
  "valid": false,
  "warn": [
    "Deprecated config parameter: experimental.webapp.proxy.serviceType=NodePort"
  ],
  "fatal": [
    "Cannot set proxy service type in both components and experimental"
  ]
}
Error: configuration invalid
Usage:
  gitpod-installer validate config [flags]

Metadata

Metadata

Assignees

Labels

component: installTerraform installation scripts, helm charts, installer imagesteam: deliveryIssue belongs to the self-hosted team

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions