Bug 1769641
| Summary: | StorageOSCluster example on StorageOS Operator description is not correct | ||
|---|---|---|---|
| Product: | OpenShift Container Platform | Reporter: | Bruno Andrade <bandrade> |
| Component: | ISV Operators | Assignee: | Bruno Andrade <bandrade> |
| Status: | CLOSED ERRATA | QA Contact: | Bruno Andrade <bandrade> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 4.3.0 | CC: | aos-bugs, jiazha, mdorn, mifiedle, scolange, sd-ecosystem, simon.croome, tbuskey |
| Target Milestone: | --- | ||
| Target Release: | 4.3.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2020-01-23 11:11:28 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
This should be fixed in https://github.com/storageos/cluster-operator/pull/197. We'll release in 1.5.1 sometime this week. Thanks Simon! We see the change adding `k8sDistro: openshift` field/value. Can we also make the example CR look exactly like your tutorial section here?: https://docs.storageos.com/docs/platforms/openshift/install/4.1 Specifically ensuring the user sets secretRefNamespace within openshift-operators namespace (not default): apiVersion: storageos.com/v1 kind: StorageOSCluster metadata: name: storageos namespace: openshift-operators spec: secretRefName: "storageos-api" secretRefNamespace: "openshift-operators" namespace: kube-system csi: enable: true deploymentStrategy: deployment resources: requests: memory: "512Mi" k8sDistro: "openshift" I know this may seem pretty obvious to someone installing it...but just trying to make it as easy as possible for people to get StorageOS running! Apologies Matt, I missed this. Upstream PR: https://github.com/storageos/cluster-operator/pull/212. We'll need to do a new release. Tested at 1.5.1 Operator version and it looks good. Here is the StorageOSCluster description:
apiVersion: storageos.com/v1
kind: StorageOSCluster
metadata:
name: example-storageos
namespace: default
spec:
namespace: kube-system
secretRefName: storageos-api
secretRefNamespace: default
k8sDistro: openshift
csi:
enable: true
deploymentStrategy: deployment
Marking as VERIFIED, thanks.
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. https://access.redhat.com/errata/RHBA-2020:0062 |
Description of problem: When a StorageOSCluster is being created, the suggested yaml looks like: apiVersion: storageos.com/v1 kind: StorageOSCluster metadata: name: example-storageos namespace: openshift-operators spec: namespace: kube-system secretRefName: storageos-api secretRefNamespace: default csi: enable: true deploymentStrategy: deployment According to official product documentation (https://docs.storageos.com/docs/platforms/openshift/install/4.1), it should be: apiVersion: storageos.com/v1 kind: StorageOSCluster metadata: name: storageos namespace: openshift-operators spec: secretRefName: "storageos-api" secretRefNamespace: "openshift-operators" namespace: openshift-operators csi: enable: true deploymentStrategy: deployment resources: requests: memory: "512Mi" k8sDistro: "openshift" By using the default example, the CR is ignored and objects are not created. Version-Release number of selected component (if applicable): Storage OS 1.4.0 OCP Version: 4.3.0-0.nightly-2019-11-02-092336 How reproducible: Always Steps to Reproduce: 1.Install it in the Web console, for example: "Operators"->"OperatorHub"->"Portworx" 2. Create CR of type StorageCluster Actual results: Wrong StorageOSCluster example is being shown on Operator description Expected results: The example of StorageOSCluster should be adapted for Openshift.