REST Resource: projects.locations.deliveryPipelines.targets

Risorsa: destinazione

Una risorsa Target nell'API Google Cloud Deploy.

Un Target definisce una località in cui è possibile eseguire il deployment di una configurazione Skaffold.

Rappresentazione JSON
{
  "name": string,
  "targetId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "requireApproval": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionConfigs": [
    {
      object (ExecutionConfig)
    }
  ],

  // Union field deployment_target can be only one of the following:
  "gkeCluster": {
    object (GKECluster)
  },
  "cluster": {
    object (GkeCluster)
  },
  "gke": {
    object (GkeCluster)
  }
  // End of list of possible types for union field deployment_target.
}
Campi
name

string

Facoltativo. Nome di Target. Il formato è projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/targets/[a-z][a-z0-9-]{0,62}.

targetId

string

Solo output. ID risorsa di Target.

uid

string

Solo output. Identificatore univoco di Target.

description

string

Facoltativo. Descrizione del Target. La lunghezza massima è di 255 caratteri.

annotations

map (key: string, value: string)

Facoltativo. Annotazioni dell'utente. Questi attributi possono essere impostati e utilizzati solo dall'utente e non da Google Cloud Deploy. Consulta la pagina https://google.aip.dev/128#annotations per ulteriori dettagli quali le limitazioni relative a formato e dimensioni.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

labels

map (key: string, value: string)

Facoltativo. Le etichette sono attributi che possono essere impostati e utilizzati sia dall'utente sia da Google Cloud Deploy. Le etichette devono soddisfare i seguenti vincoli: Ogni risorsa ha un limite di 64 etichette. Le chiavi devono essere conformi all'espressione regolare: [a-zA-Z][a-zA-Z0-9_-]{0,62} I valori devono essere conformi all'espressione regolare: [a-zA-Z0-9_-]{0,63} Sia le chiavi che i valori sono inoltre vincolati a una dimensione inferiore a 128 byte.

Un oggetto contenente un elenco di "key": value coppie. Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

requireApproval

boolean

Facoltativo. Indica se Target richiede o meno l'approvazione.

createTime

string (Timestamp format)

Solo output. Ora in cui è stato creato l'elemento Target.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Solo output. Ora più recente dell'aggiornamento di Target.

Un timestamp in formato "Zulu" RFC3339 UTC, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

etag

string

Facoltativo. Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato in caso di richieste di aggiornamento ed eliminazione per garantire che il client abbia un valore aggiornato prima di procedere.

executionConfigs[]

object (ExecutionConfig)

Configurazioni per tutte le esecuzioni correlate a questo Target. Ogni valore ExecutionEnvironmentUsage può essere utilizzato in un'unica configurazione; utilizzare lo stesso valore più volte è un errore. Quando vengono specificate una o più configurazioni, è necessario includere i valori ExecutionEnvironmentUsage di RENDER e DEPLOY. Se non viene specificata alcuna configurazione, l'esecuzione utilizzerà il valore predefinito specificato in DefaultPool.

Campo di unione deployment_target. Destinazione a cui viene applicata la configurazione Skaffold durante un'implementazione. deployment_target può essere solo uno dei seguenti:
gkeCluster

object (GKECluster)

Informazioni che specificano un cluster GKE.

cluster

object (GkeCluster)

Informazioni che specificano un cluster GKE.

gke

object (GkeCluster)

Informazioni che specificano un cluster GKE.

GKECluster

Informazioni che specificano un cluster GKE.

Rappresentazione JSON
{
  "project": string,
  "cluster": string,
  "location": string
}
Campi
project

string

Progetto in cui si trova il cluster.

cluster

string

Nome del cluster.

location

string

Località del cluster.

GkeCluster

Informazioni che specificano un cluster GKE.

Rappresentazione JSON
{
  "cluster": string
}
Campi
cluster

string

Informazioni che specificano un cluster GKE. Il formato è "projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.

ExecutionConfig

Configurazione dell'ambiente da utilizzare per la chiamata a Skaffold.

Rappresentazione JSON
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],

  // Union field execution_environment can be only one of the following:
  "defaultPool": {
    object (DefaultPool)
  },
  "privatePool": {
    object (PrivatePool)
  }
  // End of list of possible types for union field execution_environment.
}
Campi
usages[]

enum (ExecutionEnvironmentUsage)

Obbligatorio. Utilizzo quando deve essere applicata questa configurazione.

Campo di unione execution_environment. Dettagli dell'ambiente. execution_environment può essere solo uno dei seguenti:
defaultPool

object (DefaultPool)

Facoltativo. Usa il pool di Cloud Build predefinito.

privatePool

object (PrivatePool)

Facoltativo. Usa il pool di Cloud Build privato.

ExecutionEnvironmentUsage

Possibili utilizzi di questa configurazione.

Enum
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Valore predefinito. Questo valore non è utilizzato.
RENDER Da utilizzare per il rendering.
DEPLOY Da utilizzare per gli hook di deployment e deployment.

DefaultPool

Esecuzione con il pool Cloud Build predefinito.

Rappresentazione JSON
{
  "serviceAccount": string,
  "artifactStorage": string
}
Campi
serviceAccount

string

Facoltativo. Account di servizio Google da utilizzare per l'esecuzione. Se non specificato, verrà utilizzato l'account di servizio di esecuzione del progetto (-compute@developer.gserviceaccount.com).

artifactStorage

string

Facoltativo. Località di Cloud Storage in cui devono essere archiviati gli output di esecuzione. Può essere un bucket ("gs://my-bucket") o un percorso all'interno di un bucket ("gs://my-bucket/my-dir"). Se non specificato, verrà utilizzato un bucket predefinito che si trova nella stessa regione.

PrivatePool

Esecuzione con un pool Cloud Build privato.

Rappresentazione JSON
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Campi
workerPool

string

Obbligatorio. Nome della risorsa del pool di worker Cloud Build da utilizzare. Il formato è projects/{project}/locations/{location}/workerPools/{pool}.

serviceAccount

string

Facoltativo. Account di servizio Google da utilizzare per l'esecuzione. Se non specificato, verrà utilizzato l'account di servizio di esecuzione del progetto (-compute@developer.gserviceaccount.com).

artifactStorage

string

Facoltativo. Località di Cloud Storage in cui devono essere archiviati gli output di esecuzione. Può essere un bucket ("gs://my-bucket") o un percorso all'interno di un bucket ("gs://my-bucket/my-dir"). Se non specificato, verrà utilizzato un bucket predefinito che si trova nella stessa regione.

Metodi

create

Crea un nuovo target in un progetto e una località specifici.

delete

Elimina una singola destinazione condivisa.

get

Recupera i dettagli di un singolo target condiviso.

list

Elenca le destinazioni in un determinato progetto e località.

patch

Aggiorna i parametri di un singolo target condiviso.