Skip to content

realm9-platform/realm9-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

Realm9 Documentation Hub

Complete Documentation and API Reference for the Realm9 Platform

Docs API Status

Overview

Welcome to the Realm9 documentation repository. This comprehensive resource contains everything you need to deploy, configure, and manage the Realm9 platform.

Documentation Structure

realm9-docs/
├── getting-started/     # Quick start guides
├── platform/           # Platform architecture and concepts
├── api/               # REST API documentation
├── deployment/        # Deployment guides
├── integrations/      # Third-party integrations
├── security/          # Security and compliance
├── troubleshooting/   # Common issues and solutions
└── release-notes/     # Version history and updates

Quick Links

🚀 Getting Started

📖 Core Documentation

🔌 API Reference

🛠️ Administration

Platform Guides

Environment Management

Complete guide to managing environments including:

  • Creating and configuring environments
  • Booking and approval workflows
  • Cost tracking and chargeback
  • Shared environment management
  • Maintenance windows

Infrastructure Automation

  • Natural language to Terraform
  • GitOps workflows
  • Policy as code
  • Drift detection
  • Cost optimization

Observability (RO9)

  • Log ingestion setup
  • Query optimization
  • Dashboard creation
  • Alert configuration
  • Data retention policies

Security & Compliance

  • MFA setup
  • SSO configuration
  • Audit logging
  • Compliance reporting
  • Security best practices

Integration Guides

CI/CD

ITSM

Cloud Providers

Deployment Options

☁️ Cloud (SaaS)

Fastest way to get started:

curl -X POST https://api.realm9.app/signup \
  -H "Content-Type: application/json" \
  -d '{"organization": "your-org"}'

🏢 Self-Hosted

Full control in your infrastructure:

API Examples

Environment Creation

curl -X POST https://api.realm9.app/v1/environments \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "prod-app-01",
    "type": "PRODUCTION",
    "cloud": "AWS",
    "region": "us-east-1"
  }'

Terraform Execution

curl -X POST https://api.realm9.app/v1/terraform/run \
  -H "Authorization: Bearer $TOKEN" \
  -d '{
    "workspace": "production",
    "action": "apply",
    "auto_approve": false
  }'

Troubleshooting

Common Issues

Debug Tools

# Check system status
realm9 status --verbose

# Validate configuration
realm9 config validate

# Test connectivity
realm9 test connection --all

# Generate support bundle
realm9 support bundle --output realm9-debug.tar.gz

Release Notes

Latest Version (v2.5.0)

  • ✅ AI-powered infrastructure co-pilot
  • ✅ RO9 observability platform GA
  • ✅ ServiceNow CMDB integration
  • ✅ Multi-cloud cost analysis
  • ✅ Enhanced security features

View all releases →

Migration Guides

From Other Platforms

Video Tutorials

Community & Support

Resources

Support Channels

  • Documentation: You are here!
  • Community Support: GitHub Discussions
  • Professional Support: support@realm9.app
  • Enterprise Support: 24/7 with SLA

Contributing

We welcome contributions to our documentation:

  1. Fork this repository
  2. Create a feature branch
  3. Make your improvements
  4. Submit a pull request

See CONTRIBUTING.md for guidelines.

License

Copyright © 2025 Realm9. All rights reserved.


Need help? Contact support@realm9.app or visit realm9.app/support

Part of the Realm9 Platform

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •