Add CRD/APIService sections to CSV topic #15089
Conversation
openshift-ci-robot
added
the
size/L
|
@jianzhangbjz PTAL for QE review. |
modules/osdk-apiservices.adoc
Outdated
|
|
||
| It is recommended to only list out the objects that are important to a human, | ||
| not an exhaustive list of everything you orchestrate. For example, ConfigMaps | ||
| that store internal state that should not be modified by a user should npt |
There was a problem hiding this comment.
Typing error: npt, shoud be not I guess.
| [id="osdk-apiservices_{context}"] | ||
| = Understanding your API services | ||
|
|
||
| As with CRDs, there are two types of APIServices that your Operator may use: |
There was a problem hiding this comment.
@ecordell Do we have the two sections for APIServices in the csv object? I'm sorry, but I haven't seen any csv which contains the owned/required for APIService in community-operators. I can only find the csv which contain owned/required for CRD.
There was a problem hiding this comment.
cc @njhale since I believe you authored the upstream version via operator-framework/operator-lifecycle-manager#492.
There was a problem hiding this comment.
Yes, there are both sections for apiservices as well. I beleive the template service broker and ansible service broker make use of them?
But yes, the vast majority of operators are CRD-based (and this is a good thing)
| such as top-level database configuration in one object and a representation of | ||
| ReplicaSets in another. Each one should be listed out in the CSV file. | ||
|
|
||
| .Owned CRD fields |
There was a problem hiding this comment.
That makes sense to me; though the fields are defined required/optional in the schema for the api.
There was a problem hiding this comment.
Updated Tables 3, 4, 5, and 6 with a Required/Optional column, based on what was listed as required for customresourcedefinitions and apiservicedefinitions in https://github.com/operator-framework/operator-lifecycle-manager/blob/master/manifests/0000_50_olm_03-clusterserviceversion.crd.yaml.
| an etcd cluster (from an etcd Operator) to use for distributed locking and a | ||
| Postgres database (from a Postgres Operator) for data storage. | ||
|
|
||
| The Operator Lifecycle Manager (OLM) checks against the available CRDs and |
There was a problem hiding this comment.
@ecordell OLM will resolve and install the required CRD, right? Do we need to point out it here?
There was a problem hiding this comment.
This is describing the "single-operator" workflow. If you have no catalogs and no subscriptions, OLM will still check that your required CRDs exist (if, for example, you have installed it outside of OLM)
adellape
force-pushed
the
yourapiservices
branch
2 times, most recently
from
fdd57b5 to
db36950
Compare
adellape
force-pushed
the
yourapiservices
branch
from
2ea83d8 to
1cef90a
Compare
|
@adellape added 4.2 as well, but remove if not applicable. |
|
@adellape Sorry for the late, I will try to review it ASAP. |
|
/cherrypick enterprise-4.1 |
|
@adellape: new pull request created: #16509 In response to this:
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. |
|
/cherrypick enterprise-4.2 |
|
@adellape: new pull request created: #16510 In response to this:
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. |
xref: https://jira.coreos.com/browse/OSDOCS-25
Preview (internal):