Update wiki Home page for caffeine-action

gitea_admin 2026-03-11 14:35:19 +00:00
parent e23f155549
commit 2e01770584

42
Home.md

@ -1,21 +1,35 @@
# Deploy the Project on CamelX Platform
# Caffeine Action
Deploy on CamelX Platform in three steps
Perform operations on a caffeine cache
## Step 1: Create a release
From the project space, click on **"Create a release"**
The Kamelet expects the following headers to be set:
The new version is automatically available in the list
- `caffeine-key` / `ce-caffeinekey`: as the cache key used in the operation
## Step 2: Deploy
Click on **"Deploy"**
- `caffeine-operation` / `ce-caffeineoperation`: as the operation to perform. It can be PUT, GET, INVALIDATE and CLEANUP.
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
If the caffeine-key header won't be set the exchange ID will be used as key.
## Step 3: Expose
Enable **"Expose"**
If the caffeine-operation header won't be set, the GET operation will be performed.
Choose an **API Gateway** (Internal, Public, etc.)
## Metadata
| Property | Value |
|----------|-------|
| Type | action |
| Group | Caffeine |
| Namespace | Cache |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Properties
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `cacheName` | string | ✓ | `caffeine-cache` | The name of the cache we want to use |
## Dependencies
- `camel:core`
- `camel:caffeine`
- `camel:kamelet`