ElastiCache docs initial version #9
Conversation
| description: AWS ElastiCache, in-memory data storage and cache services for your serverless functions, with SLAppForge Sigma cloud IDE | ||
| --- | ||
|
|
||
| #  AWS ElastiCache |
There was a problem hiding this comment.
better to add an alt-text (e.g. just "ElastiCache": ![ElastiCache]...)
|
|
||
| ElastiCache is a fully managed, in-memory data store for enterprise-level, data-intensive applications. ElastiCache | ||
| can improve the performance of consumer applications, by retrieving data from its in-memory data stores with high throughput and low latency. | ||
| ElastiCache supports two open-source cache engines, Amazon ElastiCache for Redis and Amazon ElastiCache for Memcached. |
There was a problem hiding this comment.
, Redis and Memcached
(drop "Amazon ElastiCache for " part coz that's not part of the open-source engine name)
|
|
||
| ### New Redis Cluster | ||
|
|
||
| To create a new cluster, first, go to the **New Cluster** tab of the configuration panel. Inorder to create new Redis cluster following configurations |
| ### New Redis Cluster | ||
|
|
||
| To create a new cluster, first, go to the **New Cluster** tab of the configuration panel. Inorder to create new Redis cluster following configurations | ||
| required. |
| Node Type | :white_check_mark: | The compute and memory capacity of the node | ||
| Cluster mode | :white_check_mark: | Standalone or Clustered | ||
| Multi-AZ with Auto-failover | :white_check_mark: | Auto failover with multi availability zones | ||
| Number of Shards | :white_check_mark: | Number of shards in the cluster |
There was a problem hiding this comment.
Better to link "shards" to any available AWS docs describing it
| Cluster mode | :white_check_mark: | Standalone or Clustered | ||
| Multi-AZ with Auto-failover | :white_check_mark: | Auto failover with multi availability zones | ||
| Number of Shards | :white_check_mark: | Number of shards in the cluster | ||
| Number of Replicas | :white_check_mark: | Number of replicas within a single shard |
|
|
||
| Field | Constraints | ||
| --- | --- | ||
| Multi-AZ with Auto-failover | Only available in standalone mode(cluster mode disabled). In cluster mode enabled by default |
There was a problem hiding this comment.
Add a few words describing what it is (possibly with an AWS doc link)
"mode (cluster" (space)
(when cluster mode is disabled)
In cluster mode_, this is_ enabled
"... enabled by default" does this mean that you can also disable it in cluster mode?
| Field | Constraints | ||
| --- | --- | ||
| Multi-AZ with Auto-failover | Only available in standalone mode(cluster mode disabled). In cluster mode enabled by default | ||
| Number of Shards | Only available in cluster mode, minimum:2 maximum:15. Otherwise, default to be 1 |
There was a problem hiding this comment.
mode_; minimum: 2, maximum: 15_.
Drop "Otherwise", "be" (just "Defaults to 1.")
| --- | --- | ||
| Multi-AZ with Auto-failover | Only available in standalone mode(cluster mode disabled). In cluster mode enabled by default | ||
| Number of Shards | Only available in cluster mode, minimum:2 maximum:15. Otherwise, default to be 1 | ||
| Number of Replicas | Maximum: 6, If Multi-AZ with Auto-failover enabled minimum should be 2, 1 otherwise |
There was a problem hiding this comment.
Maximum: 6; minimum: 2 if Multi..., 1 otherwise
| #### Cluster Engine Configuration | ||
|
|
||
| <p align="center"> | ||
| <img style="Padding:20px" width="400" src="./images/elasticache/ecache_cluster_conf.png"> |
There was a problem hiding this comment.
better to add alt-text (e.g. alt="ElastiCache cluster engine configuration")
| #### Cluster Settings | ||
|
|
||
| <p align="center"> | ||
| <img style="Padding:20px" width="400" src="./images/elasticache/ecache_cluster_settings.png"> |
|
|
||
| Field | Required | Description | ||
| --- | :---: | --- | ||
| Cluster Name | :white_check_mark: | Name for the cluster to be used as an identifier |
There was a problem hiding this comment.
cluster_; this will also_ be used as a code-level identifier
| --- | :---: | --- | ||
| Cluster Name | :white_check_mark: | Name for the cluster to be used as an identifier | ||
| Cluster Description | :white_check_mark: | Description for the cluster | ||
| Port | :white_check_mark: | The port number on which cluster accepts connections |
There was a problem hiding this comment.
the cluster should accept conn..
| Port | :white_check_mark: | The port number on which cluster accepts connections | ||
| | ||
|
|
||
| Field | Constraints |
There was a problem hiding this comment.
Do we need a separate table (since there's only one entry)? Can't we simply mention the constraints under Cluster Name on the previous table?
|
|
||
| #### VPC Configuration | ||
|
|
||
| When creating a new ElastiCache cluster, you need to configure a VPC as well. Sigma enables |
There was a problem hiding this comment.
better if
Sigma allows you to
create a new
existing VPC.
|
|
||
| ##### Create New VPC | ||
|
|
||
| To create new VPC, expand VPC settings and select **Create New VPC** option from VPC type dropdown. |
There was a problem hiding this comment.
a new
VPC Settings
the VPC Type
| To create new VPC, expand VPC settings and select **Create New VPC** option from VPC type dropdown. | ||
|
|
||
| <p align="center"> | ||
| <img style="Padding:20px" width="400" src="./images/elasticache/ecache_new_vpc.png"> |
| Engine Version | :white_check_mark: | The version number of the cache engine to be used for the cluster | ||
| Node Type | :white_check_mark: | The compute and memory capacity of the node | ||
| Cluster mode | :white_check_mark: | Standalone or Clustered | ||
| Multi-AZ with Auto-failover | :white_check_mark: | Auto failover with multi availability zones |
| Field | Required | Description | ||
| --- | :---: | --- | ||
| VPC Name | :white_check_mark: | Name of the VPC | ||
| CIDR block | :white_check_mark: | IPv4 CIDR block for the VPC |
There was a problem hiding this comment.
better to link if there are any AWS docs (same for subnet and its CIDR block, below)
| Engine | :white_check_mark: | The cache engine type to be used for the cluster | ||
| Engine Version | :white_check_mark: | The version number of the cache engine to be used for the cluster | ||
| Node Type | :white_check_mark: | The compute and memory capacity of the node | ||
| Cluster mode | :white_check_mark: | Standalone or Clustered |
There was a problem hiding this comment.
_M_ode
Clustered (multiple instances) if disabled, standalone (single instance) otherwise
| --- | :---: | --- | ||
| Engine | :white_check_mark: | The cache engine type to be used for the cluster | ||
| Engine Version | :white_check_mark: | The version number of the cache engine to be used for the cluster | ||
| Node Type | :white_check_mark: | The compute and memory capacity of the node |
There was a problem hiding this comment.
How about Instance Family radio selection?
|
|
||
| ##### Using Existing VPC | ||
|
|
||
| To use already existing VPC, select **Existing VPC** option from VPC type under VPC settings. |
| CIDR block for subnet | :white_check_mark: | IPv4 CIDR block for the private subnet | ||
|
|
||
| **Important:** | ||
| > **When creating a new VPC, make sure your lambda is also deploying in the same VPC. Select No VPC option |
There was a problem hiding this comment.
_L_ambda (* 3)
**No VPC**
. This will allow Sigma IDE to automatically deploy (delete "ed")
| To use already existing VPC, select **Existing VPC** option from VPC type under VPC settings. | ||
|
|
||
| <p align="center"> | ||
| <img style="Padding:20px" width="400" src="./images/elasticache/ecache_existing_vpc.png"> |
| <img style="Padding:20px" width="400" src="./images/elasticache/ecache_new_vpc.png"> | ||
| </p> | ||
|
|
||
| Field | Required | Description |
There was a problem hiding this comment.
Use exact field names as in the popup ("IPv4 CIDR block for VPC", "SubNet Name", "IPv4 CIDR block for Private Subnet")
P.S. better if we can rename SubNet -> Subnet in the UI
There was a problem hiding this comment.
double-check other places too, to see if there are label discrepancies
| **Important:** | ||
| > **When using an existing VPC, make sure your lambda function is also deployed in the same VPC. Either select the same VPC | ||
| (with the same Subnet and Security Group) that you selected for ElastiCache cluster in lambda advanced configuration or | ||
| leave 'No Vpc' option so that Sigma IDE will be able to deployed your lambda function in the same VPC as ElastiCache cluster** |
There was a problem hiding this comment.
_L_ambda (check all)
for the Elasti..
_A_dv.. _C_onf..
maybe don't make the whole sentence boldface (since "Important" is already in bold); instead make just boldface the important phrases, e.g.
No VPC (bold, case)
able to deploy (delete "ed")
as the Elasti.. cluster_._
| ### Existing Redis Cluster | ||
|
|
||
| To choose an existing redis cluster, go to the **Existing Cluster** tab of the configuration panel. Existing cluster | ||
| instances can be selected from Existing cluster dropdown. |
There was a problem hiding this comment.
**Existing Cluster** (bold, C)
| } | ||
| }); | ||
| ``` | ||
| ### Testing your cluster |
|
|
||
| **Important:** | ||
| >**At the moment you cannot test ElasitiCache operations using Sigma IDE test lambda. We will enable this feature | ||
| in near future for you.** |
| ### Testing your cluster | ||
|
|
||
| **Important:** | ||
| >**At the moment you cannot test ElasitiCache operations using Sigma IDE test lambda. We will enable this feature |
There was a problem hiding this comment.
ElastiCache (spelling)
within the Sigma IDE test environment.
|
|
||
| ### ElastiCache for Redis Operations | ||
|
|
||
| Sigma IDE currently supports following categories of Redis operations. |
|
|
||
| - Description | ||
|
|
||
| Set a timeout in seconds on key. The key will be automatically deleted after the timeout has been expired. |
There was a problem hiding this comment.
Set_s_
timeout is reached.
| - Description | ||
|
|
||
| Set a timeout in seconds on key. The key will be automatically deleted after the timeout has been expired. | ||
| A key which associated with a timeout is said to be volatile in Redis terminology. |
There was a problem hiding this comment.
which is
better to make "volatile" italic or boldface
|
|
||
| Parameter | Type | Required | ||
| :---: | :---: | :---: | ||
| Key | String | :white_check_mark: |
There was a problem hiding this comment.
better if parameter names are in code style
|
|
||
| - Description | ||
|
|
||
| Remove the existing timeout on key, making the key from volatile |
There was a problem hiding this comment.
Remove_s_
making -> changing
| - Description | ||
|
|
||
| Remove the existing timeout on key, making the key from volatile | ||
| to persistent (a key with no timeout is association). |
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| Integer | `1` | `0` if key does not have associated time out or key does not exists |
There was a problem hiding this comment.
have an
timeout (one word)
exist (no s)
|
|
||
| - Description | ||
|
|
||
| Remove the existing timeout on key, making the key from volatile |
|
|
||
| - Description | ||
|
|
||
| Rename a key into a new key. If new key already exists then its value will be overwritten. |
|
|
||
| - Description | ||
|
|
||
| Append value at the end of string key if key does exists. If key does not exists, |
There was a problem hiding this comment.
Append_s_ the (also make other descriptions singular as such)
exist (* 2)
and append the value
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| String | Type of the key | `none` if key does not exists |
There was a problem hiding this comment.
exist (no s)
also check other "does not exists" type occurrences
|
|
||
| Return type | Success | ||
| :---: | :---: | ||
| Integer | The length of the string after the operation. |
|
|
||
| - Description | ||
|
|
||
| Decrement the value of the key by decrement. Limited to 64 but signed integers. |
There was a problem hiding this comment.
"by decrement amount"
64-bit ?
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| Integer | Value of the key after the operation. | An `error` if the key contains a value of the wrong type or contains a string that can not be represented as integer |
There was a problem hiding this comment.
delete trailing dot on Success column (also check other occurrences)
as an integer
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| Bulk String | Value of the key. | `Null` if the key does not exists, An `error` if the stored value is not a string |
There was a problem hiding this comment.
trailing dot
Null or null?
exist (no s)
, or _a_n (lowercase)
|
|
||
| - Description | ||
|
|
||
| Increment the value of the key by increment. Limited to 64 but signed integers. |
|
|
||
| - Description | ||
|
|
||
| Create new key with string value and set key to timeout after the given timeout in seconds. |
There was a problem hiding this comment.
Create_s_
set_s_
"to expire" sounds better IMO
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| String | `OK` | An `error` if the seconds are invalid |
|
|
||
| - Description | ||
|
|
||
| Create new key with string value. If key holds a value, it will overwritten regardless |
|
|
||
| Return type | Success | Failure | ||
| :---: | :---: | :---: | ||
| Integer | The length of the value stored in the key | `0` if key does not exists, An `error` if the key holds non string value |
There was a problem hiding this comment.
, _or a_n
holds a non-string (dash)
|
|
||
| - Description | ||
|
|
||
| Add the specified members to the set stored at key. Specified members that already contains in the set are ignored. |
There was a problem hiding this comment.
. Members that are already contained
|
|
||
| Return type | Success | ||
| :---: | :---: | ||
| Integer | Number of members that were added to the set, not including all the members that already present in the set |
There was a problem hiding this comment.
excluding members that were (delete "all the")
| - Description | ||
|
|
||
| Equivalent command to SDIFF, but instead of returning the resulting set, | ||
| this command will stored resulting set in specified destination. |
There was a problem hiding this comment.
store (no d)
check other occurrences too
in the
|
|
||
| - Description | ||
|
|
||
| Returns if a element(s) is a member of the specified set. |
|
|
||
| - Response | ||
|
|
||
| Return type | Success | Failure | Failure |
|
|
||
| - Description | ||
|
|
||
| Returns the members of the set resulting from the addition(union) of all the given sets. |
| - Description | ||
|
|
||
| Equivalent command to SUNION, but instead of returning the resulting set, | ||
| this command will be stored resulting set in specified destination. |
2 participants
No description provided.