Gremlin Spoke

  • Release version: Yokohama
  • Updated January 30, 2025
  • 3 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Gremlin Spoke

    The Gremlin Spoke enables ServiceNow customers to simulate outages and manage attack scenarios directly from their ServiceNow instance by integrating with their Gremlin platform. This functionality helps organizations automate chaos engineering and attack management tasks within their IT workflows. Note that starting with the Yokohama release, Gremlin Spoke is being prepared for future deprecation and will no longer be activated on new instances, although it remains supported. Customers are encouraged to explore the Spoke Generator as the modern alternative.

    Show full answer Show less

    Key Features

    • Attack Management Actions: Create and manage attacks, retrieve attack details and executions, halt all active attacks, and list attacks on the Gremlin platform.
    • Attack Schedule Management: Create, delete, get details, and list active attack schedules, respecting the ServiceNow instance time zone for scheduling accuracy.
    • Data Retrieval Limits: By default, responses are limited to 5 MB, configurable up to 10 MB. Customers can specify the number of records to retrieve to manage payload sizes effectively.
    • Integration Hub Subscription Required: The spoke requires a valid Integration Hub subscription to function.
    • Connection Management: Uses Integration Hub connection and credential aliases to simplify management across multiple environments and reduce maintenance when credentials change.

    Prerequisites and Requirements

    • Admin access to the Gremlin dashboard and an existing team within the Gremlin account for integration.
    • Team ID and API Key for authentication, obtained via signature-based authentication.
    • Installation of dependent ServiceNow plugins including IntegrationHub Runtime, Complex Object, Flow Designer - Dynamic Inputs, and IntegrationHub Action Step - REST. Some require licenses.
    • Gremlin Spoke version 1.0.3 or later and compatibility with Gremlin platform version 1, possibly later versions.
    • Gremlin license must permit access to relevant Gremlin features to enable corresponding spoke actions in ServiceNow.

    Practical Considerations for ServiceNow Customers

    • Plan for eventual migration away from Gremlin Spoke due to upcoming deprecation; monitor ServiceNow communications about the Spoke Generator replacement.
    • Configure data retrieval limits and record counts thoughtfully to avoid errors from large payloads.
    • Ensure proper connection and credential setup via Integration Hub aliases to streamline maintenance and support multi-environment use.
    • Verify that your Gremlin license aligns with the features you intend to use through the ServiceNow spoke to avoid functionality gaps.

    Simulate outages and manage attacks using Gremlin instance from your ServiceNow instance.

    Important:

    Starting with the Yokohama release, Gremlin Spoke is being prepared for future deprecation. It will be hidden and no longer activated on new instances but will continue to be supported. Spoke Generator provides the latest experience for this functionality.

    For details, see the Deprecation Process [KB0867184] article in the Now Support knowledge base.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Integration Hub subscription

    This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.

    Spoke version

    Gremlin spoke v1.0.3 is the latest version.

    Supported versions

    This spoke was built for Gremlin version v1, but may be compatible with later versions.

    Spoke requirements

    • Set up clients as per your requirement.
    • Admin access to the Gremlin dashboard.
    • Team in your Gremlin account for integration with ServiceNow instance. For more information about creating teams, see Teams.
    • Team ID and API Key of the team. Copy and record these value for later use. For more information about accessing these values, see the Signature-based Authentication section.

    Spoke dependencies

    If you’re having trouble installing the app, ensure that these dependent plugins are installed:
    • ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
    • Complex Object (com.glide.cobject)
    • ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
    • ServiceNow IntegrationHub Action Step - REST (com.glide.hub.action_step.rest)
    Note:
    Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.

    Spoke actions

    The Gremlin spoke provides actions to automate Gremlin tasks when events occurs in your ServiceNow instance. Available actions include:

    Category Action Description
    Attack Management Create Attack Creates an attack on the Gremlin platform.
    Get Attack Details Retrieves details about an attack.
    Get Attack Executions Retrieves a list of executions associated with an attack.
    Halt All Attacks Idempotently halts all active attacks across the Gremlin platform.
    Look up Attacks Lists all attacks on the Gremlin platform.
    Note:
    • By default, this action can retrieve data up to 5 MB. You can configure the glide.pf.rest.response_payload_max_size property to retrieve data up to 10 MB. If the data in the response is more 10 MB, an error is displayed.
    • As data up to 10 MB only can be retrieved, you can also specify number of records that should be retrieved in the input field, Number of records to return.
    Attack Schedule Management Create Attack Schedule Creates an attack schedule on the Gremlin platform.
    Delete Attack Schedule Deletes the specified attach schedule.
    Get Attack Schedule Details Retrieves details about the specified attack schedule.
    Look up Active Attack Schedules Lists all the attack schedules on the Gremlin platform.
    Note:
    • Time zone that is considered in the spoke actions, is same as the time zone of your ServiceNow instance.
    • Based on your Gremlin license, if you don't have access to certain Gremlin functionality, you can't use the associated spoke actions in your ServiceNow instance as well.
    • For some arguments that take True or False as input, the actual value that the Gremlin platform considers, might be different from the value you have provided.

    Connection and credential alias requirements

    Integration Hub uses aliases to manage connection and credential information, and OAuth credentials. Using an alias eliminates the need to configure multiple credentials and connection information profiles when using multiple environments. If the connection or credential information changes, you don't need to update any actions that use the connection.

    For information about setting up the spoke, see Create Connection and Credential record for the Gremlin spoke.