Panoramica
Le API preaddestrate sono una raccolta di servizi di AI che includono il riconoscimento ottico dei caratteri (OCR), Speech-to-Text e Translation. I servizi vengono abilitati e disabilitati utilizzando l'API Kubernetes Resource Model (KRM). L'API KRM è un'API di gestione utilizzata facoltativamente dall'amministratore di Vertex AI Platform.
Lo scopo di questa pagina è fornire solo informazioni.
aiplatform.private.gdc.goog/v1
Il pacchetto v1 contiene le definizioni dello schema dell'API per il gruppo di API aiplatform.private.gdc.goog v1
Avvisi
Alerting contiene i nomi dei ConfigMap da elaborare e trasformare in CR di avviso della piattaforma di osservabilità: MonitoringRule e LoggingRule.
Appare in: - Osservabilità
| Campo | Descrizione |
|---|---|
monitoringAlertsConfigMap string |
ConfigMap con CR MonitoringRule incorporata da recuperare dal cluster K8s remoto ed elaborare trasformandola in una CR MonitoringRule della piattaforma di osservabilità ed eseguirne il deployment nel cluster di amministrazione. |
loggingAlertsConfigMap string |
ConfigMap con CR LoggingRule incorporata da recuperare dal cluster K8s remoto ed elaborare trasformandola in una CR LoggingRule della piattaforma di osservabilità ed eseguirne il deployment nel cluster di amministrazione. |
AppConfig
AppConfig è lo schema per l'API AppConfig. Deve essere presente un solo elemento per spazio dei nomi
Presente in: - AppConfigList
| Campo | Descrizione |
|---|---|
apiVersion string |
aiplatform.private.gdc.goog/v1 |
kind string |
AppConfig |
metadata ObjectMeta |
Consulta la documentazione dell'API Kubernetes per i campi di metadata. |
spec AppConfigSpec |
|
status AppConfigStatus |
AppConfigList
AppConfigList contiene un elenco di AppConfig
| Campo | Descrizione |
|---|---|
apiVersion string |
aiplatform.private.gdc.goog/v1 |
kind string |
AppConfigList |
metadata ListMeta |
Consulta la documentazione dell'API Kubernetes per i campi di metadata. |
items AppConfig |
AppConfigSpec
Viene visualizzato in: - AppConfig
| Campo | Descrizione |
|---|---|
sql Database |
AppConfigStatus
AppConfigStatus definisce lo stato osservato di AppConfig.
Viene visualizzato in: - AppConfig
| Campo | Descrizione |
|---|---|
ready boolean |
Ready indica se la risorsa è in stato Pronto. |
primaryCondition ResourceCondition |
PrimaryCondition rappresenta la condizione principale di una risorsa. Se la risorsa è pronta, la condizione indicherà che la risorsa è pronta. In caso contrario, la condizione sarà il motivo principale per cui la risorsa non è pronta. |
resourceConditions Array ResourceCondition |
ResourceConditions è una raccolta di condizioni per una risorsa e le relative sottorisorse. Può essere utilizzato per determinare lo stato di integrità complessivo di una risorsa e delle relative risorse secondarie. |
conditions Array Condition |
Conditions rappresenta le condizioni delle risorse non elaborate compilate dalle risorse Kubernetes per il debug. |
database DatabaseInfo |
Presenta le informazioni sulla risorsa secondaria Database. |
Dashboard
Dashboards contiene un elenco dei nomi dei ConfigMap compatibili con la dashboard della piattaforma di osservabilità da elaborare.
Appare in: - Osservabilità
| Campo | Descrizione |
|---|---|
configMaps array di stringhe |
ConfigMap (con definizione JSON della dashboard di Grafana incorporata) da elaborare; si prevede che esistano nel cluster utente e nello spazio dei nomi in cui viene eseguito il deployment dei workload AI. Deve esserci una mappatura 1:1 tra il numero di dashboard desiderate e le ConfigMap delle dashboard. Supponiamo che nella mappa di configurazione sia presente una singola chiave: "data", che conterrà la stringa JSON di definizione della dashboard. |
Database
Database configura i requisiti del database relazionale per il microservizio di destinazione.
Appare in: - AppConfigSpec
| Campo | Descrizione |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo definisce lo stato osservato delle informazioni del database.
Presente in: - AppConfigStatus
| Campo | Descrizione |
|---|---|
endpoint string |
|
port string |
HPAStatus
HPAStatus descrive le condizioni di stato di HorizontalPodAutoscaler.
Appare in: - MicroserviceStatus
| Campo | Descrizione |
|---|---|
statusConditions Array HorizontalPodAutoscalerCondition |
Condizioni di stato |
currentReplicas integer |
Numero di repliche attuali gestite dall'HPA |
desiredReplicas integer |
Numero di repliche desiderate gestite dall'HPA |
Logging
Logging configura la funzionalità di raccolta dei log per la piattaforma di osservabilità su GDC con air gap (non attivare se esegui test su GKE, questa funzionalità non è applicabile in questo caso).
Appare in: - Osservabilità
| Campo | Descrizione |
|---|---|
enableLogCollection boolean |
EnableLogCollection indica se abilitare o meno la raccolta dei log tramite la piattaforma di osservabilità. |
staticLabels oggetto (chiavi:stringa, valori:stringa) |
Esegue la mappatura alla proprietà "additionalLabels" della risorsa LoggingTargetCR di OP. Etichette statiche da aggiungere a tutte le voci di log acquisite. I nomi delle etichette non devono contenere trattini ("-"); i valori delle etichette possono contenere trattini. |
Metriche
Metrics configura la modalità di raccolta delle metriche di un pod.
Appare in: - Osservabilità
| Campo | Descrizione |
|---|---|
prometheus PrometheusMetrics |
Microservizio
Microservice è lo schema per l'API dei servizi
Appare in: - MicroserviceList
| Campo | Descrizione |
|---|---|
apiVersion string |
aiplatform.private.gdc.goog/v1 |
kind string |
Microservice |
metadata ObjectMeta |
Consulta la documentazione dell'API Kubernetes per i campi di metadata. |
spec MicroserviceSpec |
|
status MicroserviceStatus |
MicroserviceList
MicroserviceList contiene un elenco di microservizi
| Campo | Descrizione |
|---|---|
apiVersion string |
aiplatform.private.gdc.goog/v1 |
kind string |
MicroserviceList |
metadata ListMeta |
Consulta la documentazione dell'API Kubernetes per i campi di metadata. |
items Array di microservizi |
MicroserviceSpec
MicroserviceSpec definisce lo stato desiderato di Microservice.
Appare in: - Microservizio
| Campo | Descrizione |
|---|---|
public boolean |
Indica se questo microservizio è pubblico. Se impostato su true, avrà un record DNS esposto e un endpoint pubblico. Anche TLS verrà configurato automaticamente sul gateway in base al nome DNS. Il prefisso DNS sarà il nome del microservizio nei metadati. |
enableBucketAccess boolean |
Se eseguire il provisioning delle configurazioni relative al bucket di archiviazione nel container |
dnsname string |
Nome host DNS. Verrà utilizzato per creare il nome host DNS per il microservizio nell'ambiente GDC quando il microservizio è pubblico |
autoscaling |
Configurazioni di scalabilità automatica. |
observability Osservabilità |
Configurazione dell'osservabilità (logging, metriche, monitoraggio e dashboard), alcune delle quali sono applicabili solo alle configurazioni GDC con air gap. |
prerequisites Prerequisiti |
Configurazione dei prerequisiti. |
template PodTemplateSpec |
Modello per creare pod nel microservizio. Il microservizio conterrà deployment stateless per questi pod. |
PodSpec
PodSpec è una versione minimalista del PodSpec principale.
Presente in: - PodTemplateSpec
| Campo | Descrizione |
|---|---|
containers Array di container |
Specifica i container. Non tutti gli attributi sono supportati. Verranno esposte le porte specificate di tutti i container. Il primo container (containers[0]) è considerato il container principale e verrà taggato con le richieste di risorse per il provisioning automatico dei nodi. Il resto dei container è considerato ausiliario (ad es. sidecar). |
nodeSelector oggetto (chiavi:stringa, valori:stringa) |
NodeSelector è un selettore che deve essere true affinché il pod possa essere inserito in un nodo. Selettore che deve corrispondere alle etichette di un nodo affinché il pod venga pianificato su quel nodo. |
volumes Array Volume |
Elenco dei volumi che verranno montati sui pod |
initContainers Array di container |
Elenco dei container di inizializzazione appartenenti al pod. I container init vengono eseguiti in ordine prima dell'avvio dei container. Se un container init non riesce, il pod viene considerato non riuscito e viene gestito in base alla sua restartPolicy. Il nome di un container init o di un container normale deve essere univoco tra tutti i container. Impossibile aggiornare. Scopri di più: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
tolerations Array di tolleranze |
Se specificate, le tolleranze del pod. |
serviceAccount string |
Il account di servizio Kubernetes precreato che verrà utilizzato dal pod. |
PodTemplateSpec
PodTemplateSpec è un oggetto container per PodSpec ed eventualmente per la specifica dei metadati.
Appare in: - Microservizio
| Campo | Descrizione |
|---|---|
metadata ObjectMeta |
Consulta la documentazione dell'API Kubernetes per i campi di metadata. |
spec PodSpec |
MicroserviceStatus
MicroserviceStatus definisce lo stato osservato del microservizio.
Appare in: - Microservizio
| Campo | Descrizione |
|---|---|
observedGeneration integer |
La generazione osservata dal controller Deployment. |
endpoint string |
L'endpoint da cui è accessibile questo microservizio. Compilato solo per i servizi pubblici. |
deploymentStatus DeploymentStatus |
Lo stato di deployment di questo microservizio. |
hpaStatus HPAStatus |
Lo stato di HorizontalPodAutoscaler. |
ready boolean |
Stato di idoneità complessivo del microservizio |
conditions Array Condition |
Rappresenta le ultime osservazioni disponibili dello stato attuale di un microservizio. |
Osservabilità
Observability configura i vari componenti e parametri richiesti dalla piattaforma di osservabilità (su GDC con air gap) o dall'esposizione delle metriche (su GKE).
Viene visualizzato in: - MicroserviceSpec
| Campo | Descrizione |
|---|---|
metrics Metriche |
Configurazione delle metriche. Su GKE, vengono raccolti solo sul primo container. In GDC con air gap, viene utilizzata insieme alla sezione Osservabilità per configurare il comportamento della piattaforma di osservabilità. |
logging Logging |
|
alerting Avvisi |
|
dashboards Dashboard |
PostgresConfig
PostgresConfig definisce le impostazioni di configurazione di destinazione pertinenti per un database Postgres.
Appare in: - Database
| Campo | Descrizione |
|---|---|
version string |
Prerequisiti
Prerequisites configura i prerequisiti per il microservizio.
Viene visualizzato in: - MicroserviceSpec
| Campo | Descrizione |
|---|---|
sql boolean |
Configurazione SQL, se richiesta dal workload di destinazione |
PrometheusMetrics
PrometheusMetrics configura le metriche di Prometheus esposte da un pod.
Disponibile in: - Metriche
| Campo | Descrizione |
|---|---|
path string |
Il percorso URI delle metriche da cui eseguire lo scraping delle metriche. Il valore predefinito è /metrics. |
port integer |
La porta da cui eseguire lo scraping delle metriche. Il valore predefinito è 80. |