Initial commit: loc_az_hci (smom-dbis-138 excluded via .gitignore)
Some checks failed
Test / test (push) Has been cancelled
Some checks failed
Test / test (push) Has been cancelled
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
defiQUG
111
docs/reference/api-reference.md
Normal file
111
docs/reference/api-reference.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# API Reference
|
||||
|
||||
API documentation for the Azure Stack HCI project.
|
||||
|
||||
## Proxmox API
|
||||
|
||||
### Authentication
|
||||
|
||||
```bash
|
||||
# Get ticket
|
||||
curl -k -d "username=root@pam&password=YOUR_PASSWORD" \
|
||||
https://PROXMOX_HOST:8006/api2/json/access/ticket
|
||||
|
||||
# Use ticket in subsequent requests
|
||||
curl -k -H "Cookie: PVEAuthCookie=TICKET" \
|
||||
-H "CSRFPreventionToken: TOKEN" \
|
||||
https://PROXMOX_HOST:8006/api2/json/version
|
||||
```
|
||||
|
||||
### Common Endpoints
|
||||
|
||||
- `GET /api2/json/version` - Get Proxmox version
|
||||
- `GET /api2/json/cluster/status` - Get cluster status
|
||||
- `GET /api2/json/nodes` - List nodes
|
||||
- `GET /api2/json/nodes/{node}/qemu` - List VMs on node
|
||||
- `POST /api2/json/nodes/{node}/qemu` - Create VM
|
||||
- `GET /api2/json/nodes/{node}/qemu/{vmid}/config` - Get VM config
|
||||
- `PUT /api2/json/nodes/{node}/qemu/{vmid}/config` - Update VM config
|
||||
|
||||
## Azure Arc API
|
||||
|
||||
### Connected Machines
|
||||
|
||||
```bash
|
||||
# List connected machines
|
||||
az connectedmachine list --resource-group HC-Stack
|
||||
|
||||
# Get machine details
|
||||
az connectedmachine show \
|
||||
--resource-group HC-Stack \
|
||||
--name MACHINE_NAME
|
||||
|
||||
# Delete machine
|
||||
az connectedmachine delete \
|
||||
--resource-group HC-Stack \
|
||||
--name MACHINE_NAME
|
||||
```
|
||||
|
||||
### Kubernetes Clusters
|
||||
|
||||
```bash
|
||||
# List connected clusters
|
||||
az connectedk8s list --resource-group HC-Stack
|
||||
|
||||
# Get cluster details
|
||||
az connectedk8s show \
|
||||
--resource-group HC-Stack \
|
||||
--name CLUSTER_NAME
|
||||
```
|
||||
|
||||
## Kubernetes API
|
||||
|
||||
### Common kubectl Commands
|
||||
|
||||
```bash
|
||||
# Get nodes
|
||||
kubectl get nodes
|
||||
|
||||
# Get pods
|
||||
kubectl get pods --all-namespaces
|
||||
|
||||
# Get services
|
||||
kubectl get services --all-namespaces
|
||||
|
||||
# Get deployments
|
||||
kubectl get deployments --all-namespaces
|
||||
|
||||
# Describe resource
|
||||
kubectl describe pod POD_NAME -n NAMESPACE
|
||||
|
||||
# Get logs
|
||||
kubectl logs POD_NAME -n NAMESPACE
|
||||
|
||||
# Execute command in pod
|
||||
kubectl exec -it POD_NAME -n NAMESPACE -- COMMAND
|
||||
```
|
||||
|
||||
## Cloudflare API
|
||||
|
||||
### Tunnel Management
|
||||
|
||||
```bash
|
||||
# List tunnels
|
||||
curl -X GET "https://api.cloudflare.com/client/v4/accounts/ACCOUNT_ID/cfd_tunnel" \
|
||||
-H "Authorization: Bearer API_TOKEN" \
|
||||
-H "Content-Type: application/json"
|
||||
|
||||
# Create tunnel
|
||||
curl -X POST "https://api.cloudflare.com/client/v4/accounts/ACCOUNT_ID/cfd_tunnel" \
|
||||
-H "Authorization: Bearer API_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"name":"tunnel-name","config_src":"cloudflare"}'
|
||||
```
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Proxmox VE API Documentation](https://pve.proxmox.com/pve-docs/api-viewer/index.html)
|
||||
- [Azure Arc REST API](https://docs.microsoft.com/rest/api/azurearc/)
|
||||
- [Kubernetes API Documentation](https://kubernetes.io/docs/reference/kubernetes-api/)
|
||||
- [Cloudflare API Documentation](https://developers.cloudflare.com/api/)
|
||||
|
||||
224
docs/reference/command-reference.md
Normal file
224
docs/reference/command-reference.md
Normal file
@@ -0,0 +1,224 @@
|
||||
# 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/)
|
||||
|
||||
Reference in New Issue
Block a user