API de modelo de recurso do Kubernetes do sistema particular da API pré-treinada

Visão geral

As APIs pré-treinadas são um conjunto de serviços de IA que incluem reconhecimento óptico de caracteres (OCR), Speech-to-Text e tradução. Os serviços são ativados e desativados usando a API do modelo de recursos do Kubernetes (KRM). A API KRM é uma API de gerenciamento usada opcionalmente pelo administrador do AI Platform.

O objetivo desta página é apenas fornecer informações.

aiplatform.private.gdc.goog/v1

O pacote v1 contém definições de esquema de API para o grupo de APIs aiplatform.private.gdc.goog v1.

Alertas

O alerta contém os nomes dos ConfigMaps que serão processados e transformados em CRs de alerta da plataforma de observabilidade: MonitoringRule e LoggingRule.

Aparece em: - Observabilidade

Campo Descrição
monitoringAlertsConfigMap string Configmap com CR MonitoringRule incorporado para buscar do cluster K8s remoto e processar transformando em um CR MonitoringRule da plataforma de observabilidade e implantação no cluster de administrador.
loggingAlertsConfigMap string ConfigMap com CR LoggingRule incorporado para buscar do cluster remoto do K8s e processar transformando em um CR LoggingRule da plataforma de observabilidade e implantar no cluster de administrador.

AppConfig

AppConfig é o esquema da API AppConfig. Deve ter um por namespace

Aparece em: - AppConfigList

Campo Descrição
apiVersion string aiplatform.private.gdc.goog/v1
kind string AppConfig
metadata ObjectMeta Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata.
spec AppConfigSpec
status AppConfigStatus

AppConfigList

AppConfigList contém uma lista de AppConfig.

Campo Descrição
apiVersion string aiplatform.private.gdc.goog/v1
kind string AppConfigList
metadata ListMeta Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata.
items Matriz de AppConfig

AppConfigSpec

Aparece em: - AppConfig

Campo Descrição
sql Banco de dados

AppConfigStatus

AppConfigStatus define o estado observado de AppConfig.

Aparece em: - AppConfig

Campo Descrição
ready booleano "Ready" indica se o recurso está pronto.
primaryCondition ResourceCondition PrimaryCondition representa a condição principal de um recurso. Se o recurso estiver pronto, a condição vai indicar isso. Caso contrário, a condição será o principal motivo para o recurso não estar pronto.
resourceConditions ResourceCondition "ResourceConditions" é uma coleção de condições para um recurso e seus sub-recursos. Ele pode ser usado para determinar a integridade geral de um recurso e seus sub-recursos.
conditions Matriz de condição "Conditions" representa condições de recursos brutos preenchidas com recursos do Kubernetes para fins de depuração.
database DatabaseInfo Apresenta as informações do subrecurso do banco de dados.

Painéis

"Dashboards" contém uma lista dos nomes dos configmaps compatíveis com o painel da plataforma de observabilidade a serem processados.

Aparece em: - Observabilidade

Campo Descrição
configMaps matriz de string ConfigMaps (com definição JSON do painel do Grafana incorporada) a serem processados. Eles precisam estar no cluster de usuário e no namespace em que as cargas de trabalho de IA são implantadas. É preciso haver um mapeamento de um para um entre o número de painéis desejados e os configmaps do painel. Vamos presumir que há uma única chave no configmap: "data", que vai armazenar a string JSON de definição do painel.

Banco de dados

O banco de dados configura os requisitos de banco de dados relacional para o microsserviço de destino.

Aparece em: - AppConfigSpec

Campo Descrição
postgres PostgresConfig

DatabaseInfo

DatabaseInfo define o estado observado das informações do banco de dados.

Aparece em: - AppConfigStatus

Campo Descrição
endpoint string
port string

HPAStatus

HPAStatus descreve as condições de status do HorizontalPodAutoscaler.

Aparece em: - MicroserviceStatus

Campo Descrição
statusConditions HorizontalPodAutoscalerCondition Condições de status
currentReplicas número inteiro Número de réplicas atuais gerenciadas pelo HPA
desiredReplicas número inteiro Número de réplicas desejadas gerenciadas pelo HPA

Logging

O Logging configura a funcionalidade de coleta de registros para a plataforma de observabilidade em um ambiente isolado do GDC. Não ative se estiver testando no GKE, porque essa funcionalidade não se aplica a ele.

Aparece em: - Observabilidade

Campo Descrição
enableLogCollection booleano "EnableLogCollection" indica se a coleta de registros pela plataforma de observabilidade está ativada ou não.
staticLabels objeto (chaves:string, valores:string) Mapeia a propriedade "additionalLabels" do OP LoggingTargetCR. Rótulos estáticos a serem adicionados a todas as entradas de registro capturadas. Os nomes de rótulos não podem conter traços ("-"), mas os valores podem.

Métricas

As métricas configuram como as métricas de um pod serão coletadas.

Aparece em: - Observabilidade

Campo Descrição
prometheus PrometheusMetrics

Microsserviço

Microservice é o esquema da API services.

Aparece em: - MicroserviceList

Campo Descrição
apiVersion string aiplatform.private.gdc.goog/v1
kind string Microservice
metadata ObjectMeta Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata.
spec MicroserviceSpec
status MicroserviceStatus

MicroserviceList

"MicroserviceList" contém uma lista de "Microservice".

Campo Descrição
apiVersion string aiplatform.private.gdc.goog/v1
kind string MicroserviceList
metadata ListMeta Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata.
items Matriz Microservice

MicroserviceSpec

MicroserviceSpec define o estado desejado do microsserviço.

Aparece em: - Microservice

Campo Descrição
public booleano Indica se o microsserviço é público. Se for verdadeiro, ele terá um registro DNS de exposição e um endpoint público. O TLS também será configurado automaticamente no gateway de acordo com o nome DNS. O prefixo DNS será o nome do microsserviço nos metadados.
enableBucketAccess booleano Se as configurações relacionadas ao bucket de armazenamento precisam ser provisionadas para o contêiner.
dnsname string Nome do host DNS. Isso será usado para construir o nome do host DNS para o microsserviço no ambiente do GDC quando ele for público.
autoscaling Configurações de escalonamento automático.
observability Observabilidade Configuração de observabilidade (registros, métricas, monitoramento e painéis), algumas das quais são aplicáveis apenas a configurações isoladas do GDC.
prerequisites Pré-requisitos Configuração de pré-requisitos.
template PodTemplateSpec Modelo para criar pods no microsserviço. O microsserviço vai conter implantações sem estado para esses pods.

PodSpec

O PodSpec é uma versão minimalista do PodSpec principal.

Aparece em: - PodTemplateSpec

Campo Descrição
containers Matriz de contêineres Especifica contêineres. Nem todos os atributos são compatíveis. As portas especificadas de todos os contêineres serão expostas. O primeiro contêiner (containers[0]) é considerado o principal e será aquele marcado com solicitações de recursos para o provisionamento automático de nós. O restante dos contêineres é considerado auxiliar (por exemplo, sidecars).
nodeSelector objeto (chaves:string, valores:string) NodeSelector é um seletor que precisa ser verdadeiro para que o pod se ajuste a um nó. Seletor que precisa corresponder aos rótulos de um nó para que o pod seja programado nele.
volumes Matriz de volume Lista de volumes que serão montados nos pods
initContainers Matriz de contêineres Lista de contêineres de inicialização pertencentes ao pod. Os contêineres de inicialização são executados em ordem antes do início dos contêineres. Se um contêiner de inicialização falhar, o pod será considerado com falha e será processado de acordo com a restartPolicy. O nome de um contêiner de inicialização ou normal precisa ser exclusivo entre todos os contêineres. Não foi possível atualizar. Mais informações: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
tolerations Matriz de tolerância Se especificado, as tolerâncias do pod.
serviceAccount string A conta de serviço do Kubernetes pré-criada que será usada pelo pod.

PodTemplateSpec

PodTemplateSpec é um objeto contêiner para PodSpec e, possivelmente, para especificação de metadados.

Aparece em: - Microservice

Campo Descrição
metadata ObjectMeta Consulte a documentação da API Kubernetes para saber mais sobre os campos de metadata.
spec PodSpec

MicroserviceStatus

MicroserviceStatus define o estado observado do microsserviço.

Aparece em: - Microservice

Campo Descrição
observedGeneration número inteiro A geração observada pelo controlador de implantação.
endpoint string O endpoint em que esse microsserviço pode ser acessado. Preenchido apenas para serviços públicos.
deploymentStatus DeploymentStatus O status de implantação deste microsserviço.
hpaStatus HPAStatus O status do HorizontalPodAutoscaler.
ready booleano Status geral de prontidão do microsserviço
conditions Matriz de condição Representa as últimas observações disponíveis do estado atual de um microsserviço.

Observabilidade

A capacidade de observação configura os vários componentes e parâmetros exigidos pela plataforma de capacidade de observação (em GDC isolado por ar) ou pela exposição de métricas (no GKE).

Aparece em: - MicroserviceSpec

Campo Descrição
metrics Métricas Configuração de métricas. No GKE, elas são coletadas apenas no primeiro contêiner. No GDC isolado por ar, isso é usado em conjunto com a seção "Observabilidade" para configurar o comportamento da plataforma de observabilidade.
logging Logging
alerting Alertas
dashboards Painéis

PostgresConfig

O PostgresConfig define as configurações relevantes de configuração de destino para um banco de dados Postgres.

Aparece em: - Banco de dados

Campo Descrição
version string

Pré-requisitos

"Prerequisites" configura todos os pré-requisitos do microsserviço.

Aparece em: - MicroserviceSpec

Campo Descrição
sql booleano Configuração do SQL, se exigida pela carga de trabalho de destino

PrometheusMetrics

O PrometheusMetrics configura as métricas do Prometheus expostas por um pod.

Aparece em: - Métricas

Campo Descrição
path string O caminho do URI das métricas para extrair métricas. O padrão é "/metrics".
port número inteiro A porta de onde as métricas serão extraídas. O padrão é 80.