Represents an interactive container session that provides shell access to running containers for debugging and troubleshooting purposes. Sessions enable developers to connect directly to containers in their stacks for real-time inspection and problem solving.
uidstringUnique session identifier used to reference this specific session.
titlestringHuman-readable title or description for the session.
service_namestringName of the service this session is connected to.
namespacestringKubernetes namespace where the session container is running (for Kubernetes-based stacks).
commandstringCommand or shell that will be executed when the session starts (e.g., "/bin/bash", "/bin/sh").
deployment_namestringName of the deployment that contains the target container.
pod_namestringKubernetes pod name where the session is established (for Kubernetes-based stacks).
container_namestringSpecific container name within the pod or deployment for multi-container scenarios.
Session Types
Sessions are created based on the stack type:
Kubernetes Sessions
- Pod-based - Connect to specific pods in deployments
- Namespace isolation - Sessions operate within stack namespaces
- kubectl integration - Uses Kubernetes APIs for session management
Docker Sessions
- Container-based - Connect directly to Docker containers
- Service targeting - Sessions target specific service containers
- Docker integration - Uses Docker APIs for container access
Session Lifecycle
- Creation - Session is requested for a specific service
- Provisioning - Container connection is established
- Active - Session is ready for interactive use
- Termination - Session ends automatically or manually
Use Cases
- Application Debugging - Inspect running application processes
- Log Analysis - Real-time log monitoring and analysis
- Configuration Inspection - Examine runtime configuration files
- Performance Monitoring - Monitor system resources and performance
- Database Operations - Direct database client access
- File System Exploration - Browse and modify container filesystem
Security Considerations
- Permission-based Access - Requires SSH key download permissions
- Session Limits - Maximum concurrent sessions per service (typically 15)
- Audit Logging - All session activities are logged for security
- Secure Connections - All session traffic is encrypted
Example
{
"uid": "session-550e8400-e29b-41d4-a716",
"title": "Debug web service",
"service_name": "web",
"namespace": "myapp-production",
"command": "/bin/bash",
"deployment_name": "web-deployment",
"pod_name": "web-deployment-7d4f8c6b5d-xyz12",
"container_name": "web"
}