Panoramica
Le API preaddestrate sono una raccolta di servizi AI che includono il riconoscimento ottico dei caratteri (OCR), Speech-to-Text e la traduzione. 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 AI Platform.
Lo scopo di questa pagina è fornire solo informazioni.
aiplatform.private.gdc.goog/v1
Il pacchetto v1 contiene definizioni dello schema API per il gruppo di API v1 di aiplatform.private.gdc.goog
Avvisi
Alerting contiene i nomi delle ConfigMap da elaborare e trasformare in CR di avvisi della piattaforma di osservabilità: MonitoringRule e LoggingRule.
Visualizzato in: - Osservabilità
| Campo | Descrizione |
|---|---|
monitoringAlertsConfigMap stringa |
Configmap con CR MonitoringRule incorporato da recuperare dal cluster K8s remoto ed elaborare trasformandolo in un CR MonitoringRule della piattaforma di osservabilità e distribuirlo al cluster di amministrazione. |
loggingAlertsConfigMap stringa |
ConfigMap con CR LoggingRule incorporato da recuperare dal cluster K8s remoto ed elaborare trasformandolo in un CR LoggingRule della piattaforma di osservabilità e eseguirlo il deployment nel cluster di amministrazione. |
AppConfig
AppConfig è lo schema per l'API AppConfig. Deve essercene uno per spazio dei nomi
Visualizzato in: - AppConfigList
| Campo | Descrizione |
|---|---|
apiVersion stringa |
aiplatform.private.gdc.goog/v1 |
kind stringa |
AppConfig |
metadata ObjectMeta |
Per i campi di metadata, consulta la documentazione dell'API Kubernetes. |
spec AppConfigSpec |
|
status AppConfigStatus |
AppConfigList
AppConfigList contiene un elenco di AppConfig
| Campo | Descrizione |
|---|---|
apiVersion stringa |
aiplatform.private.gdc.goog/v1 |
kind stringa |
AppConfigList |
metadata ListMeta |
Per i campi di metadata, consulta la documentazione dell'API Kubernetes. |
items Array AppConfig |
AppConfigSpec
Visualizzato in: - AppConfig
| Campo | Descrizione |
|---|---|
sql Database |
AppConfigStatus
AppConfigStatus definisce lo stato osservato di AppConfig.
Visualizzato in: - AppConfig
| Campo | Descrizione |
|---|---|
ready boolean |
Pronto 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 è 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 risorse secondarie. Può essere utilizzato per determinare lo stato generale di una risorsa e delle relative risorse secondarie. |
conditions Array Condition |
Conditions rappresenta le condizioni delle risorse non elaborate popolate dalle risorse Kubernetes a scopo di debug. |
database DatabaseInfo |
Mostra le informazioni sulla risorsa secondaria Database. |
Dashboard
Dashboard contiene un elenco dei nomi dei configmap compatibili con le dashboard della piattaforma di osservabilità da elaborare.
Visualizzato in: - Osservabilità
| Campo | Descrizione |
|---|---|
configMaps array di stringhe |
ConfigMaps (con definizione JSON della dashboard Grafana incorporata) da elaborare. Questi file devono esistere nel cluster utente e nello spazio dei nomi in cui vengono implementati i carichi di lavoro AI. Deve esistere una mappatura 1:1 tra il numero di dashboard desiderate e i configmap delle dashboard. Supponiamo che nella configmap ci sia una sola chiave: "data", che conterrà la stringa JSON di definizione del dashboard. |
Database
Database configura i requisiti del database relazionale per il microservizio di destinazione.
Visualizzato in: - AppConfigSpec
| Campo | Descrizione |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo definisce lo stato osservato delle informazioni sul database.
Visualizzato in: - AppConfigStatus
| Campo | Descrizione |
|---|---|
endpoint stringa |
|
port stringa |
HPAStatus
HPAStatus descrive le condizioni di stato di HorizontalPodAutoscaler.
Visualizzato in: - MicroserviceStatus
| Campo | Descrizione |
|---|---|
statusConditions HorizontalPodAutoscalerCondition |
Condizioni di stato |
currentReplicas integer |
Numero di repliche attuali gestite da HPA |
desiredReplicas integer |
Numero di repliche desiderate gestite da HPA |
Logging
Logging configura la funzionalità di raccolta dei log per la piattaforma di osservabilità su GDC air-gapped (non abilitare se esegui test su GKE, questa funzionalità non si applica).
Visualizzato in: - Osservabilità
| Campo | Descrizione |
|---|---|
enableLogCollection boolean |
EnableLogCollection indica se abilitare o meno la raccolta dei log tramite la piattaforma di osservabilità. |
staticLabels object (keys:string, values:string) |
Corrisponde alla proprietà "additionalLabels" di OP LoggingTargetCR. Etichette statiche da aggiungere a tutte le voci di log acquisite. I nomi delle etichette non devono contenere trattini ("-"), mentre i valori delle etichette possono contenerli. |
Metriche
Metrics configura la modalità di raccolta delle metriche di un pod.
Visualizzato in: - Osservabilità
| Campo | Descrizione |
|---|---|
prometheus PrometheusMetrics |
Microservizio
Microservice è lo schema per l'API dei servizi
Visualizzato in: - MicroserviceList
| Campo | Descrizione |
|---|---|
apiVersion stringa |
aiplatform.private.gdc.goog/v1 |
kind stringa |
Microservice |
metadata ObjectMeta |
Per i campi di metadata, consulta la documentazione dell'API Kubernetes. |
spec MicroserviceSpec |
|
status MicroserviceStatus |
MicroserviceList
MicroserviceList contiene un elenco di Microservice
| Campo | Descrizione |
|---|---|
apiVersion stringa |
aiplatform.private.gdc.goog/v1 |
kind stringa |
MicroserviceList |
metadata ListMeta |
Per i campi di metadata, consulta la documentazione dell'API Kubernetes. |
items Array di Microservice |
MicroserviceSpec
MicroserviceSpec definisce lo stato desiderato del microservizio.
Visualizzato in: - Microservice
| Campo | Descrizione |
|---|---|
public boolean |
Indica se questo microservizio è pubblico. Se 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 stringa |
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 air-gap di GDC. |
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 di PodSpec di base.
Appare in: - PodTemplateSpec
| Campo | Descrizione |
|---|---|
containers Array di container |
Specifica i container. Non tutti gli attributi sono supportati. Verranno esposte le porte specificate da tutti i container. Il primo container (containers[0]) è considerato il container principale e sarà quello da taggare con le richieste di risorse per il provisioning automatico dei nodi. Il resto dei contenitori è considerato ausiliario (ad es. sidecar). |
nodeSelector object (keys:string, values:string) |
NodeSelector è un selettore che deve essere vero 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 di inizializzazione vengono eseguiti in ordine prima dell'avvio dei container. Se un container init non va a buon fine, il pod viene considerato non riuscito e viene gestito in base a 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 Tolleranza |
Se specificate, le tolleranze del pod. |
serviceAccount stringa |
L'account di servizio Kubernetes pre-creato che verrà utilizzato dal pod. |
PodTemplateSpec
PodTemplateSpec è un oggetto contenitore per PodSpec e potenzialmente per la specifica dei metadati.
Visualizzato in: - Microservice
| Campo | Descrizione |
|---|---|
metadata ObjectMeta |
Per i campi di metadata, consulta la documentazione dell'API Kubernetes. |
spec PodSpec |
MicroserviceStatus
MicroserviceStatus definisce lo stato osservato di Microservice.
Visualizzato in: - Microservice
| Campo | Descrizione |
|---|---|
observedGeneration integer |
La generazione osservata dal controller Deployment. |
endpoint stringa |
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 osservazioni più recenti disponibili sullo stato attuale di un microservizio. |
Osservabilità
Observability configura i vari componenti e parametri richiesti dalla piattaforma di osservabilità (su GDC air-gapped) o dall'esposizione delle metriche (su GKE).
Visualizzato in: - MicroserviceSpec
| Campo | Descrizione |
|---|---|
metrics Metriche |
Configurazione delle metriche. Su GKE vengono raccolti solo sul primo container. Su GDC air-gapped, questa sezione 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.
Visualizzato in: - Database
| Campo | Descrizione |
|---|---|
version stringa |
Prerequisiti
Prerequisites configura tutti i prerequisiti per il microservizio.
Visualizzato in: - MicroserviceSpec
| Campo | Descrizione |
|---|---|
sql boolean |
Configurazione SQL, se richiesta dal workload di destinazione |
PrometheusMetrics
PrometheusMetrics configura le metriche Prometheus esposte da un pod.
Visualizzato in: - Metriche
| Campo | Descrizione |
|---|---|
path stringa |
Il percorso URI delle metriche da estrarre. Il valore predefinito è /metrics. |
port integer |
La porta da cui eseguire lo scraping delle metriche. Il valore predefinito è 80. |