Skip to content

Conversation

@wking
Copy link
Member

@wking wking commented Nov 27, 2018

That approach should be documented in the CVO itself, since it's not installer-specific and moving it gets the docs and implementation for that approach into the same repository. I've filed openshift/cluster-version-operator#59 to land dynamic-object docs in the CVO repo (based on some of the content I'm removing here). Naming files, etc. are already covered by the existing CVO documentation.

CC @rajatchopra, since this is a follow-up to #377 and openshift/cluster-version-operator#34.

That approach should be documented in the CVO itself, since it's not
installer-specific and moving it gets the docs and implementation for
that approach into the same repository.  I've filed [1] to land
dynamic-object docs in the CVO repo (based on some of the content I'm
removing here).  Naming files, etc. are already covered by the
existing CVO documentation.

[1]: openshift/cluster-version-operator#59
@openshift-ci-robot openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Nov 27, 2018
@abhinavdahiya
Copy link
Contributor

CVO is a consumer for the update payload and doesn't drive these. So these cannot exist in CVO. I would keep them in installer as people come to installer to ask how do I install my operator?.

@wking
Copy link
Member Author

wking commented Nov 27, 2018

CVO is a consumer for the update payload and doesn't drive these.

Who does drive these? If a new release image rolls out, someone will be reading and pushing its manifests into existing clusters, and that won't be the installer. With this PR and openshift/cluster-version-operator#59, all the "usual way" docs are collected in one place. If that place should be some third location (not the installer, and maybe not the CVO either?), point me at it and I'll move the "usual way" docs there.

I would keep them in installer as people come to installer to ask how do I install my operator?

I'm still prominently linking the CVO docs, so folks who come here first and then realize the don't need instal;er coupling can find the "usual way" docs.

Copy link

@rajatchopra rajatchopra left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci-robot openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Nov 27, 2018
@openshift-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rajatchopra, wking

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

The pull request process is described here

Details 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-merge-robot openshift-merge-robot merged commit adebbb9 into openshift:master Nov 27, 2018
@wking wking deleted the installer-specific-operator-doc-focus branch November 27, 2018 20:20
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. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants