IBM Cloud Docs
Referência da CLI do IBM Cloud Kubernetes Service

Referência da CLI do IBM Cloud Kubernetes Service

Consulte esses comandos para criar e gerenciar clusters da comunidade do Kubernetes ou do Red Hat OpenShift no IBM Cloud® Kubernetes Service.

Na linha de comandos, você é notificado quando as atualizações para a CLI ibmcloud e os plug-ins estão disponíveis. Certifique-se de manter sua CLI atualizada para que você possa usar todos os comandos e opções disponíveis.

Procurando comandos ibmcloud cr? Veja a IBM Cloud Container Registry referência CLI. Procurando comandos kubectl? Consulte a Documentação do Kubernetes.

Comandos do IBM Cloud Kubernetes Service

As tabelas a seguir listam os grupos de comandos ibmcloud ks. Para obter uma lista completa de todos os comandos ibmcloud ks como eles são estruturados na CLI, consulte o Mapa da CLI do IBM Cloud Kubernetes Service.

IBM Cloud Kubernetes Service Grupos de comandos CLI
Grupo de comandos Descrição
Comandos de cluster Crie, visualize e modifique clusters e configurações de cluster, como configurações de complemento, sub-rede e mestre.
Comandos de trabalhador Visualize e modifique nós do trabalhador para um cluster.
Comandos do conjunto de trabalhadores Visualize e modifique conjuntos de trabalhadores para um cluster.
Comandos zone Liste as zonas de disponibilidade e modifique as zonas conectadas a um conjunto de trabalhadores.
Comandos de ingresso Visualize e modifique os serviços e configurações do Ingress.
Comandos de criação de log Encaminhar logs de seu cluster.
Comandos nlb-dns Crie e gerencie nomes de host para endereços IP do balanceador de carga de rede (NLB) em um cluster e monitores de verificação de funcionamento para nomes de host.
Comandos de criação de webhook Registrar um webhook em um cluster.
Comandos api-key Visualize informações sobre a chave de API para um cluster ou reconfigure-o para uma nova chave.
Comandos de credencial Configure e desconfigure credenciais que permitam acessar o portfólio de infraestrutura clássica do IBM Cloud por meio de sua conta do IBM Cloud.
Comandos infra-permissions Confira as permissões da infraestrutura clássica da IBM Cloud usadas no IBM Cloud Kubernetes Service.
Comandos kms Ative um provedor de serviço de gerenciamento de chave (KMS) no cluster para criptografar o componente etcd e os segredos de Kubernetes com uma chave raiz controlada por você.
Comandos de cota Visualize a cota e os limites para os recursos relacionados ao cluster em sua conta do IBM Cloud.
Comandos de sub-redes Liste as sub-redes disponíveis em sua conta de infraestrutura do IBM Cloud.
Comandos vlan Liste VLANs públicas e privadas para uma zona e visualize o status o VLAN Spanning.
Comandos de VPCS Liste todos os VPCs no grupo de recursos de destino. Se nenhum grupo de recursos for designado como o destino, todos os VPCs na conta serão listados.
Flavor comandos Obter as informações de um sabor ou listar sabores disponíveis para uma zona.
Comandos de locais Liste os locais que são suportados pelo IBM Cloud Kubernetes Service.
Comandos de mensagens Visualize as mensagens atuais do usuário.
Comandos de versões Liste todas as versões da plataforma de contêiner que estão disponíveis para clusters IBM Cloud Kubernetes Service.
Comandos de API descontinuados Visualize ou direcione o terminal de API e a versão de API para o serviço.
Comandos descontinuados init Inicialize o plug-in IBM Cloud Kubernetes Service ou especifique a região na qual deseja criar ou acessar clusters de Kubernetes.
Comandos de script Gravar novamente os scripts que chamam os comandos de plug-in do IBM Cloud Kubernetes Service.
Comandos de armazenamento Beta Visualizar e modificar recursos de armazenamento.

cluster comandos

Crie, visualize e modifique clusters e configurações de cluster, como configurações de complemento, sub-rede e mestre.

ibmcloud ks cluster addon disable

Desativar um complemento gerenciado em um cluster existente. Esse comando deve ser combinado com um dos subcomandos a seguir para o complemento gerenciado que você deseja desativar.

ibmcloud ks cluster addon disable alb-oauth-proxy

Virtual Private Cloud Infra-estrutura Classic

Desative o complemento para o ALB OAuth Proxy em um cluster.

ibmcloud ks cluster addon disable alb-oauth-proxy --cluster CLUSTER
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
Exemplo de comando addon disable alb-oauth-proxy
ibmcloud ks cluster addon disable alb-oauth-proxy --cluster my_cluster

ibmcloud ks cluster addon disable debug-tool

Virtual Private Cloud Infra-estrutura Classic

Desative o complemento para o IBM Cloud Kubernetes Service Diagnostics and Debug Tool.

ibmcloud ks cluster addon disable debug-tool --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

ibmcloud ks cluster addon disable istio

Infraestrutura clássica

Desativar o complemento Istio gerenciado. Remove todos os componentes principais do Istio do cluster, incluindo o Prometheus.

ibmcloud ks cluster addon disable istio --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: este complemento do Istio é uma dependência para os complementos gerenciados istio-extras e istio-sample-bookinfo. Inclua essa opção para também desativar esses complementos.

ibmcloud ks cluster addon disable istio-extras

Infraestrutura clássica

Desative o complemento gerenciado adicional do Istio, que não é suportado. Remove o Grafana, o Jeager e o Kiali do cluster.

ibmcloud ks cluster addon disable istio-extras --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: este complemento do Istio é uma dependência para o complemento gerenciado istio-sample-bookinfo. Inclua essa opção para também desativar esse complemento.

ibmcloud ks cluster addon disable istio-sample-bookinfo

Infraestrutura clássica

Desative o complemento gerenciado do Istio BookInfo, que não é suportado. Remove do cluster todas as implementações, os pods e outros recursos do app BookInfo.

ibmcloud ks cluster addon disable istio-sample-bookinfo --cluster CLUSTER
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.

ibmcloud ks cluster addon disable kube-terminal

Virtual Private Cloud Infra-estrutura Classic

Desative o complemento do terminal da web do Kubernetes. Para usar o terminal da web do Kubernetes no console do cluster IBM Cloud Kubernetes Service, deve-se ativar novamente o complemento primeiro.

ibmcloud ks cluster addon disable kube-terminal --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

ibmcloud ks cluster addon disable static-route

Virtual Private Cloud Infra-estrutura Classic

Desative o complemento rota estática.

ibmcloud ks cluster addon disable static-route --cluster CLUSTER
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

ibmcloud ks cluster addon disable vpc-block-csi-driver

Infraestrutura clássica

Desative o complemento Driver de CSI do IBM Cloud VPC Block Storage.

ibmcloud ks cluster addon disable vpc-block-csi-driver --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

ibmcloud ks cluster addon enable

Ative um complemento gerenciado em um cluster existente. Esse comando deve ser combinado com um dos subcomandos a seguir para o complemento gerenciado que você deseja ativar.

ibmcloud ks cluster addon enable alb-oauth-proxy

Virtual Private Cloud Infra-estrutura Classic

Ative o complemento para o ALB OAuth Proxy em um cluster. Quando seus ALBs executarem a imagem do Kubernetes Ingress, será possível usar o ALB OAuth Proxy para aplicar a autenticação aos seus apps configurando o Ingress com o IBM Cloud App ID.

ibmcloud ks cluster addon enable alb-oauth-proxy --cluster CLUSTER [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version VERSION
Opcional: especifique a versão do complemento a ser instalado. Se nenhuma versão for especificada, a versão padrão será instalada.
Exemplo de comando addon enable alb-oauth-proxy
ibmcloud ks cluster addon enable alb-oauth-proxy --cluster my_cluster

ibmcloud ks cluster addon enable debug-tool

Virtual Private Cloud Infra-estrutura Classic

Ative o complemento para o IBM Cloud Kubernetes Service Diagnostics and Debug Tool em um cluster.

ibmcloud ks cluster addon enable debug-tool --cluster CLUSTER [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version VERSION
Opcional: especifique a versão do complemento a ser instalado. Se nenhuma versão for especificada, a versão padrão será instalada.
Exemplo de comando addon enable debug-tool
ibmcloud ks cluster addon enable debug-tool --cluster my_cluster

ibmcloud ks cluster addon enable istio

Infraestrutura clássica

Ative o Complemento Istio gerenciado. Instala os componentes principais do Istio, incluindo o Prometheus.

ibmcloud ks cluster addon enable istio --cluster CLUSTER [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version VERSION
Opcional: especifique a versão do complemento a ser instalado. Se nenhuma versão for especificada, a versão padrão será instalada. Observe que o Istio versão 1.3 é suportado apenas no Kubernetes versão 1.15 e clusters anteriores e o Istio versões 1.4 e mais recentes é suportado apenas no Kubernetes versão 1.16 e clusters mais recentes.

ibmcloud ks cluster addon enable static-route

Virtual Private Cloud Infra-estrutura Classic

Ative o complemento rota estática.

ibmcloud ks cluster addon enable static-route --cluster CLUSTER [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version VERSION
Opcional: especifique a versão do complemento a ser instalado. Se nenhuma versão for especificada, a versão padrão será instalada.

ibmcloud ks cluster addon enable vpc-block-csi-driver

Virtual Private Cloud

Ative o complemento Driver de CSI do IBM Cloud VPC Block Storage.

ibmcloud ks cluster addon enable vpc-block-csi-driver --cluster CLUSTER [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version VERSION
Opcional: especifique a versão do complemento a ser instalado. Se nenhuma versão for especificada, a versão padrão será instalada.

ibmcloud ks cluster addon get

Virtual Private Cloud Infra-estrutura Classic

Visualizar os detalhes de um complemento instalado.

ibmcloud ks cluster addon get --addon ADDON --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--addon ADDON
Obrigatório: o nome do addon. Para listar os complementos instalados, execute ibmcloud ks cluster addon ls.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks cluster addon ls

Virtual Private Cloud Infra-estrutura Classic

Listar quaisquer complementos gerenciados que estejam ativados em um cluster.

ibmcloud ks cluster addon ls --cluster CLUSTER
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

ibmcloud ks cluster addon options

Virtual Private Cloud Infra-estrutura Classic

Antes de ativar um complemento, visualize suas opções de instalação.

ibmcloud ks cluster addon options --addon ADDON [--output OUTPUT] [-q] [--version VERSION]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--addon ADDON
Obrigatório: o nome do addon. Para listar os complementos disponíveis, execute ibmcloud ks cluster addon versions.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--version VERSION
Opcional: especificar uma versão do complemento para exibir opções. Se nenhuma versão for especificada, as opções da versão padrão serão exibidas. Para listar versões de complementos disponíveis, execute ibmcloud ks cluster addon versions.

ibmcloud ks cluster addon update

Virtual Private Cloud Infra-estrutura Classic

Atualize um complemento instalado.

ibmcloud ks cluster addon update ADD-ON_NAME --cluster CLUSTER [-f] [-q] [--version VERSION] [-y]
Permissões mínimas necessárias
Nenhum

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--version VERSION
Opcional: especifique a versão para a qual atualizar o complemento. Se nenhuma versão for especificada, o complemento será atualizado para a versão padrão. Para listar versões de complementos disponíveis, execute ibmcloud ks cluster addon versions.

ibmcloud ks cluster addon versions

Virtual Private Cloud Infra-estrutura Classic

Visualize uma lista de versões suportadas para complementos gerenciados no IBM Cloud Kubernetes Service.

ibmcloud ks cluster addon versions [--addon ADD-ON_NAME] [--output json] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--addon ADD-ON_NAME
Opcional: especifique um nome de complemento, como istio, para o qual filtrar as versões.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando addon versions

ibmcloud ks cluster addon versions --addon istio

ibmcloud ks cluster ca create

Virtual Private Cloud Infra-estrutura Classic

Crie uma nova autoridade de certificação (CA) para o seu cluster. O servidor de API do cluster é atualizado automaticamente após a criação da CA e a emissão dos novos certificados de CA para os componentes em seu cluster.

Após executar esse comando e antes de executar o comando ibmcloud ks cluster ca rotate, siga as etapas em Girando certificados de CA em seu cluster para assegurar que qualquer conjunto de ferramentas que use certificados que são assinados pela CA antiga seja atualizado para usar os novos certificados e para atualizar seus nós do trabalhador.

ibmcloud ks cluster ca create --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster ca create

ibmcloud ks cluster ca create --cluster my_cluster

ibmcloud ks cluster ca get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um certificado de autoridade de certificação do cluster.

ibmcloud ks cluster ca get --cluster CLUSTER [ --output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster ca get

ibmcloud ks cluster ca get --cluster my_cluster

ibmcloud ks cluster ca rotate

Virtual Private Cloud Infra-estrutura Classic

Gire os certificados de autoridade de certificação (CA) de um cluster. O giro invalida os certificados assinados pela CA anterior do cluster e emite certificados assinados pela nova CA do cluster para os nós do trabalhador.

Antes de executar esse comando, siga as etapas em Girando certificados de CA em seu cluster para garantir que qualquer conjunto de ferramentas que use os certificados de CA antigos seja atualizado para usar os novos e atualizar os nós do trabalhador.

ibmcloud ks cluster ca rotate --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster ca rotate

ibmcloud ks cluster ca rotate --cluster my_cluster

ibmcloud ks cluster ca status

Virtual Private Cloud Infra-estrutura Classic

Após executar ibmcloud ks cluster ca rotate, visualize o status de rotação dos certificados de autoridade de certificação (CA) para um cluster.

ibmcloud ks cluster ca status --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster ca status

ibmcloud ks cluster ca status --cluster my_cluster

ibmcloud ks cluster config

Virtual Private Cloud Infra-estrutura Classic

Após efetuar o login em IBM Cloud, faça o download dos certificados e dos dados de configuração do Kubernetes como um arquivo kubeconfig para sua máquina local para que seja possível se conectar ao seu cluster e executar comandos kubectl.

O arquivo kubeconfig é mesclado ao arquivo kubeconfig existente em ~/.kube/config (<user_profile>/.kube/config no Windows) ou ao último arquivo configurado pela variável de ambiente KUBECONFIG na sessão de linha de comandos. Depois de executar ibmcloud ks cluster config, você pode interagir com o seu cluster imediatamente e alterar rapidamente o contexto para outros clusters no contexto Kubernetes.

ibmcloud ks cluster config --cluster CLUSTER [--admin] [--endpoint ENDPOINT_TYPE] [--network] [--skip-rbac] [-q] [-o]
Permissões mínimas necessárias
Viewer ou Reader IBM Cloud Função de acesso de serviços do IAM para o cluster em IBM Cloud Kubernetes Service. Além disso, se você tiver somente uma função de acesso à plataforma ou somente uma função de acesso ao serviço, restrições adicionais se aplicarão.
  • Plataforma: Se você tiver apenas uma função de acesso à plataforma, poderá executar esse comando, mas precisará de uma função de acesso ao serviço para executar as ações do Kubernetes no cluster.
  • Serviço: Se você tiver a função de acesso service, poderá executar esse comando. No entanto, seu administrador de cluster deve reunir os detalhes do cluster para você executando o comando ibmcloud ks cluster ls ou usando o console IBM Cloud Kubernetes Service. Depois de receber o nome do cluster e o ID, é possível ativar o painel do Kubernetes por meio da CLI e trabalhar com o Kubernetes.

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--admin
Opcional: A função Administrador da plataforma é necessária para usar essa opção. Faça download dos certificados TLS e dos arquivos de permissão para a função de Super usuário. Os arquivos são baixados para <user_home_directory>/.bluemix/plugins/kubernetes-service/clusters/<cluster_name>-admin. Os certificados podem ser revogados ou rotacionados. Para obter mais informações, consulte Rotação de certificados CA em seu cluster.
--endpoint ENDPOINT_TYPE
Opcional: especifique o tipo de terminal a ser usado para se conectar ao cluster. Se você não especificar essa opção, será usado o endpoint de serviço padrão do seu cluster.
  • private: se o terminal em serviço de nuvem privada estiver ativado para o seu cluster, configure como private para usar o terminal em serviço de nuvem privada para o seu contexto de cluster. Observe que você deve estar na rede privada da IBM Cloud ou conectado à rede privada por meio de uma conexão VPN de VPC, ou para uma infraestrutura clássica, por uma conexão VPN clássica ou pelo IBM Cloud Direct Link.

  • vpe: Se for um cluster VPC, configure como vpe para usar o gateway Virtual Private Endpoint para o seu contexto de cluster. Note que você deve estar conectado ao mesmo VPC onde o cluster é implementado através de Conexão VPN VPN.

--network
Opcional: faça o download do arquivo de configuração do Calico, certificados TLS e arquivos de permissão que são necessários para executar comandos calicoctl no cluster.
--skip-rbac
Ignore a inclusão de funções RBAC do usuário Kubernetes com base nas funções de acesso ao serviço do IBM Cloud IAM para a configuração do cluster. Inclua essa opção somente se você gerenciar suas próprias funções RBAC do Kubernetes. Se você usar funções de acesso de serviço IAM da IBM Cloud para gerenciar todos os usuários do RBAC, não inclua essa opção.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
-o
Opcional: imprime a saída do comando em YAML, JSON ou .zip formatar.

Exemplo de comando cluster config

ibmcloud ks cluster config --cluster my_cluster

ibmcloud ks cluster create classic

Infraestrutura clássica

Crie um cluster com os nós do trabalhador na infraestrutura clássica.

ibmcloud ks cluster create classic [--hardware HARDWARE] --zone ZONE --flavor FLAVOR --name NAME  [--operating-system SYSTEM] [--version MAJOR.MINOR.PATCH] [--no-subnet] [--sm-group GROUP] [--sm-instance INSTANCE] [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN] [--private-only] [--private-service-endpoint] [--public-service-endpoint] [--workers WORKER] [--disable-disk-encrypt] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--skip-advance-permissions-check] [-q]

Para criar um cluster VPC, use o comando ibmcloud ks cluster create vpc-gen2.

Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o IBM Cloud Kubernetes Service no nível de conta
Função de acesso à plataforma Administrador para o IBM Cloud Container Registry no nível de conta
Função Superusuário para a infraestrutura da IBM Cloud

Opções de comando:

--hardware HARDWARE

O nível de isolamento de hardware para seu nó do trabalhador. Use dedicated para que os recursos físicos disponíveis sejam dedicados apenas a você ou shared para permitir que recursos físicos sejam compartilhados com outros clientes IBM. O padrão é shared. Para os tipos bare metal, especifique dedicated.

--zone ZONE

A zona na qual você deseja criar o cluster. Esse valor é necessário para clusters padrão.

Revise as zonas clássica ou de VPC. Quando você seleciona uma zona que está localizada fora de seu país, tenha em mente que você pode requerer autorização legal antes que os dados possam ser armazenados fisicamente em um país estrangeiro.

--flavor FLAVOR

Escolha um tipo, ou tipo de máquina, para os nós do trabalhador. É possível implementar os nós do trabalhador como máquinas virtuais em hardware compartilhado ou dedicado ou como máquinas físicas no bare metal. Os tipos físicos e virtuais disponíveis variam de acordo com a zona na qual você implementa o cluster. Para obter mais informações, consulte a documentação do comando ibmcloud ks flavors (machine-types).

--name NAME

Necessário: o nome para o cluster. O nome deve começar com uma letra, pode conter letras, números, pontos (.) e hífens (-) e deve conter 35 caracteres ou menos. Use um nome que seja exclusivo entre as regiões. O nome do cluster e a região na qual o cluster está implementado formam o nome completo do domínio para o subdomínio do Ingress. Para assegurar que o subdomínio do Ingress seja exclusivo dentro de uma região, o nome do cluster pode ser truncado e anexado com um valor aleatório dentro do nome de domínio do Ingress.

--operating-system UBUNTU_20_64|UBUNTU_24_64

Opcional. O sistema operacional dos nós do trabalhador no cluster. Para obter uma lista dos sistemas operacionais disponíveis por versão do cluster, consulte as informações da versão Kubernetes. Se nenhuma opção for especificada, o sistema operacional padrão que corresponde à versão do cluster será usado

--version MAJOR.MINOR.PATCH

Opcional: a versão do Kubernetes para o nó do cluster mestre. Quando a versão não for especificada, o cluster será criado com o padrão de versões do Kubernetes suportadas. Para ver as versões disponíveis, execute ibmcloud ks versions.

--no-subnet

Por padrão, uma sub-rede móvel pública e uma privada são criadas na VLAN associada ao cluster. Inclua a opção --no-subnet para evitar a criação de sub-redes com o cluster. É possível criar ou incluir sub-redes em um cluster posteriormente.

--sm-group GROUP

A ID do grupo secreto da instância Secrets Manager onde seus segredos são mantidos. Para obter um ID de grupo secreto, consulte o Secrets Manager referência CLI.

--sm-instance INSTANCE

O CRN da instância Secrets Manager. Para obter o CRN de uma instância, execute ibmcloud ks ingress instance ls --cluster CLUSTER.

--private-vlan PRIVATE_VLAN

Se esse cluster padrão for o primeiro cluster padrão que você criar nessa zona, não inclua essa opção. Uma VLAN privada é criada para você quando o cluster é criado. Se você criou um cluster padrão antes dessa zona ou criou uma VLAN privada na infraestrutura da IBM Cloud antes, deverá especificar essa VLAN privada. Os roteadores de VLAN privada sempre iniciam com bcr (roteador de backend) e roteadores de VLAN pública sempre iniciam com fcr (roteador de front-end). Ao criar um cluster e especificar as VLANs públicas e privadas, a combinação de número e letra após esses prefixos devem corresponder.

Para saber se você já tem uma VLAN privada para uma zona específica ou para localizar o nome de uma VLAN privada existente, execute ibmcloud ks vlan ls --zone ZONE.

--public-vlan PUBLIC_VLAN

Se esse cluster padrão for o primeiro cluster padrão que você criar nessa zona, não use essa opção. Uma VLAN pública é criada para você quando o cluster é criado. Se você criou um cluster padrão antes dessa zona ou criou uma VLAN pública na infraestrutura da IBM Cloud antes, especifique essa VLAN pública. Para conectar nós do trabalhador a apenas uma VLAN privada, não especifique essa opção. Os roteadores de VLAN privada sempre iniciam com bcr (roteador de backend) e roteadores de VLAN pública sempre iniciam com fcr (roteador de front-end). Ao criar um cluster e especificar as VLANs públicas e privadas, a combinação de número e letra após esses prefixos devem corresponder.

Para saber se você já tem uma VLAN pública para uma zona específica ou para localizar o nome de uma VLAN pública existente, execute ibmcloud ks vlan ls --zone ZONE.

--private-only

Use essa opção para evitar que uma VLAN pública seja criada. Necessário apenas quando você especificar a opção --private-vlan e não incluir a opção --public-vlan. Se os nós do trabalhador forem configurados somente com uma VLAN privada, o terminal em serviço de nuvem privada deverá ser ativado ou um dispositivo de gateway deverá ser configurado. Para obter mais informações, consulte Comunicação de trabalhador para principal e de usuário para principal.

--private-service-endpoint

Clusters padrão em contas que são ativadas com o VRF e terminais em serviço: ative o terminal em serviço de nuvem privada para que o principal do Kubernetes e os nós do trabalhador possam se comunicar por meio da VLAN privada. Além disso, você pode optar por ativar o ponto de extremidade do serviço de nuvem pública usando a opção --public-service-endpoint para acessar seu cluster pela Internet. Se você ativar somente o terminal em serviço de nuvem privada, deverá estar conectado à VLAN privada para se comunicar com o mestre do Kubernetes. Após ativar um terminal em serviço de nuvem privada, não é mais possível desativá-lo. Depois de criar o cluster, é possível obter o terminal executando ibmcloud ks cluster get --cluster <cluster_name_or_ID>.

--public-service-endpoint

Ative o terminal em serviço de nuvem pública para que o principal do Kubernetes possa ser acessado por meio da rede pública, por exemplo, para executar comandos kubectl por meio de sua linha de comandos. Os clusters somente públicos podem ser criados apenas em contas que não têm o VRF ativado Se você tiver uma conta que esteja habilitada com VRF e pontos de extremidade de serviço e também incluir a opção --private-service-endpoint, a comunicação do nó mestre-trabalhador passa pela rede privada e pública. Posteriormente, é possível desativar o terminal em serviço de nuvem pública se você desejar um cluster somente privado. Depois de criar o cluster, é possível obter o terminal executando ibmcloud ks cluster get --cluster <cluster_name_or_ID>.

--workers WORKERS

Opcional: Especifique o número de nós de trabalho a serem incluídos no cluster. O valor padrão é 1. Se você criar um cluster com somente um nó do trabalhador por zona, poderá ter problemas com o Ingress. Para alta disponibilidade, crie um cluster com pelo menos dois trabalhadores por zona. Cada nó do trabalhador recebe um ID de nó do trabalhador exclusivo e um nome de domínio que não devem ser mudados manualmente após a criação do cluster. Mudar o ID ou o nome do domínio evita que o mestre do Kubernetes gerencie o cluster.

--disable-disk-encrypt

Os nós do trabalhador apresentam criptografia de disco AES de 256 bits por padrão; saiba mais. Para desativar a criptografia, inclua essa opção.

--pod-subnet SUBNET

Todos os pods implantados em um nó de trabalho recebem um endereço IP privado no intervalo 172.17.0.0/18 por padrão. Se você planeja conectar seu cluster a redes no local por meio do IBM Cloud® Direct Link ou um serviço VPN, é possível evitar conflitos de sub-rede especificando um CIDR de sub-rede customizado que forneça os endereços IP privados para os seus pods.

Ao escolher um tamanho de sub-rede, considere o tamanho do cluster que planeja criar e o número de nós do trabalhador que podem ser incluídos no futuro. A sub-rede deve ter um CIDR de pelo menos /23, que fornece IPs de pod suficientes para um máximo de quatro nós do trabalhador em um cluster. Para clusters maiores, use /22 para ter endereços IP de pod suficientes para oito nós do trabalhador, /21 para ter endereços IP de pod suficientes para 16 nós do trabalhador e assim por diante.

A sub-rede que você escolheu deve estar dentro de um dos intervalos a seguir:

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.255.255

  • 198.18.0.0 - 198.19.255.255

Observe que as sub-redes de pod e de serviço não podem se sobrepor. A sub-rede de serviço está no intervalo 172.21.0.0/16 por padrão.

--service-subnet *SUBNET

Todos os serviços implementados no cluster recebem um endereço IP privado no intervalo de 172.21.0.0/16 por padrão. Se você planeja conectar seu cluster a redes no local por meio do IBM Cloud Direct Link ou um serviço de VPN, é possível evitar conflitos de sub-rede especificando um CIDR de sub-rede customizado que forneça os endereços IP privados para os seus serviços.

A sub-rede deve ser especificada no formato CIDR com um tamanho de pelo menos /24, que permite um máximo de 255 serviços no cluster, ou maior. A sub-rede que você escolheu deve estar dentro de um dos intervalos a seguir:

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.255.255

  • 198.18.0.0 - 198.19.255.255

Observe que as sub-redes de pod e de serviço não podem se sobrepor. A sub-rede de pod está no intervalo 172.30.0.0/16 por padrão.

--skip-advance-permissions-check

Opcional: ignore a verificação de permissões de infraestrutura antes de criar o cluster. Note que se você não tiver as permissões de infraestrutura corretas, a criação do cluster poderá ser bem-sucedida apenas parcialmente, como, por exemplo, o principal fornecendo, mas os nós do trabalhador incapazes de fornecer. Será possível ignorar a verificação de permissões ao continuar uma operação que estaria bloqueada de outra maneira, como ao usar diversas contas de infraestrutura e ser capaz de manipular os recursos de infraestrutura separadamente do principal, se necessário posteriormente.

-q

Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo cluster create classic comandos

Crie seu primeiro cluster: O primeiro cluster padrão criado em uma zona também cria uma VLAN privada. Portanto, não inclua a opção --public-vlan.

ibmcloud ks cluster create classic --zone dal10 --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system UBUNTU_20_64

Crie clusters padrão subsequentes: Se você já criou um cluster padrão nesta zona ou criou uma VLAN pública na infraestrutura IBM Cloud anteriormente, especifique essa VLAN pública com a opção --public-vlan. Para saber se você já tem uma VLAN pública para uma zona específica ou para localizar o nome de uma VLAN pública existente, execute ibmcloud ks vlan ls --zone <zone>.

ibmcloud ks cluster create classic --zone dal10 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --name my_cluster --hardware shared --workers 2 --operating-system UBUNTU_20_64

ibmcloud ks cluster create vpc-gen2

Virtual Private Cloud

Crie um cluster de Nuvem particular virtual (VPC) com nós do trabalhador na infraestrutura Geração 2. Ao efetuar login em sua conta do IBM Cloud, destine a região e o grupo de recursos do IBM Cloud onde você deseja criar seu cluster de VPC. Para ver as regiões suportadas, consulte Criando uma VPC em uma região diferente. O grupo de recursos do cluster pode diferir do grupo de recursos da VPC.

Os tipos de cluster VPC Gen 2 com armazenamento de instância estão disponíveis para contas permitidas na lista. Para ser incluído na lista de permissões, abra um caso com o suporte.

ibmcloud ks cluster create vpc-gen2 --name NAME --zone ZONE --vpc-id VPC_ID --subnet-id VPC_SUBNET_ID --flavor WORKER_FLAVOR [--cluster-security-group GROUP_ID] [--operating-system SYSTEM] [--version VERSION] [--workers NUMBER_WORKERS_PER_ZONE] [--dedicated-host-pool POOL] [--disable-outbound-traffic-protection] [--disable-public-service-endpoint] [--pod-subnet SUBNET] [--service-subnet SUBNET] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID][--skip-advance-permissions-check] [--sm-group GROUP] [--sm-instance INSTANCE] [-q] [--secondary-storage STORAGE]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para infraestrutura de VPC.
A função de acesso a plataforma Administrador para o IBM Cloud Kubernetes Service no nível da conta.
Função de acesso ao serviço Gravador ou Gerenciador para o IBM Cloud Kubernetes Service.
A função de acesso a plataforma Administrador para o IBM Cloud Container Registry no nível da conta.

Opções de comando:

--name NAME

Necessário: o nome para o cluster. O nome deve começar com uma letra, pode conter letras, números, pontos (.) e hífens (-) e deve conter 35 caracteres ou menos. Use um nome que seja exclusivo entre as regiões. O nome do cluster e a região na qual o cluster está implementado formam o nome completo do domínio para o subdomínio do Ingress. Para assegurar que o subdomínio do Ingress seja exclusivo dentro de uma região, o nome do cluster pode ser truncado e anexado com um valor aleatório dentro do nome de domínio do Ingress.

--zone ZONE

Necessário: selecione uma zona na qual implementar o conjunto de trabalhadores do cluster inicial. Se você criar o cluster em uma área metropolitana multizona, será possível incluir uma zona posteriormente no conjunto de trabalhadores. Para listar as zonas de VPC disponíveis, execute ibmcloud ks zone ls --provider vpc-gen2.

Quando você seleciona uma zona que está localizada fora de seu país, tenha em mente que você pode requerer autorização legal antes que os dados possam ser armazenados fisicamente em um país estrangeiro.

--vpc-id VPC_ID

Necessário: O ID da VPC no qual criar o cluster e os nós do trabalhador. Para listar os IDs disponíveis, execute ibmcloud ks vpcs.

--subnet-id VPC_SUBNET_ID

Necessário: a sub-rede da VPC a ser designada ao cluster. Para listar as sub-redes VPC disponíveis, execute ibmcloud ks subnets --provider vpc-gen2.

--version VERSION

A versão do Kubernetes para o nó principal do cluster. Para ver as versões disponíveis, execute ibmcloud ks versions.

--flavor FLAVOR

Escolha um tipo para os nós do trabalhador. É possível implementar os nós do trabalhador como máquinas virtuais em hardware compartilhado ou dedicado. Para ver os tipos que estão disponíveis em uma zona, execute ibmcloud ks flavors --zone <vpc_zone> --provider vpc-gen2.

--cluster-security-group GROUP_ID

Opcional. Especifique IDs de grupo de segurança adicionais para aplicar a todos os trabalhadores no cluster. Inclua uma opção --cluster-security-group separada para cada grupo de segurança individual que deseja incluir. Para aplicar o kube-clusterID criado pela IBM, use --cluster-security-group cluster. Se nenhum valor for especificado, apenas o kube-clusterID e o grupo de segurança padrão do VPC serão aplicados. Um máximo de cinco grupos de segurança pode ser aplicado aos trabalhadores, incluindo os grupos de segurança padrão. Observe que o grupo de segurança VPC só é aplicado se nenhum outro grupo de segurança for especificado. Para obter mais informações, consulte Incluindo grupos de segurança VPC em clusters e conjuntos de trabalhadores durante o tempo de criação. Os grupos de segurança aplicados a um cluster não podem ser mudados após a criação do cluster. Você pode alterar as regras dos grupos de segurança que são aplicados ao cluster, mas não pode adicionar ou remover grupos de segurança no nível do cluster. Se você aplicar os grupos de segurança incorretos no tempo de criação do cluster, deverá excluir o cluster e criar um novo. Para obter mais informações, consulte Adição de grupos de segurança VPC a clusters e pools de trabalho durante o tempo de criação.

--operating-system UBUNTU_20_64|UBUNTU_24_64

Opcional. O sistema operacional dos nós do trabalhador no cluster. Para obter uma lista dos sistemas operacionais disponíveis por versão do cluster, consulte as informações da versão Kubernetes. Se nenhuma opção for especificada, o sistema operacional padrão que corresponde à versão do cluster será usado

--preview PREVIEW

Opcional: especifique um ou mais recursos de visualização de nível de cluster, como fips.

--dedicated-host-pool POOL

Opcional: o ID do conjunto de hosts dedicado no qual você deseja executar seus trabalhadores.

--workers NUMBER_WORKERS_PER_ZONE

Opcional: especifique o número de nós do trabalhador a serem incluídos no cluster. O valor padrão é 1.

--disable-outbound-traffic-protection

Inclua essa opção para permitir o acesso de saída pública dos trabalhadores do cluster. Por padrão, o acesso de saída pública é bloqueado no OpenShift versões 4.15 e mais recentes e Kubernetes versões 1.30 e mais recentes.

--disable-public-service-endpoint

Para garantir que os nós de trabalho e os usuários autorizados do cluster se comuniquem com o mestre somente por meio do ponto de extremidade do serviço de nuvem privada, inclua essa opção para criar o cluster sem o ponto de extremidade do serviço de nuvem pública.

--pod-subnet SUBNET

No primeiro cluster que você cria em uma VPC, a sub-rede de pod padrão é 172.17.0.0/18. No segundo cluster que você cria naquela VPC, a sub-rede de pod padrão é 172.17.64.0/18. Em cada cluster subsequente, o intervalo de sub-rede do pod é a próxima sub-rede disponível não sobreposta /18. Se você planeja conectar seu cluster a redes no local por meio do IBM Cloud® Direct Link ou um serviço VPN, é possível evitar conflitos de sub-rede especificando um CIDR de sub-rede customizado que forneça os endereços IP privados para os seus pods.

Ao escolher um tamanho de sub-rede, considere o tamanho do cluster que planeja criar e o número de nós do trabalhador que podem ser incluídos no futuro. A sub-rede deve ter um CIDR de pelo menos /23, que fornece IPs de pod suficientes para um máximo de quatro nós do trabalhador em um cluster. Para clusters maiores, use /22 para ter endereços IP de pod suficientes para oito nós do trabalhador, /21 para ter endereços IP de pod suficientes para 16 nós do trabalhador e assim por diante.

: Todos os pods implantados em um nó de trabalho recebem um endereço IP privado no intervalo 172.17.0.0/18 por padrão. Se você planeja conectar seu cluster a redes no local por meio do IBM Cloud® Direct Link ou um serviço VPN, é possível evitar conflitos de sub-rede especificando um CIDR de sub-rede customizado que forneça os endereços IP privados para os seus pods.

Para clusters VPC, é possível especificar o tamanho da sub-rede, incluindo-o na opção --pod-subnet Por exemplo: --pod-subnet 0.0.0.0/X em que X é o tamanho de sub-rede do pod necessário. Em seguida, a sub-rede do pod é selecionada automaticamente. Ao alocar a sub-rede do pod automaticamente, a alocação será iniciada em 172.17.0.0, a maior sub-rede será limitada a 13 e o menor tamanho de sub-rede será limitado a 23. Para obter mais informações, consulte Configurando as sub-redes do VPC A sub-rede escolhida precisa estar dentro de um dos intervalos a seguir.

  • 172.17.0.0 - 172.17.255.255

  • 172.21.0.0 - 172.31.255.255

  • 192.168.0.0 - 192.168.255.255

  • 198.18.0.0 - 198.19.255.255

Observe que as sub-redes de pod e de serviço não podem se sobrepor. Se usar sub-redes customizadas para nós do trabalhador, você deverá assegurar que as sub-redes do nó do trabalhador não se sobreponham à sub-rede de pod do cluster.

--service-subnet SUBNET

Todos os serviços implementados no cluster recebem um endereço IP privado no intervalo de 172.21.0.0/16 por padrão. Se você planeja conectar seu cluster a redes no local por meio do IBM Cloud Direct Link ou um serviço de VPN, é possível evitar conflitos de sub-rede especificando um CIDR de sub-rede customizado que forneça os endereços IP privados para os seus serviços. A sub-rede deve ser especificada no formato CIDR com um tamanho de pelo menos /24, que permite um máximo de 255 serviços no cluster, ou maior. A sub-rede escolhida precisa estar dentro de um dos intervalos a seguir.

  • 172.17.0.0 - 172.17.255.255
  • 172.21.0.0 - 172.31.255.255
  • 192.168.0.0 - 192.168.255.255
  • 198.18.0.0 - 198.19.255.255

Observe que as sub-redes de pod e de serviço não podem se sobrepor.

--skip-advance-permissions-check

Opcional: ignore a verificação de permissões de infraestrutura antes de criar o cluster. Note que se você não tiver as permissões de infraestrutura corretas, a criação do cluster poderá ser bem-sucedida apenas parcialmente, como, por exemplo, o principal fornecendo, mas os nós do trabalhador incapazes de fornecer. Será possível ignorar a verificação de permissões ao continuar uma operação que estaria bloqueada de outra maneira, como ao usar diversas contas de infraestrutura e ser capaz de manipular os recursos de infraestrutura separadamente do principal, se necessário posteriormente.

--kms-account-id ID

Opcional: O ID da conta que contém a instância do KMS que você deseja usar para criptografia de disco local ou secreta.

--kms-instance KMS_INSTANCE_ID

Opcional: inclua o ID de uma instância de serviço de gerenciamento de chaves (KMS) para criptografar o disco local nos nós do trabalhador no conjunto de trabalhadores default. Para listar instâncias KMS disponíveis, execute ibmcloud ks kms instance ls. Ao incluir esta opção, é preciso também incluir a opção --crk. Antes de usar a criptografia KMS, é preciso criar uma instância KMS e configurar a autorização de serviço necessária no IAM. Consulte Gerenciando a criptografia para os nós de processamento em seu cluster.

--crk ROOT_KEY

Opcional: inclua o ID da chave raiz na instância do KMS para criptografar o disco local nos nós do trabalhador no conjunto de trabalhadores default. Para listar chaves de raiz disponíveis, execute ibmcloud ks kms crk ls --instance-id. Ao incluir esta opção, é preciso também incluir a opção --kms-instance. Antes de usar a criptografia KMS, é preciso criar uma instância KMS e configurar a autorização de serviço necessária no IAM. Consulte Gerenciando a criptografia para os nós de processamento em seu cluster.

--sm-group GROUP

A ID do grupo secreto da instância Secrets Manager onde seus segredos são mantidos. Para obter um ID de grupo secreto, consulte o Secrets Manager referência CLI.

--sm-instance INSTANCE

O CRN da instância Secrets Manager. Para localizar o CRN de uma instância, execute ibmcloud ks ingress instance ls --cluster CLUSTER.

--secondary-storage STORAGE

Opcional: A opção de armazenamento para o sabor. Por exemplo, 900gb.5iops-tier. Ao adicionar um disco secundário, esse disco é usado para o tempo de execução do container, enquanto que o disco primário é usado para o sistema operacional. Para visualizar as opções de armazenamento para um aroma, execute o comando **ibmcloud ks flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2.

-q

Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster create vpc-gen2

ibmcloud ks cluster create vpc-gen2 --name mycluster --version 1.32 --zone us-south-1 --vpc-id a0123456-78b9-0c1d-23d4-567890123ef4 --subnet-id 1ab23c45-6789-0123-456d-789ef01gh234 --flavor bx2.4x16 --workers 3

ibmcloud ks cluster get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um cluster.

ibmcloud ks cluster get --cluster CLUSTER [--show-resources] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--show-resources
Mostre mais recursos de cluster, como complementos, VLANs, sub-redes e armazenamento.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster get

ibmcloud ks cluster get --cluster my_cluster --show-resources

ibmcloud ks cluster image-security disable

Virtual Private Cloud Infra-estrutura Classic

Desative o cumprimento de segurança de imagem. Ao desativar o recurso, o CRD ClusterImagePolicy subjacente é removido, o que remove todas as políticas de imagem padrão e quaisquer políticas de imagens customizadas que você criou.

ibmcloud ks cluster image-security disable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster image-security disable

ibmcloud ks cluster image-security disable --cluster my_cluster

ibmcloud ks cluster image-security enable

Virtual Private Cloud Infra-estrutura Classic

Ative o cumprimento de segurança de imagem instalando o controlador de admissão do Portieris Kubernetes e as políticas de imagem padrão associadas em seu cluster.

ibmcloud ks cluster image-security enable --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster image-security enable

ibmcloud ks cluster image-security enable --cluster my_cluster

ibmcloud ks cluster ls

Virtual Private Cloud Infra-estrutura Classic Satellite

Liste todos os clusters em sua conta do IBM Cloud.

Os clusters em todos os locais são retornados. Para filtrar os clusters por um local específico, inclua a opção --location. Por exemplo, se você filtrar clusters da área metropolitana dal, serão retornados clusters de diversas zonas nessa área metropolitana e clusters de zona única em data centers (zonas) dentro dessa área metropolitana. Se você filtrar clusters para o data center dal10 (zona), serão retornados clusters de diversas zonas que tiverem um nó do trabalhador nessa zona e clusters de zona única nessa zona. É possível passar um local ou uma lista de locais separada por vírgulas.

ibmcloud ks cluster ls [--provider (classic | vpc-gen2)] [--location LOCATION] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--provider (classic | vpc-gen2)
Opcional: saída de filtro com base no tipo de provedor de infraestrutura.
-l, --location LOCATION
Filtre a saída por um local específico. Para ver locais suportados, execute ibmcloud ks locations. Para especificar vários locais, use uma opção para cada local, como -l dal -l seo.
--output json
Opcional: imprimirá a saída de comando em formato JSON. Observação: se você não incluir a opção --provider, somente os clusters clássicos serão retornados.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster ls

ibmcloud ks cluster ls -l ams03 -l wdc -l ap

ibmcloud ks cluster master audit-webhook

Modifique o back-end do webhook que encaminha os logs de auditoria do servidor de API para um servidor remoto.

Os aliases apiserver-config-get|set|unset audit-webhook para estes comandos foram descontinuados.

ibmcloud ks cluster master audit-webhook get

Visualize a URL para o serviço de criação de log remoto para o qual você está enviando logs de auditoria do servidor de API. A URL foi especificada quando você criou o back-end do webhook para a configuração do servidor de API.

ibmcloud ks cluster master audit-webhook get --cluster CLUSTER [-q]

Infraestrutura clássica

Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master audit-webhook get
ibmcloud ks cluster master audit-webhook get --cluster mycluster

ibmcloud ks cluster master audit-webhook set

Infraestrutura clássica

Configure o backend do webhook para a configuração do servidor de API. O back-end do webhook encaminha os logs de auditoria do servidor de API para um servidor remoto. Depois de configurar o webhook, deve-se executar o comando ibmcloud ks cluster master refresh para aplicar as mudanças no mestre do Kubernetes.

ibmcloud ks cluster master audit-webhook set --cluster CLUSTER [--remote-server SERVER_URL_OR_IP] [--ca-cert CA_CERT_PATH] [--client-cert CLIENT_CERT_PATH] [--client-key CLIENT_KEY_PATH] [--policy POLICY] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--remote-server SERVER_URL
Opcional: a URL ou o endereço IP para o serviço de criação de log remoto para o qual você deseja enviar logs de auditoria. Se você fornecer uma URL insegura do servidor, todos os certificados serão ignorados. Se você fornecer um endereço IP, inclua o prefixo http:// no IP.
--ca-cert CA_CERT_PATH
Opcional: o caminho de arquivo para o certificado de autoridade de certificação que é usado para verificar o serviço de criação de log remoto.
--client-cert CLIENT_CERT_PATH
Opcional: o caminho de arquivo para o certificado de cliente que é usado para se autenticar no serviço de criação de log remoto.
--client-key CLIENT_KEY_PATH
Opcional: o caminho de arquivo para a chave do cliente correspondente que é usado para se conectar ao serviço de criação de log remoto.
--policy POLICY
Opcional: o tipo de política que é utilizada para auditoria. Use default ou verbose. Observe que o tipo de política verbose audita um número maior de transações de API, o que pode afetar o desempenho do cluster, e é recomendado apenas para uso ocasional.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master audit-webhook set
ibmcloud ks cluster master audit-webhook set --cluster my_cluster --remote-server https://audit.example.com/audit --ca-cert /mnt/etc/kubernetes/apiserver audit/ca.pem --client-cert /mnt/etc/kubernetes/apiserver audit/cert.pem --client-key /mnt/etc/kubernetes/apiserver audit/key.pem

ibmcloud ks cluster master audit-webhook unset

Infraestrutura clássica

Desative a configuração de backend de webhook para o servidor de API do cluster. Desativando o back-end do webhook para o encaminhamento de logs de auditoria do servidor de API para um servidor remoto.

ibmcloud ks cluster master audit-webhook unset --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks cluster master console-oauth-access get

Obtenha o console da web do OpenShift e o tipo de acesso do servidor OAuth.

ibmcloud ks cluster master console-oauth-access get --cluster CLUSTER [--output OUTPUT] [-q]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

ibmcloud ks cluster master console-oauth-access set

Configure o console da web do OpenShift e o tipo de acesso do servidor OAuth

ibmcloud ks cluster master console-oauth-access set --cluster CLUSTER [-f] [-q] [--type TYPE]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--type TYPE
Especifique o console da web do OpenShift e o tipo de acesso do servidor OAuth Valores aceitos: vpe-gateway, legacy

ibmcloud ks cluster master pod-security get

Virtual Private Cloud Infra-estrutura Classic

Visualize a configuração de admissão de segurança do pod para o servidor de API Kubernetes de um cluster.

ibmcloud ks cluster master pod-security get --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security get

ibmcloud ks cluster master pod-security get --cluster mycluster

ibmcloud ks cluster master pod-security policy disable

Virtual Private Cloud Infra-estrutura Classic

Desative a política de segurança de pod para o servidor de API do Kubernetes de um cluster.

ibmcloud ks cluster master pod-security policy disable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security policy disable

ibmcloud ks cluster master pod-security policy disable --cluster mycluster

ibmcloud ks cluster master pod-security policy enable

Virtual Private Cloud Infra-estrutura Classic

Ative a política de segurança de pod para um servidor de API do Kubernetes do cluster.. Observe que as políticas de segurança de pod não estão disponíveis em clusters que executam a versão 1.25 ou mais recente

ibmcloud ks cluster master pod-security policy enable --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security policy enable

ibmcloud ks cluster master pod-security policy enable --cluster mycluster

ibmcloud ks cluster master pod-security policy get

Virtual Private Cloud Infra-estrutura Classic

Visualize a configuração da política de segurança do pod para o servidor de API Kubernetes de um cluster. Observe que as políticas de segurança de pod não estão disponíveis em clusters que executam a versão 1.25 ou mais recente

ibmcloud ks cluster master pod-security policy get --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security policy get

ibmcloud ks cluster master pod-security policy get --cluster mycluster

ibmcloud ks cluster master pod-security set

Virtual Private Cloud Infra-estrutura Classic

Configure e ative a admissão de segurança de pod para um servidor de APIs do Kubernetes do cluster...

ibmcloud ks cluster master pod-security set --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security set

ibmcloud ks cluster master pod-security set --cluster mycluster

ibmcloud ks cluster master pod-security unset

Virtual Private Cloud Infra-estrutura Classic

Remova a configuração de admissão de segurança de pod para um servidor de API Kubernetes do cluster.

ibmcloud ks cluster master pod-security unset --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master pod-security unset

ibmcloud ks cluster master pod-security unset --cluster mycluster

ibmcloud ks cluster master private-service-endpoint allowlist

As listas de permissão de ponto de extremidade de serviço privado não são mais suportadas. Migrar de listas de permissão para restrições baseadas em contexto o mais rápido possível. Para obter mais informações, consulte Migração de uma lista de permissões de ponto de extremidade de serviço privado para restrições baseadas em contexto(CBR).

Gerencie uma lista de permissões do terminal em serviço de nuvem privada para que os usuários autorizados possam acessar o seu terminal em serviço de nuvem privada somente por meio das sub-redes especificadas na lista de permissões.

ibmcloud ks cluster master private-service-endpoint allowlist add

Virtual Private Cloud Infra-estrutura Classic

Depois de ativar uma lista de permissões do terminal em serviço de nuvem privada, inclua sub-redes por meio das quais os usuários autorizados podem acessar o seu terminal em serviço de nuvem privada na lista de permissões.

Por exemplo, para acessar o terminal em serviço de nuvem privada de seu cluster, deve-se conectar à rede clássica da IBM Cloud ou à rede VPC por meio de uma VPN ou do IBM Cloud Direct Link. É possível incluir a sub-rede para a VPN ou o túnel do IBM Cloud Direct Link para que os usuários autorizados em sua organização possam acessar o terminal em serviço de nuvem privada somente por meio dessa sub-rede.

As sub-redes do nó do trabalhador são automaticamente incluídas e removidas de sua lista de permissões para que os nós do trabalhador sempre possam acessar o principal por meio do terminal em serviço de nuvem privada.

ibmcloud ks cluster master private-service-endpoint allowlist add --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--subnet SUBNET
Necessário: a sub-rede no formato CIDR. Especifique mais de uma sub-rede usando várias opções repetidas.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master private-service-endpoint allowlist add
ibmcloud ks cluster master private-service-endpoint allowlist add --cluster mycluster --subnet 1.1.1.1/16

ibmcloud ks cluster master private-service-endpoint allowlist disable

Virtual Private Cloud Infra-estrutura Classic

Desative o recurso de lista de permissões de sub-rede para um terminal em serviço de nuvem privada do cluster.

Depois de desativar esse recurso, as solicitações autorizadas para seu cluster principal por meio do terminal em serviço de nuvem privada do cluster podem ser originadas de qualquer sub-rede.

ibmcloud ks cluster master private-service-endpoint allowlist disable --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar o comando a ser executado sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master private-service-endpoint allowlist disable
ibmcloud ks cluster master private-service-endpoint allowlist disable --cluster mycluster

ibmcloud ks cluster master private-service-endpoint allowlist enable

Virtual Private Cloud Infra-estrutura Classic

Ative o recurso de lista de permissões de sub-rede para um terminal em serviço de nuvem privada do cluster.

Depois de executar esse comando, use o comando ibmcloud ks cluster master private-service-endpoint allowlist para incluir sub-redes na lista de permissões. Somente solicitações autorizadas para o seu cluster principal originadas de sub-redes na lista de permissões são permitidas por meio do terminal em serviço de nuvem privada do cluster. Se o terminal em serviço de nuvem pública estiver ativado para seu cluster, as solicitações autorizadas ainda serão permitidas por meio do terminal em serviço de nuvem pública.

ibmcloud ks cluster master private-service-endpoint allowlist enable --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar o comando a ser executado sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master private-service-endpoint allowlist enable
ibmcloud ks cluster master private-service-endpoint allowlist enable --cluster mycluster

ibmcloud ks cluster master private-service-endpoint allowlist get

Virtual Private Cloud Infra-estrutura Classic

Liste todas as sub-redes na lista de permissões para um terminal em serviço de nuvem privada do cluster.

Essa lista inclui as sub-redes que você incluiu manualmente usando o comando ibmcloud ks cluster master private-service-endpoint allowlist add e as sub-redes que são automaticamente incluídas e gerenciadas pela IBM, como as sub-redes de nó do trabalhador.

ibmcloud ks cluster master private-service-endpoint allowlist get --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master private-service-endpoint allowlist get
ibmcloud ks cluster master private-service-endpoint allowlist get --cluster mycluster

ibmcloud ks cluster master private-service-endpoint allowlist rm

Virtual Private Cloud Infra-estrutura Classic

Remova as sub-redes incluídas anteriormente na lista de permissões para um terminal em serviço de nuvem privada do cluster.

Após a remoção de uma sub-rede, todas as solicitações originadas dessa sub-rede para o cluster principal por meio do terminal em serviço de nuvem privada serão negadas.

ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster CLUSTER --subnet SUBNET [--subnet SUBNET ...] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--subnet SUBNET
Necessário: a sub-rede CIDR. Especifique mais de uma sub-rede usando várias opções repetidas.
-f
Opcional: forçar o comando a ser executado sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
Exemplo de comando cluster master private-service-endpoint allowlist rm
ibmcloud ks cluster master private-service-endpoint allowlist rm --cluster mycluster
 --subnet 1.1.1.1/16

ibmcloud ks cluster master private-service-endpoint disable

Infraestrutura clássica

Desative o terminal em serviço de nuvem privada para remover a acessibilidade privada para o cluster mestre.

Importante: antes de desativar o terminal privado, primeiro deve-se concluir as etapas a seguir para ativar o terminal em serviço de nuvem pública:

  1. Ative o terminal em serviço de nuvem pública executando ibmcloud ks cluster master public-service-endpoint enable --cluster <cluster_name>.
  2. Siga o prompt na CLI para atualizar o servidor de API do mestre do Kubernetes.
  3. Recarregue todos os nós do trabalhador no cluster para captar a configuração do terminal público.
ibmcloud ks cluster master private-service-endpoint disable --cluster CLUSTER [-f] [-q] [-y]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
-y
Opcional: atualize o cluster mestre e recarregue os nós do trabalhador sem prompts de usuário.

Exemplo de comando cluster master private-service-endpoint disable

ibmcloud ks cluster master private-service-endpoint disable --cluster my_cluster

ibmcloud ks cluster master private-service-endpoint enable

Infraestrutura clássica

Ative o terminal em serviço de nuvem privada para tornar o seu cluster principal acessível de forma privada.

Para executar este comando:

  1. Ative o VRF em sua conta de infraestrutura do IBM Cloud. Para verificar se um VRF já está ativado, use o comando ibmcloud account show.
  2. Ative sua conta do IBM Cloud para usar os terminais em serviço.
  3. Execute o ibmcloud ks cluster master private-service-endpoint enable --cluster <cluster_name>.
  4. Siga o prompt na CLI para atualizar o servidor de API do mestre do Kubernetes.
  5. Recarregue todos os nós do trabalhador em seu cluster para selecionar a configuração de terminal privado.
ibmcloud ks cluster master private-service-endpoint enable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
-y
Opcional: atualize o cluster mestre e recarregue os nós do trabalhador sem prompts de usuário.

Exemplo de comando cluster master private-service-endpoint enable

ibmcloud ks cluster master private-service-endpoint enable --cluster my_cluster

ibmcloud ks cluster master public-service-endpoint disable

Virtual Private Cloud Infra-estrutura Classic

Desative o terminal em serviço de nuvem pública para um cluster.

Importante: antes de desativar o terminal público, primeiro deve-se concluir as seguintes etapas para ativar o terminal em serviço de nuvem privada:

  1. Ative o terminal em serviço de nuvem privada executando ibmcloud ks cluster master private-service-endpoint enable --cluster <cluster_name>.
  2. Siga o prompt na CLI para atualizar o servidor de API do mestre do Kubernetes.
  3. Recarregue todos os nós do trabalhador em seu cluster para selecionar a configuração de terminal privado.
ibmcloud ks cluster master public-service-endpoint disable --cluster CLUSTER [-q] [-f]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-y
Opcional: atualize o cluster mestre e recarregue os nós do trabalhador sem prompts de usuário.

Exemplo de comando cluster master public-service-endpoint disable

ibmcloud ks cluster master public-service-endpoint disable --cluster my_cluster

ibmcloud ks cluster master public-service-endpoint enable

Virtual Private Cloud Infra-estrutura Classic

Ative o terminal em serviço de nuvem pública para tornar o seu cluster mestre acessível publicamente.

Após a execução desse comando, deve-se atualizar o servidor de API para usar o terminal de serviço seguindo o prompt na CLI.

ibmcloud ks cluster master public-service-endpoint enable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
-y
Opcional: atualize o cluster mestre sem prompts de usuário.

Exemplo de comando cluster master public-service-endpoint enable

ibmcloud ks cluster master public-service-endpoint enable --cluster my_cluster

ibmcloud ks cluster master refresh

Virtual Private Cloud Infra-estrutura Classic

Aplique as mudanças de configuração para o mestre do Kubernetes que são solicitadas com os comandos ibmcloud ks cluster master. Os componentes do principal do Kubernetes altamente disponíveis são reiniciados em uma reinicialização contínua. Os nós do trabalhador, os apps e os recursos não são modificados e continuam a ser executados.

Os aliases apiserver-refresh e cluster-refresh para este comando foram descontinuados.

ibmcloud ks cluster master refresh --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks cluster master update

Virtual Private Cloud Infra-estrutura Classic Satellite

Atualize o servidor principal e de API do Kubernetes Durante a atualização, não é possível acessar ou mudar o cluster. Os nós de trabalho, aplicativos e recursos que foram implantados não são modificados e continuam a ser executados.

Pode ser necessário mudar seus arquivos YAML para implementações futuras. Revise essa nota sobre a liberação para obter detalhes.

O alias cluster-update para esse comando foi descontinuado.

ibmcloud ks cluster master update --cluster CLUSTER [--version MAJOR.MINOR.PATCH] [--force-update] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--version MAJOR.MINOR.PATCH
Opcional: a versão do Kubernetes do cluster. Se você não especificar uma versão, o principal do Kubernetes será atualizado para a versão padrão da API. Para ver as versões disponíveis, execute ibmcloud ks versions.
--force-update
Opcional: tente realizar a atualização mesmo se a mudança for mais recente que a versão do nó do trabalhador em mais de duas versões secundárias.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster master update

ibmcloud ks cluster master update --cluster my_cluster

ibmcloud ks cluster pull-secret apply

Virtual Private Cloud Infra-estrutura Classic

Crie um ID de serviço do IBM Cloud IAM para o cluster, crie uma política para o ID de serviço que designa a função de acesso ao serviço Leitor no IBM Cloud Container Registry e, em seguida, crie uma chave de API para o ID de serviço. A chave de API é então armazenada em um segredo de extração de imagem de Kubernetes para que seja possível fazer o pull de imagens dos seus namespaces do IBM Cloud Container Registry para contêineres que estão no namespace do Kubernetes default. Esse processo acontece automaticamente quando você cria um cluster. Se você tiver um erro durante o processo de criação do cluster ou tiver um cluster existente, será possível usar esse comando para aplicar o processo novamente.

Usando chaves de API do IAM para acessar IBM Cloud Container Registry, você pode personalizar as políticas do IAM para o ID do serviço a fim de restringir o acesso aos seus namespaces ou a imagens específicas. Por exemplo, é possível mudar as políticas de ID de serviço no segredo de extração da imagem do cluster para extrair imagens de apenas uma determinada região de registro ou namespace. Antes de poder customizar as políticas do IAM, deve-se ativar as políticas do IBM Cloud IAM para o IBM Cloud Container Registry. Para obter mais informações, consulte Entendendo como seu cluster é autorizado a extrair imagens do IBM Cloud Container Registry.

Quando você executa esse comando, a criação de credenciais do IAM e de segredos de extração de imagem é iniciada e pode levar algum tempo para ser concluída. Não é possível implementar contêineres que extraem uma imagem dos domínios do IBM Cloud Container Registry icr.io até que os segredos de extração de imagem sejam criados. Para verificar os segredos de pull de imagem, execute kubectl get secrets | grep icr-io. Se você incluiu políticas do IAM em um ID de serviço existente, como para restringir o acesso a um registro regional, o ID do serviço, as políticas do IAM e a chave de API para o segredo de extração da imagem serão reconfigurados por esse comando.

ibmcloud ks cluster pull-secret apply --cluster CLUSTER

Permissões mínimas necessárias:

  • Função de acesso à plataforma Operador ou Administrador para o cluster no IBM Cloud Kubernetes Service
  • Função de acesso à plataforma Administrador no IBM Cloud Container Registry em todas as regiões e grupos de recursos. A política não pode ter o escopo definido para uma determinada região ou grupo de recursos.

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.

ibmcloud ks cluster rm

Virtual Private Cloud Infra-estrutura Classic

Excluir um cluster. Todos os nós do trabalhador, apps e contêineres são excluídos permanentemente. Não é possível desfazer essa ação.

ibmcloud ks cluster rm --cluster CLUSTER [--force-delete-storage] [--skip-advance-permissions-check] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--force-delete-storage
Opcional: exclui o cluster e qualquer armazenamento persistente que o cluster usa. Atenção: Se você incluir essa opção, os dados armazenados no cluster ou em suas instâncias de armazenamento associadas não poderão ser recuperados.
--skip-advance-permissions-check
Opcional: ignore a verificação de permissões de infraestrutura antes de excluir o cluster. Note que se você não tiver as permissões de infraestrutura corretas, a exclusão do cluster poderá ser bem-sucedida apenas parcialmente, como, por exemplo, o principal gerenciado pela IBM sendo removido, mas os nós do trabalhador não sendo removidos da conta de infraestrutura. Será possível ignorar a verificação de permissões ao continuar uma operação que estaria bloqueada de outra maneira, como ao usar diversas contas de infraestrutura e ser capaz de manipular os recursos de infraestrutura separadamente do principal, se necessário posteriormente.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster rm

ibmcloud ks cluster rm --cluster my_cluster

ibmcloud ks cluster service bind

Virtual Private Cloud Infra-estrutura Classic

Inclua um serviço IBM Cloud em um cluster ligando a instância de serviço a um namespace do Kubernetes. Esse comando cria credenciais de um serviço IBM Cloud e as armazena em um segredo do Kubernetes em seu cluster.

Para visualizar os serviços do IBM Cloud disponíveis por meio do catálogo do IBM Cloud, execute ibmcloud service offerings. Nota: é possível incluir apenas serviços do IBM Cloud que suportam chaves de serviço. Para obter mais informações sobre a ligação de serviços e quais serviços podem ser incluídos em seu cluster, consulte Incluindo serviços usando a ligação de serviços do IBM Cloud.

ibmcloud ks cluster service bind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE [--key SERVICE_INSTANCE_KEY] [--role IAM_SERVICE_ROLE] --service SERVICE_INSTANCE [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-n, --namespace KUBERNETES_NAMESPACE
Necessário: o nome do namespace do Kubernetes no qual você deseja criar o segredo do Kubernetes para suas credenciais de serviço.
--key SERVICE_INSTANCE_KEY
Opcional: o nome ou o GUID de uma chave de serviço existente. Quando você usa o comando service-binding, as novas credenciais de serviço são criadas automaticamente para sua instância de serviço e designadas à função de acesso ao serviço Gravador do IAM para serviços ativados para IAM. Se desejar usar uma chave de serviço existente que você criou anteriormente, use essa opção. Se você definir uma chave de serviço, não será possível configurar a opção --role ao mesmo tempo, pois as chaves de serviço já são criadas com uma função de acesso de serviço IAM específica.
--role IAM_SERVICE_ROLE
A função do IBM Cloud IAM que você deseja que a chave de serviço tenha. Esse valor é opcional e pode ser usado somente para serviços ativados para IAM. Se você não definir essa opção, suas credenciais de serviço serão criadas automaticamente e receberão a função de acesso de serviço IAM Gravador. Para usar as chaves de serviço existentes especificando a opção --key, não inclua essa opção. Para listar funções disponíveis para o serviço, execute ibmcloud iam roles --service <service_name>. O nome do serviço é o nome do serviço no catálogo, que é possível obter executando ibmcloud catalog search.
--service SERVICE_INSTANCE
Necessário: o nome da instância de serviço da IBM Cloud que você deseja ligar. Para localizar o nome, execute ibmcloud resource service-instances.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster service bind

ibmcloud ks cluster service bind --cluster my_cluster --namespace my_namespace --service my_service_instance

ibmcloud ks cluster service ls

Virtual Private Cloud Infra-estrutura Classic

Liste os serviços que estão ligados a um ou todos os espaços de nomes do Kubernetes em um cluster. Se nenhuma opção é especificada, os serviços para o namespace padrão são exibidos.

ibmcloud ks cluster service ls --cluster CLUSTER [--namespace KUBERNETES_NAMESPACE] [--all-namespaces] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-n, --namespace KUBERNETES_NAMESPACE
Opcional: inclua os serviços que estão ligados a um namespace específico em um cluster.
--all-namespaces
Opcional: inclua os serviços que estão ligados a todos os espaços de nomes em um cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster service ls

ibmcloud ks cluster service ls --cluster my_cluster --namespace my_namespace

ibmcloud ks cluster service unbind

Virtual Private Cloud Infra-estrutura Classic

Remova um serviço do IBM Cloud de um cluster, desvinculando-o de um namespace do Kubernetes.

Quando você remove um serviço do IBM Cloud, as credenciais de serviço são removidas do cluster. Se um pod ainda estiver usando o serviço, ele falhará porque as credenciais de serviço não podem ser localizadas.

ibmcloud ks cluster service unbind --cluster CLUSTER --namespace KUBERNETES_NAMESPACE --service SERVICE_INSTANCE [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-n, --namespace KUBERNETES_NAMESPACE
Necessário: o nome do namespace do Kubernetes.
--service SERVICE_INSTANCE
Necessário: o nome da instância de serviço da IBM Cloud que você deseja remover. Para localizar o nome da instância de serviço, execute ibmcloud ks cluster service ls --cluster <cluster_name_or_ID>.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster service unbind

ibmcloud ks cluster service unbind --cluster my_cluster --namespace my_namespace --service 8567221

ibmcloud ks cluster subnet add

Infraestrutura clássica

Disponibilize uma sub-rede clássica pública ou privada, móvel e existente em sua conta de infraestrutura da IBM Cloud disponível para um cluster ou reuse sub-redes de um cluster excluído em vez de usar as sub-redes provisionadas automaticamente.

Quando você torna uma sub-rede disponível para um cluster, os endereços IP dessa sub-rede são usados para propósitos de rede do cluster. Para evitar conflitos de endereço IP, certifique-se de usar uma sub-rede com somente um cluster. Não use uma sub-rede para múltiplos clusters ou para outros propósitos fora do IBM Cloud Kubernetes Service ao mesmo tempo. Se você usar a mesma sub-rede entre diversos clusters, seu certificado TLS padrão do Ingress poderá se tornar invalidado. Para ativar a comunicação entre trabalhadores que estão em sub-redes diferentes na mesma VLAN em contas não VRF, é necessário ativar o roteamento entre sub-redes na mesma VLAN.

ibmcloud ks cluster subnet add --cluster CLUSTER --subnet-id SUBNET [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--subnet-id SUBNET
Necessário: o ID da sub-rede.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster subnet add

ibmcloud ks cluster subnet add --cluster my_cluster --subnet-id 1643389

ibmcloud ks cluster subnet create

Infraestrutura clássica

Crie uma sub-rede clássica móvel em uma conta de infraestrutura da IBM Cloud em sua VLAN pública ou privada e disponibilize-a para um cluster.

Os endereços IP públicos móveis são cobrados mensalmente. Se você remover os endereços IP públicos móveis depois que o cluster for provisionado, ainda terá que pagar o encargo mensal, mesmo se os tiver usado apenas por um curto período de tempo. Quando você torna uma sub-rede disponível para um cluster, os endereços IP dessa sub-rede são usados para propósitos de rede do cluster. Para evitar conflitos de endereço IP, certifique-se de usar uma sub-rede com somente um cluster. Não use uma sub-rede para múltiplos clusters ou para outros propósitos fora do IBM Cloud Kubernetes Service ao mesmo tempo. Se você usar a mesma sub-rede entre diversos clusters, seu certificado TLS padrão do Ingress poderá se tornar invalidado. Em clusters clássicos, caso haja várias VLANs para o cluster, várias sub-redes na mesma VLAN ou um cluster clássico de várias zonas, deve-se ativar uma Virtual Router Function (VRF) para a conta de infraestrutura do IBM Cloud para que os nós do trabalhador possam se comunicar entre si na rede privada. Para ativar o VRF, consulte Ativando o VRF. Para verificar se um VRF já está ativado, use o comando ibmcloud account show. Se não puder ou não quiser ativar a VRF, ative a Ampliação de VLAN. Para executar esta ação, você precisa da permissão de infraestrutura Rede > Gerenciar VLAN de rede ou pode solicitar que o proprietário da conta a habilite. Para verificar se o spanning de VLAN já está ativado, use o comando ibmcloud ks vlan spanning get --region <region>.

ibmcloud ks cluster subnet create --cluster CLUSTER --size SIZE --vlan VLAN_ID [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster. Para listar seus clusters, use o comando ibmcloud ks cluster ls.
--size SIZE
O número de endereços IP que você deseja criar na sub-rede móvel. Os valores aceitos são 8, 16, 32 ou 64. Quando você inclui endereços IP móveis para sua sub-rede, três endereços IP são usados para estabelecer a rede interna do cluster. Não é possível usar esses três endereços IP para os Application Load Balancers (ALBs) do Ingress ou criar serviços do Network Load Balancer (NLB).. Por exemplo, se você solicitar oito endereços IP públicos móveis, será possível usar cinco deles para expor os seus apps ao público.
--vlan VLAN_ID
O ID da VLAN pública ou privada na qual você deseja criar a sub-rede. Deve-se selecionar uma VLAN pública ou privada à qual um nó do trabalhador existente está conectado. Para revisar as VLANs públicas ou privadas às quais os nós do trabalhador estão conectados, execute ibmcloud ks cluster get --cluster <cluster> --show-resources e procure a seção VLANs de sub-rede na saída. A sub-rede é provisionada na mesma zona na qual a VLAN está.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster subnet create

ibmcloud ks cluster subnet create --cluster my_cluster --size 8 --vlan 1764905

ibmcloud ks cluster subnet detach

Infraestrutura clássica

Remova uma sub-rede clássica móvel pública ou privada em uma conta de infraestrutura da IBM Cloud de um cluster. A sub-rede permanece disponível em sua conta de infraestrutura da IBM Cloud. Nota: qualquer serviço que foi implementado em um endereço IP da sub-rede permanece ativo após a sub-rede ser removida.

ibmcloud ks cluster subnet detach --cluster CLUSTER --subnet-id SUBNET_ID [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster. Para listar seus clusters, use o comando ibmcloud ks cluster ls.
--vlan VLAN_ID
O ID da sub-rede pública ou privada que você deseja remover. Para localizar o ID de sub-rede, primeiro execute ibmcloud ks cluster get --cluster <cluster> --show-resources e procure a sub-rede CIDR na seção VLANs de sub-rede da saída. Em seguida, usando o CIDR da sub-rede, execute ibmcloud ks subnets --provider classic e procure o ID da sub-rede.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando cluster subnet detach

ibmcloud ks cluster subnet detach --cluster my_cluster --subnet-id 1602829

Descontinuado: ibmcloud ks cluster user-subnet add

Infraestrutura clássica

Traga a sua própria sub-rede privada para os seus clusters do IBM Cloud Kubernetes Service. Essa sub-rede privada não é fornecida pela infraestrutura da IBM Cloud. Como tal, deve-se configurar qualquer roteamento de tráfego de rede de entrada e saída para a sub-rede.

Esse comando foi descontinuado. Inclua uma sub-rede de infraestrutura da IBM Cloud existente em seu cluster executando ibmcloud ks cluster subnet add.

Quando você torna uma sub-rede disponível para um cluster, os endereços IP dessa sub-rede são usados para propósitos de rede do cluster. Para evitar conflitos de endereço IP, certifique-se de usar uma sub-rede com somente um cluster. Não use uma sub-rede para múltiplos clusters ou para outros propósitos fora do IBM Cloud Kubernetes Service ao mesmo tempo. Se você usar a mesma sub-rede entre diversos clusters, seu certificado TLS padrão do Ingress poderá se tornar invalidado. Em clusters clássicos, caso haja várias VLANs para o cluster, várias sub-redes na mesma VLAN ou um cluster clássico de várias zonas, deve-se ativar uma Virtual Router Function (VRF) para a conta de infraestrutura do IBM Cloud para que os nós do trabalhador possam se comunicar entre si na rede privada. Para ativar o VRF, consulte Ativando o VRF. Para verificar se um VRF já está ativado, use o comando ibmcloud account show. Se não puder ou não quiser ativar a VRF, ative a Ampliação de VLAN. Para executar esta ação, você precisa da permissão de infraestrutura Rede > Gerenciar VLAN de rede ou pode solicitar que o proprietário da conta a habilite. Para verificar se o spanning de VLAN já está ativado, use o comando ibmcloud ks vlan spanning get --region <region>.

ibmcloud ks cluster user-subnet add --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--subnet-cidr SUBNET_CIDR
O Classless InterDomain Routing (CIDR) de sub-rede. Esse valor é necessário e não deve entrar em conflito com nenhuma sub-rede que é usada pela infraestrutura da IBM Cloud. Os prefixos suportados variam de /30 (1 endereço IP) a /24 (253 endereços IP). Se você definir o CIDR com um comprimento de prefixo e posteriormente precisar mudá-lo, primeiro inclua o novo CIDR, então, remova o CIDR antigo.
--private-vlan PRIVATE_VLAN
Necessário: o ID da VLAN privada. O ID deve ser para uma VLAN privada no cluster no qual estão um ou mais nós do trabalhador. Para ver VLANs privadas no cluster, execute ibmcloud ks cluster get --cluster <cluster_name_or_ID> --show-resources. Na seção VLANs de sub-rede da saída, procure por VLANs que possuem um valor para Público de false.

Exemplo de comando cluster user-subnet add

ibmcloud ks cluster user-subnet add --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

Descontinuado: ibmcloud ks cluster user-subnet rm

Infraestrutura clássica

Remova a sua própria sub-rede privada de um cluster especificado. Qualquer serviço que foi implementado com um endereço IP de sua própria sub-rede privada permanece ativo depois que a sub-rede é removida.

Esse comando foi descontinuado. Como alternativa, para remover uma sub-rede de infraestrutura da IBM Cloud de seu cluster, execute ibmcloud ks cluster subnet detach.

ibmcloud ks cluster user-subnet rm --cluster CLUSTER --subnet-cidr SUBNET_CIDR --private-vlan PRIVATE_VLAN
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--subnet-cidr SUBNET_CIDR
O Classless InterDomain Routing (CIDR) de sub-rede. Esse valor é obrigatório e deve corresponder ao CIDR que foi definido pelo comando ibmcloud ks cluster user-subnet add.
--private-vlan PRIVATE_VLAN
O ID da VLAN privada. Esse valor é obrigatório e deve corresponder à VLAN ID que foi definida pelo comando ibmcloud ks cluster user-subnet add.

Exemplo de comando cluster user-subnet rm

ibmcloud ks cluster user-subnet rm --cluster my_cluster --subnet-cidr 169.xx.xxx.xxx/29 --private-vlan 1502175

Beta: dedicated comandos

Visualizar, criar e remover um host dedicado ou conjunto de hosts dedicados.

Os comandos do dedicated estão disponíveis em versão beta.

Beta: ibmcloud ks dedicated flavors

Virtual Private Cloud

Visualizar tipos de hosts dedicados.

ibmcloud ks dedicated flavors --zone ZONE --provider PROVIDER
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--zone ZONE
A zona para procurar tipos de hosts dedicados.
--provider PROVIDER
O provedor a ser usado para procurar tipos de hosts dedicados.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks dedicated flavors --zone us-south-1 --provider myprovider1

Beta: ibmcloud ks dedicated host create

Virtual Private Cloud

Criar um host dedicado.

ibmcloud ks dedicated host create --flavor FLAVOR --pool POOL --zone ZONE [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

-- flavor FLAVOR
O tipo de host dedicado.
-- pool POOL
O nome do conjunto de hosts dedicados em que o host dedicado é incluído.
--zone ZONE
A zona na qual criar o host dedicado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks dedicated host create --flavor b3c.4x16 --pool mypool --zone wdc

Beta: ibmcloud ks dedicated host get

Virtual Private Cloud

Obter os detalhes de um host dedicado.

ibmcloud ks dedicated host get --host HOST --pool POOL [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do visualizador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--host HOST
O ID do host dedicado.
--pool POOL
O ID do conjunto de hosts dedicados no qual o host dedicado está localizado. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated host get --host myhost  --pool mypool

Beta: ibmcloud ks dedicated host ls

Virtual Private Cloud

Listar todos os hosts dedicados em um conjunto de hospedado dedicado.

ibmcloud ks dedicated host ls --pool POOL [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do visualizador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--pool POOL
O ID do conjunto de hosts dedicados. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated host ls --pool mypool

Beta: ibmcloud ks dedicated host placement disable

Virtual Private Cloud

Desativar o posicionamento de host dedicado.

ibmcloud ks dedicated host placement disable --host HOST --pool POOL
Permissões mínimas necessárias
Função de acesso à plataforma de administrador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--host HOST
O ID do host dedicado para o qual desativar o posicionamento.
--pool POOL
O ID do conjunto de hosts dedicados no qual o host dedicado está localizado. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
--q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated host placement disable --host myhost --pool mypool

Beta: ibmcloud ks dedicated host placement enable

Virtual Private Cloud

Ativar o posicionamento de host dedicado.

ibmcloud ks dedicated host placement enable --host HOST --pool POOL
Permissões mínimas necessárias
Função de acesso à plataforma de administrador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--host HOST
O ID do host dedicado para o qual ativar o posicionamento.
--pool POOL
O ID do conjunto de hosts dedicados no qual o host dedicado está localizado. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
--q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated host placement enable --host myhost --pool mypool

Beta: ibmcloud ks dedicated host rm

Virtual Private Cloud

Excluir um host dedicado. Não é possível desfazer essa ação.

ibmcloud ks dedicated host rm --host HOST --pool POOL [-q]
Permissões mínimas necessárias
Função de acesso à plataforma de administrador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--pool POOL
O ID do conjunto de hosts dedicados que contém o host dedicado a excluir. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
--q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated host rm --host myhost --pool mypool

Beta: ibmcloud ks dedicated pool create

Virtual Private Cloud

Criar um conjunto de hosts dedicados.

ibmcloud ks dedicated pool create --flavor-class CLASS --metro METRO --name NAME [--output OUTPUT]
Permissões mínimas necessárias
Função de acesso à plataforma de administrador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--flavor-class CLASS
A classe-tipo do conjunto de hosts dedicados. Para ver as opções disponíveis, execute ibmcloud ks flavors.
--metro METRO
A área metropolitana na qual criar o conjunto de hosts dedicados, como dal ou wdc.
--name NAME
O nome do conjunto de hosts dedicados.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated pool --flavor-class mb4c.20x64 --metro dal --name mypool

Beta: ibmcloud ks dedicated pool get

Virtual Private Cloud

Obter os detalhes de um conjunto de hosts dedicados.

ibmcloud ks dedicated pool get --pool POOL [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do visualizador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--pool POOL
O ID do conjunto de hosts dedicados. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.

--output OUTPUT

-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated pool get --pool mypool

Beta: ibmcloud ks dedicated pool ls

Virtual Private Cloud

Listar todos os pools de hosts dedicados.

ibmcloud ks dedicated pool ls [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do visualizador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--output json
Opcional: imprimirá a saída de comando em formato JSON.
--q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated pool ls

Beta: ibmcloud ks dedicated pool rm

Virtual Private Cloud

Excluir um conjunto de hosts dedicados. Não é possível desfazer essa ação.

ibmcloud ks dedicated pool rm --pool POOL [-q]
Permissões mínimas necessárias
Função de acesso à plataforma de administrador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--pool POOL
O ID do pool de hosts dedicados a ser excluído. Para listar conjuntos de hosts dedicados, execute ibmcloud ks dedicated pool ls.
--q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks dedicated pool rm --pool mypool

worker comandos

Visualize e modifique nós do trabalhador para um cluster.

Descontinuado: ibmcloud ks worker add

Virtual Private Cloud Infra-estrutura Classic

Inclua nós do trabalhador independentes em um cluster.

Esse comando foi descontinuado. Crie um conjunto de trabalhadores executando ibmcloud ks worker-pool create classic ou ibmcloud ks worker-pool create vpc-gen2 ou inclua trabalhadores em um conjunto de trabalhadores existente executando ibmcloud ks worker-pool resize.

ibmcloud ks worker add --cluster CLUSTER [--hardware HARDWARE] --flavor FLAVOR --workers NUMBER --private-vlan PRIVATE_VLAN --public-vlan PUBLIC_VLAN [--disable-disk-encrypt] [--operating-system SYSTEM] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--hardware HARDWARE
Opcional: o nível de isolamento de hardware para seu nó do trabalhador. Use dedicated para que os recursos físicos disponíveis sejam dedicados apenas a você ou shared para permitir que recursos físicos sejam compartilhados com outros clientes IBM. O padrão é shared. Para os tipos bare metal, especifique dedicated.
--flavor FLAVOR
Escolha um tipo de máquina, ou tipo, para os nós do trabalhador. É possível implementar os nós do trabalhador como máquinas virtuais em hardware compartilhado ou dedicado ou como máquinas físicas no bare metal. Os tipos de máquinas físicas e virtuais disponíveis variam de acordo com a zona na qual você implementa o cluster. Para obter mais informações, consulte a documentação do comando ibmcloud ks flavors (machine-types).
--workers NUMBER
Um número inteiro que representa o número de nós do trabalhador a serem criados no cluster.
--private-vlan PRIVATE_VLAN
Necessário: a VLAN privada que foi especificada quando o cluster foi criado. Os roteadores de VLAN privada sempre iniciam com bcr (roteador de backend) e roteadores de VLAN pública sempre iniciam com fcr (roteador de front-end). Ao criar um cluster e especificar as VLANs públicas e privadas, a combinação de número e letra após esses prefixos devem corresponder.
--public-vlan PUBLIC_VLAN
Opcional: a VLAN pública que foi especificada quando o cluster foi criado. Se quiser que os nós do trabalhador existam apenas em uma VLAN privada, não forneça um ID de VLAN pública. Os roteadores de VLAN privada sempre iniciam com bcr (roteador de backend) e roteadores de VLAN pública sempre iniciam com fcr (roteador de front-end). Ao criar um cluster e especificar as VLANs públicas e privadas, a combinação de número e letra após esses prefixos devem corresponder. Se os nós do trabalhador forem configurados somente com uma VLAN privada, deve-se permitir que os nós do trabalhador e o cluster principal se comuniquem ativando o terminal em serviço de nuvem privada ou configurando um dispositivo de gateway.
--disable-disk-encrypt
Os nós do trabalhador apresentam criptografia de disco AES de 256 bits por padrão; saiba mais. Para desativar a criptografia, inclua essa opção.
--operating-system UBUNTU_20_64|UBUNTU_24_64
Opcional. O sistema operacional dos nós do trabalhador no cluster. Para obter uma lista dos sistemas operacionais disponíveis por versão do cluster, consulte as informações da versão Kubernetes. Se nenhuma opção for especificada, o sistema operacional padrão que corresponde à versão do cluster será usado
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker add

ibmcloud ks worker add --cluster my_cluster --workers 3 --public-vlan my_public_VLAN_ID --private-vlan my_private_VLAN_ID --flavor b3c.4x16 --hardware shared

ibmcloud ks worker get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um nó do trabalhador.

ibmcloud ks worker get --cluster CLUSTER_NAME_OR_ID --worker WORKER_NODE_ID [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER_NAME_OR_ID
Opcional: o nome ou o ID do cluster do nó do trabalhador.
--worker WORKER_NODE_ID
Necessário: o nome de seu nó do trabalhador. Execute ibmcloud ks worker ls --cluster CLUSTER para visualizar os IDs dos nós do trabalhador em um cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker get

ibmcloud ks worker get --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud ks worker ls

Virtual Private Cloud Infra-estrutura Classic

Liste todos os nós do trabalhador em um cluster.

ibmcloud ks worker ls --cluster CLUSTER [--worker-pool POOL] [--show-pools] [--show-deleted] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster para os nós do trabalhador disponíveis.
-p, --worker-pool POOL
Opcional: visualizar apenas nós do trabalhador que pertencem ao conjunto de trabalhadores. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID>.
--show-pools
Opcional: listar o conjunto de trabalhadores ao qual cada nó do trabalhador pertence.
--show-deleted
Opcional: visualizar nós do trabalhador que foram excluídos do cluster, incluindo o motivo da exclusão.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker ls

ibmcloud ks worker ls --cluster my_cluster

ibmcloud ks worker reboot

Virtual Private Cloud Infra-estrutura Classic

Reinicialize um nó do trabalhador em um cluster.

Durante a reinicialização, o estado do nó do trabalhador não muda. Por exemplo, será possível usar uma reinicialização se o status do nó do trabalhador na infraestrutura clássica do IBM Cloud for Powered Off e for necessário ativar o nó do trabalhador. Uma reinicialização limpa os diretórios temporários, mas não limpa o sistema de arquivos inteiro ou reformata os discos. O endereço IP do nó do trabalhador permanece o mesmo após a operação de reinicialização.

Reinicializar um nó do trabalhador pode causar distorção de dados no nó do trabalhador. Use esse comando com cuidado e quando souber que uma reinicialização pode ajudar a recuperar seu nó do trabalhador. Em todos os outros casos, recarregue seu nó do trabalhador.

Antes de reinicializar o seu nó do trabalhador, certifique-se de que tenha capacidade suficiente em outros nós do trabalhador para reagendar os pods no nó do trabalhador. O replanejamento de pods ajuda a evitar o tempo de inatividade para seu app ou a distorção de dados no nó do trabalhador.

  1. Liste todos os nós do trabalhador em seu cluster e anote o nome do nó do trabalhador que você deseja remover.

    kubectl get nodes
    

    O nome retornado nesse comando é o endereço IP privado designado ao nó do trabalhador. É possível localizar mais informações sobre o nó do trabalhador ao executar o comando ibmcloud ks worker ls --cluster <cluster_name_or_ID> e procurar o nó do trabalhador com o mesmo endereço IP privado.

  2. Force os pods para que sejam removidos do nó do trabalhador e reprogramados nos nós do trabalhador restantes no cluster. O nó do trabalhador também é isolado ou marcado como indisponível para planejamento de pod futuro. Substitua <worker_name> pelo endereço IP privado do nó do trabalhador recuperado anteriormente.

    kubectl drain <worker_name>
    

    Esse processo pode levar alguns minutos.

  3. Reinicialize o nó do trabalhador. Use o ID do trabalhador que é retornado do comando ibmcloud ks worker ls --cluster <cluster_name_or_ID>.

    ibmcloud ks worker reboot --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
    
  4. Espere cerca de 5 minutos antes de disponibilizar o seu nó do trabalhador para planejamento de pod para assegurar que a reinicialização esteja concluída. Durante a reinicialização, o estado do nó do trabalhador não muda. A reinicialização de um nó do trabalhador é geralmente concluída em alguns segundos.

  5. Disponibilize o nó do trabalhador para planejamento do pod. Use o nome do nó do trabalhador retornado do comando kubectl get nodes.

    kubectl uncordon <worker_name>
    
ibmcloud ks worker reboot [--hard] --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--hard
Opcional: use essa opção para forçar uma reinicialização forçada de um nó do trabalhador, cortando a energia para o nó do trabalhador. Use essa opção se o nó do trabalhador não estiver responsivo ou o tempo de execução do contêiner do nó do trabalhador não estiver responsivo.
-w, --worker WORKER
Especifique um ID do nó do trabalhador. Para recarregar vários nós de trabalho, use várias opções, como -w worker1_id -w worker2_id.
--skip-master-healthcheck
Ignore uma verificação de funcionamento de seu mestre antes de recarregar ou reinicializar os nós do trabalhador.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker reboot

ibmcloud ks worker reboot --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker reload

Infraestrutura clássica

Recarregar as configurações de um nó de trabalho clássico. Para recarregar um nó de trabalho em um cluster VPC, use o comando ibmcloud ks worker replace.

Um recarregamento poderá ser útil se seu nó do trabalhador tiver problemas, como desempenho lento ou se o nó do trabalhador estiver preso em um estado inoperante. Durante o recarregamento, a máquina do nó do trabalhador é atualizada com a imagem mais recente e os dados são excluídos se não armazenados fora do nó do trabalhador. O endereço IP público e privado do trabalhador do nó permanece o mesmo após a operação de recarregamento.

O recarregamento de um nó do trabalhador aplica atualizações da versão de correção ao nó do trabalhador, mas não atualizações principais ou secundárias. Para ver as alterações de uma versão de patch para a próxima, consulte a documentação do registro de alterações de versão.

Antes de recarregar o nó do trabalhador, certifique-se de que tenha capacidade suficiente em outros nós do trabalhador para reagendar os pods no nó do trabalhador. O replanejamento de pods ajuda a evitar o tempo de inatividade para seu app ou a distorção de dados no nó do trabalhador.

  1. Liste todos os nós do trabalhador em seu cluster e anote o nome do nó do trabalhador que você deseja recarregar.

    kubectl get nodes
    

    O nome retornado nesse comando é o endereço IP privado designado ao nó do trabalhador. É possível localizar mais informações sobre o nó do trabalhador ao executar o comando ibmcloud ks worker ls --cluster <cluster_name_or_ID> e procurar o nó do trabalhador com o mesmo endereço IP privado.

  2. Recarregue o nó do trabalhador. Como parte do processo de recarregamento, os pods que são executados no nó do trabalhador são drenados e reagendados sobre os nós restantes nós do trabalhador no cluster. O nó do trabalhador também é isolado ou marcado como indisponível para planejamento de pod futuro. Use o ID do nó do trabalhador que é retornado do comando ibmcloud ks worker ls --cluster <cluster_name_or_ID>.

    ibmcloud ks worker reload --cluster <cluster_name_or_ID> --worker <worker_name_or_ID>
    
  3. Aguarde o recarregamento ser concluído. Quando o seu nó do trabalhador está em um estado Normal, o nó do trabalhador fica disponível para planejamento de pod novamente.

ibmcloud ks worker reload --cluster CLUSTER --worker WORKER_ID [--skip-master-healthcheck] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-w, --worker WORKER
Especifique um ID do nó do trabalhador. Para recarregar vários nós de trabalho, use várias opções, como -w worker1_id -w worker2_id.
--skip-master-healthcheck
Ignore uma verificação de funcionamento de seu mestre antes de recarregar ou reinicializar os nós do trabalhador.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker reload

ibmcloud ks worker reload --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker replace

Virtual Private Cloud Infra-estrutura Classic

Exclua um nó do trabalhador e substitua-o por um novo nó do trabalhador no mesmo conjunto de trabalhadores.

O nó do trabalhador de substituição é criado na mesma zona e tem o mesmo tipo que o nó do trabalhador antigo, mas pode ser designado a novos endereços IP públicos ou privados. É possível substituir um nó do trabalhador se você não puder recarregá-lo ou atualizá-lo, como, por exemplo, se ele entrar em um estado problemático.

Você também pode usar esse comando para atualizar a versão Kubernetes do nó de trabalho para corresponder à versão maior e menor do mestre Kubernetes, incluindo a opção --update. Se você não incluir a opção --update, as atualizações da versão do patch serão aplicadas ao nó de trabalho, mas não as atualizações principais ou secundárias. Para ver as alterações de uma versão principal, secundária ou de patch para a próxima, consulte a documentação do registro de alterações de versão. Lembre-se de que seus nós do trabalhador podem ser anteriores ao mestre somente em até duas versões (n-2).

Ao substituir um nó do trabalhador, tenha em mente as considerações a seguir.

Para atualizar nós do trabalhador Satellite, consulte Atualizando hosts designados como nós do trabalhador aos serviços ativados para Satellite.

  • Vários nós do trabalhador são substituídos simultaneamente: se você substituir vários nós do trabalhador ao mesmo tempo, eles serão excluídos e substituídos simultaneamente, não um por um. Certifique-se de que você tenha capacidade suficiente em seu cluster para remarcar suas cargas de trabalho antes de substituir os nós do trabalhador.
  • As customizações de nível do nó não são preservadas: quaisquer rótulos customizados ou contaminações que você tenha aplicado no nível do nó do trabalhador individual não serão aplicadas ao nó do trabalhador de substituição. Em vez disso, aplique rótulos ou contaminações no nível do conjunto de trabalhadores para que o nó do trabalhador de substituição obtenha esses atributos.
  • Rebalanceamento automático: um nó do trabalhador de substituição não será criado se o conjunto de trabalhadores não tiver o rebalanceamento automático ativado.

Antes de começar, certifique-se de que seu cluster tenha outros nós do trabalhador para que seus pods possam ser reprogramados e continuem sendo executados.

  1. Liste todos os nós do trabalhador em seu cluster e anote o nome do nó do trabalhador que deseja substituir.

    kubectl get nodes
    

    O nome retornado nesse comando é o endereço IP privado designado ao nó do trabalhador. É possível localizar mais informações sobre o nó do trabalhador ao executar o comando ibmcloud ks worker ls --cluster <cluster_name_or_ID> e procurar o nó do trabalhador com o mesmo endereço IP privado.

  2. Substitua o nó do trabalhador. Como parte do processo de substituição, os pods que são executados no nó do trabalhador são drenados e reagendados sobre nós restantes do trabalhador no cluster. O nó do trabalhador também é isolado ou marcado como indisponível para planejamento de pod futuro. Use o ID do nó do trabalhador que é retornado do comando ibmcloud ks worker ls --cluster <cluster_name_or_ID>.

    ibmcloud ks worker replace --cluster <cluster_name_or_ID> --worker <worker_node_ID>
    
  3. Verifique se o nó do trabalhador foi substituído.

    ibmcloud ks worker ls --cluster <cluster_name_or_ID>
    
ibmcloud ks worker replace --cluster CLUSTER_NAME_OR_ID --worker WORKER_ID [--update] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--worker WORKER
Necessário: o nome ou o ID de um nó do trabalhador.
--update
Inclua essa opção para atualizar o nó de trabalho para a mesma versão maior e menor do mestre e do patch mais recente.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker replace

ibmcloud ks worker replace --cluster my_cluster --worker kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1

ibmcloud ks worker rm

Virtual Private Cloud Infra-estrutura Classic

Remover um ou mais nós do trabalhador de um cluster. Se você remover um nó do trabalhador, seu cluster se tornará desbalanceado e a substituição de um nó do trabalhador não criará mais um nó do trabalhador de substituição. Você pode reequilibrar automaticamente o pool de workers executando o comando ibmcloud ks worker-pool rebalance depois de remover um nó de worker.

ibmcloud ks worker rm --cluster CLUSTER --worker WORKER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-w, --worker WORKER
Especifique um ID do nó do trabalhador. Para recarregar vários nós de trabalho, use várias opções, como -w worker1_id -w worker2_id.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker rm

ibmcloud ks worker rm --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

ibmcloud ks worker update

Infraestrutura clássica

Atualize os nós do trabalhador para aplicar as atualizações e correções de segurança mais recentes ao sistema operacional e para atualizar a versão do Kubernetes para corresponder à versão do mestre do Kubernetes. Você pode atualizar a versão mestre Kubernetes com o comando ibmcloud ks cluster master update. Lembre-se de que os nós do trabalhador podem estar apenas até duas versões atrás da versão principal (n-2). O endereço IP do nó do trabalhador permanece o mesmo após a operação de atualização.

Para atualizar um nó de trabalho em um cluster VPC, use o comando ibmcloud ks worker replace.

A execução de ibmcloud ks worker update pode causar tempo de inatividade em seus apps e serviços. Durante a atualização, todos os pods são reprogramados em outros nós do trabalhador, o nó do trabalhador tem a imagem reinstalada e os dados são excluídos, se não armazenados fora do pod. Para evitar tempo de inatividade, assegure-se de que você tenha nós do trabalhador suficientes para manipular a carga de trabalho enquanto os nós do trabalhador selecionados estão atualizando.

Para atualizar nós do trabalhador Satellite, consulte Atualizando hosts designados como nós do trabalhador aos serviços ativados para Satellite.

Pode ser necessário mudar seus arquivos YAML para as implementações antes de atualizar. Revise essa nota sobre a liberação para obter detalhes.

ibmcloud ks worker update --cluster CLUSTER --worker WORKER_ID [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual você lista nós do trabalhador disponíveis.
-w, --worker WORKER
Especifique um ID do nó do trabalhador. Para recarregar vários nós de trabalho, use várias opções, como -w worker1_id -w worker2_id.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker update

ibmcloud ks worker update --cluster my_cluster -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w1 -w kube-dal10-cr18a61a63a6a94b658596aa93d087aaa9-w2

worker-pool comandos

Visualize e modifique conjuntos de trabalhadores para um cluster.

ibmcloud ks worker-pool create classic

Infraestrutura clássica

É possível criar um conjunto de trabalhadores em seu cluster. Quando você incluir um conjunto de trabalhadores, ele não terá uma zona designada por padrão. Você especifica o número de trabalhadores que deseja em cada zona e os tipos para os trabalhadores. O conjunto de trabalhadores recebe as versões padrão do Kubernetes. Para concluir a criação de trabalhadores, inclua uma zona ou zonas em seu conjunto.

Para criar um pool de trabalho em um cluster de VPC, use o comando ibmcloud ks worker-pool create vpc-gen2.

ibmcloud ks worker-pool create classic --name POOL_NAME --cluster CLUSTER --flavor FLAVOR --size-per-zone WORKERS_PER_ZONE --hardware ISOLATION [--disable-disk-encrypt] [--label KEY1=VALUE1] [--operating-system SYSTEM]  [-q] [--output json]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--name POOL_NAME
O nome que você deseja dar ao seu conjunto de trabalhadores.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--flavor FLAVOR
Escolha um tipo de máquina, ou tipo. É possível implementar os nós do trabalhador como máquinas virtuais em hardware compartilhado ou dedicado ou como máquinas físicas no bare metal. Os tipos de máquinas físicas e virtuais disponíveis variam de acordo com a zona na qual você implementa o cluster. Para obter mais informações, consulte a documentação do comando ibmcloud ks flavors (machine-types).
--size-per-zone WORKERS_PER_ZONE
O número de trabalhadores a serem criados em cada zona.
--hardware ISOLATION
Necessário: o nível de isolamento de hardware para seu nó do trabalhador. Use dedicated se desejar ter recursos físicos disponíveis que são dedicados apenas a você ou shared para permitir que recursos físicos sejam compartilhados com outros clientes IBM. O padrão é shared. Para os tipos bare metal, especifique dedicated.
--disable-disk-encrypt
Especifica que o disco não está criptografado. O valor padrão é false.
-l, --label KEY1=VALUE1
Opcional: aplique rótulos de valor da chave para cada nó do trabalhador no conjunto de trabalhadores. Para especificar vários rótulos, use várias opções, como -l key1=value1 -l key2=value2.
--operating-system UBUNTU_20_64|UBUNTU_24_64
Opcional. O sistema operacional dos nós do trabalhador no cluster. Para obter uma lista dos sistemas operacionais disponíveis por versão do cluster, consulte as informações da versão Kubernetes. Se nenhuma opção for especificada, o sistema operacional padrão que corresponde à versão do cluster será usado
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo de comando worker-pool create classic

ibmcloud ks worker-pool create classic --name my_pool --cluster my_cluster --flavor b3c.4x16 --size-per-zone 6

ibmcloud ks worker-pool create vpc-gen2

Virtual Private Cloud

Inclua um conjunto de trabalhadores em um cluster de VPC. Nenhum nó do trabalhador é criado até que você inclua zonas no conjunto de trabalhadores.

ibmcloud ks worker-pool create vpc-gen2 --name <worker_pool_name> --cluster <cluster_name_or_ID> --flavor <flavor> --size-per-zone <number_of_workers_per_zone> [--operating-system SYSTEM][--dedicated-host-pool POOL][--vpc-id <VPC ID>] [--label KEY1=VALUE1] [--kms-account-id ID] [--kms-instance KMS_INSTANCE_ID] [--crk ROOT_KEY_ID] [--operating-system SYSTEM] [-q] [--secondary-storage STORAGE] [--security-group GROUP ...] [--output json]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

--name NAME
Necessário: configurar o nome para o conjunto de trabalhadores.
-c, --cluster CLUSTER
Necessário: especificar o nome ou ID do cluster. Para listar clusters VPC, execute ibmcloud ks cluster ls --provider vpc-gen2.
--size-per-zone NUMBER_WORKERS_PER_ZONE
Especifique o número de nós do trabalhador a serem criados por zona nesse conjunto de trabalhadores. Nenhum nó do trabalhador é criado até que você inclua zonas no conjunto de trabalhadores.
--operating-system UBUNTU_20_64|UBUNTU_24_64
Opcional. O sistema operacional dos nós do trabalhador no cluster. Para obter uma lista dos sistemas operacionais disponíveis por versão do cluster, consulte as informações da versão Kubernetes. Se nenhuma opção for especificada, o sistema operacional padrão que corresponde à versão do cluster será usado
--flavor FLAVOR
Escolha um tipo para os nós do trabalhador. É possível implementar os nós do trabalhador como máquinas virtuais em hardware compartilhado ou dedicado. Para ver os tipos que estão disponíveis em uma zona de VPC, execute ibmcloud ks flavors --zone <vpc_zone> --provider vpc-gen2.
--dedicated-host-pool POOL
Opcional. O ID do pool de hosts dedicados em que você deseja executar seus funcionários.
--vpc-id VPC_ID
Opcional: especificar o ID da VPC na qual criar os nós do trabalhador do conjunto de trabalhadores. O valor deve corresponder ao ID VPC que o cluster está em. Para listar o ID de VPC do cluster, execute ibmcloud ks cluster get -c <cluster_name_or_ID>. Se essa opção não for fornecida, o pool de trabalho terá como padrão a ID de VPC dos pools de trabalho existentes no cluster.
-l, --label KEY1=VALUE1
Opcional: aplique rótulos de valor da chave para cada nó do trabalhador no conjunto de trabalhadores. Para especificar vários rótulos, use várias opções, como -l key1=value1 -l key2=value2.
--kms-account-id ID
Opcional: O ID da conta que contém a instância do KMS que você deseja usar para criptografia de disco local ou secreta.
--kms-instance KMS_INSTANCE_ID
Opcional: inclua o ID de uma instância de serviço de gerenciamento de chaves (KMS) para criptografar o disco local nos nós do trabalhador no conjunto de trabalhadores default. Para listar instâncias KMS disponíveis, execute ibmcloud ks kms instance ls. Ao incluir esta opção, é preciso também incluir a opção --crk. Para obter mais informações, incluindo as etapas de criação, consulte Como gerenciar criptografia para os nós do trabalhador em seu cluster.
--crk ROOT_KEY
Opcional: inclua o ID da chave raiz na instância do KMS para usar para criptografar o disco local nos nós do trabalhador neste conjunto de trabalhadores. Para listar chaves de raiz disponíveis, execute ibmcloud ks kms crk ls --instance-id. Se você incluir essa opção, também deverá incluir a opção --kms-instance. Antes de usar a criptografia KMS, é preciso criar uma instância KMS e configurar a autorização de serviço necessária no IAM. Consulte Gerenciando a criptografia para os nós de processamento em seu cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--secondary-storage STORAGE
Opcional: A opção de armazenamento para o sabor. Por exemplo, 900gb.5iops-tier. Ao adicionar um disco secundário, esse disco é usado para o tempo de execução do container, enquanto que o disco primário é usado para o sistema operacional. Para visualizar as opções de armazenamento para um aroma, execute o comando **ibmcloud ks flavor get --flavor FLAVOR --zone ZONE --provider vpc-gen2.
--security-group GROUP
Opcional. Especifique um ou mais IDs de grupo de segurança para aplicar a todos os trabalhadores no cluster. Para OpenShift versão 4.15 e Kubernetes versão 1.30 e mais recente, esses grupos de segurança são aplicados além do grupo de segurança IBM kube-clusterID. Para versões anteriores do cluster, especifique a opção --cluster-security-group cluster para aplicar o grupo de segurança do kube-clusterID Se nenhum valor for especificado, um conjunto padrão de grupos de segurança incluindo kube-clusterID será aplicado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo de comando worker-pool create vpc-gen2

ibmcloud ks worker-pool create vpc-gen2 --name my_pool --cluster my_cluster --flavor bx2.4x16 --size-per-zone 3

ibmcloud ks worker-pool get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um conjunto de trabalhadores.

ibmcloud ks worker-pool get --worker-pool WORKER_POOL --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador do qual você deseja visualizar os detalhes. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID>.
-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual o conjunto de trabalhadores está localizado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool get

ibmcloud ks worker-pool get --worker-pool pool1 --cluster my_cluster

ibmcloud ks worker-pool label rm

Virtual Private Cloud Infra-estrutura Classic

Remova todos os rótulos customizados do Kubernetes de todos os nós do trabalhador em um conjunto de trabalhadores.

Não é possível remover uma contaminação individual de um conjunto de trabalho. Em vez disso, use o comando kubectl taint node <worker_privateIP> key:effect- para remover uma mancha de um nó de trabalho individual.

ibmcloud ks worker-pool label rm --cluster CLUSTER --worker-pool POOL [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual o conjunto de trabalhadores está localizado.
-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador do qual você deseja visualizar os detalhes. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID>.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool label rm

ibmcloud ks worker-pool label rm --worker-pool pool1 --cluster my_cluster

ibmcloud ks worker-pool label set

Virtual Private Cloud Infra-estrutura Classic

Configure os rótulos customizados do Kubernetes no formato key=value para todos os nós do trabalhador no conjunto de trabalhadores. Para manter quaisquer rótulos customizados existentes no conjunto de trabalhadores, deve-se incluir esses rótulos neste comando.

ibmcloud ks worker-pool label set --cluster CLUSTER --label LABEL [--label LABEL ...] --worker-pool POOL [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual o conjunto de trabalhadores está localizado.
--label LABEL
Necessário: um rótulo customizado no formato key=value para ser configurado para todos os nós do trabalhador no conjunto de trabalhadores. Para vários rótulos, repita essa opção. Para manter os rótulos personalizados existentes no pool de trabalhadores, inclua esses rótulos com essa opção. É possível listar os rótulos customizados existentes em nós do trabalhador no conjunto de trabalhadores executando ibmcloud ks worker-pool get -c <cluster_name_or_ID> --worker-pool <pool>.
-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador do qual você deseja visualizar os detalhes. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls --cluster <cluster_name_or_ID>.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool label set

ibmcloud ks worker-pool label set --worker-pool pool1 --cluster my_cluster --label app=dev

ibmcloud ks worker-pool ls

Virtual Private Cloud Infra-estrutura Classic

Liste todos os conjuntos de trabalhadores em um cluster.

ibmcloud ks worker-pool ls --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER_NAME_OR_ID
Necessário: o nome ou o ID do cluster para o qual você deseja listar conjuntos de trabalhadores.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool ls

ibmcloud ks worker-pool ls --cluster my_cluster

ibmcloud ks worker-pool operating-system set

Defina o sistema operacional. Depois de definir o sistema operacional, você deve atualizar seus trabalhadores executando ibmcloud ks worker update ou ibmcloud ks worker replace.

ibmcloud ks worker-pool operating-system set --cluster CLUSTER --operating-system SYSTEM --worker-pool POOL [-q]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
--operating-system SYSTEM
Especifique o nome do sistema operacional.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--worker-pool POOL, -p POOL
Especifique um conjunto de trabalhadores.

ibmcloud ks worker-pool rebalance

Virtual Private Cloud Infra-estrutura Classic

Rebalancear um conjunto de trabalhadores em um cluster depois de excluir um nó do trabalhador. Quando você executa esse comando, um novo trabalhador ou trabalhadores são incluídos no conjunto de trabalhadores para que o conjunto de trabalhadores tenha o mesmo número de nós por zona que você especificou.

ibmcloud ks worker-pool rebalance --cluster CLUSTER --worker-pool WORKER_POOL [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-p, --worker-pool WORKER_POOL
Necessário: o conjunto de trabalhadores que você deseja rebalancear.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool rebalance

ibmcloud ks worker-pool rebalance --cluster my_cluster --worker-pool my_pool

ibmcloud ks worker-pool resize

Virtual Private Cloud Infra-estrutura Classic

Redimensione seu conjunto de trabalhadores para aumentar ou diminuir o número de nós do trabalhador que estão em cada zona de seu cluster.

ibmcloud ks worker-pool resize --cluster CLUSTER --worker-pool WORKER_POOL --size-per-zone WORKERS_PER_ZONE [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster para o qual você deseja redimensionar conjuntos de trabalhadores.
--worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador que você deseja atualizar.
--size-per-zone WORKERS_PER_ZONE
O número de trabalhadores que você deseja ter em cada zona.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool resize

ibmcloud ks worker-pool resize --cluster my_cluster --worker-pool my_pool --size-per-zone 3

ibmcloud ks worker-pool rm

Virtual Private Cloud Infra-estrutura Classic

Remover um conjunto de trabalhadores do seu cluster. Todos os nós do trabalhador no conjunto são excluídos. Seus pods são reprogramados quando você exclui. Para evitar tempo de inatividade, certifique-se de que você tenha trabalhadores suficientes para executar a carga de trabalho.

ibmcloud ks worker-pool rm --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador que você deseja remover.
-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster do qual você deseja remover o conjunto de trabalhadores.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

Exemplo de comando worker-pool rm

ibmcloud ks worker-pool rm --cluster my_cluster --worker-pool pool1

ibmcloud ks worker-pool taint

Configure ou remova contaminações do Kubernetes para todos os nós do trabalhador em um conjunto de trabalhadores. Após a configuração de contaminações, os pods sem uma tolerância correspondente não podem ser executados no conjunto de trabalhadores. É possível que use contaminações para dedicar o seu conjunto de trabalhadores exclusivamente a um determinado tipo de carga de trabalho, como para nós de borda de rede ou o escalador automático de cluster. Para obter mais informações sobre como as contaminações e tolerâncias funcionam, consulte a Documentação do Kubernetes.

ibmcloud ks worker-pool taint set

Virtual Private Cloud Infra-estrutura Classic

Configure contaminações do Kubernetes para todos os nós do trabalhador em um conjunto de trabalhadores. As contaminações impedem que pods sem tolerâncias correspondentes sejam executados sobre os nós do trabalhador. Após configurar a contaminação customizada para o conjunto de trabalhadores, confirme se ela está definida nos nós do trabalhador obtendo o endereço IP privado do nó do trabalhador (ibmcloud ks worker ls -c <cluster_name_or_ID>) e executando kubectl describe node <worker_private_IP>.

Ao configurar contaminações para o conjunto de trabalhadores, quaisquer contaminações customizadas que você configurou anteriormente com esse comando serão sobrescritas. Para manter suas contaminações customizadas existentes e configurar novas contaminações, verifique as contaminações existentes do conjunto de trabalhadores e inclua-as ao executar novamente esse comando.

ibmcloud ks worker-pool taint set --worker-pool WORKER_POOL --cluster CLUSTER --taint KEY=VALUE:EFFECT [--taint KEY=VALUE2:EFFECT] [-f]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador no qual você deseja incluir a contaminação. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls -c <cluster_name_or_ID>.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster com o conjunto de trabalhadores que você deseja contaminar.
--taint KEY=VALUE:EFFECT
Necessário: O rótulo e o efeito para a contaminação do Kubernetes que você deseja configurar para o conjunto de trabalhadores. Especifique a taint no formato key=value:effect. O key=value é um par de rótulo, como env=prod que você usa para gerenciar a contaminação do nó do trabalhador e tolerâncias de pod correspondentes. O effect é um Efeito de contaminação do Kubernetes, como NoSchedule, PreferNoSchedule ou NoExecute, que descreve como a contaminação funciona. Dependendo do efeito da contaminação que você configurou, os pods que estão em execução em seus nós do trabalhador podem ser despejados.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

Exemplo de comando worker-pool taint set

ibmcloud ks worker-pool taint set --cluster my_cluster --worker-pool pool1 --taint env=prod:NoSchedule

ibmcloud ks worker-pool taint rm

Virtual Private Cloud Infra-estrutura Classic

Remova todas as contaminações do Kubernetes para todos os nós do trabalhador em um conjunto de trabalhadores. Para verificar as contaminações antes de removê-las, execute ibmcloud ks worker-pool get -c <cluster_name_or_ID> --worker-pool <worker_pool_name_or_ID>.

Ao remover contaminações para o conjunto de trabalhadores, todas as contaminações do Kubernetes são removidas do conjunto de trabalhadores e dos nós do trabalhador dele. Para remover uma contaminação individual de todos os nós do trabalhador, execute novamente o comando ibmcloud ks worker-pool taint set e inclua apenas as contaminações que você deseja manter. Ou use o comando kubectl taint node <worker_privateIP> key:effect- para remover uma contaminação de um nó do trabalhador individual.

ibmcloud ks worker-pool taint rm --worker-pool WORKER_POOL --cluster CLUSTER [-f]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador no qual você deseja incluir a contaminação. Para listar conjuntos de trabalhadores disponíveis, execute ibmcloud ks worker-pool ls -c <cluster_name_or_ID>.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster com o conjunto de trabalhadores que você deseja contaminar.
-f
Opcional: forçar a execução do comando sem prompts do usuário.

Exemplo de comando worker-pool taint rm

ibmcloud ks worker-pool taint rm --cluster my_cluster --worker-pool pool1

ibmcloud ks worker-pool zones

Virtual Private Cloud Infra-estrutura Classic

Visualize as zonas que estão anexadas a um conjunto de trabalhadores.

ibmcloud ks worker-pool zones --worker-pool WORKER_POOL --cluster CLUSTER [-q] [-f]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual o conjunto de trabalhadores existe.
-p, --worker-pool WORKER_POOL
Necessário: o nome do conjunto de nós do trabalhador para o qual você deseja ver zonas.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando worker-pool zones

ibmcloud ks worker-pool zones --cluster my_cluster --worker-pool pool1

zone comandos

ibmcloud ks zone add classic

Infraestrutura clássica

Depois de criar um cluster clássico ou conjunto de trabalhadores, será possível incluir uma zona. Quando você incluir uma zona, os nós do trabalhador serão incluídos na nova zona para corresponder ao número de trabalhadores por zona que você especificou para o conjunto de trabalhadores. É possível incluir mais de uma zona apenas se o seu cluster está em uma área metropolitana multizona.

Para adicionar uma zona aos pools de trabalho em um cluster de VPC, use o comando ibmcloud ks zone add vpc-gen2.

ibmcloud ks zone add classic --zone ZONE --cluster CLUSTER --worker-pool WORKER_POOL [--private-vlan PRIVATE_VLAN] [--public-vlan PUBLIC_VLAN] [--private-only] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--zone ZONE
Necessário: a zona que você deseja incluir. A zona deve ser uma zona com capacidade multizona dentro da região do cluster.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-p, --worker-pool WORKER_POOL
O nome do conjunto de trabalhadores no qual incluir a zona. Para especificar vários pools de trabalho, use várias opções, como -p pool1 -p pool2.
--private-vlan PRIVATE_VLAN
O ID da VLAN privada. Esse valor é condicional. Se você tiver uma VLAN privada na zona, esse valor deverá corresponder ao ID de VLAN privada de um ou mais nós do trabalhador no cluster. Para ver as VLANs que estão disponíveis, execute ibmcloud ks cluster get --cluster <cluster> --show-resources. Novos nós do trabalhador são incluídos na VLAN especificada, mas as VLANs de quaisquer nós do trabalhador existentes não mudam. Se você não tiver uma VLAN privada ou pública nessa zona, não especifique essa opção. Uma VLAN privada e pública é automaticamente criada para você quando você inclui inicialmente uma zona para o seu conjunto de trabalhadores. Em clusters clássicos, caso haja várias VLANs para o cluster, várias sub-redes na mesma VLAN ou um cluster clássico de várias zonas, deve-se ativar uma Virtual Router Function (VRF) para a conta de infraestrutura do IBM Cloud para que os nós do trabalhador possam se comunicar entre si na rede privada. Para ativar o VRF, consulte Ativando o VRF. Para verificar se um VRF já está ativado, use o comando ibmcloud account show. Se não puder ou não quiser ativar a VRF, ative a Ampliação de VLAN. Para executar esta ação, você precisa da permissão de infraestrutura Rede > Gerenciar VLAN de rede ou pode solicitar que o proprietário da conta a habilite. Para verificar se o spanning de VLAN já está ativado, use o comando ibmcloud ks vlan spanning get --region <region>.
--public-vlan PUBLIC_VLAN
O ID da VLAN pública. Esse valor será necessário se você desejar expor as cargas de trabalho nos nós para o público depois de criar o cluster. Ele deve corresponder ao ID da VLAN pública de um ou mais nós do trabalhador no cluster para a zona. Para ver as VLANs que estão disponíveis, execute ibmcloud ks cluster get --cluster <cluster> --show-resources. Novos nós do trabalhador são incluídos na VLAN especificada, mas as VLANs de quaisquer nós do trabalhador existentes não mudam. Se você não tiver uma VLAN privada ou pública nessa zona, não especifique essa opção. Uma VLAN privada e pública é automaticamente criada para você quando você inclui inicialmente uma zona para o seu conjunto de trabalhadores. Em clusters clássicos, caso haja várias VLANs para o cluster, várias sub-redes na mesma VLAN ou um cluster clássico de várias zonas, deve-se ativar uma Virtual Router Function (VRF) para a conta de infraestrutura do IBM Cloud para que os nós do trabalhador possam se comunicar entre si na rede privada. Para ativar o VRF, consulte Ativando o VRF. Para verificar se um VRF já está ativado, use o comando ibmcloud account show. Se não puder ou não quiser ativar a VRF, ative a Ampliação de VLAN. Para executar esta ação, você precisa da permissão de infraestrutura Rede > Gerenciar VLAN de rede ou pode solicitar que o proprietário da conta a habilite. Para verificar se o spanning de VLAN já está ativado, use o comando ibmcloud ks vlan spanning get --region <region>.
--private-only
Use essa opção para evitar que uma VLAN pública seja criada. Necessário apenas quando você especificar a opção --private-vlan e não incluir a opção --public-vlan. Se os nós do trabalhador forem configurados somente com uma VLAN privada, o terminal em serviço de nuvem privada deverá ser ativado ou um dispositivo de gateway deverá ser configurado. Para obter mais informações, consulte Planejando a configuração do cluster privado e do nó do trabalhador.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando zone add classic

ibmcloud ks zone add classic --zone dal10 --cluster my_cluster -p pool1 -w pool2 --private-vlan 2294021

ibmcloud ks zone add vpc-gen2

Virtual Private Cloud

Depois de criar um cluster de VPC de Geração 2 ou um conjunto de trabalhadores, será possível incluir uma zona. Quando você incluir uma zona, os nós do trabalhador serão incluídos na nova zona para corresponder ao número de trabalhadores por zona que você especificou para o conjunto de trabalhadores. É possível incluir mais de uma zona apenas se o seu cluster está em uma área metropolitana multizona.

ibmcloud ks zone add vpc-gen2 --zone ZONE --subnet-id VPC_SUBNET_ID --cluster CLUSTER --worker-pool WORKER_POOL [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--zone ZONE
Necessário: a zona que você deseja incluir. Ela deve ser do VPC na região do cluster. Para ver as zonas de VPC disponíveis, execute ibmcloud ks zone ls --provider vpc-gen2.
--subnet-id SUBNET_ID
Necessário: O ID da sub-rede que você deseja incluir. A sub-rede do VPC deve estar na zone especificada. Para ver as sub-redes de VPC disponíveis, execute ibmcloud ks subnets --provider vpc-gen2 --vpc-id <vpc> --zone <vpc_zone>. As sub-redes do VPC fornecem endereços IP para seus nós do trabalhador e serviços de balanceador de carga no cluster, portanto, use uma sub-rede do VPC com endereços IP suficientes, como 256.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster. Para listar clusters VPC, execute ibmcloud ks cluster ls --provider vpc-gen2.
-p, --worker-pool WORKER_POOL
O nome do conjunto de trabalhadores no qual incluir a zona. Para especificar vários pools de trabalho, use várias opções, como -p pool1 -p pool2.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando zone add vpc-gen2

ibmcloud ks zone add vpc-gen2 --zone us-south-3 --cluster my_cluster -p pool1 -w pool2

ibmcloud ks zone ls

Virtual Private Cloud Infra-estrutura Classic Satellite

Visualize uma lista de zonas disponíveis nas quais é possível criar um cluster.

O alias locations para esse comando foi descontinuado.

ibmcloud ks zone ls --provider (classic | satellite | vpc-gen2) [--location LOCATION] [--region-only] [--output json] [-q]

Permissões mínimas: nenhuma

Opções de comando:

--provider (classic | satellite | vpc-gen2)
O tipo de provedor de infraestrutura para o qual listar zonas. Essa opção é necessária.
-l, --location LOCATION
Filtre a saída por um local específico. Para ver locais suportados, execute ibmcloud ks locations. Para especificar vários locais, use uma opção para cada local, como -l dal -l seo.
--region-only
Opcional: listar multizonas apenas dentro da região na qual você efetuou login.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks zone ls -l ap

ibmcloud ks zone network-set

Infraestrutura clássica

Somente clusters clássicos multizona: configure os metadados da rede para que um conjunto de trabalhadores use uma VLAN pública ou privada para a zona que seja diferente da usada anteriormente. Os nós do trabalhador que já foram criados no conjunto continuam a usar a VLAN pública ou privada anterior, mas os novos nós do trabalhador no conjunto usam os novos dados de rede.

ibmcloud ks zone network-set --zone ZONE --cluster CLUSTER  --private-vlan PRIVATE_VLAN --worker-pool WORKER_POOL [--public-vlan PUBLIC_VLAN] [--private-only] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--zone ZONE
Necessário: a zona que você deseja incluir. A zona deve ser uma zona com capacidade multizona dentro da região do cluster.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-p, --worker-pool WORKER_POOL
O nome do conjunto de trabalhadores no qual incluir a zona. Para especificar vários pools de trabalho, use várias opções, como -p pool1 -p pool2.
--private-vlan PRIVATE_VLAN
O ID da VLAN privada. Esse valor é necessário, se você deseja usar a mesma VLAN privada ou uma diferente daquela que usou para seus outros nós do trabalhador. Novos nós do trabalhador são incluídos na VLAN especificada, mas as VLANs de quaisquer nós do trabalhador existentes não mudam. As VLANs privadas e públicas devem ser compatíveis e podem ser determinadas por meio do prefixo de ID do Roteador.
--public-vlan PUBLIC_VLAN
O ID da VLAN pública. Esse valor será necessário somente se você desejar mudar a VLAN pública para a zona. Para mudar a VLAN pública, deve-se sempre fornecer uma VLAN privada compatível. Novos nós do trabalhador são incluídos na VLAN especificada, mas as VLANs de quaisquer nós do trabalhador existentes não mudam. As VLANs privadas e públicas devem ser compatíveis e podem ser determinadas por meio do prefixo de ID do Roteador.
--private-only
Opcional: desconfigure a VLAN pública para que os trabalhadores nessa zona sejam conectados a somente uma VLAN privada.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Uso:

  1. Verifique as VLANs que estão disponíveis em seu cluster.

    ibmcloud ks cluster get --cluster <cluster_name_or_ID> --show-resources
    

    Exemplo de saída

    Subnet VLANs
    VLAN ID   Subnet CIDR         Public   User-managed
    229xxxx   169.xx.xxx.xxx/29   true     false
    229xxxx   10.xxx.xx.x/29      false    false
    
  2. Verifique se os IDs de VLAN pública e privada que você deseja usar são compatíveis. Para serem compatíveis, o Roteador deve ter o mesmo ID de pod. Os roteadores de VLAN privada sempre iniciam com bcr (roteador de backend) e roteadores de VLAN pública sempre iniciam com fcr (roteador de front-end). Ao criar um cluster e especificar as VLANs públicas e privadas, a combinação de número e letra após esses prefixos devem corresponder.

    ibmcloud ks vlan ls --zone <zone>
    

    Na saída de exemplo, observe que os IDs de pod do Roteador correspondem: 01a e 01a. Se o ID de um pod fosse 01a e o outro fosse 02a, não seria possível configurar esses IDs de VLAN públicos e privados para o conjunto de trabalhadores.

    ID        Name   Number   Type      Router         Supports Virtual Workers
    229xxxx          1234     private   bcr01a.dal12   true
    229xxxx          5678     public    fcr01a.dal12   true
    
  3. Se não tiver VLANs disponíveis, você poderá solicitar novas VLANs.

Exemplo de comando zone network-set

ibmcloud ks zone network-set --zone dal10 -c my_cluster -p pool1 -p pool2 --private-vlan 2294021

ibmcloud ks zone rm

Virtual Private Cloud Infra-estrutura Classic

Somente clusters multizona: remova uma zona de um ou mais conjuntos de trabalhadores em seu cluster. Todos os nós do trabalhador no conjunto de trabalhadores para essa zona são excluídos.

Antes de remover uma zona, assegure-se de ter nós de trabalhadores suficientes em outras zonas no cluster para que seus pods possam reprogramar. O reescalonamento de seus pods pode evitar um tempo de inatividade para seu aplicativo ou distorção de dados em seu nó do trabalhador.

ibmcloud ks zone rm --cluster CLUSTER --zone ZONE --worker-pool WORKER_POOL [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--zone ZONE
Necessário: a zona que você deseja remover.
-p, --worker-pool WORKER_POOL
O nome do conjunto de trabalhadores do qual remover a zona. Para especificar vários pools de trabalho, use várias opções, como -p pool1 -p pool2. Para remover a zona de todos os pools de trabalho do cluster, não inclua essa opção.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando zone rm

ibmcloud ks zone rm --zone dal10 --cluster my_cluster

ingress comandos

Visualize e configure os balanceadores de carga do aplicativo (ALBs) do Ingress.

Na CLI versão 1.0.157 e mais recente, a categoria ibmcloud ks alb está descontinuada e esses comandos agora são listados na subcategoria ibmcloud ks ingress alb. Para obter mais informações, consulte o log de mudanças da CLI.

ibmcloud ks ingress alb autoscale get

Virtual Private Cloud Infra-estrutura Classic

Obtenha os detalhes e o status de uma configuração de ajuste automático de escala do ALB do Ingress

ibmcloud ks ingress alb autoscale get --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB
Necessário: o nome ou o ID do ALB no qual configurar o ajuste automático de escala.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo de comando ingress alb autoscale get

ibmcloud ks ingress alb autoscale get --alb myalb123 --cluster mycluster

ibmcloud ks ingress alb autoscale set

Virtual Private Cloud Infra-estrutura Classic

Configure o ajuste automático de escala para aumentar ou diminuir automaticamente o número de pods do ALB do Ingress com base na carga atual É possível escolher escalar pods com base na utilização da CPU ou usar métricas customizadas que você especificar. Se você basear a configuração de ajuste automático de escala na utilização da CPU, especifique uma taxa média de utilização da CPU, bem como um número máximo e mínimo de pods a serem implementados a qualquer momento. Se você optar por especificar métricas customizadas para ajuste automático de escala, passará um caminho para um arquivo de métrica customizado.

ibmcloud ks ingress alb autoscale set --alb ALB --cluster CLUSTER --max-replicas REPLICAS --min-replicas REPLICAS [--output OUTPUT] [-q] (--cpu-average-utilization PERCENT | --custom-metrics-file FILE)
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB
Necessário: o nome ou o ID do ALB no qual configurar o ajuste automático de escala.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--max-replicas REPLICAS
O número máximo de réplicas implementadas a qualquer momento. Esse valor será necessário se você incluir a opção ---cpu-average-utilization
--min-replicas REPLICAS
O número mínimo de réplicas a serem implementadas a qualquer momento Esse valor será necessário se você incluir a opção ---cpu-average-utilization
--cpu-average-utilization PERCENTAGE
O limite médio de utilização usado para calcular dinamicamente o número de replicas.
--custom-metrics-file
O caminho para o arquivo de métricas customizado.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo de comando ingress alb autoscale set

ibmcloud ks ingress alb autoscale set --alb myalb123 --cluster mycluster --max-replicas 5 --min-replicas 2 --cpu-average-utilization 5

ibmcloud ks ingress alb autoscale unset

Virtual Private Cloud Infra-estrutura Classic

Remova o ajuste automático de escala de seus ALBs do Ingress, excluindo a configuração de ajuste automático de escala

ibmcloud ks ingress alb autoscale unset --alb ALB --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB
Necessário: o nome ou o ID do ALB no qual configurar o ajuste automático de escala.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb autoscale unset

ibmcloud ks ingress alb autoscale unset --alb myalb123 --cluster mycluster

ibmcloud ks ingress alb autoupdate disable

Virtual Private Cloud Infra-estrutura Classic

Desative as atualizações automáticas de todos os pods do ALB do Ingress em um cluster.

Por padrão, as atualizações automáticas para os balanceadores de carga do aplicativo (ALBs) do Ingress são ativadas. Os pods do ALB são atualizados automaticamente quando uma nova versão de imagem está disponível. Atualize o complemento manualmente; use esse comando para desativar as atualizações automáticas. Em seguida, é possível atualizar pods do ALB executando o comando ibmcloud ks ingress alb update.

Quando você atualiza a versão principal ou secundária do Kubernetes de seu cluster, a IBM faz automaticamente as mudanças necessárias na implementação do Ingress, mas não muda a versão de imagem do complemento ALB do seu Ingress. Você é responsável por verificar a compatibilidade das versões mais recentes do Kubernetes e de suas imagens do complemento ALB do Ingress.

ibmcloud ks ingress alb autoupdate disable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb autoupdate disable

ibmcloud ks ingress alb autoupdate disable --cluster mycluster

ibmcloud ks ingress alb autoupdate enable

Virtual Private Cloud Infra-estrutura Classic

Ative as atualizações automáticas de todos os pods do ALB do Ingress em um cluster.

Se as atualizações automáticas para o complemento ALB de Ingress estiverem desativadas, será possível reativar as atualizações automáticas. Sempre que a próxima versão de imagem é disponibilizada, os ALBs são atualizados automaticamente para a construção mais recente.

ibmcloud ks ingress alb autoupdate enable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks ingress alb autoupdate get

Virtual Private Cloud Infra-estrutura Classic

Verifique se as atualizações automáticas para o complemento ALB do Ingress estão ativadas e se os seus ALBs são atualizados para a versão de imagem mais recente.

ibmcloud ks ingress alb autoupdate get --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks ingress alb create classic

Infraestrutura clássica

Crie um ALB público ou privado em um cluster clássico. O ALB criado é ativado por padrão.

ibmcloud ks ingress alb create classic --cluster CLUSTER --type (PUBLIC|PRIVATE) --vlan VLAN_ID --zone ZONE [--ip IP] [--version IMAGE_VERSION] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster.
--type (PUBLIC|PRIVATE)
O tipo de ALB: public ou private. Esse tipo deve corresponder a vlan.
--vlan VLAN_ID
O ID da VLAN para criação do ALB. Essa VLAN deve corresponder ao type do ALB e deve estar na mesma zone que o ALB que você deseja criar.
--zone ZONE
A zona para criação do ALB.
--ip IP
Opcional: um endereço IP a ser designado ao ALB. Esse IP deve estar na vlan especificada e deve estar na mesma zone que o ALB que você deseja criar. Esse endereço IP não deve estar em uso por outro balanceador de carga ou ALB no cluster. Para ver os endereços IP que estão atualmente em uso, execute kubectl get svc --all-namespaces.
--version IMAGE_VERSION
Opcional: a versão da imagem na qual você deseja que o ALB seja executado. Para listar as versões disponíveis, execute ibmcloud ks ingress alb versions. Para especificar uma versão diferente da padrão, deve-se primeiro desativar as atualizações automáticas executando o comando ibmcloud ks ingress alb autoupdate disable. Se você omitir essa opção, o ALB executará a versão padrão do tipo de imagem Kubernetes Ingress.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb create classic

ibmcloud ks ingress alb create classic --cluster mycluster --type public --vlan 2234945 --zone dal10 --ip 1.1.1.1 --version 1.1.2_2507_iks

ibmcloud ks ingress alb create vpc-gen2

Virtual Private Cloud

Crie um ALB público ou privado em um cluster de VPC. O ALB criado é ativado por padrão.

ibmcloud ks ingress alb create vpc-gen2 --cluster CLUSTER --type PUBLIC|PRIVATE --zone ZONE [--version IMAGE_VERSION] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster. Para visualizar clusters VPC, execute ibmcloud ks cluster ls --provider vpc-gen2.
--type PUBLIC|PRIVATE
O tipo de ALB: public ou private.
--zone ZONE
A zona do VPC na qual implementar o ALB.
--version IMAGE_VERSION
Opcional: a versão da imagem na qual você deseja que o ALB seja executado. Para listar as versões disponíveis, execute ibmcloud ks ingress alb versions. Para especificar uma versão diferente da padrão, deve-se primeiro desativar as atualizações automáticas executando o comando ibmcloud ks ingress alb autoupdate disable. Se você omitir essa opção, o ALB executará a versão padrão do tipo de imagem Kubernetes Ingress.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb create vpc-gen2

ibmcloud ks ingress alb create vpc-gen2 --cluster mycluster --type public --zone us-south-1 --version 1.1.2_2507_iks

ibmcloud ks ingress alb disable

Virtual Private Cloud Infra-estrutura Classic

Desative um ALB em seu cluster. O ALB e seus pods ainda existem, mas param de rotear o tráfego para seus apps.

O alias anterior para esse comando, ibmcloud ks ingress alb configure, está descontinuado.

ibmcloud ks ingress alb disable --alb ALB_ID --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB_ID
Necessário: o ID para um ALB. Para visualizar os IDs dos ALBs em um cluster, execute ibmcloud ks ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
O nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb disable

ibmcloud ks ingress alb disable --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud ks ingress alb enable classic

Infraestrutura clássica

Ative um ALB em seu cluster clássico.

O alias anterior para esse comando, ibmcloud ks ingress alb configure classic, está descontinuado.

É possível usar esse comando para:

  • Ative um ALB privado padrão. Ao criar um cluster, um ALB privado padrão é criado em cada zona na qual você tem trabalhadores e em uma sub-rede privada disponível, mas os ALBs privados padrão não são ativados. No entanto, todos os ALBs públicos padrão são ativados automaticamente e quaisquer ALBs públicos ou privados que você cria com o comando ibmcloud ks ingress alb create classic também são ativados por padrão.
  • Ative um ALB que você desativou anteriormente.
ibmcloud ks ingress alb enable classic --alb ALB_ID --cluster CLUSTER [--ip IP_ADDRESS] [--version IMAGE_VERSION] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB_ID
Necessário: o ID para um ALB. Para visualizar os IDs dos ALBs em um cluster, execute ibmcloud ks ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
O nome ou ID do cluster.
--ip IP_ADDRESS
Opcional: especifique um endereço IP que esteja em uma VLAN na zona na qual o ALB foi criado. O ALB é ativado e usa esse endereço IP público ou privado. Esse endereço IP não deve estar em uso por outro balanceador de carga ou ALB no cluster. Se nenhum endereço IP for fornecido, o ALB será implementado com um endereço IP público ou privado da sub-rede móvel pública ou privada que foi provisionada automaticamente quando você criou o cluster ou, se você reativar um ALB que foi ativado anteriormente, o endereço IP público ou privado que foi designado anteriormente para o ALB.
--version IMAGE_VERSION
Opcional: a versão da imagem na qual você deseja que o ALB seja executado. Para listar as versões disponíveis, execute ibmcloud ks ingress alb versions. Para especificar uma versão diferente da padrão, deve-se primeiro desativar as atualizações automáticas executando o comando ibmcloud ks ingress alb autoupdate disable. Se você omitir essa opção, o ALB executará a versão padrão da mesma imagem que o ALB executou anteriormente: a imagem Kubernetes Ingress ou a imagem IBM Cloud Kubernetes Service Ingress.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb enable classic

ibmcloud ks ingress alb enable classic --alb private-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster --ip 169.XX.XXX.XX --version 1.1.2_2507_iks

ibmcloud ks ingress alb enable vpc-gen2

Virtual Private Cloud

Ative um ALB em um cluster de VPC.

O alias anterior para esse comando, ibmcloud ks ingress alb configure vpc-gen2, está descontinuado.

É possível usar esse comando para:

  • Ative um ALB privado padrão. Ao criar um cluster, um ALB privado padrão é criado para você em cada zona na qual você tem nós do trabalhador, mas os ALBs privados padrão não são ativados. No entanto, todos os ALBs públicos padrão são ativados automaticamente e quaisquer ALBs públicos ou privados que você cria com o comando ibmcloud ks ingress alb create vpc-gen2 também são ativados por padrão.
  • Ative um ALB que você desativou anteriormente.
ibmcloud ks ingress alb enable vpc-gen2 --alb ALB_ID --cluster CLUSTER [--version IMAGE_VERSION] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB_ID
Necessário: o ID para um ALB. Para visualizar os IDs dos ALBs em um cluster, execute ibmcloud ks ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
O nome ou ID do cluster.
--version IMAGE_VERSION
Opcional: a versão da imagem na qual você deseja que o ALB seja executado. Para listar as versões disponíveis, execute ibmcloud ks ingress alb versions. Para especificar uma versão diferente da padrão, deve-se primeiro desativar as atualizações automáticas executando o comando ibmcloud ks ingress alb autoupdate disable. Se você omitir essa opção, o ALB executará a versão padrão da mesma imagem que o ALB executou anteriormente: a imagem Kubernetes Ingress ou a imagem IBM Cloud Kubernetes Service Ingress.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb enable vpc-gen2

ibmcloud ks ingress alb enable vpc-gen2 --alb private-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster --version 1.1.2_2507_iks

ibmcloud ks ingress alb get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um ALB do Ingress em um cluster.

ibmcloud ks ingress alb get --alb ALB_ID --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--alb ALB_ID
Necessário: o ID para um ALB. Para visualizar os IDs dos ALBs em um cluster, execute ibmcloud ks ingress alb ls --cluster CLUSTER.
-c, --cluster CLUSTER
O nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb get

ibmcloud ks ingress alb get --alb public-cr18a61a63a6a94b658596aa93a087aaa9-alb1 --cluster mycluster

ibmcloud ks ingress alb health-checker disable

Virtual Private Cloud Infra-estrutura Classic

Desative o verificador de saúde para um Ingresso ALB em um cluster.

ibmcloud ks ingress alb health-checker disable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb health-checker disable

ibmcloud ks ingress alb health-checker disable --cluster mycluster

ibmcloud ks ingress alb health-checker enable

Virtual Private Cloud Infra-estrutura Classic

Habilitar o verificador de saúde para um Ingresso ALB em um cluster.

ibmcloud ks ingress alb health-checker enable --cluster CLUSTER [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb health-checker enable

ibmcloud ks ingress alb health-checker enable --cluster mycluster

ibmcloud ks ingress alb health-checker get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes do verificador de saúde para um Ingresso ALB em um cluster.

ibmcloud ks ingress alb health-checker get --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb health-checker get

ibmcloud ks ingress alb health-checker get --cluster mycluster

ibmcloud ks ingress alb ls

Virtual Private Cloud Infra-estrutura Classic

Liste todos os IDs do ALB do Ingress em um cluster e visualize se uma atualização para os pods do ALB está disponível.

Se nenhum ID de ALB for retornado, o cluster não terá uma sub-rede móvel. É possível criar ou incluir sub-redes em um cluster. Em seguida, os ALBs são criados automaticamente para você.

ibmcloud ks ingress alb ls --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

*-c, --cluster *CLUSTER
Necessário: o nome ou o ID do cluster no qual você lista os ALBs disponíveis.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress alb ls

ibmcloud ks ingress alb ls --cluster my_cluster

ibmcloud ks ingress alb update

Virtual Private Cloud Infra-estrutura Classic

Force uma atualização dos pods dos ALBs do Ingress individuais ou para todos no cluster para uma versão mais recente ou específica.

Se as atualizações automáticas para o complemento ALB do Ingress estiverem desativadas e você desejar atualizar o complemento, será possível forçar uma atualização única de seus pods do ALB. Se os seus pods do ALB tiverem sido recentemente atualizados, mas uma configuração customizada para seus ALBs for afetada pela construção mais recente, também será possível usar esse comando para retroceder os pods do ALB para uma versão anterior suportada. Note que é possível usar esse comando para atualizar a imagem do ALB para uma versão diferente, mas não para mudar o ALB de um tipo de imagem para outro. Depois de forçar uma atualização única, as atualizações automáticas permanecem desativadas, mas podem ser reativadas com o comando ibmcloud ks ingress alb autoupdate enable.

ibmcloud ks ingress alb update --cluster CLUSTER [--alb ALB1_ID --alb ALB2_ID ...] [--version IMAGE_VERSION] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual você deseja atualizar os ALBs.
--alb CLUSTER
Opcional: o ID do ALB individual a ser atualizado. Para listar IDs do ALB, execute ibmcloud ks ingress alb ls -c <cluster>. Para atualizar vários ALBs, use várias opções, como --alb ALB1_ID --alb ALB2_ID. Se você omitir essa opção, todos os ALBs do cluster serão atualizados.
--version IMAGE_VERSION
Opcional: a versão da imagem para a qual você deseja atualizar os ALBs.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
  • Para atualizar todos os pods do ALB no cluster:
    ibmcloud ks ingress alb update -c mycluster --version 1.1.2_2507_iks
    
  • Para atualizar os pods do ALB para um ou mais ALBs específicos:
    ibmcloud ks ingress alb update -c mycluster --version 1.1.2_2507_iks --alb public-crdf253b6025d64944ab99ed63bb4567b6-alb1
    

ibmcloud ks ingress alb versions

Virtual Private Cloud Infra-estrutura Classic

Visualize as versões do ALB do Ingress disponíveis

ibmcloud ks ingress alb versions [--output json] [-q]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks ingress domain create

Crie um domínio do Ingress para um cluster.

ibmcloud ks ingress domain create --cluster CLUSTER [--crn CRN] [--default] [--domain DOMAIN] [--hostname HOSTNAME] [--ip IP] [--output OUTPUT] [--domain-provider PROVIDER] [-q] [--secret-namespace NAMESPACE] [--domain-zone ZONE]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster onde você deseja criar o domínio.
--crn CRN
Necessário para domínios do IBM Cloud Internet Services. O CRN para a instância IBM Cloud Internet Services.
--is-default
Opcional. Inclua essa opção para definir o domínio relevante como o domínio padrão do cluster.
--domain DOMAIN
O domínio do Ingress. Você pode especificar um domínio existente ou criar um novo. Para obter informações específicas do provedor sobre como especificar domínios, consulte Criando seu próprio domínio do Ingress.
--hostname HOSTNAME
Opcional. Para clusters VPC. O nome do host a ser registrado para o domínio.
--ip IP
Opcional. Os endereços IP a serem registrados para o domínio.
--output OUTPUT
Opcional: imprimirá a saída de comando em formato JSON.
--domain-provider PROVIDER
Opcional. O tipo de provedor DNS externo. As opções disponíveis são akamai, cis-ext. Se nenhum provedor for especificado, um domínio será criado com o provedor interno IBM-managed.
--secret-namespace NAMESPACE
Opcional. O namespace no qual o segredo do TLS é criado. Se nenhum namespace for especificado, o segredo será criado no namespace default.
--domain-zone ZONE
Opcional. O ID de domínio para sua instância do IBM Cloud Internet Services. Esse é um valor GUID.

Exemplo de comando ingress domain create

Este comando de exemplo cria um domínio registrado com o provedor interno IBM Cloud. Para obter exemplos de como criar domínios com diferentes provedores, consulte Criando seu próprio domínio do Ingress

ibmcloud ks ingress domain create --cluster my-cluster --domain exampledomain

ibmcloud ks ingress domain default replace

Mude o domínio padrão do Ingress de um cluster.

ibmcloud ks ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service.

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio que você deseja especificar como o novo domínio padrão para o cluster Você deve especificar um domínio existente.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain default replace

ibmcloud ks ingress domain default replace --cluster CLUSTER --domain DOMAIN [-q]

ibmcloud ks ingress domain get

Visualize os detalhes de um domínio do Ingress.

ibmcloud ks ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio para o qual deseja visualizar detalhes.
--output OUTPUT
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain get

ibmcloud ks ingress domain get --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]

ibmcloud ks ingress domain ls

Liste todos os domínios do Ingress para um cluster.

ibmcloud ks ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output OUTPUT
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain ls

ibmcloud ks ingress domain ls --cluster CLUSTER [--output OUTPUT] [-q]

ibmcloud ks ingress domain rm

Remova um domínio do Ingress de um cluster.

ibmcloud ks ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio que você deseja remover do cluster Não é possível especificar o domínio padrão Se você desejar remover o domínio que está atualmente configurado como o padrão para seu cluster, deverá primeiro substituir o padrão por outro domínio.

-f

-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain rm

ibmcloud ks ingress domain rm --cluster CLUSTER --domain DOMAIN [-f] [-q]

ibmcloud ks ingress domain secret regenerate

Gere novamente o certificado para um domínio do Ingress. Execute este comando para gerar um novo token em seu provedor DNS e aplicá-lo em seu cluster

ibmcloud ks ingress domain secret regenerate --cluster CLUSTER --domain DOMAIN [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio que você deseja gerar novamente
--output OUTPUT
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain secret regenerate

ibmcloud ks ingress domain secret regenerate --cluster mycluster --domain exampledomain [--output OUTPUT] [-q]

ibmcloud ks ingress domain secret rm

Excluir o segredo de um domínio Ingress e impedir a renovação futura do certificado.

ibmcloud ks ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio do qual você deseja remover o segredo.

-f

--output OUTPUT
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain secret rm

ibmcloud ks ingress domain secret rm --cluster CLUSTER --domain DOMAIN [-f] [--output OUTPUT] [-q]

ibmcloud ks ingress domain update

Atualize um domínio do Ingress para um cluster para mudar os nomes do host ou os endereços IP associados ao domínio Esse comando atualiza todos os recursos em seu cluster com os endereços IP ou nomes de host especificados e muda as URLs de seu app

ibmcloud ks ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [--ip IP] [-q]

Observe que ao incluir endereços IP ou nomes de host, deve-se incluir quaisquer IPs ou nomes de host que estejam atualmente registrados para o domínio O domínio é atualizado com os valores exatos especificados, portanto, quaisquer endereços IP ou nomes de host atuais serão sobrescritos se eles não forem incluídos Por exemplo, se 52.137.182.166 estiver registrado atualmente em seu domínio e você desejar incluir 52.137.182.270, deverá especificar --ip 52.137.182.166 --ip 52.137.182.270 no comando.

Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Obrigatório: O nome ou ID do cluster em que o domínio é aplicado.
--domain DOMAIN
Obrigatório. O domínio que você deseja atualizar
--hostname HOSTNAME
Para clusters VPC. O nome do host a ser registrado para o domínio.
--ip IP
Os endereços IP a serem registrados para o domínio. Os endereços IP transmitidos substituem totalmente aqueles que estão atualmente associados com o domínio Se você desejar manter os endereços IP atuais, deverá incluí-los. Especificar essa sinalização sem valores cancela o registro dos endereços IP atuais do domínio.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress domain update

ibmcloud ks ingress domain update --cluster CLUSTER --domain DOMAIN [--hostname HOSTNAME] [--ip IP] [-q]

ibmcloud ks ingress instance default set

Virtual Private Cloud Infra-estrutura Classic

Configure uma instância da IBM Cloud Secrets Manager como padrão. Se uma instância padrão já existir, ela será desconfigurada do padrão.

Quando você configura uma nova instância padrão do Secrets Manager, quaisquer segredos existentes que não sejam gerenciados pela IBM Cloud devem ter seu certificado CRN manualmente atualizado para corresponder ao CRN da nova instância padrão. Para atualizar o CRN, use o comando ibmcloud ks ingress secret update. Se você não atualizar o CRN, esses segredos não serão atualizados na próxima renovação de certificado programada.

ibmcloud ks ingress instance default set --cluster CLUSTER --crn CRN --name NAME [-q] [--secret-group GROUP]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--crn
Obrigatório. O CRN da instância do IBM Cloud Secret Manager.
--name NAME
Obrigatório. O nome da instância do Secret Manager.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--secret-group GROUP
ID do grupo de segredo da instância IBM Cloud Secret Manager, em que os segredos são persistidos. Para obter um ID de grupo secreto, consulte o Secrets Manager referência CLI.

Exemplo:

ibmcloud ks ingress instance default set --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud ks ingress instance default unset

Virtual Private Cloud Infra-estrutura Classic

Remova uma instância do Secrets Manager como instância padrão.

Se nenhuma instância padrão for definida, seus segredos serão apenas gravados diretamente no cluster e não serão gravados em nenhuma instância do Secrets Manager.

ibmcloud ks ingress instance default unset --cluster CLUSTER --crn CRN --name NAME [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--crn
Obrigatório. O CRN da instância do IBM Cloud Secret Manager.
--name NAME
Obrigatório. O nome da instância do Secret Manager.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks ingress instance default unset --cluster --cluster a111aaa11a1aaaaaaa1 --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --name my-secret-manager --namespace default

ibmcloud ks ingress instance get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de uma instância do Secrets Manager.

ibmcloud ks ingress instance get --cluster CLUSTER --name NAME [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--name NAME
Obrigatório. O nome da instância do Secret Manager.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks ingress instance get --cluster my-cluster --name my-secrets-manager

ibmcloud ks ingress instance ls

Virtual Private Cloud Infra-estrutura Classic

Listar todas as instâncias do Secrets Manager registradas em um cluster.

ibmcloud ks ingress instance ls --cluster CLUSTER [--output OUTPUT] [-q] [--show-deleted]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--show-deleted
Opcional. Inclua esta opção para inserir instâncias que não foram registrados por meio do cluster.

Exemplo:

ibmcloud ks ingress instance ls --cluster my-cluster --show-deleted

ibmcloud ks ingress instance register

Virtual Private Cloud Infra-estrutura Classic

Registre uma instância do Secrets Manager em um cluster.

ibmcloud ks ingress instance register --cluster CLUSTER --crn CRN [--is-default] [--secret-group GROUP] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--crn
Obrigatório. O CRN da instância do IBM Cloud Secret Manager.
--is-default
Opcional. Inclua esta opção para também configurar a instância registrada como a instância padrão do Secrets Manager em que todos os certificados de subdomínio do Ingress são armazenados. Se outra instância já estiver configurada como padrão, ela será removida. Note que você deve atualizar manualmente quaisquer certificados ou segredos para fazer upload deles para a nova instância padrão. Caso contrário, eles serão transferidos por upload no próximo horário de atualização programado para o segredo.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.
--secret-group GROUP
ID do grupo de segredo da instância IBM Cloud Secret Manager, em que os segredos são persistidos. Para obter um ID de grupo secreto, consulte o Secrets Manager referência CLI.

Exemplo:

ibmcloud ks ingress instance register --cluster my-cluster --crn crn:v1:staging:public:secrets-manager:eu-gb:a/1a11a1a111aa11aa111aa1a1111aa1a1:1aaa1a1a-aaaa-11aa-1a11-a11aaa1a11a1:secret:a1a11a11-111a-11a1-aa11-11aaa1a11a11 --secret-group 90e059dd-d04e-a32b-010f-4d303b9050b8

ibmcloud ks ingress instance unregister

Virtual Private Cloud Infra-estrutura Classic

Remova uma instância do Secrets Manager de um cluster.

ibmcloud ks ingress instance unregister --cluster CLUSTER --name NAME [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--name
Obrigatório. O nome da instância do Secrets Manager a remover.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks ingress instance unregister --cluster my-cluster --name my-secrets-manager-instance

ibmcloud ks ingress lb get

Virtual Private Cloud Infra-estrutura Classic

Obtenha a configuração de balanceadores de carga que expõem os ALBs do Ingress em seu cluster.

Por exemplo, se você tiver executado anteriormente comandos como ibmcloud ks ingress lb proxy-protocol enable, será possível usar esse comando para visualizar suas mudanças de configuração.

ibmcloud ks ingress lb get --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress lb get

ibmcloud ks ingress lb get --cluster mycluster

ibmcloud ks ingress lb proxy-protocol disable

Virtual Private Cloud

Desative o protocolo NGINX PROXY para os balanceadores de carga na frente de todos os ALBs do Ingress em seu cluster para que as informações de conexão do cliente não sejam mais transmitidas em cabeçalhos da solicitação para os ALBs.

Após executar este comando, os balanceadores de carga existentes são excluídos e recriados, o que pode causar interrupções no serviço. Dois endereços IP não usados devem estar disponíveis em cada sub-rede durante a recriação do balanceador de carga.

ibmcloud ks ingress lb proxy-protocol disable --cluster CLUSTER [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress lb proxy-protocol disable

ibmcloud ks ingress lb proxy-protocol disable --cluster mycluster

ibmcloud ks ingress lb proxy-protocol enable

Virtual Private Cloud

Ative o Protocolo NGINX PROXY para todos os balanceadores de carga que expõem os ALBs do Ingress no cluster para que as informações de conexão do cliente sejam passadas nos cabeçalhos de solicitação para os ALBs.

O protocolo PROXY permite que os balanceadores de carga transmitam informações de conexão do cliente contidas em cabeçalhos na solicitação do cliente para os ALBs. Essas informações do cliente podem incluir o endereço IP do cliente, o endereço IP do servidor proxy e ambos os números de porta.

Após executar este comando, os balanceadores de carga existentes são excluídos e recriados, o que pode causar interrupções no serviço. Dois endereços IP não usados devem estar disponíveis em cada sub-rede durante a recriação do balanceador de carga.

ibmcloud ks ingress lb proxy-protocol enable --cluster CLUSTER [--cidr CIDR ...] [--header-timeout TIMEOUT] [-f] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do operador para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--cidr CIDR
Opcional: CIDRs do balanceador de carga por meio dos quais os ALBs processam informações em cabeçalhos do protocolo PROXY. Se as solicitações que contiverem cabeçalhos PROXY forem originadas de balanceadores de carga em outros intervalos de IP, as informações nos cabeçalhos não serão processadas pelo ALB. Essa opção é suportada apenas para os ALBs que executam a imagem do Kubernetes Ingress da comunidade. Padrão: 0.0.0.0/0
--header-timeout TIMEOUT
Opcional: o valor de tempo limite, em segundos, para o balanceador de carga receber os cabeçalhos do protocolo PROXY que contêm as informações de conexão do cliente. Essa opção é suportada apenas para os ALBs que executam a imagem do Kubernetes Ingress da comunidade. Padrão: 5
-f
Opcional: forçar a execução do comando sem prompts do usuário.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress lb proxy-protocol enable

ibmcloud ks ingress lb proxy-protocol enable --cluster mycluster --cidr 1.1.1.1/16

ibmcloud ks ingress secret create

Virtual Private Cloud Infra-estrutura Classic

Crie um segredo do Ingress em um cluster para um certificado armazenado no IBM Cloud® Secrets Manager. Este comando pode ser usado para criar segredos TLS ou não TLS.

O alias anterior para esse comando, ibmcloud ks ingress alb cert deploy, está descontinuado. Na CLI versão 1.0.157 e mais recente, a categoria ibmcloud ks ingress alb cert está descontinuada e esses comandos agora são listados na subcategoria ibmcloud ks ingress secret. Para obter mais informações, consulte o log de mudanças da CLI.

Para usar o comando ibmcloud ks ingress secret create, você deve ter uma instância padrão Secrets Manager registrada em seu cluster. Se você não tiver uma instância Secrets Manager e seus segredos forem, em vez disso, escritos diretamente para o seu cluster, seus segredos não possuem o valor CRN necessário e você deve gerenciá-los com comandos kubectl.

ibmcloud ks ingress secret create --cert-crn CERTIFICATE_CRN --cluster CLUSTER --name SECRET_NAME  [--namespace NAMESPACE] [--field CRN] [--persist] [--type] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--cert-crn CERTIFICATE_CRN
Necessário: o CRN do certificado.
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--name SECRET_NAME
Necessário: especificar um nome para o segredo. Certifique-se de não criar o segredo com o mesmo nome do segredo de Ingress fornecido pela IBM, que pode ser localizado executando ibmcloud ks cluster get --cluster <cluster_name_or_ID> | grep Ingress.
--field CRN
Necessário para segredos não TLS. Adicione um campo ao segredo. É possível especificar mais de um campo de cada vez. Para obter mais informações, consulte Gerenciando campos secretos não TLS. Essa opção não é compatível com segredos TLS.
  • Para puxar no segredo com o nome de campo padrão para o tipo secreto, use a opção de campo padrão: --field <crn>. Esta opção está disponível para todos os tipos secretos não TLS.
  • Para especificar o nome do campo, use a opção de campo denominada: --field name=<crn>. Esta opção está disponível para tipos secretos credenciados arbitrários e IAM.
  • Para usar o IBM Cloud Secrets Manager segredo como o prefixo, use a opção de campo prefixado: --field prefix=<crn>. Esta opção está disponível para credencial de IAM, nome de usuário e senha e tipos secretos de valor de chave.
--namespace NAMESPACE
Opcional: especificar o namespace com o qual seu recurso do Ingress está implementado. Se o ALB executar a imagem do Ingress do Kubernetes, esse valor será necessário, pois o ALB poderá identificar segredos apenas no mesmo namespace que o seu recurso do Ingress. Se o ALB executar a imagem do Ingress do IBM Cloud Kubernetes Service, e você não especificar um espaço de nomes, o segredo do certificado será criado em um espaço de nomes chamado ibm-cert-store. Uma referência a esse segredo é, então, criada no namespace default, que qualquer recurso Ingress em qualquer namespace pode acessar. Durante o processamento das solicitações, o ALB segue a referência para captar e usar o segredo do certificado do namespace ibm-cert-store.
--persist
Opcional: persista os dados do segredo em seu cluster. Se o segredo for excluído posteriormente da CLI ou do console da web do Red Hat OpenShift, ele será recriado automaticamente em seu cluster. Para excluir permanentemente o segredo, você deve usar a API /ingress/v2/secret/deleteSecret.
--type
Opcional. O tipo de segredo. Escolha em tls para CRNs de certificado ou opaque para CRNs sem certificado. Para tls, especifique até um CRN. Para opaque, é possível especificar vários CRNs. Se nenhum tipo de segredo for especificado, o tls será aplicado por padrão.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret create

ibmcloud ks ingress secret create --cert-crn crn:v1:staging:public:cloudcerts:us-south:a/06580c923e40314421d3b6cb40c01c68:0db4351b-0ee1-479d-af37-56a4da9ef30f:certificate:4bc35b7e0badb304e60aef00947ae7ff --cluster my_cluster --type tls --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret field add

Virtual Private Cloud Infra-estrutura Classic

Adicionar um campo CRN não-TLS a um segredo Opaque. Existem três maneiras de especificar o tipo de campo. Aquele que você escolhe depende do tipo secreto e como você deseja nomear o campo no segredo não TLS. Para obter mais informações, consulte Gerenciando campos secretos não TLS.

ibmcloud ks ingress secret field add --cluster CLUSTER --name SECRET_NAME --field CRN --namespace NAMESPACE [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--name NAME
Obrigatório. O nome do segredo no qual incluir o campo.
--field CRN
Obrigatório. O CRN secreto a ser adicionado ao campo. É possível especificar mais de um campo de cada vez. Para obter mais informações, consulte Gerenciando campos secretos não TLS.
  • Para puxar no segredo com o nome de campo padrão para o tipo secreto, use a opção de campo padrão: --field <crn>. Esta opção está disponível para todos os tipos secretos não TLS.
  • Para especificar o nome do campo, use a opção de campo denominada: --field name=<crn>. Esta opção está disponível para tipos secretos credenciados arbitrários e IAM.
  • Para usar o IBM Cloud Secrets Manager segredo como o prefixo, use a opção de campo prefixado: --field prefix=<crn>. Esta opção está disponível para credencial de IAM, nome de usuário e senha e tipos secretos de valor de chave.
--namespace NAMESPACE
Obrigatório. O namespace para o qual o segredo está sendo implementado.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo para adicionar campos padrão, nomeados e prefixados a um conjunto de credenciais do IAM:

ibmcloud ks ingress secret field add --cluster example-cluster --name example-iam-secret --namespace default  --field crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field unique_iam_name=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1 --field prefix=crn:v1:bluemix:public:secrets-manager:us-south:a/1aa111aa1a11111aaa1a1111aa1aa111:111a1111-11a1

ibmcloud ks ingress secret field ls

Virtual Private Cloud Infra-estrutura Classic

Visualizar os campos CRN de um segredo do Ingress. Este comando aplica-se apenas a segredos opacos.

ibmcloud ks ingress secret field ls --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--name NAME
Obrigatório. O nome do segredo no qual incluir o campo.
--namespace NAMESPACE
Obrigatório. O namespace para o qual o segredo está sendo implementado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret field ls

ibmcloud ks ingress secret field ls --cluster a11a11a11a111a1a111a --name my-secret --namespace default

ibmcloud ks ingress secret field rm

Virtual Private Cloud Infra-estrutura Classic

ibmcloud ks ingress secret field rm --cluster CLUSTER --name NAME --namespace NAMESPACE [--field-name NAME]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--c, --cluster CLUSTER
Obrigatório. O nome ou ID do cluster.
--name NAME
Obrigatório. O nome do segredo do qual remover o campo.
--namespace NAMESPACE
Obrigatório. O namespace para o qual o segredo está sendo implementado.
--field-name NAME
O nome do campo a ser removido. Para ver uma lista de campos, execute ibmcloud ks ingress secret field ls.

Exemplo de comando ingress secret field rm

ibmcloud ks ingress secret field rm --cluster a11a11a11a111a1a111a --name my-secret --namespace default --field-name test-field-name

ibmcloud ks ingress secret get

Virtual Private Cloud Infra-estrutura Classic

Visualizar informações sobre segredos do Ingress em seu cluster, incluindo segredos armazenados em IBM Cloud® Secrets Manager.

O alias anterior para esse comando, ibmcloud ks ingress alb cert get, está descontinuado. Na CLI versão 1.0.157 e mais recente, a categoria ibmcloud ks ingress alb cert está descontinuada e esses comandos agora são listados na subcategoria ibmcloud ks ingress secret. Para obter mais informações, consulte o log de mudanças da CLI.

ibmcloud ks ingress secret get --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--name SECRET_NAME
Necessário: o nome do segredo.
--namespace NAMESPACE
Necessário: o namespace para o qual o segredo está implementado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret get

ibmcloud ks ingress secret get --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret ls

Virtual Private Cloud Infra-estrutura Classic

List Ingress segredos em seu cluster, incluindo segredos armazenados em IBM Cloud® Secrets Manager.

O alias anterior para esse comando, ibmcloud ks ingress alb cert ls, está descontinuado.

ibmcloud ks ingress secret ls --cluster CLUSTER [--show-deleted] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--show-deleted
Opcional: visualizar segredos que foram excluídos do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret ls

ibmcloud ks ingress secret ls --cluster my_cluster

ibmcloud ks ingress secret rm

Virtual Private Cloud Infra-estrutura Classic

Exclua um segredo do Ingress de seu cluster. Se você tiver criado um segredo para um certificado do Secrets Manager, apenas o segredo no cluster será excluído e o certificado permanecerá em sua instância do Secrets Manager.

O alias anterior para esse comando, ibmcloud ks ingress alb cert rm, está descontinuado. Na CLI versão 1.0.157 e mais recente, a categoria ibmcloud ks ingress alb cert está descontinuada e esses comandos agora são listados na subcategoria ibmcloud ks ingress secret. Para obter mais informações, consulte o log de mudanças da CLI.

ibmcloud ks ingress secret rm --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--name SECRET_NAME
Necessário: o nome do segredo.
--namespace NAMESPACE
Necessário: o namespace para o qual o segredo está implementado.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret rm

ibmcloud ks ingress secret rm --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress secret update

Virtual Private Cloud Infra-estrutura Classic

Atualize um segredo do Ingress para um certificado que não esteja hospedado na instância padrão do Secrets Manager criada para seu cluster.

Todas as alterações que você fizer em um certificado na instância padrão do Secrets Manager em seu cluster serão automaticamente refletidas no segredo em seu cluster. Se você fizer alterações em um certificado que não esteja hospedado na instância do cluster Secrets Manager, deverá usar esse comando para atualizar a chave secreta no cluster para que ela receba as alterações no certificado.

ibmcloud ks ingress secret update --cluster CLUSTER --name SECRET_NAME --namespace NAMESPACE [--cert-crn CRN] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--name SECRET_NAME
Necessário: o nome do segredo. Para ver os segredos disponíveis, execute ibmcloud ks ingress secret ls.
--namespace NAMESPACE
Necessário: o namespace para o qual o segredo está implementado. Para ver o espaço de nomes do segredo, execute ibmcloud ks ingress secret get --cluster cluster_name_or_ID <--name secret_name> --namespace <namespace>.
--cert-crn CERTIFICATE_CRN
Opcional: O CRN do certificado. Para ver o CRN do segredo, execute ibmcloud ks ingress secret get --cluster <cluster_name_or_ID> --name secret_name> --namespace <namespace>. Esta opção requer uma instância padrão Secrets Manager em seu cluster.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress secret update

Virtual Private Cloud Infra-estrutura Classic

ibmcloud ks ingress secret update --cluster my_cluster --name my_alb_secret --namespace demo_ns

ibmcloud ks ingress status-report disable

Virtual Private Cloud Infra-estrutura Classic

Desative o relatório de status para componentes do Ingress em um cluster.

ibmcloud ks ingress status-report disable --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report disable

ibmcloud ks ingress status-report disable --cluster mycluster

ibmcloud ks ingress status-report enable

Virtual Private Cloud Infra-estrutura Classic

Ative o relatório de status dos componentes do Ingresso em um cluster.

ibmcloud ks ingress status-report enable --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report enable

ibmcloud ks ingress status-report enable --cluster mycluster

ibmcloud ks ingress status-report get

Virtual Private Cloud Infra-estrutura Classic

Obtenha o relatório de status para componentes do Ingress em um cluster.

ibmcloud ks ingress status-report get --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report get

ibmcloud ks ingress status-report get --cluster mycluster

ibmcloud ks ingress status-report ignored-errors add

Virtual Private Cloud Infra-estrutura Classic

Inclua avisos para serem ignorados pelo status do Ingress para um cluster.

ibmcloud ks ingress status-report ignored-errors add --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-code, --code CODE
Obrigatório: Código do aviso a ser ignorado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report ignored-errors add

ibmcloud ks ingress status-report ignored-errors add --cluster mycluster --code CODE

ibmcloud ks ingress status-report ignored-errors ls

Virtual Private Cloud Infra-estrutura Classic

Liste avisos que são atualmente ignorados pelo status do Ingress para um cluster.

ibmcloud ks ingress status-report ignored-errors ls --cluster CLUSTER [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report ignored-errors ls

ibmcloud ks ingress status-report ignored-errors ls --cluster mycluster

ibmcloud ks ingress status-report ignored-errors rm

Virtual Private Cloud Infra-estrutura Classic

Remova avisos que são atualmente ignorados pelo status do Ingress para um cluster. Uma vez removidos, esses avisos não são mais ignorados.

ibmcloud ks ingress status-report ignored-errors rm --cluster CLUSTER --code CODE [--code CODE ...] [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-code, --code CODE
Necessário: Código do aviso a ser removido da lista ignorada.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando ingress status-report ignored-errors rm

ibmcloud ks ingress status-report ignored-errors rm --cluster mycluster

logging comandos

Encaminhe logs de seu cluster para um servidor externo.

ibmcloud ks logging autoupdate disable

Virtual Private Cloud Infra-estrutura Classic

Desative atualizações automáticas de todos os pods do Fluentd em um cluster.

Desative as atualizações automáticas de seus pods do Fluentd em um cluster específico. Quando você atualiza a versão principal ou secundária do Kubernetes de seu cluster, a IBM automaticamente faz mudanças necessárias no configmap do Fluentd, mas não muda a versão de imagem de seu Fluentd para registrar o complemento. Você é responsável por verificar a compatibilidade das versões mais recentes do Kubernetes e de suas imagens de complementos.

ibmcloud ks logging autoupdate disable --cluster CLUSTER [-q]

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual você deseja desativar as atualizações automáticas para o complemento Fluentd.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks logging autoupdate enable

Virtual Private Cloud Infra-estrutura Classic

Ative atualizações automáticas para seus pods Fluentd em um cluster específico. Os pods do fluentd são atualizados automaticamente quando uma nova versão de imagem está disponível.

ibmcloud ks logging autoupdate enable --cluster CLUSTER [-q]

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual você deseja ativar as atualizações automáticas para o complemento Fluentd.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks logging autoupdate get

Virtual Private Cloud Infra-estrutura Classic

Visualize se seus pods do Fluentd estão configurados para serem atualizados automaticamente em um cluster.

ibmcloud ks logging autoupdate get --cluster CLUSTER [--output json] [-q]

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster no qual você deseja verificar se as atualizações automáticas para o complemento Fluentd estão ativadas.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

ibmcloud ks logging config create

Virtual Private Cloud Infra-estrutura Classic

Crie uma configuração de criação de log. É possível usar esse comando para encaminhar logs para contêineres, aplicativos, nós do trabalhador, clusters Kubernetes e balanceadores de carga do aplicativo Ingress para um servidor de syslog externo.

ibmcloud ks logging config create --cluster CLUSTER --logsource LOG_SOURCE --type syslog [--namespace KUBERNETES_NAMESPACE] [--hostname LOG_SERVER_HOSTNAME_OR_IP] [--port LOG_SERVER_PORT] [--app-containers CONTAINERS] [--app-paths PATHS_TO_LOGS] [--syslog-protocol PROTOCOL] [--skip-validation] [--force-update] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster.
--logsource LOG_SOURCE
A origem do log para o qual ativar o encaminhamento de log. Essa opção oferece suporte a uma lista separada por vírgulas de origens de registro a serem aplicadas à configuração. Os valores aceitos são container, application, worker, kubernetes, storage e ingress. Se você não fornecer uma fonte de log, as configurações serão criadas para container e ingress.
--type syslog
Insira syslog para encaminhar os logs para um servidor externo.
-n, --namespace KUBERNETES_NAMESPACE
O namespace do Kubernetes do qual você deseja encaminhar logs. O encaminhamento de log não é suportado para os namespaces do Kubernetes ibm-system e kube-system. Esse valor é válido somente para a origem de log do contêiner e é opcional. Se você não especificar um espaço de nomes, todos os espaços de nomes no cluster usarão essa configuração.
--hostname LOG_SERVER_HOSTNAME
O nome do host ou endereço IP do servidor coletor do log.
--port LOG_SERVER_PORT
Opcional: a porta do servidor do coletor de log. Se você não especificar uma porta, a porta padrão 514 será usada para syslog e a porta padrão 9091 será usada para ibm.
-p, --app-path
O caminho no contêiner no qual os apps estão efetuando login. Para encaminhar logs com o tipo de origem application, deve-se fornecer um caminho. Os curingas, como /var/log/*.log, podem ser usados, mas os globs recursivos, como /var/log/**/test.log, não podem ser usados. Para especificar mais de um caminho, use várias opções, como -p /var/log/myApp1/&ast; -p /var/log/myApp2/&ast;. Esse valor é necessário para origem de log application.
--syslog-protocol
O protocolo da camada de transferência que é usado quando o tipo de criação de log é syslog. Os valores suportados são tcp, tls e o padrão udp. Ao encaminhar para um servidor rsyslog com o protocolo udp, os logs que têm mais de 1 KB são truncados.
-C, --app-container
Para encaminhar logs de apps, é possível especificar o nome do contêiner que contém o seu app. Para especificar mais de um contêiner, use várias opções, como -C /var/log/myApp1/&ast; -C /var/log/myApp2/&ast;. Se nenhum contêiner for especificado, os logs serão encaminhados de todos os contêineres que têm os caminhos que você forneceu. Essa opção é válida somente para a origem de log application.
--skip-validation
Opcional: ignorar a validação dos nomes de organização e espaço quando eles forem especificados. Ignorar a validação diminui o tempo de processamento, mas uma configuração de criação de log inválida não encaminhará os logs corretamente.
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplos:

Exemplo para o tipo de log syslog que encaminha de uma origem de log container na porta padrão 514:

ibmcloud ks logging config create my_cluster --logsource container --namespace my_namespace  --hostname 169.xx.xxx.xxx --type syslog

Exemplo para o tipo de log syslog que encaminha logs de uma origem ingress em uma porta diferente do padrão:

ibmcloud ks logging config create --cluster my_cluster --logsource container --hostname 169.xx.xxx.xxx --port 5514 --type syslog

ibmcloud ks logging config get

Virtual Private Cloud Infra-estrutura Classic

Visualize todas as configurações de encaminhamento de log para um cluster ou filtre configurações de criação de log com base em origem de log.

ibmcloud ks logging config get --cluster CLUSTER [--logsource LOG_SOURCE] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--logsource LOG_SOURCE
Opcional: o tipo de origem de log para a qual você deseja filtrar. As configurações de criação de log de apenas essa origem de log no cluster são retornadas. Os valores aceitos são container, storage, application, worker, kubernetes e ingress.
--show-covering-filters
Mostra os filtros de criação de log que tornam os filtros prévios obsoletos.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando logging config get

ibmcloud ks logging config get --cluster my_cluster --logsource worker

ibmcloud ks logging config rm

Virtual Private Cloud Infra-estrutura Classic

Excluir uma configuração de encaminhamento de log ou todas as configurações de criação de log para um cluster. Excluir a configuração de log interrompe o encaminhamento de log para um servidor syslog remoto.

ibmcloud ks logging config rm --cluster CLUSTER (--namespace NAMESPACE --id LOG_CONFIG_ID] [--all] [--force-update] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
-n, --namespace NAMESPACE
O namespace do qual você deseja remover a configuração de encaminhamento de log. Se houver mais de uma configuração para o mesmo namespace, use a opção --id <logging_configuration_ID> em vez disso.
--id LOG_CONFIG_ID
Para remover uma configuração de criação de log única, o ID de configuração de criação de log.
--all
A opção para remover todas as configurações de registro em um cluster.
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando logging config rm

ibmcloud ks logging config rm --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e

ibmcloud ks logging config update

Virtual Private Cloud Infra-estrutura Classic

Atualize os detalhes de uma configuração de encaminhamento de log.

ibmcloud ks logging config update --cluster CLUSTER --id LOG_CONFIG_ID --type LOG_TYPE  [--namespace NAMESPACE] [--hostname LOG_SERVER_HOSTNAME_OR_IP] [--port LOG_SERVER_PORT] [--app-paths PATH] [--app-containers PATH] [--output json] [--skipValidation] [--force-update] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--id LOG_CONFIG_ID
Necessário: o ID de configuração de criação de log que você deseja atualizar.
--type LOG_TYPE
Necessário: o protocolo de encaminhamento de log que você deseja usar. Atualmente, syslog e ibm são suportados.
-n, --namespace NAMESPACE
O namespace do Kubernetes do qual você deseja encaminhar logs. O encaminhamento de log não é suportado para os namespaces do Kubernetes ibm-system e kube-system. Esse valor é válido somente para a origem de log container. Se você não especificar um espaço de nomes, todos os espaços de nomes no cluster usarão essa configuração.
--hostname LOG_SERVER_HOSTNAME
O nome do host ou endereço IP do servidor coletor do log.
--port LOG_SERVER_PORT
A porta do servidor coletor do log. Esse valor será opcional quando o tipo de criação de log for syslog. Se você não especificar uma porta, a porta padrão 514 será usada para syslog e 9091 será usada para ibm.
-p, --app-path
O caminho no contêiner no qual os apps estão efetuando login. Para encaminhar logs com o tipo de origem application, deve-se fornecer um caminho. Os curingas, como /var/log/*.log, podem ser usados, mas os globs recursivos, como /var/log/**/test.log, não podem ser usados. Para especificar mais de um caminho, use várias opções, como -p /var/log/myApp1/&ast; -p /var/log/myApp2/&ast;. Esse valor é necessário para origem de log application.
-C, --app-container
Para encaminhar logs de apps, é possível especificar o nome do contêiner que contém o seu app. Para especificar mais de um contêiner, use várias opções, como -C /var/log/myApp1/&ast; -C /var/log/myApp2/&ast;. Se nenhum contêiner for especificado, os logs serão encaminhados de todos os contêineres que têm os caminhos que você forneceu. Essa opção é válida somente para a origem de log application.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
--skipValidation
Opcional: ignorar a validação dos nomes de organização e espaço quando eles forem especificados. Ignorar a validação diminui o tempo de processamento, mas uma configuração de criação de log inválida não encaminhará os logs corretamente.
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo para tipo de log ibm:

ibmcloud ks logging config update --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e --type ibm

Exemplo para tipo de log syslog:

ibmcloud ks logging config update --cluster my_cluster --id f4bc77c0-ee7d-422d-aabf-a4e6b977264e --hostname localhost --port 5514 --type syslog

ibmcloud ks logging filter create

Virtual Private Cloud Infra-estrutura Classic

Filtre os logs que são encaminhados por sua configuração de criação de log.

ibmcloud ks logging filter create --cluster CLUSTER --type LOG_TYPE [--logging-config CONFIG] [--namespace KUBERNETES_NAMESPACE] [--container CONTAINER_NAME] [--level LOGGING_LEVEL] [--message MESSAGE] [--regex-message MESSAGE] [--force-update] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou o ID do cluster para o qual criar um filtro de criação de log.
--type LOG_TYPE
O tipo de logs nos quais você deseja aplicar o filtro. Atualmente, all, container e host são suportados.
-lc, --logging-config CONFIG
Opcional: o ID de configuração de criação de log. Se ele não for fornecido, o filtro será aplicado em todas as configurações de criação de log do cluster transmitidas para o filtro. Você pode visualizar as configurações de registro que correspondem ao filtro usando a opção --show-matching-configs com o comando. Para especificar várias IDs, use várias opções, como -lc id1 -lc id2.
-n, --namespace KUBERNETES_NAMESPACE
Opcional: o espaço de nomes do Kubernetes por meio do qual você deseja filtrar os logs.
--container CONTAINER_NAME
Opcional: o nome do contêiner por meio do qual você deseja filtrar os logs. Essa opção se aplica somente quando você estiver usando o tipo de registro container.
--level LOGGING_LEVEL
Opcional: filtrará os logs que estiverem no nível especificado e menos. Os valores aceitáveis na ordem canônica são fatal, error, warn/warning, info, debug e trace. Como um exemplo, se você tiver filtrado logs no nível info, debug e trace também serão filtrados. Observação: você pode usar essa opção somente quando as mensagens de registro estiverem no formato JSON e contiverem um campo de nível. Exemplo de saída{"log": "hello", "level": "info"}
--message MESSAGE
Opcional: filtrará qualquer log que contenha uma mensagem especificada em qualquer lugar no log. Exemplo: as mensagens "Hello", "!" e "Hello, World!" se aplicariam ao log "Hello, World!".
--regex-message MESSAGE
Opcional: filtra quaisquer logs que contenham uma mensagem especificada gravada como uma expressão regular em qualquer lugar do log. Exemplo: o padrão "hello [0-9]" se aplicaria a "hello 1", "hello 2" e "hello 9".
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplos:

Este exemplo filtra todos os logs que são encaminhados de contêineres com o nome test-container no namespace padrão que estão no nível de depuração ou menos e têm uma mensagem de log que contém "solicitação GET".

ibmcloud ks logging filter create --cluster example-cluster --type container --namespace default --container test-container --level debug --message "GET request"

Esse exemplo filtra todos os logs que são encaminhados, em um nível info ou menos, por meio de um cluster específico. A saída é retornada como JSON.

ibmcloud ks logging filter create --cluster example-cluster --type all --level info --output json

ibmcloud ks logging filter get

Virtual Private Cloud Infra-estrutura Classic

Visualize uma configuração de filtro de criação de log.

ibmcloud ks logging filter get --cluster CLUSTER [--id FILTER_ID] [--show-matching-configs] [--show-covering-filters] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster por meio do qual você deseja visualizar filtros.
--id FILTER_ID
O ID do filtro de log que você deseja visualizar.
--show-matching-configs
Opcional: mostrará as configurações de criação de log que corresponderem à configuração que você estiver visualizando.
--show-covering-filters
Opcional: mostrar os filtros de criação de log que renderizam filtros anteriores obsoletos.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando logging filter get

ibmcloud ks logging filter get --cluster mycluster --id 885732 --show-matching-configs

ibmcloud ks logging filter rm

Virtual Private Cloud Infra-estrutura Classic

Exclua um filtro de criação de log

ibmcloud ks logging filter rm --cluster CLUSTER [--id FILTER_ID] [--all] [--force-update] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
O nome ou ID do cluster por meio do qual você deseja excluir um filtro.
--id FILTER_ID
O ID do filtro de log a ser excluído.
--all
Opcional: excluir todos os filtros de encaminhamento de log.
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando logging filter rm

ibmcloud ks logging filter rm --cluster mycluster --id 885732

ibmcloud ks logging filter update

Virtual Private Cloud Infra-estrutura Classic

Atualize um filtro de criação de log.

ibmcloud ks logging filter update --cluster CLUSTER --id FILTER_ID --type LOG_TYPE [--logging-config CONFIG] [--namespace KUBERNETES_NAMESPACE] [--container CONTAINER_NAME] [--level LOGGING_LEVEL] [--message MESSAGE] [--regex-message MESSAGE] [--force-update] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster para o qual você deseja atualizar um filtro de criação de log.
--id FILTER_ID
O ID do filtro de log a ser atualizado.
--type LOG_TYPE
O tipo de logs nos quais você deseja aplicar o filtro. Atualmente, all, container e host são suportados.
-lc, --logging-config CONFIG
Opcional: o ID de configuração de criação de log. Se ele não for fornecido, o filtro será aplicado em todas as configurações de criação de log do cluster transmitidas para o filtro. Você pode visualizar as configurações de registro que correspondem ao filtro usando a opção --show-matching-configs com o comando. Para especificar várias IDs, use várias opções, como -lc id1 -lc id2.
-n, --namespace KUBERNETES_NAMESPACE
Opcional: o espaço de nomes do Kubernetes por meio do qual você deseja filtrar os logs.
--container CONTAINER_NAME
Opcional: o nome do contêiner por meio do qual você deseja filtrar os logs. Essa opção se aplica somente quando você estiver usando o tipo de registro container.
--level LOGGING_LEVEL
Opcional: filtrará os logs que estiverem no nível especificado e menos. Os valores aceitáveis na ordem canônica são fatal, error, warn/warning, info, debug e trace. Como um exemplo, se você tiver filtrado logs no nível info, debug e trace também serão filtrados. Observação: você pode usar essa opção somente quando as mensagens de registro estiverem no formato JSON e contiverem um campo de nível. Exemplo de saída{"log": "hello", "level": "info"}
--message MESSAGE
Opcional: filtrará qualquer log que contenha uma mensagem especificada em qualquer lugar no log. Exemplo: as mensagens "Hello", "!" e "Hello, World!" se aplicariam ao log "Hello, World!".
--regex-message MESSAGE
Opcional: filtra quaisquer logs que contenham uma mensagem especificada gravada como uma expressão regular em qualquer lugar do log. Exemplo: o padrão "hello [0-9]" se aplicaria a "hello 1", "hello 2" e "hello 9"
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplos:

Este exemplo filtra todos os logs que são encaminhados de contêineres com o nome test-container no namespace padrão que estão no nível de depuração ou menos e têm uma mensagem de log que contém "solicitação GET".

ibmcloud ks logging filter update --cluster example-cluster --id 885274 --type container --namespace default --container test-container --level debug --message "GET request"

Esse exemplo filtra todos os logs que são encaminhados, em um nível info ou menos, por meio de um cluster específico. A saída é retornada como JSON.

ibmcloud ks logging filter update --cluster example-cluster --id 274885 --type all --level info --output json

ibmcloud ks logging refresh

Virtual Private Cloud Infra-estrutura Classic

Atualize a configuração de criação de log para o cluster. Essa ação atualiza o token de criação de log para qualquer configuração de criação de log que está encaminhando para o nível de espaço em seu cluster.

O alias logging config refresh para esse comando foi descontinuado.

ibmcloud ks logging refresh --cluster CLUSTER [--force-update] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--force-update
Force os seus pods do Fluentd para serem atualizados para a versão mais recente. O FluentD deve estar na versão mais recente para mudar suas configurações de criação de log.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando logging refresh

ibmcloud ks logging refresh --cluster my_cluster

nlb-dns comandos

Crie e gerencie subdomínios para endereços IP do balanceador de carga de rede (NLB) e monitores de verificação de funcionamento para subdomínios. Para obter mais informações, veja Registrando um subdomínio do balanceador de carga.

As atualizações de microsserviço DNS são assíncronas e podem levar vários minutos para serem aplicadas. Note que se você executar um comando ibmcloud ks nlb-dns e receber uma mensagem de confirmação de 200, ainda será possível esperar que suas mudanças sejam implementadas. Para verificar o status de seu subdomínio, execute ibmcloud ks nlb-dns ls e encontre a coluna Status na saída.

ibmcloud ks nlb-dns add

Infraestrutura clássica

Inclua um ou mais endereços IP do balanceador de carga de rede (NLB) em um subdomínio existente que você criou com o comando ibmcloud ks nlb-dns create.

Por exemplo, em um cluster clássico multizona, é possível criar um NLB em cada zona para expor um app. Você registra os IPs do NLB com um subdomínio executando ibmcloud ks nlb-dns create classic. Posteriormente, você inclui outra zona em seu cluster e outro NLB para essa zona. É possível usar esse comando para incluir o novo IP do NLB nesse subdomínio existente. Quando um usuário acessa seu subdomínio de app, o cliente acessa um desses IPs aleatoriamente, e a solicitação é enviada para esse NLB.

ibmcloud ks nlb-dns add --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP2 --ip NLB3_IP ...] --nlb-host SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--ip NLB_IP
O(s) endereço(s) IP do NLB que você deseja incluir no subdomínio. Para ver os seus IPs do NLB, execute kubectl get svc. Para especificar vários endereços IP, use várias opções de --ip.
--nlb-host SUBDOMAIN
O subdomínio no qual você deseja incluir IPs. Para ver os subdomínios existentes, execute ibmcloud ks nlb-dns ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns add

ibmcloud ks nlb-dns add --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns create classic

Infraestrutura clássica

Exponha publicamente seu app criando um subdomínio DNS para registrar um IP do balanceador de carga de rede (NLB).

ibmcloud ks nlb-dns create classic --cluster CLUSTER --ip NLB_IP [--ip NLB2_IP --ip NLB3_IP ...] [--secret-namespace NAMESPACE] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--ip IP
O endereço IP do balanceador de carga de rede que você deseja registrar. Para ver seus endereços IP do NLB, execute kubectl get svc. Para especificar vários endereços IP, use várias opções de --ip.
--secret-namespace NAMESPACE
O namespace do Kubernetes no qual você deseja criar o segredo do Kubernetes que mantém as informações do certificado SSL para o NLB. Se você não especificar um espaço de nomes, o segredo será criado automaticamente no espaço de nomes default.
--type public
O tipo de subdomínio. Atualmente, apenas public é suportado.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns create classic

ibmcloud ks nlb-dns create classic --cluster mycluster --ip 1.1.1.1

ibmcloud ks nlb-dns create vpc-gen2

Virtual Private Cloud

Crie um registro DNS para um Network Load Balancer for VPC ou Application Load Balancer for VPC.

Ao criar um Network Load Balancer for VPC, endereços IP externos são designados ao balanceador de carga para cada zona em seu cluster. Quando você cria um Application Load Balancer for VPC, um nome do host é designado ao balanceador de carga. Se quiser um subdomínio de app com finalização TLS, você poderá usar o comando ibmcloud ks nlb-dns create vpc-gen2 para criar um registro de DNS para os endereços IP ou nome de host. A IBM Cloud cuida de gerar e manter o certificado SSL curinga para o subdomínio. É possível criar subdomínios para balanceadores de carga de VPC públicos e privados.

ibmcloud ks nlb-dns create vpc-gen2 --cluster CLUSTER (--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP) [--secret-namespace NAMESPACE] [--type (public|private)] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--lb-host VPC_ALB_HOSTNAME | --ip VPC_NLB_IP
Para balanceadores de carga de aplicativo de VPC, o nome do host do balanceador de carga. Para ver os nomes dos hosts de balanceadores de carga, execute kubectl get svc -o wide. Para balanceadores de carga de rede VPC, os endereços IP externos. Para especificar vários endereços IP, use várias opções de --ip. Para ver endereços IP do balanceador de carga, execute kubectl get svc -o wide.
--secret-namespace NAMESPACE
O namespace do Kubernetes no qual você deseja criar o segredo do Kubernetes que mantém as informações do certificado SSL para o NLB. Se você não especificar um espaço de nomes, o segredo será criado automaticamente no espaço de nomes default.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns create vpc-gen2

ibmcloud ks nlb-dns create vpc-gen2 --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud --type public

ibmcloud ks nlb-dns get

Virtual Private Cloud Infra-estrutura Classic

Visualize os detalhes de um nome de host do NLB registrado em um cluster.

ibmcloud ks nlb-dns get --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output OUTPUT] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service
-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-subdomain SUBDOMAIN
O subdomínio de DNS no qual o endereço IP do Network Load Balancer (NLB) é registrado. Para listar NLBs, execute ibmcloud ks nlb-dns ls --cluster mycluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns get

Virtual Private Cloud Infra-estrutura Classic

ibmcloud ks nlb-dns get --cluster mycluster --nlb-subdomain subDomain1

ibmcloud ks nlb-dns ls

Em um cluster clássico, liste os endereços IP do balanceador de carga de rede (NLB) que estão registrados em subdomínios DNS. Em um cluster de VPC, liste os nomes de host do balanceador de carga do VPC que estão registrados em subdomínios DNS.

ibmcloud ks nlb-dns ls --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns ls

ibmcloud ks nlb-dns ls --cluster mycluster

ibmcloud ks nlb-dns monitor configure

Configure um monitor de verificação de funcionamento para um nome de host de NLB existente em um cluster. Para ativar o monitor, inclua o sinalizador --enable. Para atualizar um monitor existente, inclua apenas os sinalizadores para as configurações que deseja mudar.

ibmcloud ks nlb-dns monitor configure --cluster CLUSTER --nlb-host HOST [--enable] [--header HEADER ...] [--interval INTERVAL] [--output OUTPUT] [--path PATH] [--port PORT] [-q] [--timeout TIMEOUT] [--type TYPE]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
--enable
Ative o monitor de verificação de funcionamento para o nome do host.
--header HEADER
Obrigatório quando type é HTTP ou HTTPS: HTTP Os cabeçalhos de solicitação para a verificação de integridade são limitados ao cabeçalho Host. Essa sinalização é válida somente para o tipo 'HTTP' ou 'HTTPS'. Essa sinalização aceita valores no formato a seguir: '--header Header-Name=value'. Ao atualizar um monitor, os cabeçalhos existentes são substituídos por aqueles que você especifica. Para excluir todos os cabeçalhos existentes, especifique a sinalização com um valor vazio '--header ""'.
--interval INTERVAL
O intervalo, em segundos, entre cada verificação de funcionamento. Os intervalos curtos podem melhorar o tempo de failover, mas aumentam a carga nos IPs. O valor deve estar no intervalo [60, 300]. Padrão:60
--nlb-host HOST
O nome do host. Para ver os nomes de host existentes, execute ibmcloud ks nlb-dns ls.
--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
--path PATH
O caminho de terminal em que a verificação de funcionamento ocorrerá. Esse sinalizador é válido somente para o tipo HTTP ou HTTPS. Padrão: /
--port PORT
O número da porta à qual se conectar para a verificação de funcionamento. Quando o tipo é TCP, essa sinalização é necessária. Quando o tipo for HTTP ou HTTPS, use essa sinalização apenas para as portas diferentes de 80 para HTTP ou 443 para HTTPS. HTTP padrão: 80. HTTPS padrão: 443.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--timeout TIMEOUT
O tempo limite, em segundos, antes que o IP seja considerado não funcional. Deve estar no intervalo [1, 60]. Padrão:5
--type TYPE
O protocolo a ser usado para a verificação de funcionamento. Valores aceitos: http, https, tcp

Exemplo de comando nlb-dns monitor configure

ibmcloud ks nlb-dns monitor configure --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud --enable --type HTTPS --path / --timeout 5 --interval 60 --header Host=example.com

ibmcloud ks nlb-dns monitor disable

Infraestrutura clássica

Desative um monitor de verificação de funcionamento existente para um subdomínio em um cluster.

ibmcloud ks nlb-dns monitor disable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-host SUBDOMAIN
O subdomínio verificado pelo funcionamento do monitor. Para listar subdomínios, execute ibmcloud ks nlb-dns ls --cluster CLUSTER.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns monitor disable

ibmcloud ks nlb-dns monitor disable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor enable

Infraestrutura clássica

Ative um monitor de verificação de funcionamento que você configurou.

Na primeira criação de um monitor de verificação de funcionamento, deve-se configurá-lo e ativá-lo com o comando ibmcloud ks nlb-dns monitor configure. Use o comando ibmcloud ks nlb-dns monitor enable somente para ativar um monitor configurado, mas ainda não ativado, ou para ativar novamente um monitor desativado anteriormente.

ibmcloud ks nlb-dns monitor enable --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-host SUBDOMAIN
O subdomínio verificado pelo funcionamento do monitor. Para listar subdomínios, execute ibmcloud ks nlb-dns ls --cluster CLUSTER.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns monitor enable

ibmcloud ks nlb-dns monitor enable --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor get

Infraestrutura clássica

Visualize as configurações para um monitor de verificação de funcionamento existente.

ibmcloud ks nlb-dns monitor get --cluster CLUSTER --nlb-host SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-host SUBDOMAIN
O subdomínio verificado pelo funcionamento do monitor. Para listar subdomínios, execute ibmcloud ks nlb-dns ls --cluster CLUSTER.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns monitor get

ibmcloud ks nlb-dns monitor get --cluster mycluster --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns monitor ls

Infraestrutura clássica

Liste as configurações do monitor de verificação de funcionamento para cada subdomínio do NLB em um cluster.

ibmcloud ks nlb-dns monitor ls --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns monitor ls

ibmcloud ks nlb-dns monitor ls --cluster mycluster

ibmcloud ks nlb-dns replace

Virtual Private Cloud

Substitua o nome do host do balanceador de carga que está registrado por um subdomínio DNS. Por exemplo, se criar um novo balanceador de carga de VPC para o app, mas não quiser criar um novo subdomínio de DNS por meio do qual os usuários podem acessar seu app, você poderá substituir o nome do host do balanceador de carga antigo pelo nome do host do novo balanceador de carga.

ibmcloud ks nlb-dns replace --cluster CLUSTER --lb-host NEW_LB_HOSTNAME --nlb-subdomain SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--lb-host NEW_LB_HOSTNAME
O nome do host do novo balanceador de carga do VPC com o qual atualizar o subdomínio. Para ver os nomes do host do balanceador de carga do VPC, execute kubectl get svc -o wide.
nlb-subdomain SUBDOMAIN
O subdomínio DNS para o qual você deseja substituir o nome do host do balanceador de carga. Para ver os subdomínios existentes, execute ibmcloud ks nlb-dns ls --cluster <cluster>.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns replace

ibmcloud ks nlb-dns replace --cluster mycluster --lb-host 1234abcd-us-south.lb.appdomain.cloud nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns rm classic

Infraestrutura clássica

Remova um endereço IP do balanceador de carga de rede (NLB) de um subdomínio. Se você remover todos os IPs de um subdomínio, o subdomínio ainda existirá, mas nenhum IP será associado a ele. Nota: deve-se executar esse comando para cada endereço IP que você deseja remover.

ibmcloud ks nlb-dns rm classic --cluster CLUSTER --ip IP --nlb-host SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--ip IP
O IP do NLB que você deseja remover. Para ver os IPs registrados com cada subdomínio, execute ibmcloud ks nlb-dns ls --cluster <cluster>.
--nlb-host SUBDOMAIN
O subdomínio do qual você deseja remover um IP. Para ver os subdomínios existentes, execute ibmcloud ks nlb-dns ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns rm classic

ibmcloud ks nlb-dns rm classic --cluster mycluster --ip 1.1.1.1 --nlb-host mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks nlb-dns rm vpc-gen2

Virtual Private Cloud

Remova o nome do host do balanceador de carga (balanceadores de carga do aplicativo VPC) ou endereços IP (balanceadores de carga de rede do VPC) do registro DNS para esse balanceador de carga.

Depois de remover o nome do host ou endereços IP, o subdomínio DNS ainda existe, mas nenhum balanceador de carga é registrado com ele.

ibmcloud ks nlb-dns rm vpc-gen2 --cluster CLUSTER --nlb-subdomain SUBDOMAIN [ --ip IP] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-subdomain SUBDOMAIN
O subdomínio que você deseja desassociar do nome do host do balanceador de carga de VPC. Para ver os subdomínios existentes, execute ibmcloud ks nlb-dns ls --cluster <cluster>.
--ip IP
Para balanceadores de carga de rede VPC, o endereço IP que você deseja remover. Para ver os IPs registrados com cada subdomínio, execute ibmcloud ks nlb-dns ls --cluster <cluster>. Note que este comando deve ser repetido para cada endereço IP que você deseja remover.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns rm vpc-gen2

ibmcloud ks nlb-dns rm vpc-gen2 --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

Experimental: ibmcloud ks nlb-dns secret regenerate

Virtual Private Cloud Infra-estrutura Classic

Gerar novamente o certificado e o segredo para um subdomínio do NLB. A regeneração secreta não é disruptiva e o tráfego continua a fluir enquanto o segredo é regenerado.

Se a criação do certificado Let's Encrypt falhar durante a regeneração do segredo, um período de espera de 10 minutos deverá passar antes que a regeneração seja automaticamente tentada novamente. A regeneração do segredo leva outros 5 minutos para ser concluída, perfazendo um total de 15 minutos antes de o processo ser concluído.

Para evitar o limite de taxa Let's Encripypt, não gere novos segredos mais de cinco vezes por dia.

ibmcloud ks nlb-dns secret regenerate --cluster CLUSTER --nlb-subdomain SUBDOMAIN [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-subdomain SUBDOMAIN
O subdomínio para o qual gerar novamente o segredo. Para listar subdomínios, execute ibmcloud ks nlb-dns ls --cluster CLUSTER.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns secret regenerate

ibmcloud ks nlb-dns secret regenerate --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

Experimental: ibmcloud ks nlb-dns secret rm

Virtual Private Cloud Infra-estrutura Classic

Excluir um segredo de um subdomínio do NLB e impedir a renovação futura do certificado.

Será possível excluir o segredo para um subdomínio do NLB se não usar mais o subdomínio ou se o proprietário do segredo sair de sua organização.

ibmcloud ks nlb-dns secret rm --cluster CLUSTER --nlb-subdomain SUBDOMAIN [-f] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--nlb-subdomain SUBDOMAIN
O subdomínio para o qual excluir o segredo. Para listar subdomínios, execute ibmcloud ks nlb-dns ls --cluster CLUSTER.
-f
Opcional: forçar a execução do comando sem prompts do usuário.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando nlb-dns secret rm

ibmcloud ks nlb-dns secret rm --cluster mycluster --nlb-subdomain mycluster-a1b2cdef345678g9hi012j3kl4567890-0001.us-south.containers.appdomain.cloud

ibmcloud ks vpc secure-by-default enable

Ative o Secure By Default VPC Networking para um cluster de VPC usando grupos de segurança herdados.

ibmcloud ks vpc secure-by-default enable --cluster CLUSTER [--disable-outbound-traffic-protection] [-f] [-q]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
--disable-outbound-traffic-protection
Inclua essa opção para permitir o acesso de saída pública dos trabalhadores do cluster. Por padrão, o acesso público de saída é bloqueado.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Comando webhook-create

Virtual Private Cloud Infra-estrutura Classic

Registre um webhook.

ibmcloud ks webhook-create --cluster CLUSTER --level LEVEL --type slack --url URL  [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--level LEVEL
Opcional: o nível de notificação, como Normal ou Warning. Warning é o valor padrão.
--type slack
Necessário: o tipo de webhook. Atualmente, o Slack é suportado.
--url URL
Necessário: a URL para o webhook.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando webhook-create

ibmcloud ks webhook-create --cluster my_cluster --level Normal --type slack --url http://github.com/mywebhook

api-key comandos

Visualize informações sobre a chave de API para um cluster ou reconfigure-o para uma nova chave.

ibmcloud ks api-key info

Virtual Private Cloud Infra-estrutura Classic

Visualize o nome e o endereço de e-mail para o proprietário da chave de API do IBM Cloud Identity and Access Management (IAM) que o IBM Cloud Kubernetes Service usa para autenticar determinadas solicitações, como infraestrutura na região e grupo de recursos.

Para criar uma chave de API diferente para o grupo de recursos e a região, use o comando ibmcloud ks api-key reset.

Se você configurar manualmente as credenciais de infraestrutura da IBM Cloud usando o comando ibmcloud ks credential set, a chave de API que é retornada neste comando não será usada para permissões de infraestrutura.

ibmcloud ks api-key info --cluster CLUSTER [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

-c, --cluster CLUSTER
Necessário: o nome ou ID do cluster.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando api-key info

ibmcloud ks api-key info --cluster my_cluster

ibmcloud ks api-key reset

Virtual Private Cloud Infra-estrutura Classic

Crie uma chave de API do IBM Cloud IAM que personifique as permissões do usuário para autenticar solicitações para todos os clusters no grupo de recursos e na região atuais.

Ao usar os complementos do escalador automático de cluster ou do Block Storage for VPC no cluster, deve-se recriar os pods do controlador de complemento depois de reconfigurar a chave de API. Para obter mais informações, consulte A criação de PVC do Block Storage for VPC falha após a reconfiguração da chave de API e O ajuste automático de escala falha após a reconfiguração da chave de API.

Antes de usar esse comando, certifique-se de que o usuário que o executar tenha as permissões de infraestrutura do IBM Cloud Kubernetes Service e do IBM Cloud necessárias. Tenha como destino o grupo de recursos e a região para os quais você deseja configurar a chave de API. Quando a chave de API for redefinida, a chave de API anterior que foi usada para a região e o grupo de recursos se tornará obsoleta. É possível, então, excluir a chave de API antiga da sua lista de chaves de API. Antes de redefinir a chave de API, verifique se você tem outros serviços que usam a chave de API existente, como um provedor de serviço de gerenciamento de chaves(KMS) ou Secrets Manager.

ibmcloud ks api-key reset --region REGION [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--region REGION
Especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando api-key reset

ibmcloud ks api-key reset --region us-south

credential comandos

Configure e desconfigure credenciais que permitem acessar o portfólio da infraestrutura clássica do IBM Cloud por meio de sua conta do IBM Cloud.

Somente é possível configurar manualmente as credenciais de infraestrutura para uma conta diferente nos clusters clássicos, não nos clusters VPC.

ibmcloud ks credential get

Infraestrutura clássica

Se você configurar sua conta do IBM Cloud para usar credenciais diferentes para acessar o portfólio de infraestrutura da IBM Cloud, obtenha o nome de usuário da infraestrutura para a região e o grupo de recursos para o qual você está atualmente destinado.

ibmcloud ks credential get --region REGION [-q] [--output json]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--region REGION
Especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando credential get

ibmcloud ks credential get --region us-south

ibmcloud ks credential set classic

Infraestrutura clássica

Configure as credenciais para um grupo de recursos e uma região para que seja possível acessar o portfólio de infraestrutura da IBM Cloud por meio de sua conta do IBM Cloud.

Se você tiver uma conta pré-paga do IBM Cloud, você terá acesso ao portfólio de infraestrutura da IBM Cloud por padrão. No entanto, é possível que você queira usar uma conta de infraestrutura existente da IBM Cloud que seja diferente para solicitar a infraestrutura. É possível vincular essa conta de infraestrutura à sua conta do IBM Cloud conta usando este comando.

Se as credenciais de infraestrutura da IBM Cloud forem configuradas manualmente para uma região e um grupo de recursos, essas credenciais serão usadas para pedir a infraestrutura para todos os clusters nessa região no grupo de recursos. Essas credenciais são usadas para determinar permissões de infraestrutura, mesmo se uma chave de API do IBM Cloud IAM existe para o grupo de recursos e a região. Se o usuário cujas credenciais estão armazenadas não tiver as permissões necessárias para pedir a infraestrutura, as ações relacionadas à infraestrutura, como a criação de um cluster ou o recarregamento de um nó do trabalhador, poderão falhar.

Não é possível configurar várias credenciais para o mesmo grupo de recursos e região do IBM Cloud Kubernetes Service.

Antes de usar esse comando, certifique-se de que o usuário cujas credenciais são usadas tenha as permissões de infraestrutura do IBM Cloud Kubernetes Service e do IBM Cloud necessárias.

ibmcloud ks credential set classic --infrastructure-api-key API_KEY --infrastructure-username USERNAME --region REGION [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--infrastructure-username USERNAME
Necessário: nome do usuário da API da conta de infraestrutura da IBM Cloud. O nome de usuário da API de infraestrutura não é o mesmo que o IBMid. Para visualizar o nome de usuário da API de infraestrutura, consulte Gerenciando chaves de API de infraestrutura clássica.
--infrastructure-api-key API_KEY
Necessário: chave de API da conta de infraestrutura da IBM Cloud. Para visualizar ou gerar uma chave de API de infraestrutura, consulte Gerenciando chaves de API de infraestrutura clássica.
--region REGION
Especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando credential set classic

ibmcloud ks credential set classic --infrastructure-api-key <api_key> --infrastructure-username dbmanager --region us-south

ibmcloud ks credential unset

Infraestrutura clássica

Remova as credenciais para um grupo de recursos e região para remover o acesso ao portfólio de infraestrutura da IBM Cloud por meio de sua conta do IBM Cloud.

Depois de remover as credenciais, a chave de API do IBM Cloud IAM é usada para pedir recursos na infraestrutura da IBM Cloud.

ibmcloud ks credential unset --region REGION [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--region REGION
Especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando credential unset

ibmcloud ks credential unset --region us-south

infra-permissions comandos

Verifique as permissões de infraestrutura clássica do IBM Cloud usadas no IBM Cloud Kubernetes Service.

Os comandos ibmcloud ks infra-permissions verificam apenas a infraestrutura clássica do IBM Cloud, não as permissões do VPC.

ibmcloud ks infra-permissions get

Infraestrutura clássica

Verifique se permissões de infraestrutura sugeridas ou necessárias estão ausentes das credenciais que permitem o acesso ao portfólio de infraestrutura do IBM Cloud para o grupo de recursos e a região de destino.

Se as credenciais de infraestrutura para a região e o grupo de recursos estiverem omitindo quaisquer permissões, a saída desse comando retornará uma lista de permissões required e suggested.

  • Necessário: essas permissões são necessárias para pedir e gerenciar com êxito os recursos de infraestrutura, como nós do trabalhador. Se as credenciais de infraestrutura não tiverem uma dessas permissões, ações comuns, como worker reload, poderão falhar para todos os clusters na região e no grupo de recursos.
  • Sugerido: essas permissões são úteis para incluir em suas permissões de infraestrutura e podem ser necessárias em determinados casos de uso. Por exemplo, a permissão de infraestrutura Add Compute with Public Network Port será sugerida porque, se você desejar rede pública, precisará dessa permissão. No entanto, se seu caso de uso for um cluster somente na VLAN privada, a permissão não será necessária, portanto, ela não será considerada required.

Para obter uma lista de casos de uso comuns por permissão, consulte Funções de infraestrutura.

E se eu vir uma permissão de infraestrutura que não consigo encontrar no console ou na tabela de funções de infraestrutura?
As permissões de Support Case são gerenciadas em uma parte diferente do console do que as permissões de infraestrutura. Consulte Customizando permissões de infraestrutura.
Quais permissões de infraestrutura devo atribuir?
Se as políticas da sua empresa para permissões forem restritas, você poderá precisar limitar as permissões suggested para o caso de uso do seu cluster. Caso contrário, certifique-se de que suas credenciais de infraestrutura para a região e o grupo de recursos incluam todas as permissões required e suggested.

Para a maioria dos casos de uso, configure a chave de API para a região e o grupo de recursos com as permissões de infraestrutura apropriadas. Caso precise usar outra conta de infraestrutura diferente de sua conta atual, configure credenciais manuais.

Como posso controlar as ações que os usuários podem executar?
Depois de configurar as credenciais de infraestrutura, será possível controlar quais ações seus usuários poderão executar, atribuindo a eles funções de acesso à plataforma IAM do IBM Cloud.
ibmcloud ks infra-permissions get --region REGION [--output json] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service

Opções de comando:

--region REGION
Necessário: especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando infra-permissions get

ibmcloud ks infra-permissions get --region us-south

Exemplo de saída

Missing Virtual Worker Permissions

Add Server                    suggested
Cancel Server                 suggested
View Virtual Server Details   required

Missing Physical Worker Permissions

No changes are suggested or required.

Missing Network Permissions

No changes are suggested or required.

Missing Storage Permissions

Add Storage       required
Manage Storage    required

kms comandos

Ative um provedor de serviço de gerenciamento de chaves (KMS) em seu cluster para criptografar o componente etcd e os segredos do Kubernetes com uma chave raiz que você controla.

ibmcloud ks kms crk ls

Virtual Private Cloud Infra-estrutura Classic

Liste customer root keys (CRKs) disponíveis em uma instância de serviço de gerenciamento de chaves. As chaves raiz agrupam e desagrupam as chaves de criptografia de dados (DEKs) locais que o cluster usa para criptografar seus segredos. Para obter mais informações, consulte Entendendo os provedores de serviço de gerenciamento de chaves (KMS).

Não exclua chaves raiz em sua instância do KMS, mesmo que você gire para usar uma nova chave. Se você excluir uma chave raiz usada por um cluster, o cluster se tornará inutilizável, perderá todos os dados e não poderá ser recuperado.

ibmcloud ks kms crk ls --instance-id KMS_INSTANCE_ID [--output json] [-q]
Permissões mínimas necessárias
Função de acesso da plataforma Viewer em IBM Cloud Kubernetes Service

Opções de comando:

--instance-id KMS_INSTANCE_ID
O ID da instância de serviço de gerenciamento de chaves para a qual você deseja listar chaves raiz. Para listar instâncias KMS disponíveis, execute ibmcloud ks kms instance ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando kms crk ls

ibmcloud ks kms crk ls --instance-id 1aa1a111-1111-1111-a111-a1aaaa1a1a1a

ibmcloud ks kms enable

Virtual Private Cloud Infra-estrutura Classic

Criptografe seus segredos do Kubernetes ativando um provedor de serviço de gerenciamento de chaves (KMS) em seu cluster. Para girar uma chave em um cluster com a criptografia de chave existente, execute novamente esse comando com um novo ID de chave raiz.

Não exclua chaves raiz em sua instância do KMS, mesmo que você gire para usar uma nova chave. Se você excluir uma chave raiz usada por um cluster, o cluster se tornará inutilizável, perderá todos os dados e não poderá ser recuperado. Ao girar uma chave raiz, não é possível reutilizar uma chave raiz anterior para o mesmo cluster.

ibmcloud ks kms enable --cluster CLUSTER_NAME_OR_ID --instance-id KMS_INSTANCE_ID --crk ROOT_KEY_ID [--kms-account-id ID] [--public-endpoint] [-q]
Permissões mínimas necessárias
Função de acesso à plataforma Administrador para o cluster no IBM Cloud Kubernetes Service

Opções de comando:

--container, -c CLUSTER_NAME_OR_ID
O nome ou ID do cluster.
--instance-id KMS_INSTANCE_ID
O ID da instância do KMS que você deseja usar para criptografar os segredos em seu cluster. Para listar instâncias KMS disponíveis, execute ibmcloud ks kms instance ls.
--crk ROOT_KEY_ID
O ID da chave raiz do cliente (CRK) em sua instância do KMS que você deseja usar para agrupar as chaves de criptografia de dados (DEK) que são armazenadas localmente em seu cluster. Para listar chaves de raiz disponíveis, execute ibmcloud ks kms crk ls --instance-id <kms_instance_id>.
--kms-account-id ID
Opcional: O ID da conta que contém a instância do KMS que você deseja usar para criptografia de disco local ou secreta.
--public-endpoint
Opcional: especifique esta opção para usar o terminal em serviço de nuvem pública do KMS. Se você não incluir essa opção, o endpoint do serviço de nuvem privada será usado por padrão.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando kms enable

ibmcloud ks kms enable -c mycluster --instance-id a11aa11a-bbb2-3333-d444-e5e555e5ee5 --crk 1a111a1a-bb22-3c3c-4d44-55e555e55e55

ibmcloud ks kms instance ls

Virtual Private Cloud Infra-estrutura Classic

Liste instâncias do serviço de gerenciamento de chaves (KMS) disponíveis em sua conta do IBM Cloud que pode ser escolhida para ativar em seu cluster.

ibmcloud ks kms instance ls [--output json] [-q]
Permissões mínimas necessárias
Função de acesso da plataforma Viewer em IBM Cloud Kubernetes Service

Opções de comando:

--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks kms instance ls

quota comandos

ibmcloud ks quota ls

Virtual Private Cloud Infra-estrutura Classic

Liste todas as cotas e limites para recursos relacionados ao cluster em sua conta da IBM Cloud.

ibmcloud ks quota ls [--provider PROVIDER] [--output json]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

--provider (classic | vpc-gen2)
O tipo de provedor de infraestrutura para o qual listar a cota e os limites.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks quota ls

Comando subnets

Virtual Private Cloud Infra-estrutura Classic

Liste as sub-redes disponíveis em todos os grupos de recursos em sua conta de infraestrutura da IBM Cloud.

ibmcloud ks subnets [--provider (classic | vpc-gen2)] [--vpc-id <VPC_ID> --zone <VPC_ZONE>] [--location LOCATION] [--output json] [-q]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

--provider (classic | vpc-gen2)
O tipo de provedor de infraestrutura para o qual listar sub-redes. Essa opção é necessária para listar as sub-redes VPC.
--vpc-id VPC_ID
O ID do VPC para o qual listar sub-redes. Essa opção é necessária quando você especifica o tipo de provedor vpc-gen2. Para listar IDs do VPC, execute ibmcloud ks vpcs.
--zone VPC_ZONE
A zona para a qual listar sub-redes do VPC. Essa opção é necessária quando você especifica um tipo de provedor de VPC.
-l, --location LOCATION
Filtre a saída por um local específico. Para ver locais suportados, execute ibmcloud ks locations. Para especificar vários locais, use uma opção para cada local, como -l dal -l seo.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks subnets -l ams03 -l wdc -l ap

vlan comandos

Infraestrutura clássica

Liste VLANs públicas e privadas para uma zona e visualize o status o VLAN Spanning.

ibmcloud ks vlan ls

Infraestrutura clássica

Liste as VLANs públicas e privadas disponíveis para uma zona em sua conta de infraestrutura clássica do IBM Cloud. Para listar as VLANs disponíveis, deve-se ter uma conta paga.

ibmcloud ks vlan ls --zone ZONE [--all] [--output json] [-q]

Permissões mínimas necessárias:

  • Para visualizar as VLANs às quais o cluster está conectado em uma zona: função de acesso à plataforma Visualizador para o cluster no IBM Cloud Kubernetes Service
  • Para listar todas as VLANs disponíveis em uma zona: função de acesso à plataforma Visualizador para a região no IBM Cloud Kubernetes Service

Opções de comando:

--zone ZONE
Necessário: inserir a zona na qual você deseja listar suas VLANs privadas e públicas. Para ver zonas disponíveis, execute ibmcloud ks zone ls.
--all
Lista todas as VLANs disponíveis. Por padrão, as VLANs são filtradas para mostrar apenas as VLANs que são válidas. Para ser válida, uma VLAN deve ser associada à infraestrutura que pode hospedar um trabalhador com armazenamento em disco local.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando vlan ls

ibmcloud ks vlan ls --zone dal10

ibmcloud ks vlan spanning get

Infraestrutura clássica

Visualize o status do VLAN Spanning para uma conta de infraestrutura da IBM Cloud. O VLAN Spanning permite que todos os dispositivos em uma conta se comuniquem entre si por meio da rede privada, independentemente de sua VLAN designada.

A opção VLAN Spanning é desativada para clusters que são criados em uma conta ativada por VRF. Quando o VRF é ativado, todas as VLANs na conta podem se comunicar automaticamente entre si por meio da rede privada. Para verificar se um VRF está ativado, use o comando ibmcloud account show. Para obter mais informações, consulte Planejando a configuração de rede do cluster: comunicação de trabalhador para trabalhador.

ibmcloud ks vlan spanning get --region REGION [--output json] [-q]
Permissões mínimas necessárias
Função de acesso de plataforma Visualizador para o IBM Cloud Kubernetes Service

Opções de comando:

--region REGION
Especifique uma região no IBM Cloud Kubernetes Service: jp-osa, jp-tok, au-syd, eu-de, eu-gb, us-east ou us-south.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando vlan spanning get

ibmcloud ks vlan spanning get --region us-south

ibmcloud ks vpc ls

Liste todos os VPCs no grupo de recursos de destino. Se nenhum grupo de recursos for direcionado, todas as VPCs da conta serão listadas.

ibmcloud ks vpc ls [--output OUTPUT] [--provider PROVIDER] [-q]

Opções de comando

--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json --provider PROVIDER
O tipo de provedor da infraestrutura da VPC. Os valores suportados são vpc-classic e vpc-gen2. Por padrão, as VPCs de todos os tipos de provedor são retornadas.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

ibmcloud ks vpc outbound-traffic-protection disable

Desative a proteção de tráfego de saída para um cluster VPC Seguro por Padrão

ibmcloud ks vpc outbound-traffic-protection disable --cluster CLUSTER [-f] [-q]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

ibmcloud ks vpc outbound-traffic-protection enable

Ative a proteção de tráfego de saída para um cluster VPC Seguro por Padrão

ibmcloud ks vpc outbound-traffic-protection enable --cluster CLUSTER [-f] [-q]

Opções de comando

--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
-f
Force o comando a ser executado sem prompts do usuário.
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

Comando flavor

Cada tipo inclui a quantidade de CPU virtual, memória e espaço em disco para cada nó do trabalhador no cluster.

Por padrão, o diretório do disco de armazenamento secundário no qual todos os dados do contêiner são armazenados é criptografado com a criptografia LUKS. Se a opção disable-disk-encrypt for incluída durante a criação do cluster, os dados de tempo de execução do contêiner do host não serão criptografados. Saiba mais sobre a criptografia .

É possível provisionar o nó do trabalhador como uma máquina virtual no hardware compartilhado ou dedicado, ou para clusters clássicos apenas, como uma máquina física em bare metal.

Comando flavor get

Virtual Private Cloud Infra-estrutura Classic

Obtenha as informações de um tipo para uma zona e um provedor.

ibmcloud ks flavor get --flavor FLAVOR --provider PROVIDER --zone ZONE [--output OUTPUT] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--flavor FLAVOR
O sabor você quer obter informações. Os tipos determinam quanto de CPU virtual, memória e espaço em disco está disponível para cada nó do trabalhador.
--provider PROVIDER
O provedor de infraestrutura para o qual você deseja obter informações de sabores. As opções disponíveis são classic, vpc-classic e vpc-gen2.
--zone ZONE
A zona em que você quer obter informações de sabor. Para ver zonas disponíveis para clusters clássicos, execute ibmcloud ks zone ls. Para ver zonas disponíveis para clusters VPC, execute ibmcloud ks zone ls --provider vpc-gen2 para a computação Geração 2.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando flavor get

Virtual Private Cloud Infra-estrutura Classic

ibmcloud ks flavor get --zone us-south-1 --provider vpc-gen2 --flavor bx2d.48x192.900gb

Comando flavor ls

Virtual Private Cloud Infra-estrutura Classic

Liste os tipos disponíveis para uma zona.

ibmcloud ks flavor ls --zone ZONE [--output OUTPUT] [--provider PROVIDER] [-q] [--show-os] [--show-storage]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--zone ZONE
A zona em que você quer obter informações de sabor. Para ver zonas disponíveis para clusters clássicos, execute ibmcloud ks zone ls. Para ver zonas disponíveis para clusters VPC, execute ibmcloud ks zone ls --provider vpc-gen2 para a computação Geração 2.
--provider PROVIDER
Opcional: O provedor de infraestrutura para o qual você deseja obter informações de sabores. As opções disponíveis são classic, vpc-classic e vpc-gen2.
--show-os
Opcional: Liste os sistemas operacionais compatíveis.
--show-storage
Opcional: mostre discos rígidos adicionais que estão disponíveis para tipos de nó do trabalhador SDS. Para obter mais informações, consulte Máquinas de armazenamento definido por software (SDS). Nas tabelas de cada seção de área metropolitana, os sabores de SDS estão nas guias Bare Metal e terminam com .ssd.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo de comando flavor ls

ibmcloud ks flavor ls --zone us-south-1 --provider vpc-gen2 --show-os --show-storage

Comando messages

Virtual Private Cloud Infra-estrutura Classic

Visualize as mensagens atuais por meio do plug-in da CLI do IBM Cloud Kubernetes Service para o usuário IBMid.

ibmcloud ks messages
Permissões mínimas necessárias
Nenhum

** Opções de comando **: Nenhuma

Comando locations

Virtual Private Cloud Infra-estrutura Classic

Liste os locais que são suportados pelo IBM Cloud Kubernetes Service. Para mais informações sobre os locais que são retornados, consulte locais do IBM Cloud Kubernetes Service.

ibmcloud ks locations [--output json]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--output json
Opcional: imprimirá a saída de comando em formato JSON.

Comando versions

Virtual Private Cloud Infra-estrutura Classic

Liste todas as versões da plataforma de contêineres que estão disponíveis para os clusters do IBM Cloud Kubernetes Service. Atualize o seu cluster mestre e nós do trabalhador para a versão padrão para os recursos mais recentes, estáveis.

O alias kube-versions para esse comando foi descontinuado.

ibmcloud ks versions [--show-version (KUBERNETES|OPENSHIFT)] [--output json] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--show-version (KUBERNETES|OPENSHIFT)
Mostre somente as versões para a plataforma de contêineres especificada. Os valores suportados são kubernetes ou openshift.
--output json
Opcional: imprimirá a saída de comando em formato JSON.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo:

ibmcloud ks versions

Comando api

Virtual Private Cloud Infra-estrutura Classic

Destine o terminal da API para o IBM Cloud Kubernetes Service. Se nenhum terminal for especificado, será possível visualizar informações sobre o atual terminal de destino.

Os terminais específicos da região foram descontinuados. Em vez disso, use o endpoint global.

Se você precisar listar e trabalhar com recursos somente de uma região, será possível usar o comando ibmcloud ks api para ter como destino um terminal regional em vez do terminal global.

  • Dallas (Sul dos EUA, us-south): https://us-south.containers.cloud.ibm.com
  • Frankfurt (UE Central, eu-de): https://eu-de.containers.cloud.ibm.com
  • Londres (Sul do Reino Unido, eu-gb): https://eu-gb.containers.cloud.ibm.com
  • Osaka (jp-osa): https://jp-osa.containers.cloud.ibm.com
  • São Paulo (br-sao): https://br-sao.containers.cloud.ibm.com
  • Sydney (Sul da Ásia-Pacífico, au-syd): https://au-syd.containers.cloud.ibm.com
  • Tóquio (Norte da Ásia-Pacífico, jp-tok): https://jp-tok.containers.cloud.ibm.com
  • Toronto (ca-tor): https://ca-tor.containers.cloud.ibm.com
  • Washington, D.C. (Leste dos EUA, EUA-leste): https://us-east.containers.cloud.ibm.com

Para usar a funcionalidade global, é possível usar o comando ibmcloud ks api novamente para ter o terminal global como destino: https://containers.cloud.ibm.com

ibmcloud ks api --endpoint ENDPOINT [--insecure] [--skip-ssl-validation] [--api-version VALUE] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--endpoint ENDPOINT
O terminal de API do IBM Cloud Kubernetes Service. Nota: esse terminal é diferente dos terminais do IBM Cloud. Este valor é necessário para configurar o terminal de API.
--insecure
Permitir uma conexão HTTP insegura. Esta opção é opcional.
--skip-ssl-validation
Permitir certificados SSL não seguros. Esta opção é opcional.
--api-version VALUE
Opcional: especificar a versão da API do serviço que você deseja usar.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplo: visualize informações sobre o terminal de API atual que é destinado.

ibmcloud ks api
API Endpoint:          https://containers.cloud.ibm.com
API Version:           v1
Skip SSL Validation:   false
Region:                us-south

Comando init

Virtual Private Cloud Infra-estrutura Classic

Inicialize o plug-in do IBM Cloud Kubernetes Service ou especifique a região em que você deseja criar ou acessar clusters Kubernetes.

Os terminais específicos da região foram descontinuados. Em vez disso, use o endpoint global.

Se você precisar listar e trabalhar com recursos somente de uma região, será possível usar o comando ibmcloud ks init para ter como destino um terminal regional em vez do terminal global.

  • Dallas (Sul dos EUA, us-south): https://us-south.containers.cloud.ibm.com
  • Frankfurt (UE Central, eu-de): https://eu-de.containers.cloud.ibm.com
  • Londres (Sul do Reino Unido, eu-gb): https://eu-gb.containers.cloud.ibm.com
  • Osaka (jp-osa): https://jp-osa.containers.cloud.ibm.com
  • São Paulo (br-sao): https://br-sao.containers.cloud.ibm.com
  • Sydney (Sul da Ásia-Pacífico, au-syd): https://au-syd.containers.cloud.ibm.com
  • Tóquio (Norte da Ásia-Pacífico, jp-tok): https://jp-tok.containers.cloud.ibm.com
  • Toronto (ca-tor): https://ca-tor.containers.cloud.ibm.com
  • Washington, D.C. (Leste dos EUA, EUA-leste): https://us-east.containers.cloud.ibm.com

Para usar a funcionalidade global, é possível usar o comando ibmcloud ks init novamente para ter o terminal global como destino: https://containers.cloud.ibm.com

ibmcloud ks init [--host HOST] [--insecure] [-p] [-u] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--host HOST
Opcional: o terminal de API do IBM Cloud Kubernetes Service a ser usado.
--insecure
Permitir uma conexão HTTP insegura.
-p
Sua senha do IBM Cloud.
-u
O IBM Cloud username.
-q
Opcional: não mostrar a mensagem do dia ou lembretes de atualização.

Exemplos:

  • Exemplo para que o terminal regional do Sul dos EUA seja o destino:
    ibmcloud ks init --host https://us-south.containers.cloud.ibm.com
    
  • Exemplo para destinar o terminal global novamente:
    ibmcloud ks init --host https://containers.cloud.ibm.com
    

script comandos

ibmcloud ks script update

Virtual Private Cloud Infra-estrutura Classic

Grave novamente os scripts que chamam os comandos kubernetes-service. Os comandos estruturados anteriores são substituídos por comandos estruturados em beta.

A maioria dos comportamentos de comando e da sintaxe muda na versão 1.0. Essas mudanças não são compatíveis com versões anteriores. Depois de atualizar seus scripts, deve-se continuar a usar a versão 1.0 do plug-in dentro do script ou do ambiente no qual o script é executado. Não mude a variável de ambiente IKS_BETA_VERSION para uma versão diferente.

ibmcloud ks script update [--in-place] FILE [FILE ...]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--in-place
Opcional: reescreva o arquivo de origem com a estrutura de comando atualizada. Se essa opção não for especificada, você poderá ver um resumo das alterações no arquivo de script em STDOUT.
FILE [FILE ...]
O arquivo que contém os scripts que você deseja atualizar.

Para usar esse comando para preparar seus scripts de automação para a liberação da versão 1.0 do plug-in do IBM Cloud Kubernetes Service:

  1. Execute o comando em um script de teste sem a opção --in-place.
    ibmcloud ks script update ./mytestscript.sh
    
  2. Revise as mudanças propostas para o script na diferença que é mostrada na linha de comandos STDOUT. Exemplo de saída
    --- a/script-test-2
    +++ b/script-test-2
    @@ -1,5 +1,5 @@
    -ibmcloud ks logging-config-get --cluster mycluster
    -ibmcloud ks logging-config-update --cluster mycluster --id myconfig --logsource application --type ibm --app-containers app1,app2,app3 --app-paths /var/log/path/
    -ibmcloud ks logging-config-update --cluster mycluster --id myconfig --logsource application --type ibm --app-paths=/var/log/path/,/var/log/other/path/
    -ibmcloud ks clusters -s --locations dal09,dal12 --output json
    -ibmcloud ks subnets --locations sao01
    +ibmcloud ks logging config get --cluster mycluster
    +ibmcloud ks logging config update --cluster mycluster --id myconfig --logsource application --type ibm -C app1 -C app2 -C app3 -p /var/log/path/
    +ibmcloud ks logging config update --cluster mycluster --id myconfig --logsource application --type ibm -p /var/log/path/ -p /var/log/other/path/
    +ibmcloud ks clusters -s -l dal09 -l dal12 --output json
    +ibmcloud ks subnets -l sao01
    
  3. Para reescrever o script com as atualizações propostas, execute o comando novamente com a opção --in-place.
    ibmcloud ks script update ./mytestscript.sh --in-place
    
  4. Procure e trate quaisquer comandos que estejam sinalizados no script com mensagens # WARNING. Por exemplo, alguns comandos estão descontinuados e não têm substituição.
  5. Dentro do script ou do ambiente no qual o script é executado, configure a variável de ambiente IKS_BETA_VERSION como 1.0.
    export IKS_BETA_VERSION=1.0
    
  6. Teste sua automação com o script atualizado. Observe que você poderá incorrer em encargos se a sua automação incluir a criação de clusters.
  7. Atualize todos os scripts.
  8. Atualize o plug-in da CLI para a versão 1.0.
    ibmcloud plugin update kubernetes-service
    

security-group comandos

Virtual Private Cloud Infra-estrutura Classic

Reconfigure ou sincronize um grupo de segurança com as regras de tráfego padrão

ibmcloud ks security-group ls

Lista todos os grupos de segurança associados a um cluster.

ibmcloud ks security-group ls --cluster CLUSTER [--attached-to ATTACHED] [--managed-by MANAGER] [--output OUTPUT] [-q] [--scope SCOPE]

Opções de comando

--attached-to ATTACHED
Filtre os grupos de segurança pelos componentes aos quais estão conectados. Valores aceitos: cluster, load-balancer, vpc, vpe-gateway, worker-pool
--cluster CLUSTER, -c CLUSTER
Especificar o nome ou o ID do cluster.
--managed-by MANAGER
Especifique user para retornar os grupos de segurança criados pelo usuário Especifique ibm para retornar apenas os grupos de segurança gerenciados pela IBM.. Valores aceitos: ibm, user
--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--scope SCOPE
Especifique cluster para retornar grupos de segurança com escopo definido no cluster. Especifique vpc para retornar os grupos de segurança com escopo definido para a VPC inteira Valores aceitos: cluster, vpc

ibmcloud ks security-group reset

Virtual Private Cloud Infra-estrutura Classic

Exclui todas as regras do grupo de segurança existentes e reaplica as regras padrão

ibmcloud ks security-group reset --cluster CLUSTER --security-group GROUP [-f] [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--cluster CLUSTER
Obrigatório: Especifique o nome ou a ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--security-group GROUP_ID
Necessário: especifique o ID do grupo de segurança..

Exemplo:

ibmcloud ks security-group reset --cluster mycluster --security-group mygroup

ibmcloud ks security-group sync

Virtual Private Cloud Infra-estrutura Classic

Reaplica as regras do grupo de segurança padrão para incluir quaisquer regras ausentes Não exclui regras preexistentes.

ibmcloud ks security-group sync --cluster CLUSTER --security-group GROUP [-q]
Permissões mínimas necessárias
Nenhum

Opções de comando:

--cluster CLUSTER
Obrigatório: Especifique o nome ou a ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--security-group GROUP_ID
Necessário: especifique o ID do grupo de segurança..

Exemplo:

ibmcloud ks security-group sync --cluster mycluster --security-group mygroup

Beta: storage comandos

Virtual Private Cloud Infra-estrutura Classic

Criar, obter, listar ou remover anexos de volume de armazenamento.

Os comandos do storage estão disponíveis em versão beta.

ibmcloud ks storage attachment create

Virtual Private Cloud

Conecte um volume de armazenamento a um nó do trabalhador em seu cluster.

Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage attachment create --cluster CLUSTER_ID --volume VOLUME --worker WORKER [--output json]

Opções de comando:

--cluster CLUSTER_ID
Necessário: especificar o ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--volume VOLUME
Necessário: especificar o ID do volume. Para listar os trabalhadores disponíveis, execute ibmcloud ks storage volume ls.
--worker WORKER
Necessário: especificar o ID do trabalhador. Para listar os trabalhadores disponíveis, execute ibmcloud ks worker ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage attachment create --cluster aa1111aa11aaaaa11aa1 --volume 111111111 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud ks storage attachment get

Virtual Private Cloud

Obtenha os detalhes de um anexo de volume de armazenamento em seu cluster.

Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage attachment get --cluster CLUSTER_ID --attachment ATTACHMENT --worker WORKER [--output json]
--cluster CLUSTER_ID
Necessário: especificar o ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--attachment ATTACHMENT
Necessário: especificar o ID de anexo de volume. Para listar os anexos disponíveis, execute ibmcloud ks storage attachment ls.
--worker WORKER
Necessário: especificar o ID do trabalhador. Para listar os trabalhadores disponíveis, execute ibmcloud ks worker ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage attachment get --cluster aa1111aa11aaaaa11aa1 --attachment 0111-1a111aaa-1111-1111-111a-aaa1a1a11a11 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud ks storage attachment ls

Virtual Private Cloud

Liste os anexos de volume de armazenamento para um nó do trabalhador em seu cluster.

Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage attachment ls --cluster CLUSTER_ID --worker WORKER [--output json]
--cluster CLUSTER_ID
Necessário: especificar o ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--worker WORKER
Necessário: especificar o ID do trabalhador. Para listar os trabalhadores disponíveis, execute ibmcloud ks worker ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage attachment ls --cluster aa1111aa11aaaaa11aa1 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud ks storage attachment rm

Virtual Private Cloud

Remova um volume de armazenamento de um nó do trabalhador em seu cluster.

Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage attachment rm --cluster CLUSTER_ID --attachment ATTACHMENT --worker WORKER [--output json]

Opções de comando:

--cluster CLUSTER_ID
Necessário: especificar o ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--attachment ATTACHMENT
Necessário: especificar o ID de anexo de volume. Para listar os anexos disponíveis, execute ibmcloud ks storage attachment ls.
--worker WORKER
Necessário: especificar o ID do trabalhador. Para listar os trabalhadores disponíveis, execute ibmcloud ks worker ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage attachment rm --cluster aa1111aa11aaaaa11aa1 --attachment 0111-1a111aaa-1111-1111-111a-aaa1a1a11a11 --worker kube-aa1111aa11aaaaa11aa1-my_cluster-default-00000110 [--output json]

ibmcloud ks storage volume get

Virtual Private Cloud Infra-estrutura Classic

Liste os volumes de armazenamento para seus clusters clássicos.

Permissões mínimas necessárias
Função de acesso à plataforma do Viewer para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage volume get --volume VOLUME

Opções de comando:

--volume VOLUME
Necessário: especificar o ID do volume. Para listar volumes disponíveis, execute ibmcloud ks storage volume ls.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage volume get --volume 111111111

ibmcloud ks storage volume ls

Virtual Private Cloud Infra-estrutura Classic

Obtenha uma lista de volumes de armazenamento.

Permissões mínimas necessárias
Função de acesso à plataforma do editor para o cluster em IBM Cloud Kubernetes Service
ibmcloud ks storage volume ls [--cluster CLUSTER_ID] [--provider PROVIDER] [--zone ZONE] [--output json]

Opções de comando:

--cluster CLUSTER_ID
Opcional: especifique o ID do cluster. Para listar clusters disponíveis, execute ibmcloud ks cluster ls.
--provider PROVIDER
Opcional: especifique o provedor. Os valores suportados são classic e vpc-gen2.
--zone ZONE
Opcional: especifique a zona. Para listar as zonas disponíveis, execute ibmcloud ks locations.
--output json
Opcional: imprimirá a saída de comando em formato JSON.

Exemplo:

ibmcloud ks storage volume ls --cluster aa1111aa11aaaaa11aa1

ibmcloud ks experimental trusted-profile default get

[Expira em 2025-10-03] Obter o perfil confiável padrão para clusters criados em um grupo de recursos.

ibmcloud ks experimental trusted-profile default get --region REGION --resource-group GROUP [--output OUTPUT] [-q]

Opções de comando

--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--region REGION
A região em que o grupo de recursos está localizado.
--resource-group GROUP
O grupo de recursos cujo perfil confiável padrão deve ser recuperado.

ibmcloud ks experimental trusted-profile default set

[Expira em 2025-10-03] Definir o perfil confiável padrão para clusters criados em um grupo de recursos.

ibmcloud ks experimental trusted-profile default set --region REGION --resource-group GROUP --trusted-profile PROFILE [--output OUTPUT] [-q]

Opções de comando

--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--region REGION
A região onde o grupo de recursos está localizado.
--resource-group GROUP
A ID do grupo de recursos para definir o perfil confiável.
--trusted-profile PROFILE
A ID do perfil confiável.

ibmcloud ks experimental trusted-profile get

[Expira em 2025-10-03] Obter perfil confiável para um cluster.

ibmcloud ks experimental trusted-profile get --cluster CLUSTER [--output OUTPUT] [-q]

Opções de comando

--cluster CLUSTER
O ID do cluster para o qual será recuperado o perfil confiável.
--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.

ibmcloud ks experimental trusted-profile set

[Expira em 2025-10-03] Definir perfil confiável em um cluster.

ibmcloud ks experimental trusted-profile set --cluster CLUSTER --trusted-profile PROFILE [--output OUTPUT] [-q]

Opções de comando

--cluster CLUSTER
A ID do cluster para definir o perfil confiável.
--output OUTPUT
Imprime a saída de comando no formato fornecido. Valores aceitos: json
-q
Não mostrar a mensagem do dia ou os lembretes de atualização.
--trusted-profile PROFILE
A ID do perfil confiável.