Another chunk of documentation for beta-1 #952
Merged
Conversation
This file contains hidden or 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
yim-lee
reviewed
Jun 6, 2022
Comment on lines
+27
to
+28
| /// A node (or member) is referred to as a "replacement" if it shares _the same_ protocol+host+address (i.e. ``Node``), | ||
| /// with another member; It MAY join "over" an existing node and will immediately cause the previous node to be marked ``Cluster/MemberStatus/down`` |
Member
There was a problem hiding this comment.
Suggested change
| /// A node (or member) is referred to as a "replacement" if it shares _the same_ protocol+host+address (i.e. ``Node``), | |
| /// with another member; It MAY join "over" an existing node and will immediately cause the previous node to be marked ``Cluster/MemberStatus/down`` | |
| /// A node (or member) is referred to as a "replacement" if it shares _the same_ protocol+host+address (i.e. ``Node``) | |
| /// with another member; it MAY join "over" an existing node and will immediately cause the previous node to be marked ``Cluster/MemberStatus/down`` |
| /// A leader returning a non-nil value, guarantees that the same Member existing as part of this `Membership` as well (non-members cannot be leaders). | ||
| /// A leader is a specific ``Cluster/Member`` which was selected to fulfil the leadership role for the time being. | ||
| /// | ||
| /// A leader returning a non-nil value, guarantees that the same ``Cluster/Member`` existing as part of this ``Cluster/Membership`` as well (non-members cannot be leaders). |
Member
There was a problem hiding this comment.
Suggested change
| /// A leader returning a non-nil value, guarantees that the same ``Cluster/Member`` existing as part of this ``Cluster/Membership`` as well (non-members cannot be leaders). | |
| /// A leader returning a non-nil value guarantees that the same ``Cluster/Member`` existing as part of this ``Cluster/Membership`` as well (non-members cannot be leaders). |
| ### Leadership | ||
|
|
||
| TODO: document leadership and Leadership changes. | ||
| The cluster is able to use any node discovery mechanism that implements the `ServiceDiscovery` protocol that has an implementation of the `ServiceDiscovery` protocol. like for example: [tuplestream/swift-k8s-service-discovery](https://github.com/tuplestream/swift-k8s-service-discovery) which implements discovery using the kubernetes (k8s) APIs: |
Member
There was a problem hiding this comment.
Suggested change
| The cluster is able to use any node discovery mechanism that implements the `ServiceDiscovery` protocol that has an implementation of the `ServiceDiscovery` protocol. like for example: [tuplestream/swift-k8s-service-discovery](https://github.com/tuplestream/swift-k8s-service-discovery) which implements discovery using the kubernetes (k8s) APIs: | |
| The cluster is able to use any node discovery mechanism that implements the `ServiceDiscovery` protocol. For example: [tuplestream/swift-k8s-service-discovery](https://github.com/tuplestream/swift-k8s-service-discovery) which implements discovery using the kubernetes (k8s) APIs: |
| > order to let others know they are available to meet now. | ||
| Checking-in with the receptionist is performed by calling ``DistributedReceptionist/checkIn(_:with:)`` and passing a | ||
| specific key; The key is useful for when the same types of actor, may want to perform different roles. For example, you may |
Member
There was a problem hiding this comment.
Suggested change
| specific key; The key is useful for when the same types of actor, may want to perform different roles. For example, you may | |
| specific key. The key is useful for when the same type of actors may want to perform different roles. For example, you may |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Resolves #927 for the first beta release.
We'll be adding much more docs, but this is a good enough first cut.