JBOD support documentation #1280
Conversation
|
I am still working on it but having a WIP is better for starting to fix the comments. |
| # ... | ||
| ---- | ||
|
|
||
| It is not possible to change the `id` property for a volume. |
There was a problem hiding this comment.
This statement seems a little ambiguous. Did you mean the following: "It is not possible to change the id property for a volume after it is provisioned"?
Do the id properties need to be set to 0, 1, 2, 3, 4 etc. in ascending order?
There was a problem hiding this comment.
Yes, to both the questions :-)
There was a problem hiding this comment.
Thanks. I just need to update that sentence before the PR is merged.
|
Peer reviewed the content by checking out the remote branch. @ppatierno - please can you check it over, thanks. |
| Storage can be configured using the `storage` property in following resources: | ||
| NOTE: JBOD storage is only supported for Kafka, not for Zookeeper. | ||
|
|
||
| When configuring a `kafka` resource, you can specify the type of storage used by the Kafka broker and its corresponding Zookeeper node. You configure the storage type using the `storage` property in the following resources: |
There was a problem hiding this comment.
Kafka has to be with capital K it's about the kind of the resource, it's not the property spec.kafka
|
|
||
| The JBOD storage allows you to provide more volumes to the Kafka brokers to store data. | ||
| As well as providing more storage, using multiple disks can improve performance. | ||
| You can configure {ProductName} to use Just a Bunch of Disks (JBOD), a data storage configuration in which multiple disks are combined to create a single logical disk, or volume. JBOD is one approach to providing increased data storage for Kafka brokers. It can also improve performance. |
There was a problem hiding this comment.
in the other commit, you used the other way around ... JBOD (Just a Bunch of Disks), isn't it better to be consistent?
There was a problem hiding this comment.
Yes! Be Consistent! :) But Just a Bunch of Disks (JBOD) is the order it should be displayed in. So I'd change the other section referenced.
There was a problem hiding this comment.
@ncbaratta tbh I think that all developers/engineers refer to it as JBOD more than "Just a Bunch of Disks". I would refer it as JBOD and the having the acronym explained in parenthesis ... so quite the opposite you said :P
There was a problem hiding this comment.
If most developers just know what it is then I'd remove the spelled out name. If people don't refer to it that way, then we don't have to define it at all.
There was a problem hiding this comment.
Good discussion here :). I think I'll remove the spelled out name.
There was a problem hiding this comment.
Maybe we can remove the spelled out name here but I would still have it in the assembly-storage.adoc file.
| storage: | ||
| type: jbod | ||
| # ... | ||
| ---- |
There was a problem hiding this comment.
I don't see any reason for having this "empty" example just setting the storage jbod type without volumes, because it cannot work.
There was a problem hiding this comment.
Hmm, I see your point. I just wanted to call out the relevant type. I'll remove it.
| @@ -34,10 +40,13 @@ storage: | |||
| # ... | |||
| ---- | |||
|
|
|||
| It is not possible to change the `id` property for a volume. | |||
| It is not possible to add or remove volumes from a JBOD storage configuration. | |||
| Do not change the `id` property of a JBOD volume. | |||
There was a problem hiding this comment.
Tbh the statement I used sounded clearer than this one. We should say that after volumes creation with some ids, they cannot be changed anymore.
|
|
||
| `data-_id_-_cluster-name_-kafka-_idx_`:: | ||
| Persistent Volume Claim for the volume `_id_` used for storing data for the Kafka broker pod `_idx_`. | ||
| `data-_id_-cluster-name-kafka-_idx_`:: |
There was a problem hiding this comment.
the "cluster-name" part is variable as id and idx should be used "_" as I did ?
There was a problem hiding this comment.
Oops, sorry about that. I will update.
|
@ppatierno - I've applied the changes you suggested to the reviewed content. Apart from the failing Travis CI build, I think this is good to merge. |
Type of change
Description
This PR adds documentation for the JBOD support.
Checklist
Please go through this checklist and make sure all applicable tasks have been done
./design