diff --git a/install_config/oab_broker_configuration.adoc b/install_config/oab_broker_configuration.adoc index 11e763e2b52c..d054c41a779b 100644 --- a/install_config/oab_broker_configuration.adoc +++ b/install_config/oab_broker_configuration.adoc @@ -341,59 +341,6 @@ registry: ---- -- -[[oab-config-registry-mock]] -=== Mock Registry - -A mock registry is useful for reading local APB specs. Instead of going out to a -registry to search for image specs, this uses a list of local specs. Set the -name of the registry to `mock` to use the mock registry. - -[source,yaml] ----- -registry: - - name: mock - type: mock ----- - -[[oab-config-registry-dockerhub]] -=== Dockerhub Registry - -The `dockerhub` type allows you to load APBs from a specific organization in -the DockerHub. For example, the -link:https://hub.docker.com/u/ansibleplaybookbundle/[*ansibleplaybookbundle*] -organization. - -[source,yaml] ----- -registry: - - name: dockerhub - type: dockerhub - org: ansibleplaybookbundle - user: - pass: - white_list: - - ".*-apb$" ----- - -[[oab-config-registry-galaxy]] -=== Ansible Galaxy Registry - -The `galaxy` type allows you to use APB roles from -link:https://galaxy.ansible.com[Ansible Galaxy]. You can also optionally -specify an organization. - -[source,yaml] ----- -registry: - - name: galaxy - type: galaxy - # Optional: - # org: ansibleplaybookbundle - runner: docker.io/ansibleplaybookbundle/apb-base:latest - white_list: - - ".*$" ----- - [[oab-config-apb-filtering]] === APB Filtering @@ -485,6 +432,59 @@ registry: - "^foobar-apb$" ---- +[[oab-config-registry-mock]] +=== Mock Registry + +A mock registry is useful for reading local APB specs. Instead of going out to a +registry to search for image specs, this uses a list of local specs. Set the +name of the registry to `mock` to use the mock registry. + +[source,yaml] +---- +registry: + - name: mock + type: mock +---- + +[[oab-config-registry-dockerhub]] +=== Dockerhub Registry + +The `dockerhub` type allows you to load APBs from a specific organization in +the DockerHub. For example, the +link:https://hub.docker.com/u/ansibleplaybookbundle/[*ansibleplaybookbundle*] +organization. + +[source,yaml] +---- +registry: + - name: dockerhub + type: dockerhub + org: ansibleplaybookbundle + user: + pass: + white_list: + - ".*-apb$" +---- + +[[oab-config-registry-galaxy]] +=== Ansible Galaxy Registry + +The `galaxy` type allows you to use APB roles from +link:https://galaxy.ansible.com[Ansible Galaxy]. You can also optionally +specify an organization. + +[source,yaml] +---- +registry: + - name: galaxy + type: galaxy + # Optional: + # org: ansibleplaybookbundle + runner: docker.io/ansibleplaybookbundle/apb-base:latest + white_list: + - ".*$" +---- + [[oab-config-registry-local]] === Local OpenShift Container Registry @@ -553,6 +553,76 @@ is also required to configure the broker to use the Partner Registry URL: registry.connect.redhat.com ---- +[[oab-config-helm-chart-registry]] +=== Helm Chart Registry + +Using the `helm` type allows you to consume Helm Charts from a Helm Chart Repository. + +[source,yaml] +---- +registry: + - name: stable + type: helm + url: "https://kubernetes-charts.storage.googleapis.com" + runner: "docker.io/automationbroker/helm-runner:latest" + white_list: + - ".*" +---- + +NOTE: A heavy percentage of helm charts from the stable repository are not well suited for OpenShift. +See the link:https://github.com/ansibleplaybookbundle/helm2bundle/wiki/Known-Issues[Known Issues] for more information. + +[[oab-config-api-v2-registry]] +=== API V2 Docker Registry + +Using the `apiv2` type allows you to consume images from docker registries that implement the Docker Registry +HTTP API V2 protocol. + +[source,yaml] +---- +registry: + - name: + type: apiv2 + url: + user: + pass: + white_list: + - ".*-apb$" +---- + +If the registry requires authentication for pulling images, this can be achieved by running the following +command on every node in your existing cluster: + +---- +$ docker --config=/var/lib/origin/.docker login -u -p +---- + +[[oab-config-quay-registry]] +=== Quay Docker Registry + +Using the `quay` type allows you to load APBs that are published to the link:https://quay.io/about/[CoreOS Quay Registry]. +If an authentication token is provided, private repositories that the token is configured to access will load. +Public repositories in the specified organization do not require a token to load. + +[source,yaml] +---- +registry: + - name: quay_reg + type: quay + url: https://quay.io + token: + org: + white_list: + - ".*-apb$" +---- + +If the Quay registry requires authentication for pulling images, this can be achieved by running the following +command on every node in your existing cluster: + +---- +$ docker --config=/var/lib/origin/.docker login -u -p quay.io +---- + [[oab-configmultiple-registries]] === Multiple Registries