bmctl ist ein Befehlszeilentool für Google Distributed Cloud, das die Clustererstellung und -verwaltung vereinfacht. Dieses Dokument ist eine umfassende Referenz für bmctl-Befehle und zugehörige Flags.
Hinweise
bmctl verwendet Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) für die Validierung des location-Werts in der Clusterspezifikation (clusterOperations.location), wenn dieser nicht auf global gesetzt ist. Diese Validierung ist für viele bmctl-Befehle erforderlich. Damit ADC funktioniert, müssen Sie einen der folgenden Schritte ausführen:
Legen Sie die Umgebungsvariable
GOOGLE_APPLICATION_CREDENTIALSauf Ihrer Administrator-Workstation auf den Pfad einer Datei mit den Anmeldedaten des Dienstkontos fest.Verwenden Sie Ihre Nutzeranmeldedaten als Standardanmeldedaten für Anwendungen (ADC) mit der gcloud CLI:
gcloud auth application-default login
Bei einigen bmctl-Befehlen können Sie mit einem Flag einen Pfad zu einer Datei mit Anmeldedaten angeben.
Sicherung
Clusterinformationen sichern
Optionen
-h, --help help for backup
backup cluster
Sichern Sie einen Cluster und speichern Sie die Sicherung in einer Tar-Datei.
backup cluster [flags]
Optionen
--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).
Weitere Informationen zum Sichern und Wiederherstellen von Clustern mit bmctl finden Sie unter Cluster mit bmctl sichern und wiederherstellen.
check
Führen Sie Preflight- oder Systemdiagnosen für Ihre Cluster oder Ihre Infrastruktur durch.
Optionen
-h, --help help for check
check add-ons
Prüfen Sie den Betriebsstatus von Cluster-Add-ons wie stackdriver-log-aggregator, stackdriver-log-forwarder und gke-connect-agent.
check add-ons [flags]
Beispiele
# Do a health check for add-ons
bmctl check add-ons --cluster=cluster1
Optionen
--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.
check cluster
Sie können den Status eines Clusters prüfen oder einen Clustersnapshot erstellen.
check cluster [flags]
Beispiele
# 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
Optionen
--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 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 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 snapshot that they are read-only. Commands 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 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 login to each node. This will be ignored when admin-kubeconfig is set. (default "root")
--node-ssh-key string The file contains 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 --snapshot-config and --num-of-parallel-threads flags cannot be used at the same time. (default 10)
--quiet During snapshot run suppress logging to stdout. (Console log is available in 'bmctl_diagnose_snapshot.log' file 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 "--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 throuh 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 --enforce_allowlist=false option. Note that --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 --config flag is specified. The supported scenarios are:
- system: snapshot of system components, including their logs
- all: snapshot of all pods, including their logs (default "system")
--snapshot-temp-output-dir string The temporary landing directory for 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
Prüfen Sie die Cluster-Konfigurationsdatei.
check config [flags]
Beispiele
# Do check for cluster1.yaml file
bmctl check config --cluster=cluster1
Optionen
--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
Clusterverbindung zur Google Cloud-Systemdiagnose.
check gcp [flags]
Beispiele
# Do a machines' Google Cloud connectivity health check for cluster
bmctl check gcp --cluster=cluster1
Optionen
--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
Kubernetes-Systemdiagnose.
check kubernetes [flags]
Beispiele
# Do a kubernetes health check for cluster
bmctl check kubernetes --cluster=cluster1
Optionen
--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.
check nodes
Knotenstatus prüfen
check nodes [flags]
Beispiele
# Do a health check for some provisioned nodes
bmctl check nodes --addresses=192.168.0.1,192.168.0.4
Optionen
--addresses strings Node addresses, addresses should be a comma separated
list, each address needs 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.
check preflight
Preflight-Prüfung
Zusammenfassung
Preflight-Prüfung
check preflight [flags]
Beispiele
# 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, the command will trigger a preflight check for upgrading the cluster
Optionen
--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
Preflight-Prüfung der VM-Laufzeit für GDC.
check vmruntimepfc [flags]
Beispiele
# Do vmruntime preflight check,
bmctl check vmruntimepfc --kubeconfig=$KUBECONFIG
Optionen
-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.
Weitere Informationen zu Preflight-Prüfungen finden Sie unter Informationen zu Preflight-Prüfungen.
konfigurieren
Dienstkonten und IAM-Rollen konfigurieren und APIs in Google Cloud für die Clusterauthentifizierung mit Workload Identity aktivieren.
Optionen
-h, --help help for configure
Projekte konfigurieren
Konfiguriert IAM-Richtlinienbindungen für die Clusterauthentifizierung mit Workload Identity. Erstellt die erforderlichen Dienstkonten und aktiviert die erforderlichen APIs.
configure projects [flags]
Optionen
--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
Weitere Informationen zum Aktivieren und Verwenden der Clusterauthentifizierung mit Workload Identity finden Sie unter Clusterauthentifizierung mit Workload Identity.
create
Erstellen Sie eine Cluster-Konfigurationsdatei, einen Cluster oder ein Kubernetes-Dienstkonto (KSA).
Optionen
-h, --help help for create
create cluster
Erstellen Sie einen Cluster aus einer Cluster-Konfigurationsdatei.
Zusammenfassung
Google Distributed Cloud-Ressourcen erstellen Mit diesem Befehl wird eine kubeconfig eines erstellten Clusters ausgegeben. Bewahren Sie diese Datei sicher auf, da sie Anmeldedaten für Ihren Cluster enthält. Für diesen Befehl ist die Berechtigung serviceusage.services.get erforderlich, um zu prüfen, ob die API für Ihr Google Cloud-Projekt aktiviert ist.
create cluster [flags]
Optionen
--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 Google Cloud 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.
Weitere Informationen zum Erstellen von Clustern finden Sie unter Cluster erstellen – Übersicht.
create config
Erstellen Sie eine Cluster-Konfigurationsdatei. Standardmäßig wird diese Datei im Ordner „bmctl-workspace/<cluster_name>“ erstellt.
create config [flags]
Optionen
--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 Auto create GCP service accounts keys, if they do not
already exist in workspace
--enable-apis Auto enable APIs used by Bare Metal cluster,
for the GCP Project specified by 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 env variable
HTTPS_PROXY and HTTP_PROXY
--reuse-bootstrap-cluster If true, use existing bootstrap cluster.
create ksa
Erstellen Sie ein Kubernetes-Dienstkonto mit der Rolle „cluster-admin“ des Zielclusters.
Der Standardname des Kubernetes-Dienstkontos ist kubernetes-service-account. Das Flag --name ist also optional.
Mit dem Befehl wird ein Inhabertoken generiert, mit dem Sie sich beim Cluster anmelden können.
Das Inhabertoken wird standardmäßig im Ordner bmctl-workspace/<cluster_name> gespeichert.
create ksa [flags]
Optionen
-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.
deaktivieren
Deaktivieren Sie die GVM Runtime für GDC in einem Cluster.
Optionen
-h, --help help for disable
disable vmruntime
Deaktivieren Sie die VM Runtime for GDC in einem Cluster.
disable vmruntime [flags]
Optionen
--force If true, delete all VM resources and disable vmruntime.
-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.
Weitere Informationen zum Aktivieren und Deaktivieren von VM Runtime on GDC finden Sie unter VM Runtime on GDC aktivieren oder deaktivieren.
aktivieren
Aktivieren Sie die VM Runtime für GDC in einem Cluster.
Optionen
-h, --help help for enable
enable vmruntime
Aktivieren Sie die VM Runtime für GDC in einem Cluster.
enable vmruntime [flags]
Optionen
-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.
Weitere Informationen zum Aktivieren und Deaktivieren von VM Runtime on GDC finden Sie unter VM Runtime on GDC aktivieren oder deaktivieren.
get
Rufen Sie eine Clusterkonfiguration oder Clusteranmeldedaten ab.
Optionen
-h, --help help for get
get config
Rufen Sie die Cluster-Konfigurationsdatei ab. Der Befehl ruft benutzerdefinierte Ressourcen des Zielclusters ab und gibt eine Konfigurationsdatei aus.
get config [flags]
Optionen
-c, --cluster string Cluster name, 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.
Weitere Informationen finden Sie unter Details zur Clusterkonfiguration abrufen.
get credentials
Rufen Sie die Anmeldedaten für den Zielcluster ab. Mit dem Befehl wird eine kubeconfig-Datei im Ordner <workspace dir>/<cluster name> auf der Administratorworkstation erstellt.
get credentials [flags]
Optionen
-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.
Weitere Informationen finden Sie unter Clusteranmeldedaten abrufen.
install
Führt Softwareinstallationsvorgänge aus.
Optionen
-h, --help help for install
install virtctl
Installieren Sie virtctl als kubectl-Plug-in auf der aktuellen Maschine. Das virtctl-Plug-in unterstützt grundlegende VM-Vorgänge wie Erstellen, Verbinden und Ändern des Energiestatus.
install virtctl [flags]
Optionen
-d, --dst-dir string The dir virtctl binary to be installed, this path must be a valid one within
PATH env variable
-h, --help help for virtctl
move
Verschieben Sie Google Distributed Cloud-Ressourcen und alle Abhängigkeiten zwischen Verwaltungsclustern.
- Der Namespace des Zielclusters kann zusätzliche Ressourcen enthalten. In Konflikt stehende Ressourcen werden ersetzt.
move [flags]
Optionen
--cluster-move-timeout duration Cluster move timeout, 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, will use the default discovered kubeconfig.
--from-kubeconfig-context string Context to be used within the kubeconfig file for the source
management cluster. If empty, 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, current context
will be used.
nodeagent
Node-Agent-Deployment verwalten
Zusammenfassung
Bietet Befehle zum Verwalten des Node Agent-Dienstes auf Clusterknoten.
Optionen
-h, --help help for nodeagent
nodeagent deploy
Stellen Sie den Node Agent Service über SSH auf den angegebenen Knoten bereit.
Zusammenfassung
Stellen Sie den Node Agent-Dienst mit SSH auf einem oder mehreren Zielknoten in einem angegebenen Cluster bereit.
Mit diesem Befehl kann der Node Agent installiert oder neu installiert werden. Es stellt eine Verbindung über SSH her und führt die erforderlichen Schritte aus, einschließlich der Übertragung von Binärdateien, der optionalen Generierung und Übertragung von Zertifikaten und der Einrichtung des systemd-Dienstes.
Dazu sind SSH-Zugriff und Sudo-Berechtigungen auf den Zielknoten erforderlich.
Mit diesem Befehl wird sowohl die Ersteinrichtung des Node-Agents als auch seine Wiederherstellung durchgeführt.
Zielknoten können auf verschiedene Arten angegeben werden: direkt mit dem Flag --nodes, über eine Clusterkonfigurationsdatei mit dem Flag --cluster oder durch Verweisen auf die benutzerdefinierte Ressource des Clusters.
nodeagent deploy [flags]
Optionen
--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 necessary CAs and client credentials for Node Agent.
-h, --help help for deploy
--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.
--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
Aktiviert den Node Agent-Modus für den laufenden Cluster.
Zusammenfassung
Aktiviert den Node Agent-Modus für einen Cluster.
Mit diesem Befehl wird die Konfiguration des Clusters geändert. Außerdem werden die zugehörigen Anmeldedaten erstellt oder aktualisiert, die für die Funktion dieses Modus erforderlich sind.
Wenn der Node Agent-Modus aktiv ist, wird die Clusterverwaltung vom Node Agent übernommen, der direkt auf jedem Knoten ausgeführt wird.
nodeagent enable [flags]
Optionen
--client-ca-key-path string Path for the client certificate key file.
--client-ca-path string Path for the client ca certificate file.
--client-cert-path string Path for the client cacertificate file.
--client-key-path string Path for the client private key file.
-c, --cluster string Name of the target cluster (required).
--ensure-status Ensure Node Agent running status on all node 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
Rotiert die Anmeldedaten des Node-Agents auf den angegebenen Knoten über SSH und innerhalb des Clusters.
Zusammenfassung
Rotiert die nodeagentd-Anmeldedaten auf einem oder mehreren Zielknoten über SSH. Mit diesem Befehl werden auch die entsprechenden Node Agent-Anmeldedaten aktualisiert, die im Cluster gespeichert sind.
Mit diesem Befehl können die Anmeldedaten des Node-Agents rotiert werden. Dazu sind SSH-Zugriff und Sudo-Berechtigungen auf den Zielknoten erforderlich.
Zielknoten können auf verschiedene Arten angegeben werden: direkt mit dem Flag --nodes, über eine Clusterkonfigurationsdatei mit dem Flag --cluster oder durch Verweisen auf die benutzerdefinierte Ressource des Clusters.
nodeagent rotate-credentials [flags]
Optionen
--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
Prüfen Sie den Ausführungsstatus des Node Agent auf Clusterknoten.
Zusammenfassung
Prüfen Sie den Ausführungsstatus des Node Agent auf Clusterknoten.
Zielknoten können auf verschiedene Arten angegeben werden: direkt mit dem Flag --nodes, über eine Clusterkonfigurationsdatei mit dem Flag --cluster oder durch Verweisen auf die benutzerdefinierte Ressource des Clusters.
nodeagent status [flags]
Optionen
--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.
push
Übertragen Sie Docker-Images in eine private Registry.
Optionen
-h, --help help for push
push images
Übertragen Sie eine TAR-Datei mit den lokalen Container-Images in eine private Registry.
push images [flags]
Optionen
--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.
Informationen zum Einrichten und Verwenden eines Registry-Spiegels für die Bare-Metal-Container-Images finden Sie unter Registry-Spiegel für Container-Images verwenden.
register
Registrieren Sie Ressourcen.
Optionen
-h, --help help for register
register bootstrap
Bootstrap-Cluster bei der Hub API registrieren
Zusammenfassung
Registrieren Sie den Bootstrap-Cluster bei der Hub API. Mit diesem Befehl wird ein lokaler Kind-Cluster als Administratorcluster registriert. Der Befehl wartet, bis ein Cluster in der Google Cloud Console erstellt wurde, und wird beendet, sobald der Cluster erfolgreich erstellt wurde.
register bootstrap [flags]
Optionen
--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 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 Artifact Registry 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.
Zurücksetzen
Setzen Sie Clustermaschinen auf den Zustand vor der Installation zurück.
Zusammenfassung
Mit diesem Befehl wird versucht, Änderungen rückgängig zu machen, die bei früheren Installationsversuchen vorgenommen wurden. Es handelt sich um einen Best-Effort-Versuch, der zur Wiederherstellung nach teilweisen Installationsfehlern verwendet werden soll.
reset [flags]
Optionen
--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
Löschen Sie den Bootstrap-Cluster.
reset bootstrap [flags]
Beispiele
bmctl reset bootstrap
Optionen
-h, --help help for bootstrap
reset nodes
Setzen Sie bestimmte Knoten in einem Cluster auf den Zustand vor der Installation zurück, indem Sie sie aus dem Cluster entfernen. Wenn die Knoten nicht zugänglich sind, können Sie die Option --force verwenden, um den Zurücksetzungsschritt zu überspringen. Wenn die Cluster-Steuerungsebene nicht zugänglich ist, können Sie die Optionen --ssh-private-key-path, --login-user und --gcr-service-account-key verwenden, um die angegebenen Knoten auf den vorinstallierten Zustand zurückzusetzen, ohne sie aus dem Cluster zu löschen.
reset nodes [flags]
Beispiele
bmctl reset nodes --addresses 10.200.0.10,10.200.0.11 --cluster cluster1 --kubeconfig admin-kubeconfig
Optionen
--addresses strings Node addresses, addresses should be a comma separated list, each address needs 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 --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 --cluster flag. Optional and should be used together with --ssh-private-key-path. Default 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.
Weitere Informationen zum Zurücksetzen von Clusternodes in den Zustand vor der Installation oder zum Löschen von Clustern mit bmctl reset nodes finden Sie unter Fehlerhaften Knoten in Google Distributed Cloud zurücksetzen.
Wiederherstellen
Stellen Sie einen Cluster wieder her oder versuchen Sie, das Quorum für einen Cluster wiederherzustellen.
Zusammenfassung
Cluster wiederherstellen Wenn dieser Befehl ohne den Cluster-Unterbefehl verwendet wird, wird versucht, einen HA-Cluster nach einem Quorumverlust wiederherzustellen. In Kombination mit dem Cluster-Unterbefehl wird mit dem Befehl ein Cluster aus einer Sicherungsdatei wiederhergestellt.
restore [flags]
Optionen
--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.
restore cluster
Stellen Sie einen Cluster aus einer Sicherungsdatei wieder her.
restore cluster [flags]
Optionen
--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.
Weitere Informationen zum Sichern und Wiederherstellen von Clustern mit bmctl finden Sie unter Cluster mit bmctl sichern und wiederherstellen.
update
Clusterressourcen aktualisieren
Optionen
-h, --help help for update
update cluster
Cluster- und Knotenpoolkonfigurationen aktualisieren. Mit diesem Befehl werden die Änderungen angewendet, die in der Clusterkonfigurationsdatei vorgenommen wurden. Standardmäßig wird die Konfigurationsdatei <cluster_name>.yaml im Ordner bmctl-workspace/<cluster_name>/ auf der Administrator-Workstation gespeichert.
update cluster [flags]
Optionen
--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.
Weitere Informationen zum Aktualisieren von Clustern mit bmctl finden Sie unter Cluster aktualisieren. Welche Clusterkonfigurationsdateien geändert werden können, erfahren Sie in der Referenz zu den Clusterkonfigurationsfeldern.
update credentials
Aktualisieren Sie Clusteranmeldedaten.
Zusammenfassung
Anmeldedaten von Clustern aktualisieren Mit diesem Befehl werden die Anmeldedaten des Administratorclusters und die Anmeldedaten der vom Administratorcluster verwalteten Nutzercluster aktualisiert.
update credentials [flags]
Optionen
--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 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 GCR service
account key.
--gke-connect-agent-service-account-key-path string New credential: path to gke connect
agent service account key.
--gke-connect-register-service-account-key-path string New credential: path to 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 Node Agent
client certificates.
--node-agent-client-private-key-path string New credential: path to Node Agent
client private key.
--node-agent-server-ca-path string New credential: path to Node Agent
server CA.
--reuse-bootstrap-cluster If true, use existing bootstrap cluster.
--ssh-private-key-path string New credential: path to ssh private key.
update credentials certificate-authorities
Aktualisieren Sie Zertifizierungsstellen in Clustern.
Optionen
-h, --help help for certificate-authorities
Von übergeordneten Befehlen übernommene Optionen
--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
Rotieren Sie Zertifizierungsstellen.
update credentials certificate-authorities rotate [flags]
Optionen
--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 custom cluster CA certificate.
--cluster-ca-private-key-path string New credential: path to custom cluster CA private key.
--etcd-ca-cert-path string New credential: path to custom etcd CA certificate.
--etcd-ca-private-key-path string New credential: path to custom etcd CA private key.
--front-proxy-ca-cert-path string New credential: path to custom front proxy CA
certificate.
--front-proxy-ca-private-key-path string New credential: path to 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.
Upgrade
Aktualisieren Sie einen Cluster vor Ort auf eine neue Version.
Optionen
-h, --help help for upgrade
upgrade cluster
Cluster aktualisieren.
Zusammenfassung
Cluster aktualisieren. Mit diesem Befehl wird die Zielversion aus der Clusterkonfigurationsdatei gelesen und der Zielcluster auf die angegebene Version aktualisiert. Alle anderen Änderungen in der Clusterkonfigurationsdatei werden ignoriert. Für den Befehl ist die Berechtigung serviceusage.services.get erforderlich, um die API-Aktivierung für das in der Konfigurationsdatei angegebene Projekt Google Cloud zu prüfen.
upgrade cluster [flags]
Optionen
--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, 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 CIDR and the number of nodes
to determine whether upgrade would succeed.
--skip-preflight If true, skip standalone preflight checks.
Zwischenversion upgraden
Gibt die Zwischenversion aus, auf die der Cluster zuerst aktualisiert wird, wenn ein Upgrade mit Überspringen von Nebenversionen durchgeführt wird.
Zusammenfassung
Gibt die Zwischenversion aus, auf die der Cluster zuerst aktualisiert wird, wenn ein Upgrade mit Überspringen von Nebenversionen durchgeführt wird.
Durch das Überspringen von Nebenversions-Upgrades kann ein Cluster um zwei Nebenversionen aktualisiert werden. Bei einem Cluster mit Version 1.31.x, der auf Version 1.33.z aktualisiert wird, wird der Upgradepfad 1.31.x -> 1.32.y -> 1.33.z verwendet, wobei 1.32.y die Zwischenversion ist.
upgrade intermediate-version [flags]
Optionen
-h, --help help for intermediate-version
Weitere Informationen zu Clusterupgrades finden Sie in der folgenden Dokumentation:
- Cluster aktualisieren
- Best Practices für Cluster-Upgrades in Google Distributed Cloud
- Lebenszyklus und Phasen von Clusterupgrades
Version
bmctl-Version drucken
version [flags]
Optionen
-h, --help help for version
-o, --output string Output format of version string. Supported options: [version, commit,
metadata-digest]