Try to improve concepts docs #473
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabianbaier
requested changes
Jul 1, 2019
|
|
||
| ## OperatorVersion | ||
|
|
||
| Specific version of a deployable application, including configuration and lifecycle hooks for deployments, upgrades, and rollbacks (e.g., [Kafka version 2.4.0](https://github.com/kudobuilder/kudo/blob/master/config/samples/kafka-operatorversion.yaml)). | ||
| This is already complete definition of application to be installed (except overridable parameters). By adding OperatorVersion to your cluster, no application is running yet. |
There was a problem hiding this comment.
Suggested change
| This is already complete definition of application to be installed (except overridable parameters). By adding OperatorVersion to your cluster, no application is running yet. | |
| This is already a complete definition of an application to be installed (except overridable parameters). By adding OperatorVersion to your cluster, no application is running yet. |
What do you mean by By adding OperatorVersion to your cluster, no application is running yet. ?
There was a problem hiding this comment.
that there are not pods or anything running. You have to create instance to actually run the application (= to actually run kafka)
| Resource created to manage an instance of specific OperatorVersion. Instances are pets and have the same name throughout its entire lifecycle. (e.g., [Kafka 2.4.0 cluster with 1 broker](https://github.com/kudobuilder/kudo/blob/master/config/samples/kafka-instance.yaml)). | ||
| When you create an instance, you provide missing parameters for installed OperatorVersion. Creating an instance typically causes bunch of services, pods or statefulsets to start running in your cluster. | ||
| Instances have the same name throughout its entire lifecycle. (e.g., [Kafka 2.4.0 cluster with 1 broker](https://github.com/kudobuilder/kudo/blob/master/config/samples/kafka-instance.yaml)). | ||
|
|
There was a problem hiding this comment.
Should we also mention that we add random strings #437 ?
There was a problem hiding this comment.
do you think this is the right place? 🤔 not sure, but no strong opinion as well.
Co-Authored-By: Fabian Baier <[email protected]>
Co-Authored-By: Fabian Baier <[email protected]>
Co-Authored-By: Fabian Baier <[email protected]>
Co-Authored-By: Fabian Baier <[email protected]>
Co-Authored-By: Fabian Baier <[email protected]>
Co-Authored-By: Fabian Baier <[email protected]>
kensipe
approved these changes
Jul 2, 2019
Co-Authored-By: Ken Sipe <[email protected]>
fabianbaier
approved these changes
Jul 3, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Try to improve the concepts docs. Right now it was very much around the CRDs (storage) than concepts itself. I think there is a lot to be done here, this is just a possible first step.
Which issue(s) this PR fixes:
Special notes for your reviewer:
Does this PR introduce a user-facing change?: