Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OCPVE-672: feat: add the OLM as a capability #1589

Merged
merged 1 commit into from
Oct 3, 2023

Conversation

eggfoobar
Copy link
Contributor

Add the OLM as a capability.

Note, that OLM and Marketplace have a dependency, the Marketplace should not be enabled and the OLM disabled. This enforcement will be done at the installer level similar to how we enforce MachineAPI

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Sep 18, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Sep 18, 2023

@eggfoobar: This pull request references OCPVE-672 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.15.0" version, but no target version was set.

In response to this:

Add the OLM as a capability.

Note, that OLM and Marketplace have a dependency, the Marketplace should not be enabled and the OLM disabled. This enforcement will be done at the installer level similar to how we enforce MachineAPI

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.

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Sep 18, 2023

Hello @eggfoobar! Some important instructions when contributing to openshift/api:
API design plays an important part in the user experience of OpenShift and as such API PRs are subject to a high level of scrutiny to ensure they follow our best practices. If you haven't already done so, please review the OpenShift API Conventions and ensure that your proposed changes are compliant. Following these conventions will help expedite the api review process for your PR.

@eggfoobar
Copy link
Contributor Author

/assign @JoelSpeed
/cc @kevinrizza

@JoelSpeed
Copy link
Contributor

@eggfoobar Who can LGTM this from the OLM team to say they're happy that this will be completed in 4.15?

@kevinrizza
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Sep 20, 2023
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 20, 2023
@eggfoobar
Copy link
Contributor Author

@joelanford and @JoelSpeed This should be good for another look, I went ahead and updated the annotation to include +OLM and added the validation and e2e test.

@eggfoobar
Copy link
Contributor Author

Validation

This feature was validated on a cluster by enabling everything except for OLM and marketplace. During testing a few operators had some issues either expecting OLM resources to be there or applying OLM resources. PRs were opened up to resolve those errors and after building a new payload the cluster install succeeded and things seemed to be operational.

Fixes Needed

Operator Reason PR
Node Tuning needed extra error handling for no resource existing openshift/cluster-node-tuning-operator#801
Cluster Monitoring needed added OLM annotation on an OLM resource in it's manifests openshift/cluster-monitoring-operator#2095
Console Operator requires input from console team since I'm missing some context on usage of OLM but otherwise, needed query for EnabledCapabilities to not look for OLM resource during healthcheck openshift/console-operator#795

Cluster Configuration

Platform:
aws
ClusterBot Payload:
build 4.15,openshift/cluster-config-operator#357,openshift/cluster-version-operator#971,openshift/operator-framework-olm#565,openshift/cluster-node-tuning-operator#801,openshift/cluster-monitoring-operator#2095,openshift/console-operator#795
CapabilitiesConfig:

capabilities:
  baselineCapabilitySet: None
  additionalEnabledCapabilities:
  - openshift-samples
  - baremetal
  - Console
  - Insights
  - Storage
  - CSISnapshot
  - NodeTuning
  - MachineAPI
  - Build
  - DeploymentConfig
  - ImageRegistry

@eggfoobar
Copy link
Contributor Author

eggfoobar commented Sep 25, 2023

Upgrade Validation

I was able to validate upgrading form a 4.14 cluster with only marketplace and MachineAPI(needed for aws platform) to a 4.15 cluster with the new optional OLM feature. The upgrade was done via the openshift-tests run-upgrade none --to-image=registry.build05.ci.openshift.org/ci-ln-g4wlytt/release:latest. The results show that enabledCapabilities correctly got updated to include OLM since marketplace was enabled as well as the event logs display the correct error message that enforced the marketplace+OLM dependency.

changed ImplicitlyEnabledCapabilities to True: CapabilitiesImplicitlyEnabled: 
The following capabilities could not be disabled: OLM
Initial ClusterVersion State After Upgrade ClusterVersion State
apiVersion: config.openshift.io/v1
kind: ClusterVersion
metadata:
  name: version
spec:
  capabilities:
    additionalEnabledCapabilities:
    - marketplace
    - MachineAPI
    baselineCapabilitySet: None
  channel: stable-4.14
status:
  capabilities:
    enabledCapabilities:
    - MachineAPI
    - marketplace
    knownCapabilities:
    - Build
    - CSISnapshot
    - Console
    - DeploymentConfig
    - ImageRegistry
    - Insights
    - MachineAPI
    - NodeTuning
    - Storage
    - baremetal
    - marketplace
    - openshift-samples 
apiVersion: config.openshift.io/v1
kind: ClusterVersion
metadata:
  name: version
spec:
  capabilities:
    additionalEnabledCapabilities:
    - marketplace
    - MachineAPI
    baselineCapabilitySet: None
  channel: stable-4.14
status:
  capabilities:
    enabledCapabilities:
    - MachineAPI
    - OLM
    - marketplace
    knownCapabilities:
    - Build
    - CSISnapshot
    - Console
    - DeploymentConfig
    - ImageRegistry
    - Insights
    - MachineAPI
    - NodeTuning
    - OLM
    - Storage
    - baremetal
    - marketplace
    - openshift-samples 

Cluster Configuration

Platform:
aws

Payload:
from:
quay.io/openshift-release-dev/ocp-release:4.14.0-rc.2-x86_64
to (image built with ClusterBot):
build 4.15,openshift/cluster-config-operator#357,openshift/cluster-version-operator#971,openshift/operator-framework-olm#565,openshift/cluster-node-tuning-operator#801,openshift/cluster-monitoring-operator#2095,openshift/console-operator#795

Install Capabilities Config:

capabilities:
  baselineCapabilitySet: None
  additionalEnabledCapabilities:
  - "marketplace"
  - "MachineAPI"

Signed-off-by: ehila <[email protected]>

feat: add validation and test for marketplace + OLM capabilities

Signed-off-by: ehila <[email protected]>

refactor: change OLM to full name OperatorLifecycleManager

Signed-off-by: ehila <[email protected]>
@kevinrizza
Copy link
Member

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Oct 2, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Oct 2, 2023

@eggfoobar: This pull request references OCPVE-672 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.15.0" version, but no target version was set.

In response to this:

Add the OLM as a capability.

Note, that OLM and Marketplace have a dependency, the Marketplace should not be enabled and the OLM disabled. This enforcement will be done at the installer level similar to how we enforce MachineAPI

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.

@JoelSpeed
Copy link
Contributor

/lgtm

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 3, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: eggfoobar, grokspawn, JoelSpeed, kevinrizza

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 3, 2023
@openshift-ci-robot
Copy link

openshift-ci-robot commented Oct 3, 2023

@eggfoobar: This pull request references OCPVE-672 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "4.15.0" version, but no target version was set.

In response to this:

Add the OLM as a capability.

Note, that OLM and Marketplace have a dependency, the Marketplace should not be enabled and the OLM disabled. This enforcement will be done at the installer level similar to how we enforce MachineAPI

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.

@openshift-merge-robot
Copy link
Contributor

@eggfoobar: all tests passed!

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.

1 similar comment
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 3, 2023

@eggfoobar: all tests passed!

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants