Create and manage Key Value Store instances
Zuletzt aktualisiert am
Prerequisites
Section titled “Prerequisites”- You have a STACKIT customer account: Create a customer Account
- You have a STACKIT user account: Create a user account
- You have a STACKIT project: Create a project
Instance properties
Section titled “Instance properties”Independent of the method you choose to create and manage an instance, there are common properties for a Key Value Store instance.
General information
Section titled “General information”Instance name
Section titled “Instance name”The instance name determines the friendly, readable name for your instance.
Key value version
Section titled “Key value version”This setting determines which Key Value version is deployed for your instance.
STACKIT updates the major version according to the official releases of Valkey, with a reasonable delay for testing and implementation. STACKIT skips specific minor versions. Read the Release notes for deprecation notices and announcements of updated versions.
For safety reasons, STACKIT deprecates Key Value Store versions when they reach their End-of-Life (EOL) status. Furthermore, STACKIT applies minor updates automatically for security reasons.
Select the plan that best fits your workload. It is safe to start with a smaller plan and upgrade to a larger one later. Depending on the chosen Key Value version, specific plans are unavailable.
A plan determines the number of nodes, vCPUs, RAM, and storage size. For a detailed reference of available plans, read Service plans for Key Value Store.
Number of nodes
Section titled “Number of nodes”The number of nodes determines your horizontal scaling and High Availability (HA). Horizontal scaling increases availability and read performance. The single plan (1 node) does not offer horizontal scaling. A replica plan (3 nodes) offers horizontal scaling and thereby achieves high availability.
| Use case | Plan |
|---|---|
| Development | Single (1 node) |
| Production | Replica (3 nodes) |
Number of vCPUs
Section titled “Number of vCPUs”The number of vCPUs determines how much computing power each node of your instance has. Follow Plan your Key Value Store instance to find the best option for your workload.
Memory
Section titled “Memory”The RAM setting determines how much memory each node of your instance has. Follow Plan your Key Value Store instance to find the best option for your workload.
Disk size
Section titled “Disk size”The disk size determines the capacity of the underlying storage. The smallest option is 10 GB. You can start with this size and enlarge the disk later by upgrading the plan.
Custom parameters
Section titled “Custom parameters”Disk threshold
Section titled “Disk threshold”Database instances are vulnerable to situations where the storage becomes completely full. To prevent these circumstances, STACKIT offers a parachute feature. It automatically stops the database when a predefined disk usage threshold (in percent) is reached.
You define this threshold with this setting. You can deactivate this feature by defining the threshold as 100%.
Access Control List (ACL) entries control which source IPs can connect to your instance. This is an additional security layer and does not replace the need for proper authentication and security best practices.
To ensure that you can access your instance from other STACKIT cloud services, you must add the STACKIT public IP ranges to your ACL. Since these ranges evolve over time, you can dynamically retrieve the most up-to-date list using the STACKIT CLI:
stackit auth loginstackit curl "[https://iaas.api.stackit.cloud/v2/networks/public-ip-ranges](https://iaas.api.stackit.cloud/v2/networks/public-ip-ranges)"You receive a JSON response containing the current CIDR blocks grouped by region. Add the cidr values relevant to your instance’s region to your ACL entries.
{ "items": [ { "cidr": "192.214.160.0/19", "region": "eu01" }, { "cidr": "193.148.164.0/22", "region": "eu01" }, // ... additional IPs ... { "cidr": "9.206.0.0/22", "region": "eu02" } ]}If you want to access your instance from the public internet, you need to add your client’s IPv4 address or subnet. The entries follow the CIDR notation. If you want to allow a single IP address (e.g., a single host), set 32 as the subnet parameter. For example, to allow a host with the source IPv4 address of 93.229.84.137, add 93.229.84.137/32 as the ACL entry.
Adding IPv6 addresses is not supported.
Create an instance
Section titled “Create an instance”To create an instance, you first need to navigate to the STACKIT Portal and log in.
Choose the plan and storage class
Section titled “Choose the plan and storage class”First, you need to determine which plan you need. The available plans depend on the chosen version. To get a list of available plans, execute:
stackit key-value-store plansChoose the properties for your instance
Section titled “Choose the properties for your instance”| Flag | Options | Default | Optional |
|---|---|---|---|
--name | my-keyvalue-instance | ||
--plan-id | See Service plans for Key Value Store | ||
--version | 10.6, 10.11 | 10.11 | x |
--acl | IPv4 and net in CIDR notation | 193.148.160.0/19 45.129.40.0/21 45.135.244.0/22 192.214.174.229/32 192.214.176.140/32 | x |
You can also review the Service plans for Key Value Store to learn more about the available options.
Execute the creation command
Section titled “Execute the creation command”To create your instance, execute the following command:
stackit key-value-store instance create --name <name> --plan-id <plan-id> --version <version> --acl <acl>After executing the command, you need to confirm by typing y. When the instance is created successfully, the CLI returns the instance ID:
Created instance for project "Test-Projekt-28-07-2025".Instance ID: 1737d9b7-ad6d-4a86-807a-bae5c5f5ed71Examples
Section titled “Examples”Create an instance with minimum required flags:
stackit key-value-store instance create --name my-keyvalue-instance --plan-id 3849f72f-99cc-4e2c-afda-700d66ef08f2- On the sidebar, click on Key Value Store.
- On the top bar, click on Create Key Value Store. See Instance properties for a better understanding of all options.
- After configuring everything to your needs, you can review the price estimation on the right-hand side for cost control.
- To finalize the creation, click on Order fee-based. The system adds your newly created instance to the list of your Key Value Store instances.
- After a few seconds, your instance state changes from Pending … to Active. Congratulations, your Key Value Store instance is up and running!
-
To use the Cloud Foundry CLI, you first need to log in to your STACKIT project endpoint. Read Interact with Cloud Foundry for help logging in.
-
Create the instance with the
cfcommand:Parameter Meaning Example key-value-planAn available plan for your instance.
See Service plans for Key Value Store.keyvalue-1.2.10-replica individual-service-nameThe custom name of your service.
You can freely choose anything.my-cf-keyvalue-service Terminal window cf create-service appcloud-keyvalue8 [key-value-plan] [individual-service-name]Example:
Terminal window cf create-service appcloud-keyvalue8 keyvalue-1.2.10-replica my-cf-keyvalue-service
View an instance
Section titled “View an instance”To view an instance, execute the command with the following parameters:
| Argument | Description |
|---|---|
INSTANCE_ID | Instance ID of the instance you want to query |
stackit key-value-store instance describe <INSTANCE_ID>Example output:
ID │ 1737d9b7-ad6d-4a86-807a-bae5c5f5ed71──────────────────────┼───────────────────────────────────────────────────────────────────────────────────────NAME │ my-keyvalue-instance──────────────────────┼───────────────────────────────────────────────────────────────────────────────────────LAST OPERATION TYPE │ create──────────────────────┼───────────────────────────────────────────────────────────────────────────────────────LAST OPERATION STATE │ succeeded──────────────────────┼───────────────────────────────────────────────────────────────────────────────────────PLAN ID │ 3849f72f-99cc-4e2c-afda-700d66ef08f2──────────────────────┼───────────────────────────────────────────────────────────────────────────────────────ACL │ 193.148.160.0/19,45.129.40.0/21,45.135.244.0/22,192.214.174.229/32,192.214.176.140/32- On the sidebar, click on Key Value Store.
- Click on the instance you would like to view.
-
To use the Cloud Foundry CLI, you first need to log in to your STACKIT project endpoint. Read Interact with Cloud Foundry for help logging in.
-
List the services and view details with the
cfcommand:List services:
Terminal window cf services | grep keyvalueView the details of a service:
Terminal window cf service [service-name]
Edit an instance
Section titled “Edit an instance”You can edit the following properties of an instance: acl, plan, and version. To see a reference for these flags, have a look at the Create an instance section.
| Argument | Description |
|---|---|
INSTANCE_ID | Instance ID of the instance you want to query |
| Flags | Datatype | Unit |
|---|---|---|
--acl | Array of Strings | |
--plan-id | String | - |
--plan-name | String | - |
--version | String | - |
To edit the instance, execute the following command:
stackit key-value-store instance update <INSTANCE_ID> --<Flag Name> <Flag Value>Example
Section titled “Example”stackit key-value-store instance update 1737d9b7-ad6d-4a86-807a-bae5c5f5ed71 --plan-id 8309378b-3f85-403a-bf42-525d07cfdf78To edit the plan, do the following:
- On the sidebar, click on Key Value Store.
- Click on the instance you would like to edit.
- On the Plan pane, click on the selected plan link next to Plan name.
- Next to the desired plan, click on Change.
- In the pop-up window, click on Order fee-based.
- Wait for the database to become Active again.
To change the ACL and disk threshold, do the following:
- On the sidebar, click on Key Value Store.
- Click on the instance you would like to edit.
- On the Custom parameters pane, click on Edit.
- Make your changes and click on Save.
- Wait for the database to become Active again.
Delete an instance
Section titled “Delete an instance”You can delete an instance when it operates in its READY state. After executing this command, the operation cannot be undone.
To delete an instance, execute:
| Argument | Description |
|---|---|
INSTANCE_ID | Instance ID of the instance you want to query |
stackit key-value-store instance delete <INSTANCE_ID>You receive the following output:
Deleted instance "my-keyvalue-instance"You can delete an instance when it operates in its READY state. You cannot undo a deletion.
- On the sidebar, click on Key Value Store.
- On the pane of the instance you want to delete, click on the three-dot icon.
- Click on Delete.
- Enter the exact name of the instance and confirm by clicking Delete.
-
To use the Cloud Foundry CLI, you first need to log in to your STACKIT project endpoint. Read Interact with Cloud Foundry for help logging in.
-
Delete a service with the
cfcommand:Terminal window cf delete-service [service-name]