Update the docs to reflect OperatorSource deprecation #339
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: ankitathomas The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Thanks for starting this @ankitathomas
IMO since marketplace operator is now installing CatalogSources, most of the resources are olm owned, and therefore these docs should point towards relevant portions of the OLM docs.
A doc about OperatorHub API is the only thing that's missing in terms of new addition.
README.md
Outdated
|
|
||
| `CatalogSourceConfig` is used to create OLM `CatalogSources` consisting of operators from one `OperatorSource` so that these operators can then be managed by OLM. | ||
| If you want an `CatalogSource` to work with private registry repositories, please take a look at the [Private Repo Authentication](docs/how-to-authenticate-private-repositories.md) documentation. |
There was a problem hiding this comment.
This line has to be removed. We had a way to authenticate private repos using OperatorSources, but currently there's no way to authenticate using CatalogSources, unless the node itself is authenticated (which entails different steps)
README.md
Outdated
| Once a `CatalogSourceConfig` is created successfully you can create a [`Subscription`](https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades) for your operator referencing the newly created or updated `CatalogSource`. | ||
|
|
||
| Please note that the Marketplace operator uses `CatalogSourceConfigs` and `CatalogSources` internally and you will find them present in the namespace where the Marketplace operator is running. These resources can be ignored and should not be modified or used. | ||
| Once a `CatalogSource` is created successfully you can create a [`Subscription`](https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades) for your operator referencing the newly created or updated `CatalogSource`. |
There was a problem hiding this comment.
docs/e2e-testing.md
Outdated
| require.NoError(t, err, "Could not get namespace") | ||
|
|
||
| // Create any required runtime objects | ||
| err = helpers.CreateRuntimeObject(f, ctx, helpers.CreateOperatorSourceDefinition(name, namespace)) |
There was a problem hiding this comment.
This is still referencing OperatorSource
|
|
||
| If you have an app-registry repository that is backed by authentication, you can specify an authentication token in a Secret. To do this, create a Secret in the same namespace as your Operator Source: | ||
| If you have an registry repository that is backed by authentication, you can specify an authentication token in a Secret. To do this, create a Secret in the same namespace as your Catalog Source: |
There was a problem hiding this comment.
This needs to be omitted too since private repo authentication is not possible using CatalogSource
| @@ -1,6 +1,6 @@ | |||
| # Troubleshooting Marketplace Operator | |||
|
|
|||
| This document lists out some common failures related to the Marketplace Operator a user might encounter, along with ways to troubleshoot the failures. If you encouter a failure related to the Marketplace Operator that is not listed in this document, but should be, please open an issue or a PR to have the failure appended to this document. | |||
There was a problem hiding this comment.
I have a feeling this doc needs to be ripped out mostly, and point to the olm catalogsource troubleshooting doc instead.
What'll be helpful instead, is a doc that talks about the OperatorHub API
|
@ankitathomas: The following tests failed, say
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. |
openshift-ci
bot
added
the
needs-rebase
|
@ankitathomas: PR needs rebase. 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. |
|
@ankitathomas: The following tests failed, say
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. |
Switching to CatalogSource in doc to reflect OperatorSource deprecation.