Add Splunk documentation #386
Conversation
Deploying contributing-docs with
|
| Latest commit: |
e18109e
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f19dbaf6.contributing-docs.pages.dev |
| Branch Preview URL: | https://splunk.contributing-docs.pages.dev |
|
No New Or Fixed Issues Found |
|
This would be a new direction for us, to keep these sorts of documents here vs. in the repo READMEs. I think I like that and it becomes a centralization point, plus keeps our repos light in that content so we can better manage it with best practices here. There are quite a few integration-style repos out there though, especially for Secrets Manager, that could use this treatment. |
| - Python 3.8 or 3.9 | ||
| - [Poetry][poetry] | ||
| - libmagic (macOS only), available via homebrew: `brew install libmagic` | ||
| - A Bitwarden server with event logging configured and an enterprise organization. To set this up |
There was a problem hiding this comment.
- Event logging works out of the box, there is nothing to configure - unless it's some custom self-hosted setup, which does not have event logging enabled.
- Event logging works on any business plan, including Teams - makes me wonder if this does belongs to the "Enterprise" section 🤔
There was a problem hiding this comment.
- event logging - that's true, I've amended this to be more specific. Many devs, myself included, just run the minimum api & identity projects when developing day-to-day, so I want to highlight the additional requirements here
- plan requirements - also true! I've fixed this. The "Enterprise" category is meant to describe enterprise use (business use), not the enterprise plan specifically, maybe it could be better named. Directory Connector is under this category and that is also compatible with Teams plans.
| 3. Activate the poetry shell: | ||
|
|
||
| ``` | ||
| poetry shell | ||
| ``` | ||
|
|
||
| 4. Tell poetry to use the required Python version: | ||
|
|
||
| ``` | ||
| poetry env use <executable> | ||
| ``` | ||
|
|
||
| Where `<executable>` is the executable for Python 3.8 or 3.9. If this is in your PATH variable | ||
| then you do not need to specify the full path. e.g. `poetry env use python3.8` | ||
|
|
There was a problem hiding this comment.
i just did a fresh test and i think this should be the other way around.
We firstly tell poetry to create the virtual environment for the python version we want to use.
And then we activate it with poetry shell
|
|
||
| - Docker. If you're using an Apple Silicon Mac, enable _Docker Desktop_ -> _Settings_ -> _General_ | ||
| -> _Use Rosetta for x86_64/amd64 emulation on Apple Silicon_ | ||
| - Python 3.8 or 3.9 |
There was a problem hiding this comment.
I have just tested other python versions and it works fine with 3.7-3.10
In 3.11 and 3.12 the ./package.sh step produces an error during splunk-appinspect package validation - looks like the splunk tooling is not compatible with never versions of python.
Also let's add 3.7, even though it's EOL, since it's it is still supported by Splunk.
| - Python 3.8 or 3.9 | |
| - Python 3.7-3.10 |
There was a problem hiding this comment.
LGTM.
One note, i find the "Enterprise" section without any explanation on where it applies a bit confusing, since SIEM works for Team plan too, so it should be overall labeled as "Business". Maybe it's about time to rename it or add a dedicated page that explains in one word to which this applies to ?
|
I've renamed the section to "Business", I agree that's clearer and matches the Personal/Business distinction on our plans page, for example. |
There was a problem hiding this comment.
Can't say anything about the setup process of the splunk integration as I haven't worked with it, yet. Changes are looking good though and can be refined in the future in case @mzieniukbw has any comments.
🎟️ Tracking
N/A
📔 Objective
Continue my PR from here: bitwarden/splunk#54 while moving it to this repository so it can live with the rest of our documentation.
I have:
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes