charts icon indicating copy to clipboard operation
charts copied to clipboard

[bitnami/contour] Append the missing posfix of name for service/contour

Open izturn opened this issue 3 years ago • 3 comments

Signed-off-by: Gang Liu [email protected]

Description of the change

let the naming style of service/contour like the other resources (eg: service/envoy), Just the recreate of #11240 179701789-437469bf-6fd5-4d48-9e00-01d5e48c60f5

Benefits

Possible drawbacks

Applicable issues

  • fixes #

Additional information

Checklist

  • [X] Chart version bumped in Chart.yaml according to semver. This is not necessary when the changes only affect README.md files.
  • [X] Variables are documented in the values.yaml and added to the README.md using readme-generator-for-helm
  • [X] Title of the pull request follows this pattern [bitnami/<name_of_the_chart>] Descriptive title
  • [X] All commits signed off and in agreement of Developer Certificate of Origin (DCO)

izturn avatar Jul 30 '22 23:07 izturn

Thanks for your PR, could you add more info about the change? As a standard, we are using the common feature to set this kind of name for the services so it is rendered in a standard way across Helm charts

carrodher avatar Aug 01 '22 10:08 carrodher

the service/envoy has the postfix, but service/contour has not, no matter for contour or envoy, the other resources( pod/deployment) both have the postfix, so I think it's a typo, if it's my fault, pls feels free to close it

izturn avatar Aug 01 '22 12:08 izturn

@carrodher thx, so how to make [CI/CD] CI Pipeline / VIB Verify (pull_request_target) happy?

izturn avatar Aug 06 '22 23:08 izturn

Hi @izturn

There are two main reasons for the CI Pipeline to be failing:

  • The pipeline has detected that your changes break the chart: all the pods do not reach a Ready state when they are deployed. Locally, I can reproduce the issue as well:
$ helm install contour bitnami/contour
$ kubectl get pods
NAME                               READY   STATUS    RESTARTS   AGE
contour-contour-6d987967bb-8qrhf   1/1     Running   0          7m16s
contour-envoy-z5jvj                1/2     Running   0          7m16s

It is likely that the old naming pattern of the service is used elsewhere in the chart. For instance, check these two references, you may need two update them as well:

https://github.com/bitnami/charts/blob/110c42e9c140ca405f2068b89e31a732ae47dda1/bitnami/contour/templates/envoy/daemonset.yaml#L258 https://github.com/bitnami/charts/blob/110c42e9c140ca405f2068b89e31a732ae47dda1/bitnami/contour/templates/envoy/deployment.yaml#L276

Once you have revisited your code, please ensure the chart is correctly deployed locally in your cluster and them sync the changes in the PR. The tests should begin automatically 😁

  • You also need to adapt the tests to use this new naming 😁 More precisely, the health-check probes should be updated in these two files:

https://github.com/bitnami/charts/blob/110c42e9c140ca405f2068b89e31a732ae47dda1/.vib/contour/vib-verify.json#L33-L40

https://github.com/bitnami/charts/blob/110c42e9c140ca405f2068b89e31a732ae47dda1/.vib/contour/vib-publish.json#L33-L40

      "actions": [
        {
          "action_id": "health-check",
          "params": {
-           "endpoint": "lb-contour-tcp-xds"
+           "endpoint": "lb-contour-contour-tcp-xds"
          }
        }
      ]

joancafom avatar Aug 11 '22 17:08 joancafom

@carrodher thx for your help, I checked the contour's source code and the service name contour is bind to its bootstrap process, if we don't change the source code first, it can't be changed too.

izturn avatar Aug 12 '22 03:08 izturn