add partner rhcc adapter documentation #950
Conversation
openshift-ci-robot
added
the
size/S
rthallisey
added
the
3.10 | release-1.2
docs/design.md
Outdated
|
|
||
| The `PartnerRhccAdapter` allows the broker to be bootstrapped from the the partner registry. Like the `DockerHubRegistry` adapter, it will retrieve a list of APBs and load their specs. The `PartnerRhccAdapterner` requires a valid RHN `user`, and `pass` for the API queries. | ||
|
|
||
| The below is an example of how the [broker configuration file](../etc/example-config.yaml) may be configured for the `PartnerRhccAdapter`: |
There was a problem hiding this comment.
Instead of linking to [broker configuration file](../etc/example-config.yaml) I think we should say broker configmap to be clear what needs to be changed.
There was a problem hiding this comment.
I would actually prefer the link, because the related content and docs are expected to remain up to date and indicates the expectation.
There was a problem hiding this comment.
I think I agree with @eriknelson. I would rather point to further documentation on the configuration.
I would like the link to go to this file. https://github.com/openshift/ansible-service-broker/blob/master/docs/config.md#registry-configuration
as an aside, we probably need to update this file with the registry name change?
There was a problem hiding this comment.
Is there enough info here for me to give a partner this link and they know exactly what to do without prior broker knowledge? It might be better to add this to config.md? Somewhere after: https://github.com/openshift/ansible-service-broker/blob/master/docs/config.md#multiple-registries-example
@johnkim76 @eriknelson @shawn-hurley thoughts?
docs/design.md
Outdated
| registry: | ||
| - type: partner_rhcc | ||
| name: reg | ||
| url: https://registry.access.redhat.com |
There was a problem hiding this comment.
shouldn't this be registry.connect.redhat.com?
There was a problem hiding this comment.
yes... I will fix
johnkim76
force-pushed
the
partner_adapter_doc
branch
2 times, most recently
from
4b495e3
to
bd7fdba
Compare
docs/design.md
Outdated
|
|
||
| ### Partner RHCC Adapter | ||
|
|
||
| The `PartnerRhccAdapter` allows the broker to be bootstrapped from the the partner registry. Like the `DockerHubRegistry` adapter, it will retrieve a list of APBs and load their specs. The `PartnerRhccAdapterner` requires a valid RHN `user`, and `pass` for the API queries. |
There was a problem hiding this comment.
spelling PartnerRhccAdapterner
There was a problem hiding this comment.
Third-party images in the Red Hat Container Catalog are served from the Red Hat Connect Partner Registry (registry.connect.redhat.com). The PartnerRhccAdapter allows the broker to be bootstrapped from this, "Red Hat Connect Partner Registry" to retrieve a list of APBs and load their specs. Note this is an authenticated repository and will require authentication credentials to access.
docs/design.md
Outdated
| - type: partner_rhcc | ||
| name: reg | ||
| url: https://registry.connect.redhat.com | ||
| user: <rhn-user> |
There was a problem hiding this comment.
Change to "registry-username"
docs/design.md
Outdated
| name: reg | ||
| url: https://registry.connect.redhat.com | ||
| user: <rhn-user> | ||
| pass: <rhn-pass> |
docs/design.md
Outdated
| The partner registry also requires authentication for pulling images. This can be achieved by running the following command on every node in your existing OpenShift cluster: | ||
|
|
||
| ```bash | ||
| docker --config=/var/lib/origin/.docker login -u <rhn-user> -p <rhn-pass> registry.connect.redhat.com |
There was a problem hiding this comment.
docker --config=/var/lib/origin/.docker login -u <registry_username> -p <registry_password>
johnkim76
force-pushed
the
partner_adapter_doc
branch
from
bd7fdba
to
e3c0c94
Compare
docs/design.md
Outdated
| @@ -128,3 +128,9 @@ The `DockerHubRegistry` requires a `user`, `pass`, and `org` field | |||
| to be set inside the `registry` section of the configuration file. The user | |||
| credentials are used to authenticate API queries, and the organization is the | |||
| target org that APBs will be loaded from. | |||
|
|
|||
There was a problem hiding this comment.
Think this entire blurb was intended for docs/config.md and not for design.md.
docs/config.md
Outdated
| ### OpenShift Registry | ||
| Using the OpenShift registry will allow you to load APBs that are published to this type of [registry](http://www.projectatomic.io/registry/). | ||
| ### Red Hat Connect Partner Registry | ||
| Using the Red Hat Connect Partner Registry will allow you to load APBs that are published to this type of [registry](https://registry.connect.redhat.com). |
There was a problem hiding this comment.
Let's be careful we do not lose the configuration for the OpenShift Registry type.
The partner registry is not the openshift registry, it is a new registry adapter.
johnkim76
force-pushed
the
partner_adapter_doc
branch
from
e3c0c94
to
1a5e4a9
Compare
Describe what this PR does and why we need it:
Documents the partner registry adapter implementation
Does this PR depend on another PR (Use this to track when PRs should be merged)
depends-on automationbroker/bundle-lib#77
Trello:
https://trello.com/c/PUOWeaEl