fixes #1258 controller updates deployment when headless boolean is up…

[Horiodino]

Description of Changes

checks if the environment variable "REGISTRY_HEADLESS" exists in headlessStatus, parses its value to a boolean, and sets needsUpdating to true if the parsed value differs from the Headless spec in the cr.Spec

Related Issue(s)

devfile/api#1258

Acceptance Criteria

Tests

• Test Coverage
  • Are your changes sufficiently tested, and are any applicable test cases added or updated to cover your changes?
• Gosec scans
  • Fix all MEDIUM and higher findings and/or annotate a finding per gosec instructions: https://github.com/securego/gosec#annotating-code to address why a finding is not a security issue

Documentation

• [ ✔️ ] Does the registry operator documentation need to be updated with your changes?

Tests Performed

Explain what tests you personally ran to ensure the changes are functioning as expected.

How To Test

Instructions for the reviewer on how to test your changes.

Running Unit Tests

Running Integration Tests

Notes To Reviewer

Any notes you would like to include for the reviewer.

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Horiodino
Once this PR has been reviewed and has the lgtm label, please assign elsony for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[openshift-ci]

Hi @Horiodino. Thanks for your PR.

I'm waiting for a devfile member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[Jdubrick]

/ok-to-test

[Jdubrick]

Is it possible to rename this var to be more clear that it is the array of all env vars for the container?

[Jdubrick]

Not able to get it to update when the headless is altered. Currently deploying with

apiVersion: registry.devfile.io/v1alpha1
kind: DevfileRegistry
metadata:
  name: devfile-registry
spec:
  telemetry:
    registryName: test
  k8s:
    ingressDomain: testing-registry
  tls:
    enabled: false
  headless: true

and when running kubectl apply -n devfile registry -f <path to yaml> with this file:

apiVersion: registry.devfile.io/v1alpha1
kind: DevfileRegistry
metadata:
  name: devfile-registry
spec:
  telemetry:
    registryName: test
  k8s:
    ingressDomain: testing-registry
  tls:
    enabled: false
  headless: false

It does not update. I also noticed that if you remove headless altogether then it segfaults as a memory issue, could be a one off but worth looking into.

Was this working for you/was it tested? @michael-valdron @thepetk have either of you been able to reproduce?

[thepetk]

Left a comment to get more info. I think the current feature needs to have some test cases too.

[thepetk]

I have some time to check this part of the code, so I'm not sure I understand the purpose of the env var usage here. Could you elaborate?

From my point of view, I would expect us here to:

• Compare the existing headless status with the new one.
• We could fetch the existing from dep.Spec.Template.Spec.Headless
• We could create (IIRC we don't have one) a function to get the headless status from the registryv1alpha1.DevfileRegistry resource.
• In case the two of them are different assign the current value to the existing one and update the needsUpdating variable to true.

[Horiodino]

We could create (IIRC we don't have one) a function to get the headless status from the registryv1alpha1.DevfileRegistry resource.
im comparing on the basis of deployment , i also taught about that but saw this
https://github.com/Horiodino/registry-operator/blob/headless-boolean/pkg/registry/deployment.go#L286
so i didn't added anything.

is that same thing or different ?

[Jdubrick]

That looks like it is setting the headless value but I believe @thepetk is wanting a checker function to easily grab the headless value from a CR

[Horiodino]

but the here headlessStatus := dep.Spec.Template.Spec.Containers[0].Env dep is CR isit ?

[Jdubrick]

@Horiodino yes dep is a CR but the built-in Kubernetes Deployment CR to be more specific.

[Horiodino]

ah its not the user defined one right , theirs not any wrapper for getting that CR correct ?

[Jdubrick]

Not that I can think of off the top of my head, I think just abstracting your piece of code into a function that takes in a deployment cr and fetches the headless env and returns what it is would be good to add pieces that can easily be tested with unit tests. So I would recommend doing that and adding unit tests for it. Side note, you can deploy the operator and registry on Kubernetes (Minikube/Kind) locally and can verify what happens when you change the headless value, I know during my run throughs it wasn't adding/removing the registry-viewer container as expected

[Jdubrick]

I am still unable to get this to spin up/spin down the viewer depending on the value of the headless env var. If I deploy with headless: true and then re-apply after with headless: false it does not spin up the viewer and vice-versa.

You are able to verify this by applying and deploying everything to Minikube/Kind, @Horiodino have you done this?

@thepetk do you experience the same things?

[thepetk]

I am still unable to get this to spin up/spin down the viewer depending on the value of the headless env var. If I deploy with headless: true and then re-apply after with headless: false it does not spin up the viewer and vice-versa.

You are able to verify this by applying and deploying everything to Minikube/Kind, @Horiodino have you done this?

@thepetk do you experience the same things?

I feel that's because we're currently expecting that an env var is set for that purpose. I agree tho what @Jdubrick is at least my idea of the expected behavior

[Jdubrick]

I am still unable to get this to spin up/spin down the viewer depending on the value of the headless env var. If I deploy with headless: true and then re-apply after with headless: false it does not spin up the viewer and vice-versa.
You are able to verify this by applying and deploying everything to Minikube/Kind, @Horiodino have you done this?
@thepetk do you experience the same things?

I feel that's because we're currently expecting that an env var is set for that purpose. I agree tho what @Jdubrick is at least my idea of the expected behavior

The var is present in the index container but only if headless: true or headless: false is set initially, if it isn't in the yaml file at all it isn't present. But then when you try and reapply to change it the operator doesn't pick it up. Could be related to the way the reconcile loop is working and it isn't paying attention to that field. I wonder if adding the headless field to one of the managed that triggers a rollout of the deployment would fix this

[Jdubrick]

After taking a look at this again, I believe the following is needed to get this working:

1. Updated Unit Tests
   I would personally like to see the tests have more comprehensive coverage. What I mean by that is the tests should handle the case where a Deployment has it's headless value changed after deployment and the appropriate response (viewer container is added/removed from pod) is taken. We would need to mock up the Deployment to do this in the tests.

2. Add Deployment Update Logic
   We are grabbing the headless value but I believe nothing is happening because we are relying on Update() to do this for us, but I believe in order for that to work we need to physically alter the Deployment to include/exclude that viewer container based on the headless status. This would most likely include looking through at how the viewer container is added to the deployment normally (when the headless is false) and using that as a guide to either include/exclude it when headless changes.

cc @thepetk @Horiodino

[Horiodino]

After taking a look at this again, I believe the following is needed to get this working:

1. Updated Unit Tests
   I would personally like to see the tests have more comprehensive coverage. What I mean by that is the tests should handle the case where a Deployment has it's `headless` value changed after deployment and the appropriate response (viewer container is added/removed from pod) is taken. We would need to mock up the Deployment to do this in the tests.

2. Add Deployment Update Logic
   We are grabbing the `headless` value but I believe nothing is happening because we are relying on `Update()` to do this for us, but I believe in order for that to work we need to physically alter the Deployment to include/exclude that viewer container based on the `headless` status. This would most likely include looking through at how the viewer container is added to the deployment normally (when the headless is false) and using that as a guide to either include/exclude it when headless changes.

cc @thepetk @Horiodino

Thanks for the suggestions! I’ve made some changes and will now write the test case. 👍