Referência de comandos bmctl

bmctl é uma ferramenta de linha de comandos para o Google Distributed Cloud que simplifica a criação e a gestão de clusters. Este documento é uma referência abrangente para os bmctl comandos e as flags relacionadas.

Antes de começar

Nota: como parte dos Google Cloud requisitos de recursos para instalar clusters, o seu Google Cloud projeto tem de ter a função de visualizador do Compute (roles/compute.viewer) Identity and Access Management (IAM). Esta função inclui as compute.zones.* autorizações necessárias para bmctl validar o valor location.

bmctl usa credenciais padrão da aplicação (ADC) para validar o valor location na especificação do cluster (clusterOperations.location) quando não está definido como global. Esta validação é necessária para muitos comandos do bmctl. Para o ADC funcionar, tem de fazer uma das seguintes ações:

• Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS na sua estação de trabalho de administrador para o caminho de um ficheiro de credenciais da conta de serviço.

• Use a CLI gcloud com as suas credenciais de utilizador como Credenciais padrão da aplicação (ADC):

  gcloud auth application-default login
  

Alguns comandos bmctl permitem-lhe especificar um caminho para um ficheiro de credenciais com uma flag.

cópia de segurança

Faça uma cópia de segurança das informações do cluster.

Opções

  -h, --help   help for backup

cluster de cópia de segurança

Faça uma cópia de segurança de um cluster e guarde-a num ficheiro TAR.

backup cluster [flags]

Opções

      --backup-file string                      path to the output backup files.
      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for cluster
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.
      --use-disk                                Perform the backup using the disk instead of in-memory buffer. This option only works when the command is run by the root user or with sudo.
      --yes                                     Perform the backup, and do not prompt for confirmation (non-interactive mode).

Para mais informações sobre como fazer uma cópia de segurança e restaurar clusters com bmctl, consulte o artigo Fazer uma cópia de segurança e restaurar clusters com o bmctl.

verificar

Realize verificações de funcionamento ou de pré-lançamento nos seus clusters ou infraestrutura.

Opções

  -h, --help   help for check

verifique os suplementos

Verifique o estado operacional dos suplementos de clusters, como stackdriver-log-aggregator, stackdriver-log-forwarder e gke-connect-agent.

check add-ons [flags]

Exemplos

# Do a health check for add-ons.
bmctl check add-ons --cluster=cluster1

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for add-ons
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

verificar cluster

Verifique o estado de um cluster ou gere uma captura de ecrã do cluster.

check cluster [flags]

Exemplos

# Do a health check for cluster.
bmctl check cluster --cluster=cluster1
# Take a snapshot of the cluster (requires admin cluster to be available).
bmctl check cluster --snapshot --cluster=cluster1 --admin-kubeconfig=admin-kubeconfig
# Take a snapshot of the cluster (requires admin cluster to be available) using 30 threads.
bmctl check cluster --snapshot --cluster=cluster1 --admin-kubeconfig=admin-kubeconfig --num-of-parallel-threads=30
# Take a snapshot of the cluster nodes only (does not require admin cluster to be available).
bmctl check cluster --snapshot --cluster=cluster1 --snapshot-config=snapshot-config

Opções

      --bootstrap-cluster-pod-cidr string           Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string       Bootstrap cluster service CIDR (default "10.96.0.0/27")
      --ca-file string                              The file that contains the Node Agent server CA certificate for authenticating nodes to capture snapshots. While this flag is fully optional, when provided, nodes must also be provided.
      --cert-file string                            The file that contains the Node Agent client certificate for authenticating with nodes to capture snapshots. While this flag is fully optional, when provided, nodes must also be provided.
  -c, --cluster cluster name                        Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --enforce-allowlist                           Enforces allowlist checking for kubectl/node commands executed as part of collecting a snapshot to ensure that they are read-only. Commands that are not allowed will be skipped. (default true)
  -h, --help                                        help for cluster
      --ignore-validation-errors                    A validation error override, allowing to proceed despite the validation errors.
      --key-file string                             The file that contains the Node Agent client private key for authenticating with nodes to capture snapshots. While this flag is fully optional, when provided, nodes must also be provided.
      --kubeconfig string                           Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --local                                       Save the snapshot on your workstation only. This will allow you to explicitly opt out of uploading the snapshot to Google Cloud.
      --login-user string                           The user to log in to each node. This will be ignored when admin-kubeconfig is set. (default "root")
      --node-ssh-key string                         The file that contains the SSH key to the nodes to capture snapshots against. While this flag is fully optional, when provided, nodes must also be provided.
      --nodeagent-port int                          The Node Agent server port for the client side to connect to. This flag is optional and only applies with 'nodes' options; when provided, it will override the default port.
      --nodes strings                               The comma-separated IP address list of the nodes to capture snapshots against. While this flag is fully optional, when provided, node-ssh-key must also be provided.
      --num-of-parallel-threads int                 The number of parallel threads used for processing snapshots. Note that the --snapshot-config and --num-of-parallel-threads flags cannot be used at the same time. (default 10)
      --quiet                                       During a snapshot run, suppress logging to stdout. (The console log is available in the 'bmctl_diagnose_snapshot.log' file, which is part of the snapshot.)
      --reuse-bootstrap-cluster                     If true, use existing bootstrap cluster.
      --service-account-key-file string             The service account key file that is needed to upload the snapshot to your Google Cloud Storage bucket and provision a dedicated Google Cloud service account for your project to facilitate snapshot sharing with Google.
                                                    
                                                    Make sure that the service account key has the ability to create and list buckets and objects in your project.
                                                    We recommend creating a custom role with the following permissions and assigning this custom role to your service account:
                                                    - storage.buckets.create
                                                    - storage.buckets.get
                                                    - storage.buckets.list
                                                    - storage.objects.create
                                                    - resourcemanager.projects.get
                                                    Note that all the storage permissions fall under the "roles/storage.admin" IAM role. You can also use that role, but it is too powerful and is not recommended
                                                    
                                                    Note that:
                                                    - this flag is defaulted to the environment variable GOOGLE_APPLICATION_CREDENTIALS, if not provided.
                                                    - this flag is ignored if the "--upload-to" flag is empty.
      --since duration                              This only returns logs newer than a relative duration like 5s, 4m, or 3h. It defaults to all logs.
      --snapshot                                    Takes a snapshot of the cluster's logs, configurations, and other data if true.
                                                    Note that if a service account key is provided either through the flag --service-account-key-file or GOOGLE_APPLICATION_CREDENTIALS, the snapshot will be automatically uploaded to your Google Cloud Storage bucket. Also, a dedicated Google Cloud service account for your project will be provisioned for your project to facilitate snapshot sharing with Google.
                                                    Use --local to opt out of snapshot uploading.
                                                    
      --snapshot-config --enforce_allowlist=false   The config file of the snapshot. When this flag is omitted, a default configuration is applied. An allowlist enforcing read-only commands is in effect by default. To bypass it, specify the --enforce_allowlist=false option. Note that the --snapshot-config and --num-of-parallel-threads flags cannot be used at the same time.
      --snapshot-dry-run                            In dry-run mode, the command does not take the snapshot. Instead, it prints out the actions to be taken and the snapshot configuration.
      --snapshot-output string                      The output file of the snapshot.
      --snapshot-scenario string                    The scenario of the snapshot. This is ignored when the --config flag is specified. The supported scenarios are:
                                                    - system: a snapshot of system components, including their logs
                                                    - all: a snapshot of all pods, including their logs (default "system")
      --snapshot-temp-output-dir string             The temporary landing directory for the snapshot.
      --upload-to string                            The Google Cloud Storage bucket name for uploading the snapshot. A new bucket will be created if it doesn't exist. Please follow the naming guidelines here (https://cloud.google.com/storage/docs/naming-buckets). 

check config

Verifique o ficheiro de configuração do cluster.

check config [flags]

Exemplos

# Do check for cluster1.yaml file.
bmctl check config --cluster=cluster1

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for config
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

check gcp

Conetividade do cluster à verificação de estado do Google Cloud.

check gcp [flags]

Exemplos

# Do a Google Cloud connectivity health check for cluster machines.
bmctl check gcp --cluster=cluster1

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for gcp
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

check kubernetes

Verifique o estado do Kubernetes.

check kubernetes [flags]

Exemplos

# Do a Kubernetes health check for the cluster.
bmctl check kubernetes --cluster=cluster1

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for kubernetes
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

verificar nós

Verifique o estado dos nós.

check nodes [flags]

Exemplos

# Do a health check for some provisioned nodes.
bmctl check nodes --addresses=192.168.0.1,192.168.0.4

Opções

      --addresses strings                       Node addresses; addresses should be a comma-separated list, and each address must be a single IP address (e.g., 192.168.0.1).
      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for nodes
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

verificação prévia

Verificação prévia.

Synopsis

Verificação prévia da instalação e atualização do cluster. Para executar uma verificação prévia da atualização, transmita --kubeconfig <admin_cluster_kubeconfig_path> e atualize a versão no ficheiro YAML do cluster.

check preflight [flags]

Exemplos

# Do a preflight check for cluster1.yaml in bmctl-workspace/cluster1
bmctl check preflight --cluster=cluster1. If kubeconfig flag (for example, --kubeconfig=bmctl-workspace/cluster1/cluster1-kubeconfig) is included and cluster1's spec version is updated, the command will trigger a preflight check for upgrading the cluster

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for preflight
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

check vmruntimepfc

Tempo de execução da VM para a verificação prévia do GDC.

Synopsis

Verificação prévia do tempo de execução da VM para verificar os pré-requisitos de criação de VMs.

check vmruntimepfc [flags]

Exemplos

# Do vmruntime preflight check.
bmctl check vmruntimepfc --kubeconfig=$KUBECONFIG

Opções

  -h, --help                help for vmruntimepfc
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

Para mais informações sobre as verificações pré-publicação, consulte o artigo Compreenda as verificações pré-publicação.

configurar

Configure contas de serviço e funções do IAM e ative APIs no Google Cloud para a autenticação de clusters de identidade da carga de trabalho.

Opções

  -h, --help   help for configure

configurar projetos

Configura as associações de políticas IAM para a autenticação de clusters de identidade de carga de trabalho. Cria as contas de serviço necessárias e ativa as APIs necessárias.

configure projects [flags]

Opções

      --admin-cluster string                admin cluster name
      --cloud-ops-service-account string    cloud ops service account
      --controller-service-account string   controller GCP service account
      --gcr-service-account string          GCR image pull service account
  -h, --help                                help for projects
      --location string                     GKE hub membership location (default "global")
      --project-id string                   GCP project used in GKE connect
      --proxy-url string                    proxy URL for accessing GCP services. If not specified, bmctl looks for env variables HTTPS_PROXY and HTTP_PROXY
      --user-clusters string                one or more comma-delimited user cluster names

Nota: o comando bmctl configure projects é idempotente. Se faltar alguma conta de serviço, ativação de API ou associação, o comando garante que são repostas.

Para mais informações sobre como ativar e usar a autenticação de cluster de identidade de carga de trabalho, consulte o artigo Autenticação de cluster de identidade de carga de trabalho.

criar

Crie um ficheiro de configuração do cluster, um cluster ou uma conta de serviço do Kubernetes (KSA).

Opções

  -h, --help   help for create

create cluster

Crie um cluster a partir de um ficheiro de configuração do cluster.

Synopsis

Crie um cluster. Este comando emite um kubeconfig do cluster criado. Certifique-se de que mantém este ficheiro em segurança, uma vez que contém as credenciais do seu cluster. Este comando requer a autorização serviceusage.services.get para verificar a ativação da API para o seu projeto do Google Cloud.

create cluster [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --force                                   If true, ignore errors from preflight checks and validation except for GCP check errors.
  -h, --help                                    help for cluster
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

Para mais informações sobre a criação de clusters, consulte o artigo Vista geral da criação de clusters.

create config

Crie um ficheiro de configuração do cluster. Por predefinição, este ficheiro é criado na pasta bmctl-workspace/<cluster_name>.

create config [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --create-service-accounts                 Automatically create GCP service account keys, if they do not already exist in the workspace
      --enable-apis                             Automatically enable APIs used by Anthos clusters on bare metal for the GCP project specified by the project-id flag
      --force                                   Overwrite existing config
  -h, --help                                    help for config
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --project-id string                       GCP project where the new cluster will connect with via GKE Hub and Stackdriver logging/monitoring, required if --create-service-accounts or --enable-apis is true
      --proxy-url string                        Proxy URL for accessing GCP services. If not specified, bmctl will look for the HTTPS_PROXY and HTTP_PROXY environment variables
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

create ksa

Crie uma conta de serviço do Kubernetes com a função cluster-admin do cluster de destino. O nome predefinido da conta de serviço do Kubernetes é kubernetes-service-account, pelo que a flag --ksa-name é opcional. O comando gera um token de portador que pode usar para iniciar sessão no cluster. Por predefinição, o token de portador é armazenado na pasta bmctl-workspace/<cluster_name>.

create ksa [flags]

Opções

  -c, --cluster string      Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml.
  -h, --help                help for ksa
      --ksa-name string     Name of the Kubernetes service account and default value is kubernetes-service-account. (default "kubernetes-service-account")
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

desactivar

Desative o tempo de execução de VMs para o GDC num cluster.

Opções

  -h, --help   help for disable

disable vmruntime

Desative o tempo de execução de VMs para o GDC num cluster.

disable vmruntime [flags]

Opções

      --force               If true, delete all VM resources and disable VM Runtime.
  -h, --help                help for vmruntime
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

Para mais informações sobre como ativar e desativar o VM Runtime no GDC, consulte o artigo Ative ou desative o VM Runtime no GDC.

activar

Ative o tempo de execução de VMs para o GDC num cluster.

Opções

  -h, --help   help for enable

enable vmruntime

Ative o tempo de execução de VMs para o GDC num cluster.

enable vmruntime [flags]

Opções

 -h, --help                help for vmruntime
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

Para mais informações sobre como ativar e desativar o VM Runtime no GDC, consulte o artigo Ative ou desative o VM Runtime no GDC.

receber

Obter uma configuração de cluster ou credenciais de cluster.

Opções

  -h, --help   help for get

get config

Obtenha o ficheiro de configuração do cluster. O comando extrai os recursos personalizados do cluster de destino e emite um ficheiro de configuração.

get config [flags]

Opções

  -c, --cluster string      Cluster name; the cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml.
  -h, --help                help for config
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

Para mais informações, consulte o artigo Obtenha detalhes da configuração do cluster.

obter credenciais

Obtenha as credenciais do cluster de destino. O comando emite um ficheiro kubeconfig na pasta <workspace dir>/<cluster name> na estação de trabalho do administrador.

get credentials [flags]

Opções

  -c, --cluster string      Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml.
  -h, --help                help for credentials
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

Para mais informações, consulte o artigo Obtenha credenciais do cluster.

instalar

Realiza operações de instalação de software.

Opções

  -h, --help   help for install

instale o virtctl

Instale o virtctl no computador atual como um plugin kubectl. O plug-in virtctl suporta operações básicas de VMs, como criar, ligar e alterar o estado de energia.

install virtctl [flags]

Opções

  -d, --dst-dir string   The dir virtctl binary to be installed. This path must be a valid one within the PATH env variable.
  -h, --help             help for virtctl

mover

Mova os recursos do Google Distributed Cloud e todas as dependências entre clusters de gestão.

• O espaço de nomes do cluster de destino pode conter recursos adicionais. Os recursos em conflito são substituídos.

move [flags]

Opções

      --cluster-move-timeout duration    Cluster move timeout; the default value is 15m. The input should contain the duration unit, e.g. 3600s, 60m, or 1h. (default 15m0s)
      --from-kubeconfig string           Kubeconfig file path for the source management cluster. If unspecified, the default discovered kubeconfig will be used.
      --from-kubeconfig-context string   Context to be used within the kubeconfig file for the source management cluster. If empty, the current context will be used.
  -h, --help                             help for move
  -n, --namespace string                 The namespace where the cluster resources are stored. If unspecified, the current context's namespace is used.
      --to-kubeconfig string             Kubeconfig file path for the destination management cluster.
      --to-kubeconfig-context string     Context to be used within the kubeconfig file for the destination management cluster. If empty, the current context will be used.

nodeagent

Faça a gestão da implementação do agente de nó.

Synopsis

Fornece comandos para gerir o serviço de agente de nó em nós de cluster.

Opções

  -h, --help   help for nodeagent

nodeagent deploy

Implemente com SSH o serviço de agente de nó nos nós especificados.

Synopsis

Implemente o serviço do agente de nó num ou mais nós de destino num cluster especificado, através de SSH.

Este comando pode instalar ou reinstalar o agente de nó. Liga-se através de SSH e executa os passos necessários, incluindo a transferência de ficheiros binários, a geração e a transferência opcionais de certificados, e a configuração do serviço systemd.

Requer acesso SSH e privilégios sudo nos nós de destino.

Este comando processa a configuração inicial do agente do nó e a respetiva recuperação.

Os nós de destino podem ser especificados de várias formas: diretamente através da flag --nodes, através de um ficheiro de configuração do cluster com a flag --cluster ou referenciando o recurso personalizado do cluster.

nodeagent deploy [flags]

Opções

      --cluster string             Name of the target cluster (required).
      --concurrency int            Number of parallel node deployments. (default 25)
      --deploy-creds               Deploy the server certificate, private key, and client CA to nodes. (default true)
      --enforce-host-key-verify    Verifies the remote host's SSH key against known_hosts (recommended). (default true)
      --generate-ca-creds          Generate the necessary CAs and client credentials for the Node Agent.
  -h, --help                       help for deploy
      --key-algorithm string       The private key algorithm for the CA, client certificate, and server certificate. (default "rsa")
      --key-length int             The private key length for the CA, client certificate, and server certificate. (default 4096)
      --kubeconfig string          Path to the cluster kubeconfig.
      --nodeagent-version string   The Node Agent version to pull. (default "0.0.0-gke.0")
      --nodes strings              List of node IPs to deploy to (comma-delimited).
      --non-interactive            Run non-interactively, skipping all user prompts.
      --port string                The Node Agent port. (default "9192")
      --pull-binaries              Download Node Agent binaries.
      --sa-key string              Path to the service account key to pull from GCS and GCR.
      --server-cert-validity int   The validity for the server certificate. (default 1825)
      --ssh-key string             Path to the SSH private key file. (default "~/.ssh/id_rsa")
      --ssh-user string            SSH username for connecting to nodes. (default "root")

nodeagent enable

Ativa o modo de agente de nó para o cluster em execução.

Synopsis

Ativa o modo de agente de nó para um cluster.

Este comando modifica a configuração do cluster e também cria ou atualiza as credenciais relacionadas necessárias para o funcionamento deste modo.

Quando o modo de agente de nó está ativo, a gestão do cluster é processada pelo agente de nó executado diretamente em cada nó.

nodeagent enable [flags]

Opções

      --client-ca-key-path string   Path for the client private key file.
      --client-ca-path string       Path for the client CA certificate file.
      --client-cert-path string     Path for the client certificate file.
      --client-key-path string      Path for the client private key file.
  -c, --cluster string              Name of the target cluster (required).
      --ensure-status               Ensure the Node Agent is running on all nodes in the cluster. (default true)
  -h, --help                        help for enable
  -k, --kubeconfig string           Path to the kubeconfig file (required).
      --port string                 The Node Agent port. (default "9192")
      --server-ca-key-path string   Path for the server CA key file.
      --server-ca-path string       Path for the server CA file.

nodeagent rotate-credentials

Roda as credenciais do agente de nó em nós especificados através de SSH e no cluster.

Synopsis

Roda as credenciais nodeagentd em um ou mais nós de destino através de SSH. Este comando também atualiza a credencial do agente do nó correspondente armazenada no cluster.

Este comando pode rodar as credenciais do agente do nó. Requer acesso SSH e privilégios sudo nos nós de destino.

Os nós de destino podem ser especificados de várias formas: diretamente através da flag --nodes, através de um ficheiro de configuração do cluster com a flag --cluster ou referenciando o recurso personalizado do cluster.

nodeagent rotate-credentials [flags]

Opções

      --cluster string             Name of the target cluster (required).
      --concurrency int            Number of parallel node deployments. (default 25)
      --enforce-host-key-verify    Verify remote host's SSH key against known_hosts. (default true)
      --generate-ca-creds          Generate necessary CAs and client credentials for Node Agent.
  -h, --help                       help for rotate-credentials
      --key-algorithm string       The private key algorithm for the CA, client certificatem and server certificate. (default "rsa")
      --key-length int             The private key length for the CA, client certificate and server certificate. (default 4096)
      --kubeconfig string          Path to the cluster kubeconfig.
      --nodes strings              List of node IPs to deploy to (comma-delimited).
      --non-interactive            Run non-interactively, skipping all user prompts.
      --server-cert-validity int   The validity for the server certificate. (default 1825)
      --ssh-key string             Path to the SSH private key file. (default "~/.ssh/id_rsa")
      --ssh-user string            SSH username for connecting to nodes. (default "root")

nodeagent status

Verifique o estado de execução do agente de nó nos nós do cluster.

Synopsis

Verifique o estado de execução do agente de nó nos nós do cluster.

Os nós de destino podem ser especificados de várias formas: diretamente através da flag --nodes, através de um ficheiro de configuração do cluster com a flag --cluster ou referenciando o recurso personalizado do cluster.

nodeagent status [flags]

Opções

      --client-cert-path string   Path for the client certificate file.
      --client-key-path string    Path for the client private key file.
  -c, --cluster string            Name of the target cluster (required).
  -h, --help                      help for status
  -k, --kubeconfig string         Path to the kubeconfig file.
      --nodes strings             List of node IPs to deploy to (comma-delimited).
      --port string               The Node Agent port. (default "9192")
      --server-ca-path string     Path for the server CA file.

enviar

Envie imagens de contentores para um registo privado.

Opções

  -h, --help   help for push

enviar imagens

Envie o ficheiro TAR de imagens de contentores locais para um registo privado.

push images [flags]

Opções

      --cacert string             Private registry CA certificate file path.
      --dry-run                   Dry run.
      --email string              Email for private registry.
      --force-push                If set to true, will always push images even if images already exist in registry.
      --format string             Format of images in the source file. Should be one of tarball or oci (default). (default "oci")
  -h, --help                      help for images
      --need-credential           Whether credential is needed for private registry. (default true)
      --password string           Password for private registry authentication.
  -r, --private-registry string   Private registry path that stores all bare metal images.
                                  Format should be <registry-name>/<optional-registry-namespace>.
      --source string             Path to bare metal container images compressed file.
  -t, --threads int               Push images with multiple threads. (default 4)
      --username string           Username for private registry authentication.

Para obter informações sobre a configuração e a utilização de uma imagem espelhada do registo para as imagens de contentores bare metal, consulte o artigo Use uma imagem espelhada do registo para imagens de contentores.

registar

Registar recursos.

Opções

  -h, --help   help for register

register bootstrap

Registe o cluster de arranque na API GKE Hub.

Synopsis

Registe o cluster de arranque na API GKE Hub. Este comando regista um cluster Kind local como um cluster de administrador. O comando aguarda a criação de um cluster na Google Cloud Console e termina assim que o cluster for criado com êxito.

register bootstrap [flags]

Opções

      --bootstrap-cluster-pod-cidr string            Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string        Bootstrap cluster service CIDR (default "10.96.0.0/27")
      --cloud-operation-service-account-key string   Optional, service account key file used to access Google cloud service, service account key specified by environment variable GOOGLE_APPLICATION_CREDENTIALS will be used to fetch or create the Service account.
      --enable-apis                                  Auto enable APIs used by Anthos Bare Metal cluster, for the GCP Project specified by project-id flag
      --gcr-service-account-key string               Optional, service account key file used to pull GCR images, service account key specified by environment variable GOOGLE_APPLICATION_CREDENTIALS will be used to fetch or create the Service account.
      --gke-agent-service-account-key string         Optional, service account key file used to connect the GKE cluster in Google Cloud, service account key specified by environment variable GOOGLE_APPLICATION_CREDENTIALS will be used to fetch or create the Service account.
      --gke-register-service-account-key string      Optional, service account key file used to register the cluster in Google Cloud, service account key specified by environment variable GOOGLE_APPLICATION_CREDENTIALS will be used to fetch or create the Service account.
  -h, --help                                         help for bootstrap
      --ignore-validation-errors                     A validation error override, allowing to proceed despite the validation errors.
      --location string                              Optional, Location of the GKEHub Membership, e.g. us-central1. If unspecified, global will be used. (default "global")
      --name string                                  Mandatory (either --name or --target-cluster-name needs to be provided), Name of the bootstrap cluster. bmctl will register the bootstrap cluster with this name with GKE Connect.
      --project-id string                            Optional, GCP project for GKE Connect. bmctl will register this bootstrap cluster into GCP project temporarily, and un-register it after cluster is provisioned successfully.
      --registry-mirror-ca string                    Registry mirror CA file.
      --registry-mirror-credential string            Registry mirror credential file.
      --registry-mirror-endpoint string              Registry mirror endpoint.
      --reuse-bootstrap-cluster                      If true, use existing bootstrap cluster.
      --ssh-client-cert string                       Optional, Path of the SSH certificate. ABM will use this ssh key certificate while sshing in the machines.
      --ssh-key string                               Mandatory, Path of the SSH key. ABM will use this ssh key while sshing in the machines.
      --target-cluster-name string                   Optional, The target cluster name.

repor

Reponha as máquinas do cluster para o estado anterior à instalação.

Synopsis

Este comando tenta anular as alterações realizadas em tentativas de instalação anteriores. É uma tentativa de melhor esforço destinada a ser usada para recuperar de falhas de instalação parciais.

reset [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for reset
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

reset bootstrap

Elimine o cluster de arranque.

Exemplos

bmctl reset bootstrap

Opções

  -h, --help   help for bootstrap

reponha os nós

Reponha os nós especificados num cluster para o respetivo estado pré-instalado, removendo-os do cluster. Nos casos em que os nós estão inacessíveis, pode usar a opção --force para ignorar o passo de reposição. Se o painel de controlo do cluster estiver inacessível, pode usar as opções --ssh-private-key-path, --login-user e --gcr-service-account-key para repor os nós especificados para o estado pré-instalado sem os eliminar do cluster.

Exemplos

bmctl reset nodes --addresses 10.200.0.10,10.200.0.11 --cluster cluster1 --kubeconfig admin-kubeconfig

Opções

      --addresses strings                       Node addresses; the addresses should be a comma-separated list, and each address must be a single IP address (e.g., 192.168.0.1).
      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --force                                   Optional. If provided, nodes will be forcefully removed from the cluster without running reset jobs.
      --gcr-service-account-key string          Optional, path to the service account JSON key to pull GCR images. Mutually exclusive with the --cluster flag. If not provided, the environment variable GOOGLE_APPLICATION_CREDENTIALS will be used.
  -h, --help                                    help for nodes
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --login-user string                       Login user to use to connect to the nodes. Mutually exclusive with the --cluster flag. Optional, and should be used together with --ssh-private-key-path. Defaults to root.
      --registry-mirror-ca string               Registry mirror CA file.
      --registry-mirror-credential string       Registry mirror credential file.
      --registry-mirror-endpoint string         Registry mirror endpoint.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.
      --ssh-private-key-path string             Path to the SSH private key to connect to the nodes. Either --cluster or --ssh-private-key-path should be provided, but not both. Use this flag to reset the machines if the original cluster YAML is no longer available.

Para mais informações sobre a utilização de bmctl reset nodes para repor os nós do cluster para o estado anterior à instalação ou eliminar clusters, consulte o artigo Reponha um nó com falhas no Google Distributed Cloud.

restaurar

Restaurar um cluster ou tentar recuperar o quórum de um cluster.

Synopsis

Restaurar um cluster. Quando usado sem o subcomando cluster, este comando tenta restaurar um cluster de alta disponibilidade de uma perda de quórum. Quando usado com o subcomando cluster, o comando restaura um cluster a partir de um ficheiro de cópia de segurança.

restore [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --control-plane-node string               IP for the surviving host address, should be a single IP address(e.g., 192.168.0.1).
  -h, --help                                    help for restore
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       kubeconfig file path for the management cluster. This only needs to be provided if restoring a broken user cluster.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

restaurar cluster

Restaure um cluster a partir de um ficheiro de cópia de segurança.

restore cluster [flags]

Opções

      --backup-file string                      path to the backup file of the cluster.
      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for cluster
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       path to the kubeconfig of the management cluster.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.
      --use-disk                                Perform the restore using the disk instead of in-memory buffer. This option only works when the command is run by the root user or with sudo.

Para mais informações sobre como fazer uma cópia de segurança e restaurar clusters com bmctl, consulte o artigo Fazer uma cópia de segurança e restaurar clusters com o bmctl.

atualização

Atualizar recursos do cluster.

Opções

  -h, --help   help for update

atualizar cluster

Atualize as configurações do cluster e do node pool. Este comando aplica as alterações feitas no ficheiro de configuração do cluster. Por predefinição, o ficheiro de configuração <cluster_name>.yaml é armazenado na pasta bmctl-workspace/<cluster_name>/ na estação de trabalho do administrador.

update cluster [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
  -h, --help                                    help for cluster
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.

Para mais informações sobre a atualização de clusters com bmctl, consulte o artigo Atualize clusters. Para ver que ficheiros de configuração do cluster são mutáveis, consulte a referência de campos de configuração do cluster.

atualizar credenciais

Atualize as credenciais do cluster.

Synopsis

Atualize as credenciais dos clusters. Este comando atualiza as credenciais do cluster de administrador e as credenciais dos clusters de utilizadores geridos pelo cluster de administrador.

update credentials [flags]

Opções

      --bootstrap-cluster-pod-cidr string                      Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string                  Bootstrap cluster service CIDR (default "10.96.0.0/27")
      --cloud-operations-service-account-key-path string       New credential: path to the cloud operations service account key.
  -c, --cluster cluster name                                   Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --gcr-key-path string                                    New credential: path to the GCR service account key.
      --gke-connect-agent-service-account-key-path string      New credential: path to the GKE Connect agent service account key.
      --gke-connect-register-service-account-key-path string   New credential: path to the GKE Connect register service account key.
  -h, --help                                                   help for credentials
      --ignore-validation-errors                               A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                                      Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --node-agent-client-cert-path string                     New credential: path to the Node Agent client certificates.
      --node-agent-client-private-key-path string              New credential: path to the Node Agent client private key.
      --node-agent-server-ca-path string                       New credential: path to the Node Agent server CA.
      --reuse-bootstrap-cluster                                If true, use existing bootstrap cluster.
      --ssh-private-key-path string                            New credential: path to the SSH private key.

update credentials certificate-authorities

Atualize as autoridades de certificação nos clusters.

Opções

  -h, --help   help for certificate-authorities

Opções herdadas dos comandos principais

      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

update credentials certificate-authorities rotate

Rode as autoridades de certificação.

update credentials certificate-authorities rotate [flags]

Opções

      --bootstrap-cluster-pod-cidr string        Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string    Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                     Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --cluster-ca-cert-path string              New credential: path to the custom cluster CA certificate.
      --cluster-ca-private-key-path string       New credential: path to the custom cluster CA private key.
      --etcd-ca-cert-path string                 New credential: path to the custom etcd CA certificate.
      --etcd-ca-private-key-path string          New credential: path to the custom etcd CA private key.
      --front-proxy-ca-cert-path string          New credential: path to the custom front proxy CA certificate.
      --front-proxy-ca-private-key-path string   New credential: path to the custom front proxy CA private key.
  -h, --help                                     help for rotate
      --ignore-validation-errors                 A validation error override, allowing to proceed despite the validation errors.
      --reuse-bootstrap-cluster                  If true, use existing bootstrap cluster.
````

#### Options inherited from parent commands

```none
      --kubeconfig string   Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.

atualização

Atualize um cluster no local para uma nova versão.

Opções

  -h, --help   help for upgrade

atualizar cluster

Atualize um cluster.

Synopsis

Atualize um cluster. Este comando lê a versão de destino do ficheiro de configuração do cluster e atualiza o cluster de destino para a versão especificada. Todas as outras alterações no ficheiro de configuração do cluster são ignoradas. O comando requer a autorização serviceusage.services.get para verificar a ativação da API para o projeto Google Cloud especificado no ficheiro de configuração.

upgrade cluster [flags]

Opções

      --bootstrap-cluster-pod-cidr string       Bootstrap cluster pod CIDR (default "192.168.122.0/24")
      --bootstrap-cluster-service-cidr string   Bootstrap cluster service CIDR (default "10.96.0.0/27")
  -c, --cluster cluster name                    Cluster name, cluster config is expected to be placed under <workspace dir>/<cluster name>/<cluster name>.yaml
      --cluster-update-timeout duration         Cluster update timeout; the default value is 24h. The input should contain the duration unit, e.g. 3600s, 60m, or 1h. (default 24h0m0s)
      --force                                   If true, ignore errors from preflight checks.
  -h, --help                                    help for cluster
      --ignore-validation-errors                A validation error override, allowing to proceed despite the validation errors.
      --kubeconfig string                       Optional, path to the kubeconfig file for the admin cluster. If not provided, will fall back to read env var ANTHOS_ADMIN_KUBECONFIG.
      --reuse-bootstrap-cluster                 If true, use existing bootstrap cluster.
      --skip-bootstrap-cidr-check               If true, skip checking the CIDR and the number of nodes to determine whether the upgrade would succeed.
      --skip-paused-annotation-check            If true, continue the upgrade even if the cluster is paused by skipping the paused annotation check.
      --skip-preflight                          If true, skip standalone preflight checks.

upgrade intermediate-version

Imprima a versão intermédia para a qual o cluster vai ser atualizado primeiro quando fizer uma atualização que ignore uma versão secundária.

Synopsis

Imprima a versão intermédia para a qual o cluster vai ser atualizado primeiro quando fizer uma atualização que ignore uma versão secundária.

Uma atualização de versão secundária ignorada permite que um cluster seja atualizado em duas versões secundárias. Um cluster na versão 1.31.x atualizado para a versão 1.33.z segue o caminho de atualização 1.31.x -> 1.32.y -> 1.33.z, em que 1.32.y é a versão intermédia.

upgrade intermediate-version [flags]

Opções

  -h, --help   help for intermediate-version

Para mais informações sobre as atualizações de clusters, consulte a seguinte documentação:

• Atualize clusters
• Práticas recomendadas para atualizações de clusters do Google Distributed Cloud
• Ciclo de vida e fases das atualizações de clusters

versão

Imprima a versão bmctl

version [flags]

Opções

  -h, --help            help for version
  -o, --output string   Output format of version string. Supported options: [version, commit, metadata-digest]
  -t, --timestamps      Prefix each line with a timestamp. This will be removed in future releases.