Skip to content

Commit

Permalink
Update README.md (#36)
Browse files Browse the repository at this point in the history
Signed-off-by: Mohamad Fadhil <[email protected]>
  • Loading branch information
sdil authored Dec 12, 2024
1 parent 54c049a commit 35903bb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ one can set the [`syncInterval`](./cluster/config.go) value to a low value. The
- `Put`: create key/value pair that is eventually distributed in the cluster of nodes. The `key` is a string and the `value` is a byte array. One can set an expiry to the key.
- `PutProto`: to create a key/value pair where the value is a protocol buffer message
- `PutString`: to create a key/value pair where the value is a string
- `PutAny`: to create a key/value pair with a given [`Codec`](./cluster/codec.go) to encode the value type.
- `PutAny`: to create a key/value pair with a given [`Codec`](./codec.go) to encode the value type.
- `Get`: retrieves the value of a given `key` from the cluster of nodes. This can return a false negative meaning that the key may exist but at the time of checking it is having yet to be replicated in the cluster.
- `GetProto`: retrieves a protocol buffer message for a given `key`. This requires `PutProto` or `Put` to be used to set the value.
- `GetString`: retrieves a string value for a given `key`. This requires `PutString` or `Put` to be used to set the value.
Expand Down Expand Up @@ -88,4 +88,4 @@ To get the [kubernetes](https://kubernetes.io/docs/home/) discovery working as e
- `PortName`: the client port name. This port is used by the built-in cluster client for the various operations on the key/value pair distributed store
- `PodLabels`: the POD labels

Make sure to provide the right RBAC settings to be able to access the pods.
Make sure to provide the right RBAC settings to be able to access the pods.

0 comments on commit 35903bb

Please sign in to comment.