Présentation
Les API pré-entraînées sont un ensemble de services d'IA qui incluent la reconnaissance optique des caractères (OCR), Speech-to-Text et Translation. Les services sont activés et désactivés à l'aide de l'API Kubernetes Resource Model (KRM). L'API KRM est une API de gestion utilisée de manière facultative par l'administrateur AI Platform.
Cette page a pour seul objectif de fournir des informations.
aiplatform.private.gdc.goog/v1
Le package v1 contient des définitions de schéma d'API pour le groupe d'API aiplatform.private.gdc.goog v1.
Alertes
"Alerting" contient les noms des ConfigMaps à traiter et à transformer en CR d'alerte de la plate-forme d'observabilité : MonitoringRule et LoggingRule.
Apparaît dans :Observability
| Champ | Description |
|---|---|
chaîne monitoringAlertsConfigMap |
Configmap avec CR MonitoringRule intégré à extraire du cluster K8s distant et à traiter en le transformant en CR MonitoringRule de la plate-forme d'observabilité, puis à déployer sur le cluster d'administrateur. |
chaîne loggingAlertsConfigMap |
ConfigMap avec CR LoggingRule intégré à extraire du cluster K8s distant et à traiter en le transformant en CR LoggingRule de la plate-forme d'observabilité et en le déployant sur le cluster d'administrateur. |
AppConfig
AppConfig est le schéma de l'API AppConfig. Doit en avoir un par espace de noms
Apparaît dans :AppConfigList
| Champ | Description |
|---|---|
chaîne apiVersion |
aiplatform.private.gdc.goog/v1 |
chaîne kind |
AppConfig |
metadata ObjectMeta |
Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata. |
spec AppConfigSpec |
|
status AppConfigStatus |
AppConfigList
AppConfigList contient une liste d'AppConfig.
| Champ | Description |
|---|---|
chaîne apiVersion |
aiplatform.private.gdc.goog/v1 |
chaîne kind |
AppConfigList |
metadata ListMeta |
Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata. |
Tableau AppConfig items |
AppConfigSpec
Apparaît dans :AppConfig
| Champ | Description |
|---|---|
sql Base de données |
AppConfigStatus
AppConfigStatus définit l'état observé d'AppConfig.
Apparaît dans :AppConfig
| Champ | Description |
|---|---|
ready booléen |
"Ready" indique si la ressource est prête. |
primaryCondition ResourceCondition |
PrimaryCondition représente la condition principale d'une ressource. Si la ressource est prête, la condition l'indiquera. Sinon, la condition sera la principale raison pour laquelle la ressource n'est pas prête. |
resourceConditions Tableau ResourceCondition |
ResourceConditions est une collection de conditions pour une ressource et ses sous-ressources. Elle peut être utilisée pour déterminer l'état général d'une ressource et de ses sous-ressources. |
Tableau Condition conditions |
"Conditions" représente les conditions de ressources brutes issues des ressources Kubernetes à des fins de débogage. |
database DatabaseInfo |
Présente les informations sur la sous-ressource Database. |
Tableaux de bord
"dashboards" contient la liste des noms des configmaps compatibles avec les tableaux de bord de la plate-forme Observability à traiter.
Apparaît dans :Observability
| Champ | Description |
|---|---|
Tableau de chaînes configMaps |
ConfigMaps (avec définition JSON du tableau de bord Grafana intégré) à traiter. Ils doivent exister dans le cluster d'utilisateur et l'espace de noms dans lesquels les charges de travail d'IA sont déployées. Le nombre de tableaux de bord souhaités doit correspondre au nombre de configmaps de tableaux de bord. Nous partons du principe qu'il y aura une seule clé dans le configmap : "data", qui contiendra la chaîne JSON de définition du tableau de bord. |
Base de données
La base de données configure les exigences de la base de données relationnelle pour le microservice cible.
Apparaît dans :AppConfigSpec
| Champ | Description |
|---|---|
postgres PostgresConfig |
DatabaseInfo
DatabaseInfo définit l'état observé des informations sur la base de données.
Apparaît dans :AppConfigStatus
| Champ | Description |
|---|---|
chaîne endpoint |
|
chaîne port |
HPAStatus
HPAStatus décrit les conditions d'état de HorizontalPodAutoscaler.
Apparaît dans :MicroserviceStatus
| Champ | Description |
|---|---|
statusConditions HorizontalPodAutoscalerCondition |
Conditions d'état |
Entier currentReplicas |
Nombre actuel d'instances répliquées gérées par AHP |
Entier desiredReplicas |
Nombre d'instances dupliquées souhaité géré par le AHP |
Journalisation
La journalisation configure la fonctionnalité de collecte des journaux pour la plate-forme d'observabilité sur GDC air-gapped (ne l'activez pas si vous effectuez des tests sur GKE, car cette fonctionnalité ne s'y applique pas).
Apparaît dans :Observability
| Champ | Description |
|---|---|
enableLogCollection booléen |
EnableLogCollection indique s'il faut activer ou non la collecte des journaux via la plate-forme d'observabilité. |
staticLabels objet (clés : chaîne, valeurs : chaîne) |
Correspond à la propriété "additionalLabels" de l'OP LoggingTargetCR. Libellés statiques à ajouter à toutes les entrées de journal capturées. Les noms de libellés ne doivent pas contenir de tirets ("-"), mais les valeurs de libellés peuvent en contenir. |
Métriques
Metrics configure la façon dont les métriques d'un pod seront collectées.
Apparaît dans :Observability
| Champ | Description |
|---|---|
prometheus PrometheusMetrics |
Microservice
Microservice est le schéma de l'API des services.
Apparaît dans :MicroserviceList
| Champ | Description |
|---|---|
chaîne apiVersion |
aiplatform.private.gdc.goog/v1 |
chaîne kind |
Microservice |
metadata ObjectMeta |
Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata. |
spec MicroserviceSpec |
|
status MicroserviceStatus |
MicroserviceList
MicroserviceList contient une liste de Microservice.
| Champ | Description |
|---|---|
chaîne apiVersion |
aiplatform.private.gdc.goog/v1 |
chaîne kind |
MicroserviceList |
metadata ListMeta |
Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata. |
Tableau Microservice items |
MicroserviceSpec
MicroserviceSpec définit l'état souhaité de Microservice.
Apparaît dans :Microservice
| Champ | Description |
|---|---|
public booléen |
Indique si ce microservice est public. Si la valeur est "true", un enregistrement DNS d'exposition et un point de terminaison public seront disponibles. TLS sera également configuré automatiquement sur la passerelle en fonction du nom DNS. Le préfixe DNS correspondra au nom du microservice dans les métadonnées. |
enableBucketAccess booléen |
Indique si les configurations associées au bucket de stockage doivent être provisionnées dans le conteneur. |
chaîne dnsname |
Nom d'hôte DNS. Il sera utilisé pour construire le nom d'hôte DNS du microservice dans l'environnement GDC lorsque le microservice est public. |
autoscaling |
Configurations de l'autoscaling. |
observability Observabilité |
Configuration de l'observabilité (journalisation, métriques, surveillance et tableaux de bord), dont certaines ne s'appliquent qu'aux configurations GDC isolées. |
prerequisites Conditions préalables |
Configuration des prérequis. |
template PodTemplateSpec |
Modèle permettant de créer des pods dans le microservice. Le microservice contiendra des déploiements sans état pour ces pods. |
PodSpec
PodSpec est une version minimaliste du PodSpec principal.
Apparaît dans :PodTemplateSpec
| Champ | Description |
|---|---|
Tableau Container containers |
Spécifie les conteneurs. Tous les attributs ne sont pas acceptés. Les ports spécifiés à partir de tous les conteneurs seront exposés. Le premier conteneur (containers[0]) est considéré comme le conteneur principal et sera celui qui sera associé aux demandes de ressources pour le provisionnement automatique des nœuds. Les autres conteneurs sont considérés comme auxiliaires (par exemple, les sidecars). |
nodeSelector objet (clés : chaîne, valeurs : chaîne) |
NodeSelector est un sélecteur qui doit être défini sur "true" pour que le pod puisse s'adapter à un nœud. Sélecteur qui doit correspondre aux libellés d'un nœud pour que le pod soit planifié sur ce nœud. |
Tableau Volume volumes |
Liste des volumes qui seront montés sur les pods |
Tableau Container initContainers |
Liste des conteneurs d'initialisation appartenant au pod. Les conteneurs d'initialisation sont exécutés dans l'ordre avant le démarrage des conteneurs. Si un conteneur init échoue, le pod est considéré comme ayant échoué et est géré en fonction de sa restartPolicy. Le nom d'un conteneur d'initialisation ou d'un conteneur normal doit être unique parmi tous les conteneurs. Ce paramètre ne peut pas être modifié. Pour en savoir plus, consultez https://kubernetes.io/docs/concepts/workloads/pods/init-containers/. |
Tableau Toleration tolerations |
Tolérances du pod, si spécifiées. |
chaîne serviceAccount |
Compte de service Kubernetes précréé qui sera utilisé par le pod. |
PodTemplateSpec
PodTemplateSpec est un objet conteneur pour PodSpec et potentiellement pour la spécification des métadonnées.
Apparaît dans :Microservice
| Champ | Description |
|---|---|
metadata ObjectMeta |
Reportez-vous à la documentation de l'API Kubernetes pour connaître les champs de metadata. |
spec PodSpec |
MicroserviceStatus
MicroserviceStatus définit l'état observé de Microservice.
Apparaît dans :Microservice
| Champ | Description |
|---|---|
Entier observedGeneration |
Génération observée par le contrôleur de déploiement. |
chaîne endpoint |
Point de terminaison à partir duquel ce microservice est accessible. Rempli uniquement pour les services publics. |
deploymentStatus DeploymentStatus |
État du déploiement de ce microservice. |
hpaStatus HPAStatus |
État de HorizontalPodAutoscaler. |
ready booléen |
État de préparation global du microservice |
Tableau Condition conditions |
Représente les dernières observations disponibles de l'état actuel d'un microservice. |
Observabilité
La configuration de l'observabilité configure les différents composants et paramètres requis par la plate-forme d'observabilité (sur GDC air-gapped) ou l'exposition des métriques (sur GKE).
Apparaît dans :MicroserviceSpec
| Champ | Description |
|---|---|
metrics Métriques |
Configuration des métriques. Sur GKE, elles ne sont collectées que sur le premier conteneur. Sur GDC air-gapped, cette section est utilisée conjointement avec la section "Observability" pour configurer le comportement de la plate-forme Observability. |
logging Journalisation |
|
alerting Alertes |
|
dashboards Tableaux de bord |
PostgresConfig
PostgresConfig définit les paramètres de configuration cibles pertinents pour une base de données Postgres.
Apparaît dans :Base de données
| Champ | Description |
|---|---|
chaîne version |
Prérequis
Prerequisites configure tous les prérequis pour le microservice.
Apparaît dans :MicroserviceSpec
| Champ | Description |
|---|---|
sql booléen |
Configuration SQL, si la charge de travail cible l'exige |
PrometheusMetrics
PrometheusMetrics configure les métriques Prometheus exposées par un pod.
Apparaît dans :Métriques
| Champ | Description |
|---|---|
chaîne path |
Chemin d'URI des métriques à extraire. La valeur par défaut est "/metrics". |
Entier port |
Port à partir duquel extraire les métriques. La valeur par défaut est 80. |