Enabling GraphiQL

You can enable GraphiQL for development environment and for troubleshooting purposes in production environment.

Procedure

  1. Open the custom resource and navigate to the graphql_production_setting subsection.
  2. Edit the enable_graph_iql setting to enable the GraphiQL UI.
    Set enable_graph_iql to true for development environments or for debugging mode only in production environments. False is recommended for production environments.
    Important: Entering development or debugging mode exposes your environment to XSRF/CSRF security vulnerabilities. To secure your environment against CSRF/XSRF attacks while GraphiQL is enabled, see the topic Enabling XSRF validation with GraphiQL enabled. 
    ecm_configuration:
  graphql:
    graphql_production_setting:
      enable_graph_iql: true

    If your application is already deployed in production mode, you can temporarily enable GraphIQL for troubleshooting purposes. To enable GraphiQL, modify the setting in the custom resource and apply the modified custom resource to your namespace. Wait for the operator reconcile to change the GraphQL deployment. Later, if you want to clear your selection to enter production mode again, you must redeploy your application to make sure that the application is secure.