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.

Sign up for GitHub

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

Jump to bottom

[Doc] Update README with how to set default value in schema or alm-examples #4304

Merged
merged 1 commit into from Feb 25, 2020
Merged

[Doc] Update README with how to set default value in schema or alm-examples #4304

merged 1 commit into from Feb 25, 2020

Conversation

tlwu2013
Copy link
Contributor

@tlwu2013 tlwu2013 commented Feb 13, 2020 •
edited

Add detailed info about:

  1. external doc for "set a default value on OpenAPI schema" (Need CRD v1 api / k8s 1.17+).
  2. link to "alm-examples" to specify value to set/override the default value on CRD.

Current:
current-doc

This PR:
this-pr

@openshift-ci-robot
Copy link
Contributor

Hi @tlwu2013. Thanks for your PR.

I'm waiting for a openshift 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/test-infra repository.

@openshift-ci-robot openshift-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 13, 2020
@openshift-ci-robot openshift-ci-robot added the component/olm Related to OLM label Feb 13, 2020
@tlwu2013 tlwu2013 requested review from madorn and spadgett and removed request for spadgett and jeff-phillips-18 February 13, 2020 02:00
@tlwu2013
Copy link
Contributor Author

Hey @madorn , can you help review this PR and see if this makes sense to you? Thanks!

@madorn
Copy link

madorn commented Feb 13, 2020

@komish

komish
komish approved these changes Feb 13, 2020
View reviewed changes
frontend/packages/operator-lifecycle-manager/src/components/descriptors/README.md
The `value` field is an optional field. If present, the value of this spec is the same for all instances of the CRD and can be found here instead of on the CR. You can specify the default value of the field on CRD in [OpenAPI v3 validation schema](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#defaulting).
The `value` field is an optional field. If present, the value of this spec is the same for all instances of the CRD and can be found here instead of on the CR.

You can assign the default value of the field on CRD in OpenAPI v3 validation schema (see [Defaulting](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#defaulting) feature in Kubernetes 1.17). Alternatively, you can specify the value of a field in [CRD Templates](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md#crd-templates) in the `ClusterServiceVersion` to set (or override) the default value on the CRD.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @tlwu2013!

I think adding a hint here as to why the suggested alternatives to defaulting are included in this documentation will help. Something similar to ...

This should not be used to apply a default value to a given custom resource for consumption by the console. You can assign...

I can go either way on whether or not this is needed. Your discretion. LGTM either way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me! I'll include your suggestions to the changes, thanks!

@tlwu2013
Copy link
Contributor Author

/assign @spadgett, @madorn , @komish

@tlwu2013
Copy link
Contributor Author

Hey @benjaminapetersen , could you help review/approve this? thanks!

@benjaminapetersen
Copy link
Contributor

/ok-to-test

@openshift-ci-robot openshift-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 24, 2020
@benjaminapetersen
Copy link
Contributor

/approve
/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Feb 24, 2020
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: benjaminapetersen, komish, tlwu2013

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-robot openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 24, 2020
@tlwu2013
Copy link
Contributor Author

/retest

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

3 similar comments
@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

10 similar comments
@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-bot
Copy link
Contributor

/retest

Please review the full test history for this PR and help us cut down flakes.

@openshift-merge-robot openshift-merge-robot merged commit 68bdcc9 into openshift:master Feb 25, 2020
@openshift-ci-robot
Copy link
Contributor

@tlwu2013: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
ci/prow/e2e-gcp-console 4d7d08a link /test e2e-gcp-console

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

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.

@spadgett spadgett added this to the v4.5 milestone Feb 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@komish komish komish approved these changes

@madorn madorn Awaiting requested review from madorn

@spadgett spadgett Awaiting requested review from spadgett

Assignees

@benjaminapetersen benjaminapetersen

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. component/olm Related to OLM lgtm Indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Milestone
v4.5
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@tlwu2013 @openshift-ci-robot @madorn @benjaminapetersen @openshift-bot @komish @spadgett @openshift-merge-robot