provisioning/docs/src/getting-started/setup-quickstart.md

179 lines
3.6 KiB
Markdown
Raw Normal View History

# Setup Quick Start - 5 Minutes to Deployment
**Goal**: Get provisioning running in 5 minutes with a working example
## Step 1: Check Prerequisites (30 seconds)
```bash
# Check Nushell
nu --version # Should be 0.109.0+
# Check deployment tool
docker --version # OR
kubectl version # OR
ssh -V # OR
systemctl --version
```
## Step 2: Install Provisioning (1 minute)
```bash
# Option A: Using installer script
curl -sSL https://install.provisioning.dev | bash
# Option B: From source
git clone https://github.com/project-provisioning/provisioning
cd provisioning
./scripts/install.sh
```
## Step 3: Initialize System (2 minutes)
```bash
# Run interactive setup
provisioning setup system --interactive
# Follow the prompts:
# - Press Enter for defaults
# - Select your deployment tool
# - Enter provider credentials (if using cloud)
```
## Step 4: Create Your First Workspace (1 minute)
```bash
# Create workspace
provisioning setup workspace myapp
# Verify it was created
provisioning workspace list
```
## Step 5: Deploy Your First Server (1 minute)
```bash
# Activate workspace
provisioning workspace activate myapp
# Check configuration
provisioning setup validate
# Deploy server (dry-run first)
provisioning server create --check
# Deploy for real
provisioning server create --yes
```
## Verify Everything Works
```bash
# Check health
provisioning platform health
# Check servers
provisioning server list
# SSH into server (if applicable)
provisioning server ssh <server-name>
```
## Common Commands Cheat Sheet
```bash
# Workspace management
provisioning workspace list # List all workspaces
provisioning workspace activate prod # Switch workspace
provisioning workspace create dev # Create new workspace
# Server management
provisioning server list # List servers
provisioning server create # Create server
provisioning server delete <name> # Delete server
provisioning server ssh <name> # SSH into server
# Configuration
provisioning setup validate # Validate configuration
provisioning setup update platform # Update platform settings
# System info
provisioning info # System information
provisioning capability check # Check capabilities
provisioning platform health # Check platform health
```
## Troubleshooting Quick Fixes
**Setup wizard won't start**
```bash
# Check Nushell
nu --version
# Check permissions
chmod +x $(which provisioning)
```
**Configuration error**
```bash
# Validate configuration
provisioning setup validate --verbose
# Check paths
provisioning info paths
```
**Deployment fails**
```bash
# Dry-run to see what would happen
provisioning server create --check
# Check platform status
provisioning platform status
```
## What's Next
After basic setup:
1. **Configure Provider**: Add cloud provider credentials
2. **Create More Workspaces**: Dev, staging, production
3. **Deploy Services**: Web servers, databases, etc.
4. **Set Up Monitoring**: Health checks, logging
5. **Automate Deployments**: CI/CD integration
## Need Help
```bash
# Get help
provisioning help
# Setup help
provisioning help setup
# Specific command help
provisioning <command> --help
# View documentation
provisioning guide system-setup
```
## Key Files
Your configuration is in:
**macOS**: `~/Library/Application Support/provisioning/`
**Linux**: `~/.config/provisioning/`
Important files:
- `system.toml` - System configuration
- `user_preferences.toml` - User settings
- `workspaces/*/` - Workspace definitions
---
**Ready to dive deeper?** Check out the [Full Setup Guide](SETUP_SYSTEM_GUIDE.md)