[doc] Deployment documentation migration - definitions #1073
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
barroco
changed the title
mickmis
reviewed
Aug 22, 2024
| The process required by a DSS Instance to join a DSS Pool is referred to "Pooling" | ||
| in this documentation. | ||
|
|
||
| ### CRDB cluster |
There was a problem hiding this comment.
- Add 'CRDB node'?
- What's the relationship between CRDB cluster/node and DSS instance/pool?
|
|
||
| ### DSS instance | ||
|
|
||
| A DSS instance is a single logical replica in a DSS pool hosted by a single |
There was a problem hiding this comment.
Could this 'single logical replica' be on several CRDB nodes? I.e. can a DSS instance host several CRDB nodes?
Comment on lines
+43
to
+47
| Kubernetes manages a set of services in a "cluster". This is an entirely | ||
| different thing from the CRDB data store, and this type of cluster is what the | ||
| deployment instructions refer to. A Kubernetes cluster contains one or more | ||
| node pools: collections of machines available to run jobs. This node pool is an | ||
| entirely different thing from a DSS pool. |
There was a problem hiding this comment.
Are those clarifications really needed?
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.
As part of #874, the content related to deploying a DSS in the build/ folder should be migrated to /deploy.
This PR moves the terminology to the new location.
In addition, some definitions related to naming conventions related to the DSS have been added to improve the reader's experience.