Il job potrebbe dover avere dipendenze che richiedono chiavi API, password, certificati o altre informazioni sensibili. Per Cloud Run, Google consiglia di memorizzare questo tipo di informazioni sensibili in un segreto creato in Secret Manager.
Puoi rendere disponibile un segreto per i tuoi contenitori in due modi:
- Monta ogni secret come volume, in modo che sia disponibile per il container come file. La lettura di un volume recupera sempre il valore del secret da Secret Manager, pertanto può essere utilizzata con la versione più recente. Questo funziona bene anche con la rotazione dei secret.
- Trasmetti un secret utilizzando le variabili di ambiente. Le variabili di ambiente vengono risolte all'avvio dell'istanza, pertanto se utilizzi questo metodo, Google consiglia di bloccare il segreto a una determinata versione anziché utilizzare latest.
Per ulteriori informazioni, consulta il documento sulle best practice di Secret Manager.
Come vengono controllati i secret in fase di deployment e runtime
Durante la creazione del job, tutti i secret utilizzati, come variabili di ambiente o montati come volume, vengono controllati per verificare che l'account di servizio utilizzato per eseguire il contenitore abbia accesso. Se uno dei controlli non va a buon fine, la creazione del job non va a buon fine.
Durante il runtime, all'avvio delle istanze:
- Se il secret è una variabile di ambiente, viene recuperato il valore del secret prima di avviare l'istanza, quindi se il recupero del secret non va a buon fine, l'istanza non viene avviata.
- Se il secret viene montato come volume, non viene eseguito alcun controllo durante l'avvio dell'istanza. Tuttavia, se durante il runtime non è possibile accedere a un secret, i tentativi di lettura del volume montato avranno esito negativo.
La proprietà del volume varia in base all'ambiente di esecuzione e al tipo di deployment
Quando monta un volume secret utilizzando l'esecuzione di seconda generazione nel caso dei job, il volume è di proprietà dell'utente root.
Prima di iniziare
Puoi utilizzare un secret di Secret Manager esistente o crearne uno nuovo.
Ruoli obbligatori
Per ottenere le autorizzazioni necessarie per configurare i secret, chiedi all'amministratore di concederti seguenti ruoli IAM:
-
Amministratore di Cloud Run (
roles/run.admin
) nel job Cloud Run -
Utente account di servizio (
roles/iam.serviceAccountUser
) nell'identità del servizio
Per consentire a Cloud Run di accedere al secret, l'identità del servizio deve avere il seguente ruolo:
- Secret Manager Secret Accessor (
roles/secretmanager.secretAccessor
)
Per istruzioni su come aggiungere l'entità identità del servizio al ruolo Accesso ai secret di Secret Manager, consulta Gestire l'accesso ai secret.
Per un elenco di ruoli e autorizzazioni IAM associati Cloud Run, consulta Ruoli IAM di Cloud Run e le autorizzazioni IAM di Cloud Run. Se il tuo job Cloud Run si interfaccia con le API Google Cloud, come le librerie client Cloud, consulta la guida alla configurazione dell'identità del servizio. Per saperne di più sulla concessione dei ruoli, consulta le autorizzazioni di deployment e gestisci l'accesso.
Rendi un secret accessibile a Cloud Run
Puoi rendere un segreto accessibile al tuo job utilizzando la console Google Cloud, Google Cloud CLI o YAML:
Console
Nella console Google Cloud, vai alla pagina dei job Cloud Run:
Fai clic su Esegui il deployment del contenitore e seleziona Job per compilare la pagina delle impostazioni iniziali del job. Se stai configurando un job esistente, seleziona il job, quindi fai clic su Modifica.
Fai clic su Contenitore, variabili e secret, connessioni, sicurezza per espandere la pagina delle proprietà del job.
Fai clic sul pulsante Variabili e Scheda Secret.
- Nella scheda Variabili e secret:
- In Secret, fai clic su Aggiungi un riferimento secret.
- Seleziona il segreto che vuoi utilizzare dall'elenco a discesa Secret.
- Nel menu a discesa Metodo di riferimento, seleziona il modo in cui vuoi utilizzare il secret, montato come volume o esposto come variabili di ambiente.
- Se stai montando il secret come volume,
- In Percorso di montaggio, specifica il percorso di montaggio che stai utilizzando per i secret.
- Per impostazione predefinita, è selezionata la versione più recente. Se vuoi, puoi selezionare una versione specifica. In Percorsi specificati per le versioni dei secret, specificare il percorso della versione e il relativo numero.
- Fai clic su Fine.
- Se esponi il secret come variabile di ambiente:
- Specifica il nome della variabile e seleziona la versione del secret o più recente per utilizzare sempre la versione attuale del secret.
- Fai clic su Fine.
- Nella scheda Variabili e secret:
Fai clic su Crea o Aggiorna.
gcloud
Per specificare il secret in una variabile di ambiente durante la creazione di un nuovo job:
gcloud run jobs create JOB_NAME \ --image IMAGE_URL \ --set-secrets ENV_VAR_NAME=SECRET_NAME:VERSION
Sostituisci
- JOB_NAME con il nome del tuo job.
- ENV_VAR_NAME con il nome della variabile di ambiente da utilizzare per il secret.
- SECRET_NAME con il nome del segreto nello stesso progetto, ad esempio
mysecret
. - VERSION con la versione del secret. Usa
latest
per la versione più recente versione o un numero, ad esempio2
. - Sostituisci IMAGE_URL con un riferimento all'immagine del container, ad esempio
us-docker.pkg.dev/cloudrun/container/job:latest
.
Puoi specificare diverse coppie di variabile di ambiente/secret, utilizzando una virgola delimitato da un elenco.
Per specificare il secret in una variabile di ambiente durante l'aggiornamento di un job:
gcloud run jobs update JOB_NAME \ --set-secrets ENV_VAR_NAME=SECRET_NAME:VERSION
Per montare il secret come volume durante la creazione di un job:
gcloud run jobs create JOB_NAME \ --image IMAGE_URL \ --set-secrets=PATH=SECRET_NAME:VERSION
Sostituisci:
- JOB_NAME con il nome del tuo job.
- IMAGE_URL con un riferimento all'immagine container, per
esempio,
us-docker.pkg.dev/cloudrun/container/job:latest
PATH
con il percorso di montaggio del volume e il nome del file del secret. Deve iniziare con una barra, ad esempio:/etc/secrets/dbconfig/password
, dove/etc/secrets/dbconfig/
è il percorso di montaggio del volume, mentrepassword
è il nome file del secret.SECRET_NAME
con il nome del segreto nello stesso progetto, ad esempiomysecret
.VERSION
con la versione del secret. Usalatest
per la versione più recente o un numero, ad esempio2
.
Per aggiornare un secret in un job esistente:
gcloud run jobs update JOB_NAME \ --update-secrets=PATH=SECRET_NAME:VERSION
YAML
A causa dei vincoli relativi alla compatibilità delle API, le località dei secret devono essere archiviate in un'annotazione.
Se stai creando un nuovo job, salta questo passaggio. Se stai aggiornando un job esistente, scarica la relativa configurazione YAML:
gcloud run jobs describe JOB_NAME --format export > job.yaml
Per i secret esposti come variabili di ambiente:
apiVersion: run.googleapis.com/v1 kind: Job metadata: name: JOB spec: template: spec: template: spec: containers: - env: - name: SECRET_NAME valueFrom: secretKeyRef: key: VERSION name: SECRET_LOOKUP_NAME image: IMAGE_URL
Sostituisci:
JOB
con il nome del tuo job.- IMAGE_URL con un riferimento all'immagine container, per
ad esempio
us-docker.pkg.dev/cloudrun/container/hello:latest
. Se utilizzi Artifact Registry, il repository REPO_NAME deve essere già creati. L'URL ha la formaLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
SECRET_NAME
con il nome del secret, ad esempiomysecret
.VERSION
con la versione del secret. Usalatest
per la versione più recente o un numero, ad esempio2
.SECRET_LOOKUP_NAME
con qualsiasi nome che abbia un una sintassi valida per il nome del secret (ad es.my-secret
), può essere uguale aSECRET_NAME
Per i secret montati come percorsi file:
apiVersion: run.googleapis.com/v1 kind: Job metadata: name: JOB_NAME spec: template: spec: template: spec: containers: - image: IMAGE_URL volumeMounts: - mountPath: MOUNT_PATH name: VOLUME_NAME volumes: - name: VOLUME_NAME secret: items: - key: VERSION path: FILENAME secretName: SECRET_LOOKUP_NAME
Sostituisci:
JOB_NAME
con il nome del tuo job.- IMAGE_URL con un riferimento all'immagine container, per
ad esempio
us-docker.pkg.dev/cloudrun/container/hello:latest
. Se utilizzi Artifact Registry, il repository REPO_NAME deve essere già stato creato. L'URL ha la formaLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
PATH
con il percorso di montaggio del volume e il nome file del secret. Deve iniziare con una barra, ad esempio:/etc/secrets/dbconfig/password
, dove/etc/secrets/dbconfig/
è il percorso di montaggio del volume, mentrepassword
è il nome file del secret.PROJECT_NUMBER
con il numero del progetto in cui è stato creato il secret.SECRET_NAME
con il nome del secret, ad esempiomysecret
.VERSION
con la versione del secret. Utilizzalatest
per la versione più recente o un numero, ad esempio2
.SECRET_LOOKUP_NAME
con qualsiasi nome che abbia una sintassi di nome secret valida (ad es.my-secret
), può essere uguale aSECRET_NAME
VOLUME_NAME
con qualsiasi nome (ad es.my-volume
), può essere uguale aSECRET_NAME
Fare riferimento ai secret di altri progetti
Puoi fare riferimento a un secret di un altro progetto se all'account di servizio del tuo progetto è stato consentito di accedere al secret.
Console
Nella console Google Cloud, vai alla pagina dei job Cloud Run:
Fai clic su Esegui il deployment del container e seleziona Job per compilare il job iniziale. nella pagina delle impostazioni. Se stai configurando un job esistente, seleziona il job, quindi fai clic su Modifica.
Fai clic su Contenitore, variabili e secret, connessioni, sicurezza per espandere la pagina delle proprietà del job.
Fai clic sul pulsante Variabili e Scheda Secret.
- Nella scheda Variabili e secret:
- In Secret, fai clic su Aggiungi un riferimento secret.
- Seleziona Inserisci il segreto manualmente dall'elenco a discesa Segreti per visualizzare il seguente modulo:
- Nel modulo Aggiungi un secret tramite ID risorsa, inserisci il secret dell'altro progetto nel formato
projects/PROJECT_NUMBER/secrets/SECRET_NAME
. In alternativa, puoi copiare e incollare l'ID risorsa dall'altro progetto se hai accesso, selezionando il segreto, facendo clic sull'elipsis Azioni a destra del segreto e selezionando Copia ID risorsa dal menu a discesa. - Fai clic su Aggiungi secret.
- Nel menu a discesa Metodo di riferimento, seleziona il modo in cui vuoi utilizzare il segreto, montato come volume o esposto come variabili di ambiente.
- Se stai montando il secret come volume,
- In Percorso di montaggio, specifica il percorso di montaggio che stai utilizzando per i secret.
- Per impostazione predefinita, è selezionata la versione più recente. Se vuoi, puoi selezionare una versione specifica. In Percorsi specificati per le versioni dei secret, specifica il percorso della versione e il numero di versione.
- Fai clic su Fine.
- Se esponi il secret come variabile di ambiente:
- Specifica il nome della variabile e seleziona la versione del secret o più recente per utilizzare sempre la versione attuale del secret.
- Fai clic su Fine.
- Nella scheda Variabili e secret:
Fai clic su Crea o Aggiorna.
gcloud
Per montare un secret come volume durante l'aggiornamento di un job:
gcloud run jobs update JOB_NAME \ --image IMAGE_URL \ --update-secrets=PATH=projects/PROJECT_NUMBER/secrets/SECRET_NAME:VERSION
- JOB_NAME con il nome del job.
- IMAGE_URL con un riferimento all'immagine container, per
ad esempio
us-docker.pkg.dev/cloudrun/container/hello:latest
. Se utilizzi Artifact Registry, il repository REPO_NAME deve essere già creati. L'URL ha la formaLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
PATH
con il percorso di montaggio del volume e il nome file del secret. Deve iniziare con una barra, ad esempio:/etc/secrets/dbconfig/password
, dove/etc/secrets/dbconfig/
è il percorso di montaggio del volume, mentrepassword
è il nome file del secret.PROJECT_NUMBER
con il numero del progetto in cui è stato creato il secret.SECRET_NAME
con il nome del secret, ad esempiomysecret
.VERSION
con la versione del secret. Utilizzalatest
per la versione più recente o un numero, ad esempio2
.
YAML
Se stai creando un nuovo job, salta questo passaggio. Se stai aggiornando un job esistente, scarica la relativa configurazione YAML:
gcloud run jobs describe JOB_NAME --format export > job.yaml
A causa dei vincoli relativi alla compatibilità delle API, le località dei secret devono essere archiviate in un'annotazione.
Per i secret esposti come variabili di ambiente:
apiVersion: run.googleapis.com/v1 kind: Job metadata: name: JOB spec: template: metadata: annotations: run.googleapis.com/secrets: SECRET_LOOKUP_NAME:projects/PROJECT_NUMBER/secrets/SECRET_NAME spec: template: spec: containers: - env: - name: SECRET_NAME valueFrom: secretKeyRef: key: VERSION name: SECRET_LOOKUP_NAME image: IMAGE_URL
Sostituisci:
JOB
con il nome del tuo job.- IMAGE_URL con un riferimento all'immagine container, per
ad esempio
us-docker.pkg.dev/cloudrun/container/hello:latest
. Se utilizzi Artifact Registry, il repository REPO_NAME deve essere già creati. L'URL ha la formaLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
SECRET_NAME
con il nome del secret, ad esempiomysecret
.VERSION
con la versione del secret. Utilizzalatest
per la versione più recente o un numero, ad esempio2
.PROJECT_NUMBER
con il numero del progetto in cui è stato creato il secret.SECRET_LOOKUP_NAME
con qualsiasi nome che abbia una sintassi di nome secret valida (ad es.my-secret
), può essere uguale aSECRET_NAME
.
Per i secret montati come percorsi di file:
apiVersion: run.googleapis.com/v1 kind: Job metadata: name: JOB_NAME spec: template: metadata: annotations: run.googleapis.com/secrets: SECRET_LOOKUP_NAME:projects/PROJECT_NUMBER/secrets/SECRET_NAME spec: template: spec: containers: - image: IMAGE_URL volumeMounts: - mountPath: MOUNT_PATH name: VOLUME_NAME volumes: - name: VOLUME_NAME secret: items: - key: VERSION path: FILENAME secretName: SECRET_LOOKUP_NAME
Sostituisci:
JOB_NAME
con il nome del tuo job.- IMAGE_URL con un riferimento all'immagine del container, ad esempio
us-docker.pkg.dev/cloudrun/container/hello:latest
. Se utilizzi Artifact Registry, il repository REPO_NAME deve essere già stato creato. L'URL ha la formaLOCATION-docker.pkg.dev/PROJECT_ID/REPO_NAME/PATH:TAG
PATH
con il percorso di montaggio del volume e il nome file del secret. Deve iniziare con una barra, ad esempio:/etc/secrets/dbconfig/password
, dove/etc/secrets/dbconfig/
è il percorso di montaggio del volume, mentrepassword
è il nome file del secret.PROJECT_NUMBER
con il numero del progetto in cui è stato creato il secret.SECRET_NAME
con il nome del secret, ad esempiomysecret
.VERSION
con la versione del secret. Utilizzalatest
per la versione più recente o un numero, ad esempio2
.SECRET_LOOKUP_NAME
con qualsiasi nome che abbia una sintassi di nome secret valida (ad es.my-secret
), può essere uguale aSECRET_NAME
.VOLUME_NAME
con qualsiasi nome (ad es.my-volume
), può essere uguale aSECRET_NAME
.
Visualizza le impostazioni dei secret
Per visualizzare le impostazioni attuali dei secret per Job Cloud Run:
Console
Nella console Google Cloud, vai alla pagina dei job Cloud Run:
Fai clic sul lavoro che ti interessa per aprire la pagina Dettagli offerta di lavoro.
Fai clic sulla scheda Configuration (Configurazione).
Individua l'impostazione dei secret nella configurazione i dettagli.
gcloud
Utilizza il seguente comando:
gcloud run jobs describe JOB_NAME
Individua l'impostazione dei secret nella configurazione restituita.
Percorsi non consentiti e limitazioni
Cloud Run non consente di montare secret all'indirizzo /dev
,
/proc
e /sys
o nelle relative sottodirectory.
Se monti i secret su /tmp
e utilizzi un
ambiente di esecuzione di prima generazione,
consulta il problema noto relativo al
montaggio dei secret su /tmp
.
Cloud Run non consente di montare più secret nello stesso percorso perché non è possibile montare due volumi nella stessa posizione.
Override di una directory
Se il secret è montato come volume in Cloud Run e l'ultima directory nel percorso di montaggio del volume esiste già, tutti i file o le cartelle nella directory esistente diventano inaccessibili.
Ad esempio, se un segreto denominato my-secret
è montato sul percorso/etc/app_data
, tutti i contenuti all'interno della directory app_data
verranno sovrascritti e l'unico file visibile sarà /etc/app_data/my-secret
.
Per evitare di sovrascrivere i file di una directory esistente, crea una nuova directory per
il secret, ad esempio /etc/app_data/secrets
, in modo che il token di montaggio
il percorso del secret è /etc/app_data/secrets/my-secret
.