[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["很难理解","hardToUnderstand","thumb-down"],["信息或示例代码不正确","incorrectInformationOrSampleCode","thumb-down"],["没有我需要的信息/示例","missingTheInformationSamplesINeed","thumb-down"],["翻译问题","translationIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC)：2025-08-25。"],[[["\u003cp\u003e\u003ccode\u003eapigeectl\u003c/code\u003e is a command-line interface (CLI) used for managing Apigee hybrid installations within a Kubernetes cluster, and it requires \u003ccode\u003ekubectl\u003c/code\u003e to be installed and set up.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eapigeectl\u003c/code\u003e commands like \u003ccode\u003eapply\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003echeck-ready\u003c/code\u003e, \u003ccode\u003ediagnostic\u003c/code\u003e, \u003ccode\u003eencode\u003c/code\u003e, \u003ccode\u003ehelp\u003c/code\u003e, \u003ccode\u003einit\u003c/code\u003e, and \u003ccode\u003eversion\u003c/code\u003e facilitate operations such as deploying configurations, removing components, checking pod statuses, collecting diagnostics, listing deployments and more.\u003c/p\u003e\n"],["\u003cp\u003eThe scope of \u003ccode\u003eapigeectl\u003c/code\u003e operations can be controlled with flags like \u003ccode\u003e--all-envs\u003c/code\u003e, \u003ccode\u003e--datastore\u003c/code\u003e, \u003ccode\u003e--env\u003c/code\u003e, \u003ccode\u003e--org\u003c/code\u003e, and \u003ccode\u003e--telemetry\u003c/code\u003e, which target specific components such as Cassandra, Redis, runtime environments, or reporting systems.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003e-f\u003c/code\u003e or \u003ccode\u003e--file-override-config\u003c/code\u003e flag is used to specify a YAML configuration file (overrides.yaml) that contains custom properties, and it's required for multiple commands including \u003ccode\u003eapply\u003c/code\u003e, \u003ccode\u003echeck-ready\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, and \u003ccode\u003einit\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUsing the \u003ccode\u003e--print-yaml\u003c/code\u003e along with \u003ccode\u003e--dry-run\u003c/code\u003e flags allows the user to export a copy of the cluster configuration to inspect the changes, without applying it to the cluster, which is useful for troubleshooting and debugging, however be advised that this file may contain sensitive information.\u003c/p\u003e\n"]]],[],null,["# apigeectl\n\n| You are currently viewing version 1.11 of the Apigee hybrid documentation. **This version is end of life.** You should upgrade to a newer version. For more information, see [Supported versions](/apigee/docs/hybrid/supported-platforms#supported-versions).\n\n\n`apigeectl` is a command-line interface (CLI)\nfor installing and managing Apigee hybrid in a Kubernetes cluster.\nFor\ninformation on downloading and installing `apigeectl`, see\n[Download and install apigeectl](/apigee/docs/hybrid/v1.11/install-apigeectl).\n| **Note:** You must have [`kubectl`](https://kubernetes.io/docs/reference/kubectl/overview/) installed and set up on your Kubernetes administration machine to use the `apigeectl` command.\n\nScopes for applying `apigeectl`\n-------------------------------\n\n\nBy using [`apigeectl` flags](#options) you control which scopes the command\napplies configuration changes to. For an overview of scopes within the Apigee hybrid runtime\nsee the [Runtime service configuration overview](/apigee/docs/hybrid/v1.11/service-config).\n\napigeectl syntax\n----------------\n\n```\napigeectl [command] [flags]\n```\n\nWhere:\n\n- \u003cvar translate=\"no\"\u003ecommand\u003c/var\u003e: Specifies the operation you want to\n perform. For a complete list of commands, see [apigeectl commands](#commands).\n\n- \u003cvar translate=\"no\"\u003eflags\u003c/var\u003e: Specifies command\n parameters. For a complete list of flags, see [apigeectl flags](#options).\n\napigeectl commands\n------------------\n\nThe following table lists the `apigeectl` commands:\n\napigeectl flags\n---------------\n\nThe following table lists the `apigeectl` flags:\n\n| The `apigeectl` command uses `kubectl` behind the scenes to do\n| its work. The `apigeectl` command options (`apply` and `delete`,\n| and the use of YAML configuration files, are similar to their kubectl counterparts.\n| To learn more about how objects are managed in a Kubernetes cluster, see the following topics:\n|\n| - [Imperative Management of Kubernetes Objects Using Configuration Files](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/imperative-config/)\n| - [Overview of kubectl](https://kubernetes.io/docs/reference/kubectl/overview/)\n\nExamples\n--------\n\n### Initialize the cluster configuration\n\n\nApply prerequisite component configurations to your cluster with `init`.\nYou must run the `init`\ncommand before `apply`. \n\n```\napigeectl init -f my_overrides.yaml\n```\n\n### Apply the cluster configuration\n\nTo apply hybrid configurations to your Kubernetes cluster, use the\n`apply` command. The first time you run `apply` all of the\nhybrid runtime components are created in your cluster. If you make configuration changes, rerun\n`apply` to apply only the changes or use flags to apply changes to a specific\nscope only.\n\nThe following example applies the configuration for hybrid runtime plane\ncomponents to your cluster: \n\n```\napigeectl apply -f my_overrides.yaml\n```\n\n### Apply the configuration for a single component\n\nTo restrict the `apply` command to a particular component, use the\nflags described in [apigeectl flags](#options).\n\nThe following example only applies the configuration for the Cassandra component: \n\n```\napigeectl apply --datastore -f my_overrides.yaml\n```\n\n### Print the configuration to a file\n\nIf you're debugging an installation problem, it's useful to print out the entire\ncluster configuration to a file so that you can inspect the configuration\nsettings. The `--print-yaml` flag prints\nthe hybrid configuration to stdout, and the `--dry-run` flag allows the\ncommand to run without making any changes to the cluster. \n\n```\napigeectl apply -f my_overrides.yaml --dry-run=client --print-yaml \u003e apigee-hybrid.yaml\n```\n| **Note:** It is a good practice to save a copy of the YAML output in source control for future reference. But be aware that the output file contains passwords and secrets that you may not want to store.\n\n### Check pod status\n\nThe following example checks the status of pods deployed to your cluster: \n\n```\napigeectl check-ready -f overrides/overrides.yaml\nAll containers ready in namespace 'my-namespace'\n```\n\n### Delete hybrid from the cluster\n\nFor details, see [Uninstall hybrid runtime](./uninstall.html)."]]
