Skip to content

Commit c6972e4

Browse files
committed
docs: add OpenStackSDK version customization instructions for older releases in README.md
- Affected file: README.md - Summary: Added detailed steps for customizing OpenStackSDK version for older OpenStack releases, including Dockerfile and pyproject.toml modifications, and rebuilding the Docker image.
1 parent bcd7c2f commit c6972e4

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,52 @@
3737
>
3838
> 🚧 **Coming Soon**: Dynamic multi-version OpenStack API compatibility is actively under development and will be available in upcoming releases, providing seamless support for all major OpenStack deployments automatically.
3939
40+
### 🔧 OpenStackSDK Version Customization for Older Releases
41+
42+
**Officially Supported Releases:**
43+
- ✅ OpenStack **Epoxy (2025.1)** - Fully tested
44+
- ✅ OpenStack **Dalmatian (2024.2)** - Fully tested
45+
46+
**For older OpenStack releases** (Wallaby, Caracal, Bobcat, etc.), you may need to customize the OpenStackSDK version to match your environment. The SDK version must be changed in **BOTH files**:
47+
48+
**Step 1: Modify `Dockerfile.MCP-Server`**
49+
```dockerfile
50+
RUN pip install \
51+
'uv>=0.8.5' \
52+
'mcpo>=0.0.17' \
53+
'fastmcp>=2.12.3' \
54+
'aiohttp>=3.12.0' \
55+
'openstacksdk==3.1.1' \ # ← Change to your required version (e.g., 3.1.1 for Wallaby)
56+
'python-dotenv>=1.0.0'
57+
```
58+
59+
**Step 2: Modify `pyproject.toml`**
60+
```toml
61+
dependencies = [
62+
"fastmcp>=2.12.3",
63+
"openstacksdk==3.1.1", # ← Must match Dockerfile version
64+
"python-dotenv>=1.1.1",
65+
# ... other dependencies
66+
]
67+
```
68+
69+
**Step 3: Rebuild Docker Image**
70+
```bash
71+
docker-compose build --no-cache mcp-server
72+
docker-compose up -d
73+
```
74+
75+
**OpenStackSDK Version Reference:**
76+
| OpenStack Release | Recommended SDK Version | Notes |
77+
|-------------------|------------------------|-------|
78+
| Epoxy (2025.1) | `>=3.3.0` | Current default |
79+
| Dalmatian (2024.2) | `>=3.2.0` | Fully compatible |
80+
| Caracal (2024.1) | `>=3.1.0` | May require testing |
81+
| Bobcat (2023.2) | `>=3.0.0` | May require testing |
82+
| Wallaby (2021.1) | `==3.1.1` | Downgrade required |
83+
84+
> ⚠️ **Important**: Both `Dockerfile.MCP-Server` and `pyproject.toml` must have the **same version** to avoid dependency conflicts during container runtime.
85+
4086
---
4187

4288
### Screenshots

0 commit comments

Comments
 (0)