Índice
GkeHub
(interface)ApplianceCluster
(mensagem)Authority
(mensagem)ConnectAgentResource
(mensagem)CreateMembershipRequest
(mensagem)DeleteMembershipRequest
(mensagem)EdgeCluster
(mensagem)GenerateConnectManifestRequest
(mensagem)GenerateConnectManifestResponse
(mensagem)GetMembershipRequest
(mensagem)GkeCluster
(mensagem)InitializeHubRequest
(mensagem)InitializeHubResponse
(mensagem)KubernetesMetadata
(mensagem)KubernetesResource
(mensagem)ListMembershipsRequest
(mensagem)ListMembershipsResponse
(mensagem)Membership
(mensagem)Membership.InfrastructureType
(enum)MembershipEndpoint
(mensagem)MembershipState
(mensagem)MembershipState.Code
(enum)MonitoringConfig
(mensagem)MultiCloudCluster
(mensagem)OnPremCluster
(mensagem)OnPremCluster.ClusterType
(enum)OperationMetadata
(mensagem)ResourceManifest
(mensagem)ResourceOptions
(mensagem)TypeMeta
(mensagem)UpdateMembershipRequest
(mensagem)
GkeHub
O serviço Hub do GKE lida com o registro de muitos clusters do Kubernetes no Google Cloud, representado pelo recurso Membership
.
No momento, o GKE Hub está disponível na região global e em todas as regiões em https://cloud.google.com/compute/docs/regions-zones. O recurso está disponível apenas na região global, enquanto a assinatura é uma região global e todas as regiões.
O gerenciamento de assinaturas pode não ser trivial: quando possível, ao trabalhar com os recursos da assinatura, recomendamos usar uma das ferramentas ou bibliotecas de cliente fornecidas pelo Google.
CreateMembership |
---|
Cria uma nova assinatura. No momento, isso só é compatível com clusters do GKE no Google Cloud. Para registrar outros clusters, siga as instruções em https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/registering-a-cluster.
|
DeleteMembership |
---|
Remove uma assinatura. No momento, isso só é compatível com clusters do GKE no Google Cloud. Para cancelar o registro de outros clusters, siga as instruções em https://cloud.google.com/kubernetes-engine/enterprise/multicluster-management/connect/unregistering-a-cluster.
|
GenerateConnectManifest |
---|
Gera o manifesto para implantação do agente do GKE Connect. Esse método é usado internamente pelas bibliotecas fornecidas pelo Google. A maioria dos clientes não precisa chamar esse método diretamente.
|
GetMembership |
---|
Recebe os detalhes de uma assinatura.
|
InitializeHub |
---|
Inicializa o Hub neste projeto, o que inclui a criação da conta de serviço de hub padrão e do pool de Identidade da carga de trabalho do hub. A inicialização é opcional e acontece automaticamente quando a primeira assinatura é criada. O InitializeHub precisa ser chamado quando a primeira assinatura não pode ser registrada sem esses recursos. Um exemplo comum é conceder à conta de serviço de hub acesso a outro projeto, o que exige que a conta exista primeiro.
|
ListMemberships |
---|
Lista assinaturas em um determinado projeto e local.
|
UpdateMembership |
---|
Atualiza uma assinatura existente.
|
ApplianceCluster
ApplianceCluster contém informações específicas para clusters do dispositivo GDC Edge.
Campos | |
---|---|
resource_link |
Imutável. Link automático do recurso do Google Cloud para o cluster do dispositivo. Exemplo: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance |
Autoridade
A autoridade codifica como o Google reconhecerá as identidades desta assinatura. Consulte a documentação de Identidade da carga de trabalho para mais detalhes: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity
Campos | |
---|---|
issuer |
Opcional. Um URI do emissor do JSON Web Token (JWT). Se definido, o Google vai permitir que tokens OIDC válidos deste emissor sejam autenticados no workload_identity_pool. A descoberta do OIDC será executada neste URI para validar os tokens do emissor, a menos que Limpar |
oidc_jwks |
Opcional. Chaves de verificação do OIDC para essa assinatura no formato JWKS (RFC 7517). Quando este campo for definido, a descoberta do OIDC NÃO será realizada no |
identity_provider |
Apenas saída. Um provedor de identidade que reflete o |
workload_identity_pool |
Apenas saída. O nome do pool de Identidade da carga de trabalho em que Há um único pool de Identidade da carga de trabalho por hub compartilhado entre todas as assinaturas que pertencem a esse hub. Para um Hub hospedado em {PROJECT_ID}, o formato do pool de cargas de trabalho é |
ConnectAgentResource
ConnectAgentResource representa um manifesto de recurso do Kubernetes para implantação do agente do Connect.
Campos | |
---|---|
type |
Tipo do recurso no Kubernetes. |
manifest |
Manifesto YAML do recurso. |
CreateMembershipRequest
Solicite mensagem para o método GkeHub.CreateMembership
.
Campos | |
---|---|
parent |
Obrigatório. O pai (projeto e local) em que as assinaturas serão criadas. Especificado no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
membership_id |
Obrigatório. ID escolhido pelo cliente para a assinatura.
Que pode ser expresso como o regex: |
resource |
Obrigatório. A assinatura a ser criada. |
DeleteMembershipRequest
Solicite uma mensagem para o método GkeHub.DeleteMembership
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso de Assinatura no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
force |
Opcional. Se definido como verdadeiro, todos os sub-recursos dessa assinatura também serão excluídos. Caso contrário, a solicitação só vai funcionar se a assinatura não tiver um sub-recurso. |
EdgeCluster
O EdgeCluster contém informações específicas dos clusters do Google Edge.
Campos | |
---|---|
resource_link |
Imutável. Self link do recurso do Google Cloud para o cluster de borda. Exemplo: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster |
GenerateConnectManifestRequest
Solicite uma mensagem para o método GkeHub.GenerateConnectManifest
. .
Campos | |
---|---|
name |
Obrigatório. O nome do recurso de assinatura ao qual o Agente se associará, no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
namespace |
Opcional. Namespace para recursos do agente do GKE Connect. O valor padrão é O agente do Connect é autorizado automaticamente quando executado no namespace padrão. Caso contrário, a autorização explícita precisa ser concedida com uma vinculação adicional do IAM. |
proxy |
Opcional. URI de um proxy se a conectividade do agente com gkeconnect.googleapis.com exigir o uso de um proxy. O formato precisa estar no formato |
version |
Opcional. A versão do agente do Connect a ser usada. O padrão é a versão mais atual. |
is_upgrade |
Opcional. Se verdadeiro, gera os recursos apenas para upgrade. Alguns recursos gerados apenas para instalação (por exemplo, secrets) serão excluídos. |
registry |
Opcional. O registro em que a imagem do agente do Connect vai ser buscada. O padrão é gcr.io/gkeconnect. |
image_pull_secret_content |
Opcional. O conteúdo do secret de pull da imagem para o registro, se não for público. |
GenerateConnectManifestResponse
GenerateConnectManifestResponse contém informações do manifesto para instalar/fazer upgrade de um agente do Connect.
Campos | |
---|---|
manifest[] |
A lista ordenada de recursos do Kubernetes que precisam ser aplicados ao cluster para instalação/upgrade do agente do GKE Connect. |
GetMembershipRequest
Solicite uma mensagem para o método GkeHub.GetMembership
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso de Assinatura no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
GkeCluster
O GkeCluster contém informações específicas para os clusters do GKE.
Campos | |
---|---|
resource_link |
Imutável. Self link do recurso do Google Cloud para o cluster do GKE. Exemplo:
Também há suporte para clusters zonais. |
cluster_missing |
Apenas saída. Se cluster_missing estiver definido, ele vai indicar que o cluster do GKE não existe mais no plano de controle do GKE. |
InitializeHubRequest
Mensagem de solicitação para o método InitializeHub.
Campos | |
---|---|
project |
Obrigatório. O hub a ser inicializado, no formato |
InitializeHubResponse
Mensagem de resposta para o método InitializeHub.
Campos | |
---|---|
service_identity |
Nome da identidade do serviço padrão do Hub, no formato:
A conta de serviço tem |
workload_identity_pool |
O pool de Identidade da carga de trabalho usado para clusters ativados por Identidade da carga de trabalho registrados neste hub. Formato: |
KubernetesMetadata
O KubernetesMetadata fornece metadados informativos para assinaturas criadas com endpoints do Kubernetes (atualmente, eles são equivalentes aos clusters do Kubernetes).
Campos | |
---|---|
kubernetes_api_server_version |
Apenas saída. String da versão do servidor da API Kubernetes, conforme informado por "/version". |
node_provider_id |
Apenas saída. O providerID do nó, conforme informado pelo primeiro nó na lista de nós no endpoint do Kubernetes. Nas plataformas do Kubernetes que oferecem suporte a clusters sem nó (como GKE-on-GCP), o node_count será zero, e o node_provider_id estará vazio. |
node_count |
Apenas saída. Contagem de nós conforme relatado pelos recursos de nós do Kubernetes. |
vcpu_count |
Apenas saída. Contagem de vCPUs conforme relatado pelos recursos de nós do Kubernetes. |
memory_mb |
Apenas saída. A capacidade total de memória, conforme relatado pela soma de todos os recursos dos nós do Kubernetes, definida em MB. |
update_time |
Apenas saída. A hora em que esses detalhes foram atualizados pela última vez. Esse update_time é diferente do update_time no nível da assinatura, já que os EndpointDetails são atualizados internamente para consumidores da API. |
KubernetesResource
KubernetesResource contém os manifestos YAML e a configuração dos recursos de assinatura do Kubernetes no cluster. Depois de CreateMembership ou UpdateMembership, esses recursos devem ser reaplicados no cluster.
Campos | |
---|---|
membership_cr_manifest |
Apenas entrada. A representação YAML da resposta automática de assinatura. Esse campo é ignorado para clusters do GKE em que o Hub pode ler a resposta automática diretamente. Os autores da chamada precisam fornecer a resposta automática que está presente no cluster durante a criação ou atualização ou deixar este campo em branco se não houver nenhum. O manifesto da resposta automática é usado para validar se o cluster não foi registrado em outra assinatura. |
membership_resources[] |
Apenas saída. Outros recursos do Kubernetes que precisam ser aplicados ao cluster após a criação da assinatura e depois de cada atualização. Esse campo só é preenchido na assinatura retornada de uma operação de longa duração bem-sucedida de CreateMembership ou UpdateMembership. Ele não é preenchido durante as solicitações GetMembership ou ListMemberships normais. Para receber o manifesto do recurso após o registro inicial, o autor da chamada precisa fazer uma chamada UpdateMembership com uma máscara de campo vazia. |
connect_resources[] |
Apenas saída. Os recursos do Kubernetes para instalar o agente do GKE Connect. Esse campo só é preenchido na assinatura retornada de uma operação de longa duração bem-sucedida de CreateMembership ou UpdateMembership. Ele não é preenchido durante as solicitações GetMembership ou ListMemberships normais. Para receber o manifesto do recurso após o registro inicial, o autor da chamada precisa fazer uma chamada UpdateMembership com uma máscara de campo vazia. |
resource_options |
Opcional. Opções para geração de recursos do Kubernetes. |
ListMembershipsRequest
Solicite uma mensagem para o método GkeHub.ListMemberships
.
Campos | |
---|---|
parent |
Obrigatório. O pai (projeto e local) em que as assinaturas serão listadas. Especificado no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
page_size |
Opcional. Ao solicitar uma "página" de recursos, |
page_token |
Opcional. Token retornado pela chamada anterior para |
filter |
Opcional. Lista as assinaturas que correspondem à expressão de filtro, seguindo a sintaxe descrita em https://google.aip.dev/160. Por exemplo:
|
order_by |
Opcional. Um ou mais campos para comparar e usar para ordenar a saída. Acesse https://google.aip.dev/132#ordering. |
ListMembershipsResponse
Mensagem de resposta para o método GkeHub.ListMemberships
.
Campos | |
---|---|
resources[] |
Lista de assinaturas correspondentes. |
next_page_token |
Um token para solicitar a próxima página de recursos do método |
unreachable[] |
Lista de locais que não puderam ser alcançados ao buscar esta lista. |
Participação
A assinatura contém informações sobre um cluster de membro.
Campos | |
---|---|
name |
Apenas saída. O nome completo e exclusivo desse recurso de assinatura no formato
Que pode ser expresso como o regex: |
labels |
Opcional. Rótulos para esta assinatura. |
description |
Apenas saída. Descrição da assinatura, limitada a 63 caracteres. Precisa corresponder ao regex: Esse campo está presente para fins legados. |
state |
Apenas saída. Estado do recurso Membership. |
create_time |
Apenas saída. Quando a assinatura foi criada. |
update_time |
Apenas saída. Quando a assinatura foi atualizada pela última vez. |
delete_time |
Apenas saída. Quando a assinatura foi excluída. |
external_id |
Opcional. Um ID gerado externamente e gerenciado para esta assinatura. Esse ID pode ser modificado após a criação, mas isso não é recomendado. Para clusters do GKE, o external_id é gerenciado pela API Hub, e as atualizações serão ignoradas. O ID precisa corresponder ao regex: Se essa assinatura representar um cluster do Kubernetes, esse valor precisará ser definido como o UID do objeto de namespace |
authority |
Opcional. Como identificar cargas de trabalho nesta assinatura. Consulte a documentação sobre a Identidade da carga de trabalho para mais detalhes: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity |
last_connection_time |
Apenas saída. Para clusters que usam o Connect, o carimbo de data/hora da conexão mais recente estabelecida com o Google Cloud. Esse horário é atualizado em intervalos de vários minutos, não continuamente. Para clusters que não usam o GKE Connect ou que nunca se conectaram corretamente, este campo não será definido. |
unique_id |
Apenas saída. UUID gerado pelo Google para este recurso. Isso é exclusivo em todos os recursos de assinatura. Se um recurso de assinatura for excluído e outro recurso com o mesmo nome for criado, ele receberá um unique_id diferente. |
infrastructure_type |
Opcional. O tipo de infraestrutura em que a assinatura está sendo executada. |
monitoring_config |
Opcional. As informações de configuração de monitoramento para esta assinatura. |
Campo de união type . O tipo de recurso representado por esta type de assinatura só pode ser um dos seguintes: |
|
endpoint |
Opcional. Informações do endpoint para alcançar este membro. |
InfrastructureType
Especifica o tipo de infraestrutura de uma assinatura. O tipo de infraestrutura é usado pelo Hub para controlar o comportamento específico da infraestrutura, incluindo preços.
Cada distribuição do GKE (on-GCP, no local, on-X etc.) definirá esse campo automaticamente, mas os clientes de clusters anexados precisam especificar um tipo durante o registro.
Enums | |
---|---|
INFRASTRUCTURE_TYPE_UNSPECIFIED |
Nenhum tipo foi especificado. Algumas funcionalidades do Hub podem exigir a especificação de um tipo e não são compatíveis com assinaturas com esse valor. |
ON_PREM |
Infraestrutura privada que pertence ou é operada pelo cliente. Isso inclui distribuições do GKE como GKE-OnPrem e GKE-OnBareMetal. |
MULTI_CLOUD |
Infraestrutura em nuvem pública. |
MembershipEndpoint
O MembershipEndpoint contém as informações necessárias para entrar em contato com uma API Kubernetes, um endpoint e quaisquer metadados adicionais do Kubernetes.
Campos | |
---|---|
kubernetes_metadata |
Apenas saída. Metadados úteis específicos do Kubernetes. |
kubernetes_resource |
Opcional. Os recursos do Kubernetes no cluster que precisam ser aplicados a um cluster registrado corretamente, no estado estável. Estes recursos:
|
Campo de união type . Informações do cluster registrado. type pode ser apenas de um dos tipos a seguir: |
|
gke_cluster |
Opcional. Informações específicas de um cluster do GKE no GCP. |
on_prem_cluster |
Opcional. Informações específicas de um cluster do GKE On-Prem. Um cluster de usuário local que não tem resourceLink não tem permissão para usar este campo. Em vez disso, ele deve ter um "type" nulo. |
multi_cloud_cluster |
Opcional. Informações específicas de um cluster GKE Multi-cloud. |
edge_cluster |
Opcional. Informações específicas de um cluster do Google Edge. |
appliance_cluster |
Opcional. Informações específicas de um cluster do GDC Edge Appliance. |
MembershipState
MembershipState descreve o estado de um recurso Membership.
Campos | |
---|---|
code |
Apenas saída. O estado atual do recurso Membership. |
Programar
O código descreve o estado de um recurso de assinatura.
Enums | |
---|---|
CODE_UNSPECIFIED |
O código não foi definido. |
CREATING |
O cluster está sendo registrado. |
READY |
O cluster está registrado. |
DELETING |
O registro do cluster está sendo cancelado. |
UPDATING |
A assinatura está sendo atualizada. |
SERVICE_UPDATING |
A assinatura está sendo atualizada pelo serviço de hub. |
MonitoringConfig
O MonitoringConfig informa aos aplicativos/serviços/interfaces baseados em frota como as métricas do cluster subjacente são informadas aos serviços do Cloud Monitoring. Ele pode ser definido de vazio para não vazio, mas não pode ser mudado diretamente para evitar a quebra acidental da consistência das métricas.
Campos | |
---|---|
project_id |
Opcional. Projeto usado para informar métricas |
location |
Opcional. Local usado para relatar métricas |
cluster |
Opcional. Nome do cluster usado para relatar métricas. Para o Anthos nos clusters VMWare/Baremetal/MultiCloud, ele estaria no formato {cluster_type}/{cluster_name}, por exemplo, "awsClusters/cluster_1". |
kubernetes_metrics_prefix |
Opcional. As métricas do sistema do Kubernetes, se disponíveis, são gravadas nesse prefixo. O padrão é kubernetes.io para GKE e kubernetes.io/anthos para Anthos em algum momento. Observação: o Anthos MultiCloud terá o prefixo kubernetes.io hoje, mas a migração vai ficar em kubernetes.io/anthos. |
cluster_hash |
Opcional. Para clusters do GKE e Multicloud, esse é o UUID do recurso do cluster. Para clusters VMWare e baremetal, esse é o UID do kube-system. |
MultiCloudCluster
O MultiCloudCluster contém informações específicas dos clusters GKE Multi-cloud.
Campos | |
---|---|
resource_link |
Imutável. Self link do recurso do Google Cloud para o cluster GKE Multi-cloud. Exemplo: //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/awsClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/azureClusters/my-cluster //gkemulticloud.googleapis.com/projects/my-project/locations/us-west1-a/attachedClusters/my-cluster |
cluster_missing |
Apenas saída. Se cluster_missing estiver definido, ele vai indicar que o recurso API(gkemulticloud.googleapis.com) para o cluster GKE Multi-cloud não existe mais. |
OnPremCluster
O OnPremCluster contém informações específicas dos clusters do GKE On-Prem.
Campos | |
---|---|
resource_link |
Imutável. Self link do recurso do Google Cloud para o cluster do GKE On-Prem. Exemplo: //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/vmwareClusters/my-cluster //gkeonprem.googleapis.com/projects/my-project/locations/us-west1-a/bareMetalClusters/my-cluster |
cluster_missing |
Apenas saída. Se cluster_missing estiver definido, ele vai indicar que o recurso API(gkeonprem.googleapis.com) para esse cluster do GKE On-Prem não existe mais. |
admin_cluster |
Imutável. Se o cluster é de administrador. |
cluster_type |
Imutável. O tipo do cluster local. |
ClusterType
ClusterType descreve o tipo do cluster no local.
Enums | |
---|---|
CLUSTERTYPE_UNSPECIFIED |
O ClusterType não está definido. |
BOOTSTRAP |
O ClusterType é um cluster de inicialização. |
HYBRID |
O ClusterType é um cluster híbrido baremetal. |
STANDALONE |
O ClusterType é um cluster independente baremetal. |
USER |
O ClusterType é um cluster de usuário. |
OperationMetadata
Representa os metadados da operação de longa duração.
Campos | |
---|---|
create_time |
Somente saída: a hora em que a operação foi criada. |
end_time |
Somente saída: a hora em que a operação terminou de ser executada. |
target |
Apenas saída. Caminho do recurso definido pelo servidor para o destino da operação. |
verb |
Apenas saída. Nome do verbo executado pela operação. |
status_detail |
Apenas saída. Status legível da operação, caso haja um. |
cancel_requested |
Apenas saída. Identifica se o usuário solicitou o cancelamento da operação. As operações que foram canceladas com êxito têm o valor [Operation.error][] com um |
api_version |
Apenas saída. Versão da API usada para iniciar a operação. |
ResourceManifest
ResourceManifest representa um único recurso do Kubernetes a ser aplicado ao cluster.
Campos | |
---|---|
manifest |
Manifesto YAML do recurso. |
cluster_scoped |
Indica se o recurso fornecido no manifesto é Esse campo é usado para o mapeamento REST ao aplicar o recurso em um cluster. |
ResourceOptions
ResourceOptions representam opções para geração de recursos do Kubernetes.
Campos | |
---|---|
connect_version |
Opcional. A versão do agente do Connect a ser usada em connect_resources. O padrão é a versão mais recente do GKE Connect. A versão precisa ter suporte atualmente. As versões obsoletas serão rejeitadas. |
v1beta1_crd |
Opcional. Uso de |
k8s_version |
Opcional. Versão principal do cluster do Kubernetes. Usado apenas para determinar qual versão usar para os recursos CustomResourceDefinition, |
TypeMeta
TypeMeta é a informação de tipo necessária para a desmarcação de conteúdo dos recursos do Kubernetes no manifesto.
Campos | |
---|---|
kind |
Tipo do recurso (por exemplo, implantação). |
api_version |
APIVersion do recurso (por exemplo, v1). |
UpdateMembershipRequest
Solicite uma mensagem para o método GkeHub.UpdateMembership
.
Campos | |
---|---|
name |
Obrigatório. O nome do recurso de Assinatura no formato A autorização requer a seguinte permissão do IAM no recurso especificado
|
update_mask |
Obrigatório. Máscara de campos para atualizar. |
resource |
Obrigatório. Somente os campos especificados em update_mask são atualizados. Se você especificar um campo em update_mask, mas não especificar o valor dele aqui, esse campo será excluído. Se você estiver atualizando um campo de mapa, defina o valor de uma chave como "null" ou uma string vazia para excluir a chave do mapa. Não é possível atualizar o valor de uma chave para uma string vazia. Se você especificar a update_mask como um caminho especial "*", substituirá totalmente todos os campos modificáveis pelo usuário para corresponder a |