feat: implement secondsOfInactivityBeforeIdling and secondsOfRunBefor…

[dkwon17]

…eIdling CR config

Signed-off-by: David Kwon dakwon@redhat.com

What does this PR do?

Part of eclipse-che/che#21390.

This PR adds spec.devEnvironments.secondsOfInactivityBeforeIdling and spec.devEnvironments.secondsOfRunBeforeIdling config in the CheCluster CR:

This PR reads the above config to create a configmap named che-idle-settings when a user namespace is reconciled. The configmap is created so that the data can be mounted to the devworkspace containers. This PR for che-machine-exec: eclipse-che/che-machine-exec#208 reads these environment variables. Here is an example of the generated config map:

What issues does this PR fix or reference?

Part of eclipse-che/che#21390.

How to test this PR?

To test on an OpenShift cluster:

1. Create and install Che operator with this catalog source file:

apiVersion:  operators.coreos.com/v1alpha1
kind:         CatalogSource
metadata:
  name:         eclipse-che-custom-catalog
  namespace:    openshift-operators
spec:
  image:       quay.io/dkwon17/eclipse-che-openshift-opm-catalog:next
  sourceType:  grpc
  updateStrategy:
    registryPoll:
      interval: 5m

with this che-operator image: quay.io/dkwon17/che-operator:idle-cr

2. Create a CheCluster CR with spec.devEnvironments.secondsOfInactivityBeforeIdling set to "300" and spec.devEnvironments.secondsOfRunBeforeIdling set to "360".

3. Open the dashboard to provision a user namespace.

4. In the user namespace verify that the che-idle-settings configmap in the user namespace is created, with the following data:

SECONDS_OF_DW_INACTIVITY_BEFORE_IDLING: "300"
SECONDS_OF_DW_RUN_BEFORE_IDLING: "360"

5. Edit the spec.devEnvironments.secondsOfInactivityBeforeIdling and spec.devEnvironments.secondsOfRunBeforeIdling properties in the CheCluster CR to different values and verify that the changes exist in the che-idle-settings configmap.

PR Checklist

As the author of this Pull Request I made sure that:

• The Eclipse Contributor Agreement is valid
• Code produced is complete
• Code builds without errors
• Tests are covering the bugfix
• Custom resource definition file is up to date
• OLM bundles are up to date
• The repository devfile is up to date and works
• Sections What issues does this PR fix or reference and How to test this PR completed
• Relevant user documentation updated
• Relevant contributing documentation updated
• CI/CD changes implemented, documented and communicated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

[tolusha]

@l0rd
Are you ok to add those fields to DevEnvironemnts section?

[tolusha]

@dkwon17
You have to add the fields to CheCluster API v1 as well [1] and implement conversion like here for instance [2]

[1] https://github.com/eclipse-che/che-operator/blob/3830ac4e28983dbe928d0777f63c87bed43feb4b/api/v1/checluster_types.go
[2] https://github.com/eclipse-che/che-operator/pull/1395/files

[l0rd]

@tolusha yes, having the fields in the DevEnvironments is what I suggested in the issue description.

[dkwon17]

Thanks all for the feedback

You have to add the fields to CheCluster API v1 as well [1] and implement conversion like here for instance [2]

Fixed

I updated this PR to have default values of 900 and -1 to spec.devEnvironments.secondsOfInactivityBeforeIdling and spec.devEnvironments.secondsOfRunBeforeIdling respectively:

Here is the che-idle-settings configmap that is created for a user namespace:

Inside a workspace container:

[l0rd]

@dkwon17 900 seconds = 15 minutes and that's too short for the default (15 min is ok for Developer Sandbox because it's a free service and we want to aggressively shut down workspaces if they are not used).

[tolusha]

Let's wait for PR checks

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dkwon17, tolusha

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

[tolusha]

@dkwon17
It is good to merge.

[dkwon17]

Thank you everyone, I will squash and merge

[openshift-ci]

@dkwon17: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/v9-devworkspace-happy-path	fdbbcdb	link	true	/test v9-devworkspace-happy-path

Full PR test history. Your PR dashboard.

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/test-infra repository. I understand the commands that are listed here.