docs: Add operator to the README.md #201
Conversation
danielpacak
force-pushed
the
add_operator_to_readme
branch
2 times, most recently
from
e12a127 to
2eb7069
Compare
danielpacak
force-pushed
the
add_operator_to_readme
branch
from
2eb7069 to
f8b766f
Compare
Codecov Report
@@ Coverage Diff @@
## master #201 +/- ##
=======================================
Coverage 34.36% 34.36%
=======================================
Files 42 42
Lines 2072 2072
=======================================
Hits 712 712
Misses 1244 1244
Partials 116 116 Continue to review full report at Codecov.
|
There was a problem hiding this comment.
I'm wondering what we should do with the Installation, Getting Started & Next Steps sections.
- I think it makes sense to Get Started with the command line tool and then move on to trying the operator when you see what Starboard is all about. Maybe we should explicitly suggest that?
- We need installation instructions for the operator, I think?
| $ starboard kube-hunter -h | ||
| ``` | ||
|
|
||
| ### Configuration |
There was a problem hiding this comment.
Am I right to think that the Starboard operator will create the vulnerabilityreports CRD - no need to run starboard init first?
There was a problem hiding this comment.
It depends how we install the operator. With OLM the OLM operator is taking care of creating CRDs, which are part of the installation bundle. For helm or kubecly apply installations we have to create the CRDs manually or use the init command.
In general, as a good practice the operator should not create the CRDs that it manages.
There was a problem hiding this comment.
Helm will install them if they dont already excist now, but not as the other resources. It will also not try to update them or similarly if, just warn about it if needed.
There was a problem hiding this comment.
This is great that a Helm chart package now supports CRDs that are installed before a Helm release is created. Even though it's not as powerful and automated as OLM, it's useful in case of Helm chart installation option
danielpacak
force-pushed
the
add_operator_to_readme
branch
2 times, most recently
from
0014ff1 to
c9e9cb2
Compare
README.md
Outdated
|
|
||
| Helm, which is de facto standard package manager for Kubernetes, allows installing applications from parameterized | ||
| YAML manifests called Helm charts. To address shortcomings of static YAML manifest we'll provide a Helm chart to deploy | ||
| the Starboard operator. See [#187](https://github.com/aquasecurity/starboard/issues/187) to check the progress on that. |
There was a problem hiding this comment.
I suggest to let the static resources be generated from the Helm chart in the future. See #211
There was a problem hiding this comment.
I totally agree @consideRatio Once we merge the Helm chart, we'll remove static manifests from ./deploy/static/*.yaml and update the docs to use the helm template command for those who cannot use Helm CLI
danielpacak
force-pushed
the
add_operator_to_readme
branch
from
c9e9cb2 to
33c3655
Compare
danielpacak
force-pushed
the
add_operator_to_readme
branch
2 times, most recently
from
affe516 to
dcb5c8a
Compare
Signed-off-by: Daniel Pacak <pacak.daniel@gmail.com>
danielpacak
force-pushed
the
add_operator_to_readme
branch
from
dcb5c8a to
e4b53a9
Compare
Co-authored-by: Liz Rice <liz@lizrice.com>
Signed-off-by: Daniel Pacak pacak.daniel@gmail.com