Accessing the registry

Use the following sections for instructions on accessing the registry, including viewing logs and metrics, as well as securing and exposing the registry.

You can access the registry directly to invoke podman commands. This allows you to push images to or pull them from the integrated registry directly using operations like podman push or podman pull. To do so, you must be logged in to the registry using the oc login command. The operations you can perform depend on your user permissions, as described in the following sections.

Prerequisites

  • You must have configured an identity provider (IDP).

  • For pulling images, for example when using the podman pull command, the user must have the registry-viewer role. To add this role, run the following command:

    1. $ oc policy add-role-to-user registry-viewer <user_name>

  • For writing or pushing images, for example when using the podman push command:

    • The user must have the registry-editor role. To add this role, run the following command:

      1. $ oc policy add-role-to-user registry-editor <user_name>

    • Your cluster must have an existing project where the images can be pushed to.

Accessing registry directly from the cluster

You can access the registry from inside the cluster.

Procedure

Access the registry from the cluster by using internal routes:

  1. Access the node by getting the node’s address:

    1. $ oc get nodes
    1. $ oc debug nodes/<node_address>

  2. To enable access to tools such as oc and podman on the node, run the following command:

    1. sh-4.2# chroot /host

  3. Log in to the container image registry by using your access token:

    1. sh-4.2# oc login -u kubeadmin -p <password_from_install_log> https://api-int.<cluster_name>.<base_domain>:6443
    1. sh-4.2# podman login -u kubeadmin -p $(oc whoami -t) image-registry.openshift-image-registry.svc:5000

    You should see a message confirming login, such as:

    1. Login Succeeded!

    You can pass any value for the user name; the token contains all necessary information. Passing a user name that contains colons will result in a login failure.

    Since the Image Registry Operator creates the route, it will likely be similar to default-route-openshift-image-registry.<cluster_name>.

  4. Perform podman pull and podman push operations against your registry:

    You can pull arbitrary images, but if you have the system:registry role added, you can only push images to the registry in your project.

    In the following examples, use:

    ComponentValue

    <registry_ip>

    172.30.124.220

    <port>

    5000

    <project>

    openshift

    <image>

    image

    <tag>

    omitted (defaults to latest)

    1. Pull an arbitrary image:

      1. $ podman pull name.io/image

    2. Tag the new image with the form <registry_ip>:<port>/<project>/<image>. The project name must appear in this pull specification for OKD to correctly place and later access the image in the registry:

      1. $ podman tag name.io/image image-registry.openshift-image-registry.svc:5000/openshift/image

      You must have the system:image-builder role for the specified project, which allows the user to write or push an image. Otherwise, the podman push in the next step will fail. To test, you can create a new project to push the image.

    3. Push the newly tagged image to your registry:

      1. $ podman push image-registry.openshift-image-registry.svc:5000/openshift/image

Checking the status of the registry pods

As a cluster administrator, you can list the image registry pods running in the openshift-image-registry project and check their status.

Prerequisites

  • You have access to the cluster as a user with the cluster-admin role.

  • You have installed the OpenShift CLI (oc).

Procedure

  1. List the pods in the openshift-image-registry project and view their status:

    1. $ oc get pods -n openshift-image-registry

    Example output

    1. NAME READY STATUS RESTARTS AGE
    2. cluster-image-registry-operator-764bd7f846-qqtpb 1/1 Running 0 78m
    3. image-registry-79fb4469f6-llrln 1/1 Running 0 77m
    4. node-ca-hjksc 1/1 Running 0 73m
    5. node-ca-tftj6 1/1 Running 0 77m
    6. node-ca-wb6ht 1/1 Running 0 77m
    7. node-ca-zvt9q 1/1 Running 0 74m

Viewing registry logs

You can view the logs for the registry by using the oc logs command.

Procedure

  1. Use the oc logs command with deployments to view the logs for the container image registry:

    1. $ oc logs deployments/image-registry -n openshift-image-registry

    Example output

    1. 2015-05-01T19:48:36.300593110Z time="2015-05-01T19:48:36Z" level=info msg="version=v2.0.0+unknown"
    2. 2015-05-01T19:48:36.303294724Z time="2015-05-01T19:48:36Z" level=info msg="redis not configured" instance.id=9ed6c43d-23ee-453f-9a4b-031fea646002
    3. 2015-05-01T19:48:36.303422845Z time="2015-05-01T19:48:36Z" level=info msg="using inmemory layerinfo cache" instance.id=9ed6c43d-23ee-453f-9a4b-031fea646002
    4. 2015-05-01T19:48:36.303433991Z time="2015-05-01T19:48:36Z" level=info msg="Using OpenShift Auth handler"
    5. 2015-05-01T19:48:36.303439084Z time="2015-05-01T19:48:36Z" level=info msg="listening on :5000" instance.id=9ed6c43d-23ee-453f-9a4b-031fea646002

Accessing registry metrics

The OpenShift Container Registry provides an endpoint for Prometheus metrics. Prometheus is a stand-alone, open source systems monitoring and alerting toolkit.

The metrics are exposed at the /extensions/v2/metrics path of the registry endpoint.

Procedure

There are two ways in which you can access the metrics, running a metrics query or using the cluster role.

Metrics query

  1. Run a metrics query, for example:

    1. $ curl --insecure -s -u <user>:<secret> \ (1)
    2.     https://image-registry.openshift-image-registry.svc:5000/extensions/v2/metrics | grep imageregistry | head -n 20

    Example output

    1. # HELP imageregistry_build_info A metric with a constant '1' value labeled by major, minor, git commit & git version from which the image registry was built.
    2. # TYPE imageregistry_build_info gauge
    3. imageregistry_build_info{gitCommit="9f72191",gitVersion="v3.11.0+9f72191-135-dirty",major="3",minor="11+"} 1
    4. # HELP imageregistry_digest_cache_requests_total Total number of requests without scope to the digest cache.
    5. # TYPE imageregistry_digest_cache_requests_total counter
    6. imageregistry_digest_cache_requests_total{type="Hit"} 5
    7. imageregistry_digest_cache_requests_total{type="Miss"} 24
    8. # HELP imageregistry_digest_cache_scoped_requests_total Total number of scoped requests to the digest cache.
    9. # TYPE imageregistry_digest_cache_scoped_requests_total counter
    10. imageregistry_digest_cache_scoped_requests_total{type="Hit"} 33
    11. imageregistry_digest_cache_scoped_requests_total{type="Miss"} 44
    12. # HELP imageregistry_http_in_flight_requests A gauge of requests currently being served by the registry.
    13. # TYPE imageregistry_http_in_flight_requests gauge
    14. imageregistry_http_in_flight_requests 1
    15. # HELP imageregistry_http_request_duration_seconds A histogram of latencies for requests to the registry.
    16. # TYPE imageregistry_http_request_duration_seconds summary
    17. imageregistry_http_request_duration_seconds{method="get",quantile="0.5"} 0.01296087
    18. imageregistry_http_request_duration_seconds{method="get",quantile="0.9"} 0.014847248
    19. imageregistry_http_request_duration_seconds{method="get",quantile="0.99"} 0.015981195
    20. imageregistry_http_request_duration_seconds_sum{method="get"} 12.260727916000022
    1<user> can be arbitrary, but <secret> must match the value specified in the registry configuration.

Cluster role

  1. Create a cluster role if you do not already have one to access the metrics:

    1. $ cat <<EOF | oc create -f -
    2. apiVersion: rbac.authorization.k8s.io/v1
    3. kind: ClusterRole
    4. metadata:
    5.   name: prometheus-scraper
    6. rules:
    7. - apiGroups:
    8.   - image.openshift.io
    9.   resources:
    10.   - registry/metrics
    11.   verbs:
    12.   - get
    13. EOF

  2. Add this role to a user, run the following command:

    1. $ oc adm policy add-cluster-role-to-user prometheus-scraper <username>

  3. Access the metrics using cluster role. The part of the configuration file responsible for metrics should look like this:

    1. openshift:
    2.   version: 1.0
    3.   metrics:
    4.     enabled: true
    5. ...

Additional resources