Installing Gremlin on Windows
General steps for deploying the Gremlin Agent on Windows:
Gather your credentials
All Gremlin integration installations require authentication with the Gremlin Control Plane. We recommend using the Client Configuration File method, as it contains everything needed to authenticate and configure the Gremlin Agent in one file. To create and download a client configuration file:
- Open the Settings page in the Gremlin web app.
- Under Team Settings, select Details.
- On the Client Configuration File line, click Download to download the file. You'll receive a file named
config.yaml. - Optionally, make any additional configurations to the
config.yamlfile.
If you wish to use another method of authenticating, see the Authentication docs.
Install the Gremlin Agent
Run the following from an elevated command prompt and continue through the installation wizard:
To automate the installation (e.g. for auto-deploying Gremlin onto new instances), use the following command:
Configure Gremlin
The minimum configuration required to authenticate the Gremlin Agent is:
- Team ID
- Secret or certificate
If you downloaded a client configuration file, you already have everything needed to register the Agent. Just follow these instructions:
Validate the installation
There are two ways to ensure your installation was successful and your Agents authenticated successfully:
Check the Gremlin web app
The easiest way to verify connectivity is to open the Agents list in the Gremlin web app. Check for your newly installed Agent by its identifier (by default, the host's IP address) or by tag, such as its local-hostname tag. You can also use the search box to search by name or tag, Agent version, operating system (OS), or region. If your Agent does not appear in this list, it may not have been installed or configured correctly, or it might not be able to reach Gremlin's servers.
Check the Gremlin Agent
First, verify that the Gremlin Agent is running on the target system:
This should return the following:
If the service is instead reporting as inactive or failed, try restarting the service using:
After verifying that the Gremlin Agent is running, use gremlin check auth to check the Gremlin Agent's authentication status:
If the Gremlin Agent authenticated successfully, the output will be similar to the following:
If not, the output will explain why the Gremlin Agent was unable to authenticate. This example output is from a Linux host; on Windows, the .credentials file is located at C:\ProgramData\Gremlin\Agent\.credentials.
Once your Agent shows as Active, run your first experiment against it. See How to run an experiment.
Troubleshooting
If the Agent is connected but is reporting as unhealthy, see Troubleshooting Unhealthy State in the Gremlin Knowledge Base. If you're having trouble authenticating, see the Authentication FAQ in the Gremlin Knowledge Base for possible causes and solutions.
Uninstalling Gremlin from Windows
To uninstall the Gremlin Windows agent, run the following PowerShell command from an elevated command prompt: