From baee93a1fcf1b75cf2a6b48abd5748eeb81c62ab Mon Sep 17 00:00:00 2001 From: Simon Emms Date: Wed, 2 Mar 2022 11:30:29 +0000 Subject: [PATCH] [installer]: document the StatefulSet validation error and workaround --- install/installer/README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/install/installer/README.md b/install/installer/README.md index d9029e226b57ab..61c28139b656d6 100644 --- a/install/installer/README.md +++ b/install/installer/README.md @@ -163,6 +163,24 @@ yq eval-all --inplace \ gitpod.yaml ``` +## Error validating `StatefulSet.status` + +```shell +error: error validating "gitpod.yaml": error validating data: ValidationError(StatefulSet.status): missing required field "availableReplicas" in io.k8s.api.apps.v1.StatefulSetStatus; if you choose to ignore these errors, turn validation off with --validate=false +``` + +Depending upon your Kubernetes implementation, you may receive this error. This is +due to a bug in the underlying StatefulSet dependency, which is used to generate the +OpenVSX proxy (see [#8529](https://github.com/gitpod-io/gitpod/issues/8529)). + +To fix this, you will need to post-process the rendered YAML to remove the `status` field. + +```shell +yq eval-all --inplace \ + 'del(select(.kind == "StatefulSet" and .metadata.name == "openvsx-proxy").status)' \ + gitpod.yaml +``` + --- # What is installed