Update CSV description to comply with guidelines #374
Conversation
Signed-off-by: Gary Brown <gary@brownuk.com>
|
@JStickler would you be able to review? |
There was a problem hiding this comment.
@objectiser just a couple of comments and questions. Other than this, looks good.
|
|
||
| * **Multiple modes** - Supports `allInOne`, `production`, and `streaming` [modes of deployment](https://github.com/jaegertracing/jaeger-operator#strategies). | ||
|
|
||
| * **Configuration** - Directly pass down all supported Jaeger configuration through the Operator. | ||
|
|
||
| * **Storage** - Configure storage used by Jaeger. By default, `memory` is used. | ||
| * **Storage** - Configure storage used by Jaeger. By default, `memory` is used. Other options include `elasticsearch` or `cassandra`. On openshift, the operator can delegate creation of an Elasticsearch cluster to the Elasticsearch Operator if deployed. |
There was a problem hiding this comment.
Since this is the community template, should the reference to OpenShift be to OKD instead since that is the upstream community? (If not, then camelcase OpenShift please.)
There was a problem hiding this comment.
Want to minimise the differences between the CSVs, so will use OpenShift as a general term.
| * **Storage** - Configure storage used by Jaeger. By default, `memory` is used. | ||
| * **Storage** - Configure storage used by Jaeger. By default, `memory` is used. Other options include `elasticsearch` or `cassandra`. On openshift, the operator can delegate creation of an Elasticsearch cluster to the Elasticsearch Operator if deployed. | ||
|
|
||
| * **Agent** - can be deployed as sidecar and/or daemonset |
|
|
||
| ### Before you start | ||
|
|
||
| 1. Ensure that the appropriate storage solution, that will be used by the Jaeger instance, is available and configured |
| ### Before you start | ||
|
|
||
| 1. Ensure that the appropriate storage solution, that will be used by the Jaeger instance, is available and configured | ||
| 1. If intending to deploy an Elasticsearch cluster via the Jaeger custom resource, then the Elasticsearch Operator must first be installed. |
There was a problem hiding this comment.
Should this be numbered as 2? Also "If you intend to deploy...."
Signed-off-by: Gary Brown <gary@brownuk.com>
Codecov Report
@@ Coverage Diff @@
## master #374 +/- ##
==========================================
- Coverage 90.01% 89.71% -0.31%
==========================================
Files 64 64
Lines 3076 3093 +17
==========================================
+ Hits 2769 2775 +6
- Misses 207 216 +9
- Partials 100 102 +2
Continue to review full report at Codecov.
|
Signed-off-by: Gary Brown <gary@brownuk.com>
|
@JStickler Thanks. Merging as codecov issue is unrelated to this PR. |
Signed-off-by: Gary Brown gary@brownuk.com