Übersicht
Die vortrainierten APIs sind eine Sammlung von KI-Diensten, darunter die optische Zeichenerkennung (Optical Character Recognition, OCR), Speech-to-Text und Translation. Die Dienste werden über die KRM-API (Kubernetes Resource Model) aktiviert und deaktiviert. Die KRM API ist eine Verwaltungs-API, die optional von AI Platform Admin verwendet wird.
Diese Seite dient nur zu Informationszwecken.
aiplatform.private.gdc.goog/v1
Das Paket v1 enthält API-Schemadefinitionen für die API-Gruppe „aiplatform.private.gdc.goog“ v1.
Benachrichtigungen
„Alerting“ enthält die Namen der ConfigMaps, die verarbeitet und in CRs für Benachrichtigungen der Observability Platform umgewandelt werden sollen: MonitoringRule und LoggingRule.
Wird angezeigt in: - Beobachtbarkeit
| Feld | Beschreibung |
|---|---|
monitoringAlertsConfigMap String |
ConfigMap mit eingebetteter MonitoringRule CR, die aus dem Remote-K8s-Cluster abgerufen und verarbeitet wird, indem sie in eine Observability Platform MonitoringRule CR umgewandelt und im Administratorcluster bereitgestellt wird. |
loggingAlertsConfigMap String |
ConfigMap mit eingebetteter LoggingRule CR, die aus dem Remote-K8s-Cluster abgerufen und verarbeitet wird, indem sie in eine Observability Platform LoggingRule CR umgewandelt und im Administratorcluster bereitgestellt wird. |
AppConfig
AppConfig ist das Schema für die AppConfig API. Sollte für jeden Namespace einen haben
Erscheint in: - AppConfigList
| Feld | Beschreibung |
|---|---|
apiVersion String |
aiplatform.private.gdc.goog/v1 |
kind String |
AppConfig |
metadata ObjectMeta |
Informationen zu den Feldern von metadata finden Sie in der API-Dokumentation zu Kubernetes. |
spec AppConfigSpec |
|
status AppConfigStatus |
AppConfigList
AppConfigList enthält eine Liste von AppConfig-Objekten.
| Feld | Beschreibung |
|---|---|
apiVersion String |
aiplatform.private.gdc.goog/v1 |
kind String |
AppConfigList |
metadata ListMeta |
Informationen zu den Feldern von metadata finden Sie in der API-Dokumentation zu Kubernetes. |
items AppConfig-Array |
AppConfigSpec
Wird angezeigt in: - AppConfig
| Feld | Beschreibung |
|---|---|
sql Datenbank |
AppConfigStatus
AppConfigStatus definiert den beobachteten Status von AppConfig.
Wird angezeigt in: - AppConfig
| Feld | Beschreibung |
|---|---|
ready boolean |
„Bereit“ gibt an, ob sich die Ressource in einem bereiten Zustand befindet. |
primaryCondition ResourceCondition |
PrimaryCondition stellt die primäre Bedingung einer Ressource dar. Wenn die Ressource bereit ist, wird dies im Zustand angegeben. Andernfalls ist die Bedingung der Hauptgrund dafür, dass die Ressource nicht bereit ist. |
resourceConditions ResourceCondition-Array |
„ResourceConditions“ ist eine Sammlung von Bedingungen für eine Ressource und ihre untergeordneten Ressourcen. Damit kann der Allgemeinzustand einer Ressource und ihrer Unterressourcen ermittelt werden. |
conditions Bedingungs-Array |
„Conditions“ stellt Rohressourcenbedingungen dar, die aus Kubernetes-Ressourcen zur Fehlerbehebung abgeleitet werden. |
database DatabaseInfo |
Hier werden die Informationen zur Unterressource „Database“ angezeigt. |
Dashboards
„Dashboards“ enthält eine Liste der Namen der mit Observability Platform-Dashboards kompatiblen ConfigMaps, die verarbeitet werden sollen.
Wird angezeigt in: - Beobachtbarkeit
| Feld | Beschreibung |
|---|---|
configMaps String-Array |
Zu verarbeitende ConfigMaps (mit eingebetteter JSON-Definition für das Grafana-Dashboard). Diese müssen im Nutzercluster und Namespace vorhanden sein, in dem die KI-Arbeitslasten bereitgestellt werden. Die Anzahl der gewünschten Dashboards und der Dashboard-ConfigMaps muss übereinstimmen. Wir gehen davon aus, dass es in der ConfigMap einen einzelnen Schlüssel namens „data“ gibt, der den JSON-String für die Dashboarddefinition enthält. |
Datenbank
„Database“ konfiguriert die Anforderungen an die relationale Datenbank für den Zielmikrodienst.
Erscheint in: - AppConfigSpec
| Feld | Beschreibung |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo definiert den beobachteten Status von Datenbankinformationen.
Erscheint in: - AppConfigStatus
| Feld | Beschreibung |
|---|---|
endpoint String |
|
port String |
HPAStatus
HPAStatus beschreibt die Statusbedingungen des HorizontalPodAutoscaler.
Wird angezeigt in: - MicroserviceStatus
| Feld | Beschreibung |
|---|---|
statusConditions HorizontalPodAutoscalerCondition-Array |
Statusbedingungen |
currentReplicas Ganzzahl |
Anzahl der aktuellen Replikate, die vom HPA verwaltet werden |
desiredReplicas Ganzzahl |
Anzahl der gewünschten Replikate, die von der HPA verwaltet werden |
Logging
Mit „Logging“ wird die Funktion zum Erfassen von Logs für die Observability Platform in GDC mit Air Gap konfiguriert. Aktivieren Sie diese Option nicht, wenn Sie Tests in GKE durchführen, da diese Funktion dort nicht verfügbar ist.
Wird angezeigt in: - Beobachtbarkeit
| Feld | Beschreibung |
|---|---|
enableLogCollection boolean |
EnableLogCollection gibt an, ob die Log-Erfassung über die Observability Platform aktiviert werden soll. |
staticLabels object (keys:string, values:string) |
Wird der Eigenschaft „additionalLabels“ des OP LoggingTargetCR zugeordnet. Statische Labels, die allen erfassten Logeinträgen hinzugefügt werden sollen. Labelnamen dürfen keine Bindestriche („-“) enthalten, Labelwerte schon. |
Messwerte
Mit „Metrics“ wird konfiguriert, wie Messwerte eines Pods erfasst werden.
Wird angezeigt in: - Beobachtbarkeit
| Feld | Beschreibung |
|---|---|
prometheus PrometheusMetrics |
Mikrodienst
„Microservice“ ist das Schema für die Services API.
Wird angezeigt in: - MicroserviceList
| Feld | Beschreibung |
|---|---|
apiVersion String |
aiplatform.private.gdc.goog/v1 |
kind String |
Microservice |
metadata ObjectMeta |
Informationen zu den Feldern von metadata finden Sie in der API-Dokumentation zu Kubernetes. |
spec MicroserviceSpec |
|
status MicroserviceStatus |
MicroserviceList
„MicroserviceList“ enthält eine Liste von „Microservice“.
| Feld | Beschreibung |
|---|---|
apiVersion String |
aiplatform.private.gdc.goog/v1 |
kind String |
MicroserviceList |
metadata ListMeta |
Informationen zu den Feldern von metadata finden Sie in der API-Dokumentation zu Kubernetes. |
items Microservice-Array |
MicroserviceSpec
„MicroserviceSpec“ definiert den gewünschten Status des Mikrodienstes.
Wird angezeigt in: - Mikrodienst
| Feld | Beschreibung |
|---|---|
public boolean |
Gibt an, ob dieser Microservice öffentlich ist. Bei „true“ wird ein DNS-Eintrag und ein öffentlicher Endpunkt bereitgestellt. TLS wird auf dem Gateway auch automatisch gemäß dem DNS-Namen eingerichtet. Das DNS-Präfix ist der Name des Mikrodienstes in den Metadaten. |
enableBucketAccess boolean |
Ob die Konfigurationen für den Storage-Bucket für den Container bereitgestellt werden sollen |
dnsname String |
DNS-Hostname. Dieser Wert wird verwendet, um den DNS-Hostnamen für den Mikrodienst in der GDC-Umgebung zu erstellen, wenn der Mikrodienst öffentlich ist. |
autoscaling |
Autoscaling-Konfigurationen. |
observability Beobachtbarkeit |
Konfiguration der Observability (Logging, Messwerte, Monitoring und Dashboards), von denen einige nur für GDC-Konfigurationen ohne Internetverbindung gelten. |
prerequisites Voraussetzungen |
Konfiguration der Voraussetzungen. |
template PodTemplateSpec |
Vorlage zum Erstellen von Pods im Mikrodienst. Der Mikrodienst enthält zustandslose Bereitstellungen für diese Pods. |
PodSpec
PodSpec ist eine minimalistische Version des Core-PodSpec.
Wird angezeigt in: - PodTemplateSpec
| Feld | Beschreibung |
|---|---|
containers Container-Array |
Gibt Container an. Nicht alle Attribute werden unterstützt. Die in allen Containern angegebenen Ports werden freigegeben. Der erste Container (containers[0]) gilt als primärer Container und wird mit Ressourcenanforderungen für die automatische Knotenbereitstellung getaggt. Die restlichen Container gelten als Hilfscontainer (z.B. Sidecars). |
nodeSelector object (keys:string, values:string) |
NodeSelector ist ein Selektor, der für den Pod zutreffen muss, damit er auf einen Knoten passt. Selektor, der mit den Labels eines Knotens übereinstimmen muss, damit der Pod auf diesem Knoten geplant werden kann. |
volumes Volume-Array |
Liste der Volumes, die in den Pods bereitgestellt werden |
initContainers Container-Array |
Liste der Initialisierungscontainer, die zum Pod gehören. Init-Container werden in der Reihenfolge ausgeführt, bevor die Container gestartet werden. Wenn ein Init-Container fehlschlägt, gilt der Pod als fehlgeschlagen und wird entsprechend seiner restartPolicy behandelt. Der Name eines Init-Containers oder normalen Containers muss unter allen Containern eindeutig sein. Aktualisierung nicht möglich. Weitere Informationen: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
tolerations Toleration-Array |
Falls angegeben, die Toleranzen des Pods. |
serviceAccount String |
Das vorab erstellte Kubernetes-Dienstkonto, das vom Pod verwendet wird. |
PodTemplateSpec
PodTemplateSpec ist ein Containerobjekt für PodSpec und möglicherweise für Metadatenspezifikationen.
Wird angezeigt in: - Mikrodienst
| Feld | Beschreibung |
|---|---|
metadata ObjectMeta |
Informationen zu den Feldern von metadata finden Sie in der API-Dokumentation zu Kubernetes. |
spec PodSpec |
MicroserviceStatus
„MicroserviceStatus“ definiert den beobachteten Status des Mikrodienstes.
Wird angezeigt in: - Mikrodienst
| Feld | Beschreibung |
|---|---|
observedGeneration Ganzzahl |
Die vom Deployment-Controller beobachtete Generation. |
endpoint String |
Der Endpunkt, über den auf diesen Mikrodienst zugegriffen werden kann. Wird nur für öffentliche Dienste ausgefüllt. |
deploymentStatus DeploymentStatus |
Der Bereitstellungsstatus dieses Mikrodienstes. |
hpaStatus HPAStatus |
Der Status des HorizontalPodAutoscaler. |
ready boolean |
Gesamtstatus der Bereitschaft des Mikrodienstes |
conditions Bedingungs-Array |
Entspricht den neuesten verfügbaren Beobachtungen zum aktuellen Status eines Microservice. |
Beobachtbarkeit
Mit der Observability-Konfiguration werden die verschiedenen Komponenten und Parameter konfiguriert, die für die Observability-Plattform (in GDC Air-Gap) oder die Bereitstellung von Messwerten (in GKE) erforderlich sind.
Wird angezeigt in: - MicroserviceSpec
| Feld | Beschreibung |
|---|---|
metrics Messwerte |
Messwertkonfiguration. In GKE werden sie nur für den ersten Container erhoben. In GDC mit Air Gap wird dies in Verbindung mit dem Abschnitt „Observability“ verwendet, um das Verhalten der Observability-Plattform zu konfigurieren. |
logging Logging |
|
alerting Benachrichtigungen |
|
dashboards Dashboards |
PostgresConfig
Mit PostgresConfig werden die relevanten Zielkonfigurationseinstellungen für eine Postgres-Datenbank definiert.
Wird angezeigt in: - Datenbank
| Feld | Beschreibung |
|---|---|
version String |
Vorbereitung
Mit „Prerequisites“ werden alle Voraussetzungen für den Mikrodienst konfiguriert.
Wird angezeigt in: - MicroserviceSpec
| Feld | Beschreibung |
|---|---|
sql boolean |
SQL-Konfiguration, falls für die Zielarbeitslast erforderlich |
PrometheusMetrics
Mit PrometheusMetrics werden die von einem Pod bereitgestellten Prometheus-Messwerte konfiguriert.
Wird angezeigt in: - Messwerte
| Feld | Beschreibung |
|---|---|
path String |
Der URI-Pfad für Messwerte, aus dem Messwerte extrahiert werden sollen. Die Standardeinstellung ist „/metrics“. |
port Ganzzahl |
Der Port, von dem Messwerte erfasst werden sollen. Die Standardeinstellung ist 80. |