docs(1672): initial hosted runner and mimecast plugin docs#1827
docs(1672): initial hosted runner and mimecast plugin docs#1827nic-osullivan-gravwell wants to merge 7 commits intogravwell:next-minorfrom
Conversation
configuration/configuration.md
Outdated
| (hosted_runner_configuration)= | ||
| ## Hosted Runner Configuration | ||
|
|
||
| The Hosted Runner is a shared process can run a number of different plugins. Rather than deploying a separate service for each integration, all hosted plugins are configured in a single file — typically `/opt/gravwell/etc/hosted_runner.conf` — and run together under one process. This reduces the infrastructure cost of lighter weight processes. |
There was a problem hiding this comment.
The config file is still hosted_ingesters.conf in code, but that will be updated before release.
ingesters/mimecast.md
Outdated
| | `Client-Secret` | String | | **Yes** | OAuth 2.0 client secret from your Mimecast API 2.0 integration. | | ||
| | `Api` | String | | **Yes** | The Mimecast API to poll. Can be specified multiple times. See [Available APIs](#available-apis). | | ||
| | `Host` | URL | `https://api.services.mimecast.com` | No | The Mimecast API base URL. Override for regional endpoints or testing. | | ||
| | `Lookback` | Integer (hours) | `24` | No | How far back in time to fetch events on first run. | |
There was a problem hiding this comment.
Is there any limit to how far back they can go?
There was a problem hiding this comment.
Yeah the batch api has a 7 day limit and the non batch has a 24hour limit. I'll update the docs once we land on which we're using.
| @@ -0,0 +1,13 @@ | |||
| services: | |||
There was a problem hiding this comment.
not really sure why we need this?
this seems pretty trivial to do with the README instructions in this repo
There was a problem hiding this comment.
I had issues with nix-shell on my mac and this is what I fell back to and was helpful so figured I'd just add it for others to use if desired.
ashnwade
left a comment
ashnwade
left a comment
There was a problem hiding this comment.
If you look at other ingester pages for consistency, it looks like they are not wrapping the parameters in backticks when listing them in tables. PTAL at similar pages for style consistency.
Co-authored-by: Ashley Wade <107071905+ashnwade@users.noreply.github.com>
2 participants
This PR addresses https://github.com/gravwell/issues/issues/1672
This PR proposes...
Adding docs for the new hosted runner and mimecast plugin.
PR Tasks
Reviewer Tasks