> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.itential.com/itential-gateway/5/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.itential.com/_mcp/server. # 5 ## Docs - [Itential Gateway overview](https://docs.itential.com/itential-gateway/overview.md) - [Execution engine](https://docs.itential.com/itential-gateway/execution-engine.md) - [Gateway concepts](https://docs.itential.com/itential-gateway/concepts.md) - [Gateway 5 feature comparison](https://docs.itential.com/itential-gateway/gateway-feature-comparison.md) - [Choose a deployment architecture](https://docs.itential.com/itential-gateway/choose-deployment-architecture.md): Choose the right deployment model and architecture for your Itential Gateway installation. - [Review requirements](https://docs.itential.com/itential-gateway/gateway-requirements.md) - [Application modes](https://docs.itential.com/itential-gateway/application-modes.md): Learn about the four distinct application modes Gateway can run in to provide automation for various operating environments. - [Install Gateway Manager](https://docs.itential.com/itential-gateway/install-gateway-manager.md): Install Gateway Manager for on-premises deployments. - [Deploy container image](https://docs.itential.com/itential-gateway/deploy-container-image.md): Deploy Gateway using Docker container image. - [Install Gateway RPM/DEB package](https://docs.itential.com/itential-gateway/rpm-deb-install.md): Install Gateway via traditional RPM/DEB binary installation for Linux environments. - [Create certificates](https://docs.itential.com/itential-gateway/create-certificates.md): Create required certificates to support secure communication between Gateway components and with Gateway Manager. - [Initial configuration](https://docs.itential.com/itential-gateway/initial-configuration.md): Configure your gateway server to handle client requests, manage resources, and communicate with Gateway Manager and runner nodes. - [Configure gateway client](https://docs.itential.com/itential-gateway/client-configuration.md): Configure client nodes to interact with gateway servers for resource management and service execution. - [Configure client profiles](https://docs.itential.com/itential-gateway/configure-client-profiles.md) - [Create a gateway cluster](https://docs.itential.com/itential-gateway/create-gateway-cluster.md) - [Configure etcd shared database](https://docs.itential.com/itential-gateway/configure-etcd-database.md) - [Configure Amazon DynamoDB shared database](https://docs.itential.com/itential-gateway/configure-dynamodb-table.md) - [Configure high availability clusters](https://docs.itential.com/itential-gateway/high-availability-clusters.md) - [Configure distributed execution clusters](https://docs.itential.com/itential-gateway/distributed-execution-clusters.md) - [Configuration variables](https://docs.itential.com/itential-gateway/configuration-variables-overview.md): Learn more about configurable environment vairables in Gateway. - [Application variables](https://docs.itential.com/itential-gateway/gateway-application-variables.md): Learn more about configurable application variables, including gateway cluster ID and application mode. - [Client variables](https://docs.itential.com/itential-gateway/gateway-client-variables.md): Learn more about configurable client variables. - [Connect variables](https://docs.itential.com/itential-gateway/gateway-connect-variables.md): Learn more about the variables used to establish secure connections between gateway nodes and Gateway Manager. - [Features variables](https://docs.itential.com/itential-gateway/gateway-feature-variables.md): Learn more about configurable environment variables that enable different features specific to Ansible, hostkeys, OpenTofu, and Python. - [Log variables](https://docs.itential.com/itential-gateway/gateway-log-variables.md): Learn more about configurable log variables, including gateway cluster ID and application mode. - [Metrics variables](https://docs.itential.com/itential-gateway/gateway-metrics-variables.md): Learn more about configurable variables for the gateway server metrics endpoint. - [Registry variables](https://docs.itential.com/itential-gateway/gateway-registry-variables.md): Enable or disable users' ability to override the default PyPI or Ansible Galaxy registries when creating gateway services. - [Runner variables](https://docs.itential.com/itential-gateway/gateway-runner-variables.md): Configure runner nodes. - [Secrets variables](https://docs.itential.com/itential-gateway/gateway-secrets-variables.md): Define the location of the file used to locally encrypt and decrypt secrets. - [Server variables](https://docs.itential.com/itential-gateway/gateway-server-variables.md): Configure gateway servers (controller nodes). - [Store variables](https://docs.itential.com/itential-gateway/gateway-store-variables.md): Set the backend type for persistent data storage and configure etcd and DynamoDB data stores. - [Terminal variables](https://docs.itential.com/itential-gateway/gateway-terminal-variables.md): Customize gateway terminal color and time zone. - [Manage users and credentials](https://docs.itential.com/itential-gateway/manage-users-credentials.md) - [Logging](https://docs.itential.com/itential-gateway/logging.md) - [Monitoring](https://docs.itential.com/itential-gateway/monitoring.md) - [Administer Itential Gateway](https://docs.itential.com/itential-gateway/administer-gateway.md): Routine administration and maintenance procedures for Itential Gateway, including health checks, service management, safe shutdown, log management, and TLS certificate rotation. - [Administer etcd](https://docs.itential.com/itential-gateway/administer-etcd.md): Routine administration and maintenance procedures for an etcd cluster used as the shared store backend for Itential Gateway, including health checks, backup and restore, compaction, and TLS certificate rotation. - [Gateway Manager overview](https://docs.itential.com/itential-gateway/gateway-manager-overview.md) - [View gateway cluster details](https://docs.itential.com/itential-gateway/view-gateway-cluster-details.md) - [Monitor gateway cluster health and activity](https://docs.itential.com/itential-gateway/monitor-cluster-health-activity.md) - [Gateway configuration import and export](https://docs.itential.com/itential-gateway/gateway-manager/import-export.md) - [Import a gateway configuration](https://docs.itential.com/itential-gateway/gateway-manager/import-gateway-configuration.md) - [Export a gateway configuration](https://docs.itential.com/itential-gateway/gateway-manager/export-gateway-configuration.md) - [Manage certificates](https://docs.itential.com/itential-gateway/manage-certificates.md) - [Configure proxy for Gateway Manager connections](https://docs.itential.com/itential-gateway/configure-proxy-gateway-manager-connections.md) - [RBAC in Gateway Manager](https://docs.itential.com/itential-gateway/rbac-gateway-manager.md) - [Service groups in Gateway Manager](https://docs.itential.com/itential-gateway/service-groups-overview.md) - [Create a service group](https://docs.itential.com/itential-gateway/create-service-groups.md) - [Manage service groups](https://docs.itential.com/itential-gateway/manage-service-groups.md) - [Configure Gateway secret store](https://docs.itential.com/itential-gateway/configure-secret-store.md) - [External secrets overview](https://docs.itential.com/itential-gateway/secrets/external-secrets/overview.md): Connect Itential Gateway to external secrets managers so credentials are retrieved at runtime rather than stored locally. - [Configure a secret provider](https://docs.itential.com/itential-gateway/secrets/external-secrets/configure-provider.md): Register HashiCorp Vault or CyberArk CCP as a secret provider in Itential Gateway. - [Configure a custom plugin provider](https://docs.itential.com/itential-gateway/secrets/external-secrets/configure-custom-plugin-provider.md): Use the Itential Gateway plugin interface to retrieve secrets from any external system using a customer-supplied executable. - [Manage secret aliases](https://docs.itential.com/itential-gateway/secrets/external-secrets/manage-secret-aliases.md): Create and manage secret aliases to reference external secrets by a stable name in Itential Gateway automation. - [Virtual clusters overview](https://docs.itential.com/itential-gateway/virtual-clusters/overview.md) - [Create a virtual cluster](https://docs.itential.com/itential-gateway/virtual-clusters/create-virtual-cluster.md) - [Monitor virtual cluster status](https://docs.itential.com/itential-gateway/virtual-clusters/monitor-virtual-cluster-status.md) - [Edit a virtual cluster](https://docs.itential.com/itential-gateway/edit-virtual-cluster.md) - [FlowMCP Gateway overview](https://docs.itential.com/itential-platform/flowai/flowmcp-gateway/overview.md): Learn how FlowMCP Gateway connects external MCP servers to Itential Platform and surfaces their tools natively through Gateway Manager. - [MCP server configuration reference](https://docs.itential.com/itential-platform/flowai/flowmcp-gateway/mcp-server-reference.md): Reference information for MCP server configuration fields, transport types, secret template syntax, and database export behavior in Itential Gateway. - [Register and manage MCP servers](https://docs.itential.com/itential-platform/flowai/flowmcp-gateway/manage-mcp-servers.md): Learn how to register, inspect, and remove MCP servers in Itential Gateway to make their tools available in Gateway Manager. - [Troubleshoot FlowMCP Gateway](https://docs.itential.com/itential-platform/flowai/flowmcp-gateway/troubleshoot-flowmcp-gateway.md): Diagnose and resolve common FlowMCP Gateway issues, including connectivity failures, tool discovery problems, invocation errors, and import issues. - [Create gateway services](https://docs.itential.com/itential-gateway/create-gateway-service.md) - [View service details](https://docs.itential.com/itential-gateway/view-service-details.md) - [Python virtual environments](https://docs.itential.com/itential-gateway/python-virtual-environments.md) - [Configure dependency registries](https://docs.itential.com/itential-gateway/dependency-registries.md): Configure PyPI and Ansible Galaxy registries for use with your gateway services. - [Validate and limit service inputs with decorators](https://docs.itential.com/itential-gateway/using-decorators.md): Use decorators to limit and validate the inputs passed to a service at execution time. - [Inject secrets into services](https://docs.itential.com/itential-gateway/inject-secrets-into-services.md) - [Add gateway services to workflows](https://docs.itential.com/itential-gateway/add-services-to-workflows.md): How to add gateway services to Itential Platform workflows using the runService task in Studio. - [Git repositories in Gateway](https://docs.itential.com/itential-gateway/git-repositories.md): Learn how to create and manage Git repository references in Gateway. - [Configure access to private repositories](https://docs.itential.com/itential-gateway/configure-private-repository-access.md): Configure HTTP basic authentication to access private Git repositories using a username and personal access token. - [Use SSH keys to clone git repositories](https://docs.itential.com/itential-gateway/clone-git-repositories-ssh.md) - [Executable objects overview](https://docs.itential.com/itential-gateway/executable-objects-overview.md): An overview of executable objects and services, how they work, and their integration with gateway services. - [Create an executable object](https://docs.itential.com/itential-gateway/create-executable-object.md): Define reusable execution commands for services by creating executable objects that specify a full path to an executable file. - [Manage executable objects](https://docs.itential.com/itential-gateway/manage-executable-objects.md): View, update, and delete executable objects as your system requirements change. - [Use executable objects with gateway services](https://docs.itential.com/itential-gateway/use-executable-object-with-services.md): Configure Python services to use custom Python interpreters with executable objects. - [Executable services overview](https://docs.itential.com/itential-gateway/executable-services-overview.md): Executable services run scripts or applications using pre-defined executable objects in Itential Gateway. - [Create an executable service](https://docs.itential.com/itential-gateway/create-executable-service.md): Create executable services to run scripts or applications stored in a Git repository using a pre-defined executable object. - [Run an executable service](https://docs.itential.com/itential-gateway/run-executable-service.md): Execute an executable service using the iagctl CLI, with or without runtime arguments. - [Manage executable services](https://docs.itential.com/itential-gateway/manage-executable-services.md): View, update, and delete executable services as your automation requirements change. - [iagctl cert-gen](https://docs.itential.com/itential-gateway/iagctl/cert-gen.md): Use iagctl cert-gen to generate certificates for secure communication between gateway nodes. - [iagctl completion](https://docs.itential.com/itential-gateway/iagctl/completion.md) - [iagctl create decorator](https://docs.itential.com/itential-gateway/iagctl/create-decorator.md) - [iagctl create executable-object](https://docs.itential.com/itential-gateway/iagctl/create-executable-object.md) - [iagctl create registry](https://docs.itential.com/itential-gateway/iagctl/create-registry.md) - [iagctl create repository](https://docs.itential.com/itential-gateway/iagctl/create-repository.md) - [iagctl create secret](https://docs.itential.com/itential-gateway/iagctl/create-secret.md) - [iagctl create secret-provider](https://docs.itential.com/itential-gateway/iagctl/create-secret-provider.md) - [iagctl create service ansible-playbook](https://docs.itential.com/itential-gateway/iagctl/create-service-ansible-playbook.md) - [iagctl create service executable](https://docs.itential.com/itential-gateway/iagctl/create-service-executable.md) - [iagctl create service opentofu-plan](https://docs.itential.com/itential-gateway/iagctl/create-service-opentofu-plan.md) - [iagctl create service python-script](https://docs.itential.com/itential-gateway/iagctl/create-service-python-script.md) - [iagctl create user](https://docs.itential.com/itential-gateway/iagctl/create-user.md) - [iagctl db export](https://docs.itential.com/itential-gateway/iagctl/db-export.md) - [iagctl db import](https://docs.itential.com/itential-gateway/iagctl/db-import.md) - [iagctl db migrate etcd-to-local](https://docs.itential.com/itential-gateway/iagctl/db-migrate-etcd-to-local.md) - [iagctl db migrate local-to-etcd](https://docs.itential.com/itential-gateway/iagctl/db-migrate-local-to-etcd.md) - [iagctl delete decorator](https://docs.itential.com/itential-gateway/iagctl/delete-decorator.md) - [iagctl delete executable-object](https://docs.itential.com/itential-gateway/iagctl/delete-executable-object.md) - [iagctl delete registry](https://docs.itential.com/itential-gateway/iagctl/delete-registry.md) - [iagctl delete repository](https://docs.itential.com/itential-gateway/iagctl/delete-repository.md) - [iagctl delete secret](https://docs.itential.com/itential-gateway/iagctl/delete-secret.md) - [iagctl delete secret-provider](https://docs.itential.com/itential-gateway/iagctl/delete-secret-provider.md) - [iagctl delete service](https://docs.itential.com/itential-gateway/iagctl/delete-service.md) - [iagctl delete user](https://docs.itential.com/itential-gateway/iagctl/delete-user.md) - [iagctl describe decorator](https://docs.itential.com/itential-gateway/iagctl/describe-decorator.md) - [iagctl describe executable-object](https://docs.itential.com/itential-gateway/iagctl/describe-executable-object.md) - [iagctl describe registry](https://docs.itential.com/itential-gateway/iagctl/describe-registry.md) - [iagctl describe repository](https://docs.itential.com/itential-gateway/iagctl/describe-repository.md) - [iagctl describe secret](https://docs.itential.com/itential-gateway/iagctl/describe-secret.md) - [iagctl describe secret-provider](https://docs.itential.com/itential-gateway/iagctl/describe-secret-provider.md) - [iagctl describe service](https://docs.itential.com/itential-gateway/iagctl/describe-service.md) - [iagctl describe user](https://docs.itential.com/itential-gateway/iagctl/describe-user.md) - [iagctl get decorators](https://docs.itential.com/itential-gateway/iagctl/get-decorators.md) - [iagctl get executable-object](https://docs.itential.com/itential-gateway/iagctl/get-executable-object.md) - [iagctl get registries](https://docs.itential.com/itential-gateway/iagctl/get-registries.md) - [iagctl get repositories](https://docs.itential.com/itential-gateway/iagctl/get-repositories.md) - [iagctl get runners](https://docs.itential.com/itential-gateway/iagctl/get-runners.md) - [iagctl get secrets](https://docs.itential.com/itential-gateway/iagctl/get-secrets.md) - [iagctl get secret-providers](https://docs.itential.com/itential-gateway/iagctl/get-secret-providers.md) - [iagctl get services](https://docs.itential.com/itential-gateway/iagctl/get-services.md) - [iagctl get users](https://docs.itential.com/itential-gateway/iagctl/get-users.md) - [iagctl hostkeys add](https://docs.itential.com/itential-gateway/iagctl/hostkeys-add.md) - [iagctl hostkeys clear](https://docs.itential.com/itential-gateway/iagctl/hostkeys-clear.md) - [iagctl hostkeys remove](https://docs.itential.com/itential-gateway/iagctl/hostkeys-remove.md) - [iagctl hostkeys scan](https://docs.itential.com/itential-gateway/iagctl/hostkeys-scan.md) - [iagctl inspect cluster](https://docs.itential.com/itential-gateway/iagctl/inspect-cluster.md) - [iagctl inspect cluster activity](https://docs.itential.com/itential-gateway/iagctl/inspect-cluster-activity.md) - [iagctl inspect cluster health](https://docs.itential.com/itential-gateway/iagctl/inspect-cluster-health.md) - [iagctl mcp server add](https://docs.itential.com/itential-gateway/iagctl/mcp-server-add.md) - [iagctl mcp server inspect](https://docs.itential.com/itential-gateway/iagctl/mcp-server-inspect.md) - [iagctl mcp server list](https://docs.itential.com/itential-gateway/iagctl/mcp-server-list.md) - [iagctl mcp server remove](https://docs.itential.com/itential-gateway/iagctl/mcp-server-remove.md) - [iagctl mcp tool call](https://docs.itential.com/itential-gateway/iagctl/mcp-tool-call.md) - [iagctl mcp tool list](https://docs.itential.com/itential-gateway/iagctl/mcp-tool-list.md) - [iagctl login](https://docs.itential.com/itential-gateway/iagctl/login.md) - [iagctl run service ansible-playbook](https://docs.itential.com/itential-gateway/iagctl/run-service-ansible-playbook.md) - [iagctl run service executable](https://docs.itential.com/itential-gateway/iagctl/run-service-executable.md) - [iagctl run service opentofu-plan](https://docs.itential.com/itential-gateway/iagctl/run-service-opentofu-plan.md) - [iagctl run service python-script](https://docs.itential.com/itential-gateway/iagctl/run-service-python-script.md) - [iagctl runner](https://docs.itential.com/itential-gateway/iagctl/runner.md) - [iagctl server](https://docs.itential.com/itential-gateway/iagctl/server.md) - [iagctl version](https://docs.itential.com/itential-gateway/iagctl/version.md) - [Release notes overview](https://docs.itential.com/itential-gateway/release-notes/overview.md): Release notes for all Itential Gateway 5.x versions, including feature releases and maintenance releases. - [Itential Gateway changelog](https://docs.itential.com/itential-gateway/release-notes/changelog.md): How to stay informed about Gateway 5 releases. - [Changelog (all entries)](https://docs.itential.com/itential-gateway/release-notes/changelog/llms.txt) - [Gateway 5.5.0 feature announcement](https://docs.itential.com/itential-gateway/release-notes/feature-announcements/550.md): Highlights for the Gateway 5.5 release. - [Gateway 5.4.0](https://docs.itential.com/itential-gateway/release-notes/540-feature-announcement.md): Overview of new features and improvements in Gateway 5.4, including cluster inspection commands, virtual environment pruning, Python boolean flag support, CLI config file profiles, integration execution on gateway, and extended OpenTofu support. - [Gateway 5.3.0](https://docs.itential.com/itential-gateway/release-notes/530-feature-announcement.md): Overview of new features and improvements in Gateway 5.3.0, including Inventory Manager support and executable services. - [Gateway 5.2.0 feature announcement](https://docs.itential.com/itential-gateway/release-notes/520-feature-announcement.md): Feature announcement Itential Gateway 5.2, including new features, improvements, and fixes. - [Gateway 5.1.0 feature announcement](https://docs.itential.com/itential-gateway/release-notes/510-feature-announcement.md): New features, improvements, and fixes completed in Itential Gateway 5.1. - [Gateway Manager 1.0.0 feature release](https://docs.itential.com/itential-gateway/release-notes/gateway-manager-feature-announcement.md): New features, improvements, and fixes completed in Gateway Manager 1.0.0. - [Itential Gateway 5.5.0 open source notice](https://docs.itential.com/itential-gateway/release-notes/open-source-notices/5-5-0.md): List of open source license notices related to Itential Gateway 5.5.0. - [Itential Gateway 5.4.1 open source notice](https://docs.itential.com/itential-gateway/release-notes/open-source-notices/5-4-1.md): List of open source license notices related to Itential Gateway 5.4.1.