diff --git a/charts/uffizzi-controller/Chart.yaml b/charts/uffizzi-controller/Chart.yaml index 67a3f032..a6d5ea5b 100644 --- a/charts/uffizzi-controller/Chart.yaml +++ b/charts/uffizzi-controller/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: uffizzi-controller -version: 2.2.10 +version: 2.3.0 kubeVersion: ">= 1.21.6-0" # https://issuetracker.google.com/issues/77503699 description: "A smart proxy service that handles requests from Uffizzi App to the Kubernetes API - 1 of 3 services (controller, uffizzi_app, uffizzi_cli) that comprise the uffizzi full-stack previews engine which automates trigger-based on-demand preview environments" type: application diff --git a/charts/uffizzi-controller/README.md b/charts/uffizzi-controller/README.md index 541de1b4..07664ded 100644 --- a/charts/uffizzi-controller/README.md +++ b/charts/uffizzi-controller/README.md @@ -46,6 +46,38 @@ The controller pod also has the following environment variables as Helm values: - `env` - (Doesn't do much yet.) - `sandbox` - Enable `nodeSelector` and `taint` options for gVisor on GKE. +## Installation + +If this is your first time using Helm, consult their documentation: https://helm.sh/docs/intro/quickstart/ + +Begin by adding our Helm repository: + +``` +helm repo add uffizzi-controller https://uffizzicloud.github.io/uffizzi_controller/ +``` + +Then install the lastest version as a new release using the values you specified earlier. We recommend isolating Uffizzi in its own Namespace. + +``` +helm install uc uffizzi-controller/uffizzi-controller --values myvals.yaml --namespace uffizzi-controller --create-namespace +``` + +If you encounter any errors here, tell us about them in [our Slack](https://join.slack.com/t/uffizzi/shared_invite/zt-ffr4o3x0-J~0yVT6qgFV~wmGm19Ux9A)! + +You should then see the release is installed: +``` +helm list --namespace uffizzi-controller +``` + +### Troubleshooting + +When installing this chart, you may see errors like this: +``` +clusterroles.rbac.authorization.k8s.io "my-uffizzi-controller-flux-default-source-controller-helmchart" already exists +``` + +This happens when more than one resource within a dependency chart (in this case `flux`) has a very long name truncated into the same name as another resource. To avoid this, use shorter release names as in the example above. + ## More Info See this project's main repository here: https://github.com/UffizziCloud/uffizzi_controller diff --git a/charts/uffizzi-controller/values.yaml b/charts/uffizzi-controller/values.yaml index ea0fe531..cbdc7989 100644 --- a/charts/uffizzi-controller/values.yaml +++ b/charts/uffizzi-controller/values.yaml @@ -14,9 +14,11 @@ cert-manager: # dependency ingress-nginx: controller: + enableAnnotationValidations: true config: proxy-body-size: "100m" proxy-buffer-size: "128k" + strict-validate-path-type: true extraArgs: enable-ssl-passthrough: true