Iniciar sesión en Docker y Helm

En esta página se describe cómo iniciar sesión en Docker o Helm con el ayudante de credenciales de Managed Harbor Service (MHS) o con secretos de la CLI.

Las instancias de registro de Harbor en Google Distributed Cloud (GDC) aislado usan Identity-Aware Proxy (IAP) para la autenticación. Puedes iniciar sesión en tu instancia de registro de Harbor desde la CLI de Docker o Helm mediante uno de los siguientes métodos:

  • Ayudante de credenciales de MHS (docker-credential-mhs): usa tu identidad de GDC autenticada para gestionar la autenticación de IAP automáticamente. Después de iniciar sesión con la CLI gdcloud, docker-credential-mhs obtiene tu identidad de usuario autenticada y verifica tu acceso con Harbor. Tras la verificación, Harbor proporciona un token de corta duración a Docker o Helm para que puedas realizar operaciones de registro sin crear ni gestionar secretos de CLI independientes.
  • Secretos de CLI: usa un secreto de CLI estático de tu perfil de usuario de Harbor. Después de iniciar sesión en la interfaz web de Harbor con IAP por primera vez, puedes obtener tu secreto de la CLI y usarlo como contraseña cuando inicies sesión desde la CLI de Docker o Helm. Este método solo está disponible con la interfaz de usuario de Harbor.

Antes de empezar

Para configurar la autenticación de Docker y Helm en las instancias de registro de Harbor, debes tener instalado el ayudante de credenciales de MHS (docker-credential-mhs) en tu entorno. El ayudante de credenciales se incluye de forma predeterminada en el paquete de la CLI gdcloud. Para obtener más información, consulta la descripción general de la CLI gdcloud.

Roles de gestión de identidades y accesos necesarios

Para configurar la autenticación de las instancias de registro de Harbor, ponte en contacto con el administrador de proyectos de gestión de identidades y accesos para solicitar el rol de lector de instancias de Harbor (harbor-instance-viewer), que te permite obtener, ver y supervisar las instancias de Harbor en el espacio de nombres del proyecto. Este rol incluye los permisos necesarios para ver los detalles de las instancias de Harbor que ya tienes, de modo que puedas obtener las URLs de registro para la autenticación.

Iniciar sesión con el ayudante de credenciales de MHS

La forma de autenticarte con docker-credential-mhs depende de tu cliente de CLI: puedes configurar Docker para que obtenga las credenciales automáticamente o puedes obtener credenciales temporales directamente para iniciar sesión en Docker.

Iniciar sesión en Docker

Para autenticarte con Docker, sigue estos pasos:

  1. Inicia sesión en el servidor de la API Management con la CLI gdcloud siguiendo las instrucciones de Iniciar sesión.

  2. Configura Docker para que use el ayudante de credenciales de MHS docker-credential-mhs:

    TENANT_PROJECT=PROJECT_NAME
    HARBOR_INSTANCE_NAME=HARBOR_INSTANCE_NAME
    REGISTRY=$(kubectl get harborinstance $HARBOR_INSTANCE_NAME -n $TENANT_PROJECT -o jsonpath='{.status.url}' | sed s#https://##)
    
    docker-credential-mhs configure-docker --registries=${REGISTRY}
    

    Haz los cambios siguientes:

  3. Sigue las instrucciones que se indican en Configurar Docker para que confíe en la CA raíz de Harbor.

  4. Opcional: Verifica que el ayudante de credenciales se haya configurado correctamente comprobando que la entrada mhs se haya añadido a ~/.docker/config.json:

    cat DOCKER_CONFIG_PATH
    

    Sustituye DOCKER_CONFIG_PATH por la ruta de tu archivo de configuración de Docker, como ~/.docker/config.json.

    El resultado debería ser similar al siguiente:

    {
        "auths": {
            "10.200.0.1": {
                "auth": "YWRtaW46YWRtaW4="
            },
            "10.200.16.5:10443": {
                "auth": "YWRtaW46ZEROVVJCVWE1a1FBcE4xQQ=="
            }
        },
        "credHelpers": {
            "asia.gcr.io": "gcloud",
            "eu.gcr.io": "gcloud",
            "gcr.io": "gcloud",
            "marketplace.gcr.io": "gcloud",
            "myinstance-e2e-test-user.org-1.zone1.google.gdch.test": "mhs",
            "staging-k8s.gcr.io": "gcloud",
            "us-central1-docker.pkg.dev": "gcloud",
            "us.gcr.io": "gcloud"
        }
    }
    

    En este ejemplo se muestra un resultado correcto de "myinstance-e2e-test-user.org-1.zone1.google.gdch.test": "mhs".

  5. Configura el proyecto de cliente en la CLI gdcloud:

    TENANT_PROJECT=PROJECT_NAME
    gdcloud config set project $TENANT_PROJECT
    

    Se muestra el siguiente resultado:

    Updated property [core/project].
    
  6. Identifica un proyecto de Harbor al que tengas acceso de gestión. Si no tienes ninguno, crea un proyecto de Harbor.

  7. Realiza operaciones de Docker, como enviar o extraer una imagen:

    TENANT_PROJECT=PROJECT_NAME
    HARBOR_INSTANCE_NAME=HARBOR_INSTANCE_NAME
    REGISTRY=$(kubectl get harborinstance $HARBOR_INSTANCE_NAME -n $TENANT_PROJECT -o jsonpath='{.status.url}' | sed s#https://##)
    HARBOR_PROJECT=HARBOR_PROJECT_NAME
    
    # Push image
    docker pull nginx
    docker tag nginx ${REGISTRY}/${HARBOR_PROJECT}/nginx:latest
    docker push ${REGISTRY}/${HARBOR_PROJECT}/nginx:latest
    
    # Pull image
    docker pull ${REGISTRY}/${HARBOR_PROJECT}/nginx:latest
    

    El resultado correcto es similar al siguiente:

    # Push image
    root@gpc-adhoc-70846130vm-bootstrapper-zone1:~# docker push ${REGISTRY}/harbor-project/nginx:latest
    The push refers to repository [myinstance-e2e-test-user.org-1.zone1.google.gdch.test/harbor-project/nginx]
    e4e9e9ad93c2: Pushed
    6ac729401225: Pushed
    8ce189049cb5: Pushed
    296af1bd2844: Pushed
    63d7ce983cd5: Pushed
    b33db0c3c3a8: Pushed
    98b5f35ea9d3: Pushed
    latest: digest: sha256:7ba542bde95e6523a4b126f610553e3657b8108bc3175596ee7e911ae1219bfc size: 1778
    
    # Pull image
    root@gpc-adhoc-70846130vm-bootstrapper-zone1:~# docker pull ${REGISTRY}/library/nginx:latest
    latest: Pulling from library/nginx
    Digest: sha256:7ba542bde95e6523a4b126f610553e3657b8108bc3175596ee7e911ae1219bfc
    Status: Image is up to date for myinstance-e2e-test-user.org-1.zone1.google.gdch.test/harbor-project/nginx:latest
    

    Si la operación no se realiza correctamente, puede que veas el siguiente resultado:

    E1025 19:21:39.322290 1273587 get.go:24] failed to get user name: user is not logged in or login expired, please login again
    

    En este ejemplo, la sesión de autenticación de GDC ha caducado y debes volver a iniciar sesión en GDC. Consulta más información sobre cómo iniciar sesión.

Iniciar sesión en Helm

Para autenticarte con Helm, sigue estos pasos:

  1. Después de autenticarte con GDC, obtén tus credenciales de usuario del ayudante de credenciales:

    echo $REGISTRY | docker-credential-mhs get
    

    El resultado debería ser similar al siguiente:

    {"Username":"tokenreview$fop-infrastructure-operator@example.com","Secret":"STS-Bearer-3q2o6mBKk44Gzi4105vyiSnXMuixtnm-RnyxSgJtnYkNbGV7drpwgIuftinAXVlo0Im9kgoGmc2WcZTSjE-vh2a71Su7YjB6qIAjAQ5ABkY03AHNfkHhRZzxthumDIVAd08wm2weit3_NpMPgOnf9qMblds_Q0PAWk2OhpodBpCfyl3LWZpIZBaNVgtg-TB_7fjpEDOm-_Q5VYABScOgZFP_bw"}
    
  2. Inicia sesión en la CLI de Helm con las credenciales. Cuando se te pida que introduzcas las credenciales, usa las que haya devuelto el asistente de credenciales.

    helm registry login $REGISTRY
    Username: tokenreview$fop-infrastructure-operator@example.com
    Password: STS-Bearer-3q2o6mBKk44Gzi4105vyiSnXMuixtnm-RnyxSgJtnYkNbGV7drpwgIuftinAXVlo0Im9kgoGmc2WcZTSjE-vh2a71Su7YjB6qIAjAQ5ABkY03AHNfkHhRZzxthumDIVAd08wm2weit3_NpMPgOnf9qMblds_Q0PAWk2OhpodBpCfyl3LWZpIZBaNVgtg-TB_7fjpEDOm-_Q5VYABScOgZFP_bw
    

    El resultado de esta operación es similar al siguiente:

    Login Succeeded
    

Iniciar sesión con secretos de la CLI

Para iniciar sesión en Docker o Helm con secretos de la CLI, sigue estos pasos:

  1. Inicia sesión en Harbor con una cuenta de usuario de IAP.
  2. Haz clic en tu nombre de usuario y selecciona User Profile (Perfil de usuario).
  3. Para copiar el secreto de la CLI asociado a tu cuenta, haz clic en Copiar.
  4. Opcional: Para mostrar botones que generen automáticamente o creen manualmente un nuevo secreto de CLI, haz clic en Más en tu perfil de usuario.

  5. Si has generado un nuevo secreto de CLI, haz clic en Copiar para copiarlo.

  6. Usa tu secreto de la CLI como contraseña cuando inicies sesión en Harbor desde la CLI de Docker o Helm:

    docker login -u USERNAME -p CLI_SECRET HARBOR_INSTANCE_URL
    

    Haz los cambios siguientes:

    • USERNAME: el nombre de usuario de la cuenta de Harbor.
    • CLI_SECRET: el secreto de la CLI generado.
    • HARBOR_INSTANCE_URL: la URL de la instancia de Harbor.

Siguientes pasos

Una vez que hayas iniciado sesión en Docker y Helm, tu registro estará conectado y podrás empezar a usarlo: