|
| 1 | +--- |
| 2 | +layout: docs |
| 3 | +title: Getting Started |
| 4 | +--- |
| 5 | + |
| 6 | +# Getting Started with OpenChoreo |
| 7 | + |
| 8 | +Welcome to OpenChoreo! This guide will help you get up and running with OpenChoreo quickly. |
| 9 | + |
| 10 | +## What is OpenChoreo? |
| 11 | + |
| 12 | +OpenChoreo is a complete, open-source Internal Developer Platform (IDP) designed to streamline developer workflows, simplify complexity, and deliver secure, scalable developer portals without building everything from scratch. |
| 13 | + |
| 14 | +## Prerequisites |
| 15 | + |
| 16 | +Before you begin, ensure you have: |
| 17 | + |
| 18 | +- A Kubernetes cluster (local or cloud) |
| 19 | +- `kubectl` configured to access your cluster |
| 20 | +- Helm 3.x installed |
| 21 | +- Docker (for local development) |
| 22 | + |
| 23 | +## Quick Start Options |
| 24 | + |
| 25 | +Choose the option that best fits your needs: |
| 26 | + |
| 27 | +### Option 1: Quick Local Setup |
| 28 | +Perfect for trying out OpenChoreo locally with minimal setup. |
| 29 | + |
| 30 | +```bash |
| 31 | +# Coming soon - single command setup |
| 32 | +``` |
| 33 | + |
| 34 | +### Option 2: Full Kubernetes Installation |
| 35 | +Ideal for understanding the full platform architecture. |
| 36 | + |
| 37 | +```bash |
| 38 | +# Add OpenChoreo Helm repository |
| 39 | +helm repo add openchoreo https://openchoreo.github.io/helm-charts |
| 40 | +helm repo update |
| 41 | + |
| 42 | +# Install OpenChoreo |
| 43 | +helm install openchoreo openchoreo/openchoreo --namespace openchoreo-system --create-namespace |
| 44 | +``` |
| 45 | + |
| 46 | +## Next Steps |
| 47 | + |
| 48 | +1. **[Installation Guide](/docs/guides/install/)** - Detailed installation instructions |
| 49 | +2. **[Basic Configuration](/docs/install/configuration/basic/)** - Configure OpenChoreo for your environment |
| 50 | +3. **[Your First Project](/docs/getting-started/first-project/)** - Create and deploy your first application |
| 51 | + |
| 52 | +## Need Help? |
| 53 | + |
| 54 | +- **Documentation**: Browse our [comprehensive guides](/docs/guides/) |
| 55 | +- **Community**: Join our [Discord community](https://discord.com/invite/asqDFC8suT) |
| 56 | +- **Issues**: Report problems on [GitHub Issues](https://github.com/openchoreo/openchoreo/issues) |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +Ready to dive deeper? Continue with our detailed guides or explore the platform architecture. |
0 commit comments