c39465c2bd
Some checks failed
Test / test (push) Has been cancelled
Co-authored-by: Cursor <cursoragent@cursor.com>
225 lines
3.6 KiB
Markdown
225 lines
3.6 KiB
Markdown
# Command Reference
|
|
|
|
Quick reference for common commands used in the Azure Stack HCI project.
|
|
|
|
## Prerequisites Check
|
|
|
|
```bash
|
|
# Check all prerequisites
|
|
./scripts/utils/prerequisites-check.sh
|
|
|
|
# Check specific component
|
|
./scripts/utils/prerequisites-check.sh proxmox
|
|
./scripts/utils/prerequisites-check.sh azure
|
|
./scripts/utils/prerequisites-check.sh kubernetes
|
|
```
|
|
|
|
## Connection Testing
|
|
|
|
```bash
|
|
# Test Proxmox connections
|
|
./scripts/utils/test-proxmox-connection.sh
|
|
|
|
# Test Cloudflare connection
|
|
./scripts/utils/test-cloudflare-connection.sh
|
|
```
|
|
|
|
## Deployment
|
|
|
|
```bash
|
|
# Complete deployment
|
|
./scripts/deploy/complete-deployment.sh
|
|
|
|
# Deploy all services
|
|
./scripts/deploy/deploy-all-services.sh
|
|
```
|
|
|
|
## VM Management
|
|
|
|
### Create VMs
|
|
|
|
```bash
|
|
# Create all VMs
|
|
./scripts/vm-management/create/create-all-vms.sh
|
|
|
|
# Create VM from template
|
|
./scripts/vm-management/create/create-vms-from-template.sh
|
|
|
|
# Create VM from image
|
|
./scripts/vm-management/create/create-vm-from-image.sh
|
|
```
|
|
|
|
### Configure VMs
|
|
|
|
```bash
|
|
# Complete VM setup
|
|
./scripts/vm-management/configure/complete-vm-setup.sh
|
|
|
|
# Fix VM configuration
|
|
./scripts/vm-management/configure/fix-vm-config.sh
|
|
```
|
|
|
|
### Monitor VMs
|
|
|
|
```bash
|
|
# Check VM status
|
|
./scripts/vm-management/monitor/check-vm-status.sh
|
|
|
|
# Check VM readiness
|
|
./scripts/vm-management/monitor/check-vm-readiness.sh
|
|
```
|
|
|
|
## Health Checks
|
|
|
|
```bash
|
|
# Check all components
|
|
./scripts/health/health-check-all.sh
|
|
|
|
# Check specific component
|
|
./scripts/health/check-proxmox-health.sh
|
|
./scripts/health/check-azure-arc-health.sh
|
|
./scripts/health/check-kubernetes-health.sh
|
|
./scripts/health/check-services-health.sh
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
# Run all tests
|
|
./scripts/test/run-all-tests.sh
|
|
|
|
# Run specific test
|
|
./tests/e2e/test-full-stack.sh
|
|
```
|
|
|
|
## Validation
|
|
|
|
```bash
|
|
# Validate deployment
|
|
./scripts/validate/validate-deployment.sh
|
|
|
|
# Validate scripts
|
|
./scripts/quality/validate-scripts.sh
|
|
|
|
# Lint scripts
|
|
./scripts/quality/lint-scripts.sh
|
|
```
|
|
|
|
## Monitoring
|
|
|
|
```bash
|
|
# Collect metrics
|
|
./scripts/monitoring/collect-metrics.sh
|
|
|
|
# Setup alerts
|
|
./scripts/monitoring/setup-alerts.sh
|
|
```
|
|
|
|
## Documentation
|
|
|
|
```bash
|
|
# Generate docs index
|
|
./scripts/docs/generate-docs-index.sh
|
|
|
|
# Validate documentation
|
|
./scripts/docs/validate-docs.sh
|
|
|
|
# Update diagrams
|
|
./scripts/docs/update-diagrams.sh
|
|
```
|
|
|
|
## Makefile Commands
|
|
|
|
```bash
|
|
# Run tests
|
|
make test
|
|
|
|
# Lint scripts
|
|
make lint
|
|
|
|
# Validate everything
|
|
make validate
|
|
|
|
# Health check
|
|
make health-check
|
|
|
|
# Validate docs
|
|
make validate-docs
|
|
```
|
|
|
|
## Proxmox Commands
|
|
|
|
```bash
|
|
# List VMs
|
|
qm list
|
|
|
|
# Get VM status
|
|
qm status <vmid>
|
|
|
|
# Get VM config
|
|
qm config <vmid>
|
|
|
|
# Start VM
|
|
qm start <vmid>
|
|
|
|
# Stop VM
|
|
qm stop <vmid>
|
|
|
|
# Shutdown VM
|
|
qm shutdown <vmid>
|
|
|
|
# Clone VM
|
|
qm clone <template-id> <new-vmid> --name <name>
|
|
```
|
|
|
|
## Kubernetes Commands
|
|
|
|
```bash
|
|
# Get nodes
|
|
kubectl get nodes
|
|
|
|
# Get pods
|
|
kubectl get pods --all-namespaces
|
|
|
|
# Get services
|
|
kubectl get services --all-namespaces
|
|
|
|
# Describe resource
|
|
kubectl describe <resource> <name> -n <namespace>
|
|
|
|
# Get logs
|
|
kubectl logs <pod-name> -n <namespace>
|
|
|
|
# Execute command
|
|
kubectl exec -it <pod-name> -n <namespace> -- <command>
|
|
```
|
|
|
|
## Azure CLI Commands
|
|
|
|
```bash
|
|
# Login
|
|
az login
|
|
|
|
# List subscriptions
|
|
az account list
|
|
|
|
# Set subscription
|
|
az account set --subscription <subscription-id>
|
|
|
|
# List resource groups
|
|
az group list
|
|
|
|
# List connected machines
|
|
az connectedmachine list --resource-group HC-Stack
|
|
|
|
# List connected clusters
|
|
az connectedk8s list --resource-group HC-Stack
|
|
```
|
|
|
|
## Additional Resources
|
|
|
|
- [Scripts README](../scripts/README.md)
|
|
- [Deployment Guide](../deployment/deployment-guide.md)
|
|
- [Operations Runbooks](../operations/runbooks/)
|
|
|