All Apps and Add-ons

How to enable debug refresh for all users in Add-on Debug Refresh?

thol
Explorer

Is there a way we can enable this for all or certain group of users? Currently, only admin users can use this add-on.

0 Karma
1 Solution

MuS
Legend

Hi thol,

there is no point in granting users access to the refresh command because only the admin role can actually perform the _reload on REST endpoints.
BTW, you should not use this command in a production environment for reasons 😉

Hope this helps ...

cheers, MuS

View solution in original post

chaker
Contributor

I did not test this with the App, but you can provide non admin access to the /debug/refresh endpoint with the following role:

MyRole:
Inherits from user

Selected Capabilities:
refresh_application_license
web_debug

0 Karma

MuS
Legend

While you can do such a thing, I would really recommend against it - there are reasons why this URI or the REST endpoints are not available to the users 😉

cheers, MuS

0 Karma

mmccul_fe
Explorer

Dev search head, power users will be doing many updates, and the admin cannot get in the way of updates. Since even the Splunk admins are not full admin role, to prevent them from editing certain things in the GUI, and forcing use of git for changes, not documenting this clearly is a Bad Idea(tm)

0 Karma

MuS
Legend

The original answer states you should not use it in prod environments 😉
Dev SH are best run with this settings in web.conf

[settings]
 js_no_cache = true
 cacheBytesLimit = 0
 cacheEntriesLimit = 0
 max_view_cache_size = 0
 auto_refresh_views = 1

Regarding the not documentation , you can find everything in the docs here https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTaccess#Usage_details every REST entity with a _reload endpoint will be reloaded by either using /debug/refresh or the | refresh command.

cheers, MuS

0 Karma

MuS
Legend

Hi thol,

there is no point in granting users access to the refresh command because only the admin role can actually perform the _reload on REST endpoints.
BTW, you should not use this command in a production environment for reasons 😉

Hope this helps ...

cheers, MuS

MuS
Legend

Update:

there will be soon an update to the app released which works on Splunk 7.1.x. It also features the option to only reload one specific entity, and can now be used in production environment because it excludes by default certain entities.

Link to the app: https://splunkbase.splunk.com/app/1871/#/details

cheers, MuS

0 Karma

chaker
Contributor

You can use the App's sharing permissions to control it, but there is no control on who can paste "en-US/debug/refresh" into their Splunk session.

MuS
Legend

Sorry to say, but this is twice wrong:

  1. changing the app permission will not grant the user capabilities to reload a REST endpoint
  2. you are right that anyone can access the URI /debug/refresh but without the capabilities to actually reload the REST endpoint you will get this error:

    This XML file does not appear to have any style information associated with it. The document tree is shown below.


    Forbidden

cheers, MuS

0 Karma

chaker
Contributor

Neat, I recall having a different experience on an earlier version.

So would a simpler answer be to use the rest_properties_get and rest_properties_set capabilities to control access by role?

Or is that thrice wrong? XD

0 Karma

MuS
Legend

HeHE, yep, the third wrong 😄 those two capabilities are already assigned to the user role by default. The easiest way to get the exact capability needed is try them one by one. I cannot be of much help since I don't have the time to test it right now ...

0 Karma
Get Updates on the Splunk Community!

Introducing the 2024 SplunkTrust!

Hello, Splunk Community! We are beyond thrilled to announce our newest group of SplunkTrust members!  The ...

Introducing the 2024 Splunk MVPs!

We are excited to announce the 2024 cohort of the Splunk MVP program. Splunk MVPs are passionate members of ...

Splunk Custom Visualizations App End of Life

The Splunk Custom Visualizations apps End of Life for SimpleXML will reach end of support on Dec 21, 2024, ...