Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

⚓️ Integrate with OpenDistro as alternative to elasticsearch #365

Open
8 tasks
rseedorff opened this issue Apr 10, 2021 · 3 comments
Open
8 tasks

⚓️ Integrate with OpenDistro as alternative to elasticsearch #365

rseedorff opened this issue Apr 10, 2021 · 3 comments
Labels
persistence Implement or update a persistence store

Comments

@rseedorff
Copy link
Member

⚓️ New Hook implementation request

Is your feature request related to a problem

As secureCodeBox User I would like to use the open distro solution as alternative to Elasticsearch.

Describe the solution you'd like

Please integrate https://opendistro.github.io/for-elasticsearch-docs

Describe alternatives you've considered

Additional context

Steps to implement a new hook

Hint: A general guide how to implement a new SCB Hook is documented here

  • Create a new folder with the name of the hook here
  • Add a README.md and give a brief overview of the scanner and its configuration options.
  • Add a HelmChart and document all configuration options.
  • Add (optional) a Dockerfile for the scanner if there is no existing one publicly available on dockerHub.io
  • Use the Hook-SDK to implement a new hook (currently based on NodeJS)
  • Add unit tests with at minimum 80% test coverage
  • Add some example scan.yaml and finding.yaml files in the example folder
  • Implement a new integration or E2E test for the hook here
@rseedorff rseedorff added hook Implement or update a hook persistence Implement or update a persistence store labels Apr 10, 2021
@rseedorff rseedorff added this to To do in secureCodeBox v2 via automation Apr 10, 2021
@rseedorff rseedorff changed the title Integrate with OpenDistro as alternative to elasticsearch ⚓️Integrate with OpenDistro as alternative to elasticsearch Apr 10, 2021
@rseedorff rseedorff removed the hook Implement or update a hook label Apr 10, 2021
@rseedorff rseedorff changed the title ⚓️Integrate with OpenDistro as alternative to elasticsearch ⚓️ Integrate with OpenDistro as alternative to elasticsearch Apr 16, 2021
@J12934
Copy link
Member

J12934 commented Apr 16, 2021

Haven't tested this, but should this work with the normal elasticsearch hook? API should be largely the same, as far as I know.

@rseedorff
Copy link
Member Author

I haven't tested this yet but it should work (hopefully). As our HelmChart depends on elasticsearch and also installs the sub chart for elasticsearch and Kibana we might think about switching that or add a second alternative based on opendistro.

elasticsearch:
  # elasticsearch.enabled -- Enable if you want to deploy an elasticsearch service.
  enabled: true

kibana:
  # kibana.enabled -- Enable if you want to deploy an kibana service (see: https://github.com/elastic/helm-charts/tree/master/kibana)
  enabled: true

@rseedorff rseedorff removed this from To do in secureCodeBox v2 Jun 18, 2021
secureCodeBoxBot added a commit that referenced this issue Nov 18, 2021
Signed-off-by: secureCodeBoxBot <securecodebox@iteratec.com>
## Release changes :
## Summary
 
 CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTORS.md DCO LICENSE LICENSES Makefile README.md SECURITY.md UPGRADING.md Vagrantfile auto-discovery bin common.mk demo-targets docs hook-sdk hooks hooks.mk lurker operator package-lock.json package-lock.json.license package.json package.json.license parser-sdk scanners scanners.mk sdk.mk tests Adds support for `Job` resources - thank you @superbrothers for this contribution!
 CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTORS.md DCO LICENSE LICENSES Makefile README.md SECURITY.md UPGRADING.md Vagrantfile auto-discovery bin common.mk demo-targets docs hook-sdk hooks hooks.mk lurker operator package-lock.json package-lock.json.license package.json package.json.license parser-sdk scanners scanners.mk sdk.mk tests Adds option to disable colour output when using `pretty` formatting (package only)
 CODE_OF_CONDUCT.md CONTRIBUTING.md CONTRIBUTORS.md DCO LICENSE LICENSES Makefile README.md SECURITY.md UPGRADING.md Vagrantfile auto-discovery bin common.mk demo-targets docs hook-sdk hooks hooks.mk lurker operator package-lock.json package-lock.json.license package.json package.json.license parser-sdk scanners scanners.mk sdk.mk tests Enabled Dependabot and updates dependencies
 
 ## Changelog
 
 b68cabd Update version to 0.15.0 (#372)
 7f54326 Bump github.com/jetstack/cert-manager from 1.6.0 to 1.6.1 (#371)
 9cdecb3 Bump k8s.io/apiextensions-apiserver from 0.22.2 to 0.22.3 (#368)
 6cc7a75 Add support for kind Job (#370)
 0ef3005 Bump github.com/jetstack/cert-manager from 1.5.4 to 1.6.0 (#365)
 e5c797a Bump k8s.io/apimachinery from 0.22.2 to 0.22.3 (#369)
 d597928 Bump k8s.io/apiextensions-apiserver from 0.21.3 to 0.22.2 (#362)
 79cce8c Remove wip probot (#364)
 700c39f Bump github.com/jetstack/cert-manager from 1.4.1 to 1.5.4 (#363)
 fe44171 Fix dependabot (#358)
 374a428 Support parsing for server specs (#356)
 50c618b Add Support for Services (#353)
 7b57f85 Update dependencies and add dependabot (#354)
 2d8282c Make k8s and override packages public (#351)
 47c31d5 Add option to disable printing results in color (#350)
 ca64457 Remove deprecated mountds auditor (#349)
 863e367 Remove example dependency on internal packages (#348)
 
 
 ## Docker images
 
 - `docker pull shopify/kubeaudit:latest`
 - `docker pull shopify/kubeaudit:0.15.0`
 - `docker pull shopify/kubeaudit:v0.15`
@J12934
Copy link
Member

J12934 commented Jun 28, 2023

I'd said it's probably best for us to only have either elasticsearch or opendistro included in the helm chart and and only provide the option to switch that one on or off.

If a users wants to really use the non default options they probably know better than us how to run it properly. They would then simply have to turn of the default one and configure the connection.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
persistence Implement or update a persistence store
Projects
None yet
Development

No branches or pull requests

2 participants