Skip to content

Commit 1b4b5a7

Browse files
committed
Add Documentation for Applications
Signed-off-by: Stefan Bischof <[email protected]>
1 parent 270a6c3 commit 1b4b5a7

File tree

4 files changed

+610
-10
lines changed

4 files changed

+610
-10
lines changed

docs/cubeserver/setup/app_pivot.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Pivot Application
3+
group: Application
4+
---
5+
# Eclipse Daanse Pivor Application
6+
7+
**Status: Under Construction**
8+
9+
Pivot is the foundation for every production Daanse OLAP server. This container can be adapted to specific needs and requirements.
10+
11+
## Key Configuration Areas
12+
13+
### Database Connectivity
14+
- **Dialects and Data Sources**: Support for multiple different database connections
15+
- **Multi-Database Support**: Can connect to various database types simultaneously
16+
17+
### XMLA Endpoints
18+
- **Multiple Endpoints**: Configure the number of XMLA endpoints
19+
- **Path Configuration**: Customize endpoint paths
20+
- **Port Mapping**: Assign specific ports to different endpoints
21+
22+
### Catalog Management
23+
- **Web Endpoint Assignment**: Map catalogs to specific web endpoints
24+
- **Flexible Routing**: Configure how catalogs are accessed through different entry points
25+
26+
### Observability Features
27+
- **Health Checks**: Built-in health monitoring capabilities
28+
- **Readiness Checks**: Ensure services are ready to handle requests
29+
- **Caching Configuration**: Configurable caching settings for optimal performance
30+
31+
### Security & Authentication
32+
- **Authentication Providers**: Support for necessary authentication mechanisms
33+
- **Full Control**: Complete control over security configurations
34+
- **Customizable Access**: Adapt authentication to organizational needs
35+
36+
## Benefits
37+
38+
### Security & Risk Reduction
39+
This container provides full control and adaptability while ensuring that unnecessary components are not activated at runtime, significantly reducing security risks.
40+
41+
### Production Ready
42+
Designed specifically for production environments with enterprise-grade features and reliability.
43+
44+
### Customization
45+
Every aspect can be tailored to meet specific organizational requirements and use cases.
46+
47+
## Source Code
48+
The pivot application source can be found at: `https://github.com/eclipse-daanse/org.eclipse.daanse.server/tree/main/application/pivot`
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Playground Application
3+
group: Application
4+
---
5+
# Eclipse Daanse Playground Application
6+
7+
**Availability: Git Repository Only - No Docker Container/Artifact**
8+
9+
The playground application is a comprehensive development tool that includes all components necessary for creating and configuring Daanse OLAP servers. It serves as a complete testing and development environment.
10+
11+
## What's Included
12+
13+
### Complete Component Set
14+
- **All Dialects**: Support for every database dialect available in the Daanse ecosystem
15+
- **All Data Sources**: Every possible data source connector included
16+
- **Web Consoles**: Administrative and management web interfaces
17+
- **Helper Components**: Tools that assist in creating and configuring pivot servers
18+
19+
### Development Features
20+
- **Full Configuration Testing**: Test all possible configurations before production deployment
21+
- **Component Exploration**: Discover and experiment with different Daanse components
22+
- **Integration Testing**: Validate component interactions in a complete environment
23+
24+
## Security Considerations
25+
26+
### Why No Docker Release
27+
Due to the large number of components included in the playground application, the attack surface is significantly increased. For this reason, the Daanse project has decided not to provide a Docker release or pre-built artifacts.
28+
29+
### Risk Assessment
30+
- **Increased Attack Surface**: More components mean more potential security vulnerabilities
31+
- **Development Only**: Not intended for production environments
32+
- **Security Trade-off**: Comprehensive functionality vs. security exposure
33+
34+
## Use Cases
35+
36+
### Development Tool
37+
- **Server Customization**: Ideal for adapting and developing Daanse OLAP servers
38+
- **Component Selection**: Help determine which components are needed for specific use cases
39+
- **Configuration Validation**: Test configurations before implementing in production
40+
41+
### Learning Environment
42+
- **Feature Exploration**: Understand all available Daanse capabilities
43+
- **Component Dependencies**: Learn how different components interact
44+
- **Best Practices**: Develop understanding of optimal configurations
45+
46+
## Getting Started
47+
48+
### Source Code Location
49+
The playground application source can be found at:
50+
`https://github.com/eclipse-daanse/org.eclipse.daanse.server/tree/main/application/playground`
51+
52+
### Prerequisites
53+
- Access to the Daanse git repository
54+
- Java development environment
55+
- Understanding of security implications
56+
57+
## Important Notes
58+
59+
⚠️ **Security Warning**: This application should only be used in development environments due to the increased attack surface from the comprehensive component set.
60+
61+
**Development Value**: Despite security considerations, this is a very helpful tool for customizing and developing Daanse OLAP servers.
62+
63+
🔧 **Configuration Helper**: Essential for understanding component relationships and optimal server configurations before production deployment.

0 commit comments

Comments
 (0)