Skip to content

Admin Guide

The Admin Guide provides documentation for configuring, monitoring, and maintaining kMetal. This section is for platform administrators.

Installation

Under Cluster

Prepare and set up the under cluster that will host kMetal.

Key Topics:

  • System and network requirements
  • Kubernetes cluster setup
  • Registry access

kMetal Installation

Install and configure kMetal on your prepared under cluster.

Key Topics:

  • Helm umbrella chart install
  • Registry authentication
  • Values overlay
  • Post-installation tasks
  • Upgrade procedures

Platform Validation

Practical validation procedures to ensure platform health and readiness.

Key Topics:

  • Quick validation script
  • Manual validation steps
  • Component health indicators
  • Troubleshooting common issues

Configuration Management

Platform Values

The main chart values shape and platform-wide settings.

Key Topics:

  • Top-level keys in kmetal-chart values
  • Per-component overrides
  • Environment-specific overlays

Component Configuration

Detailed configuration for individual platform components.

Key Topics:

  • Per-component values shape
  • Resource allocation and limits

Operations & Maintenance

Monitoring

Set up comprehensive monitoring and observability for the platform.

Key Topics:

  • Platform metrics and alerting
  • Log aggregation and analysis
  • Performance monitoring

Backup & Recovery

Implement robust backup and disaster recovery procedures.

Key Topics:

  • Platform state backup
  • Cluster configuration backup
  • Recovery procedures

Upgrades

Procedures for upgrading platform components and infrastructure.

Key Topics:

  • Under cluster upgrades
  • Platform component upgrades
  • Tenant cluster upgrades

Disaster Recovery

Recover from catastrophic failures.

Key Topics:

  • Recovery procedures
  • DR testing
  • RTO/RPO targets

Scaling

Scale the platform for high availability and performance.

Key Topics:

  • Horizontal and vertical scaling
  • Resource planning
  • Performance optimization
  • Capacity management

Maintenance

Regular maintenance tasks and update procedures.

Key Topics:

  • Platform updates and upgrades
  • Certificate rotation
  • Log rotation and cleanup
  • Health check procedures

Troubleshooting

Common Issues

Solutions for frequently encountered problems.

Key Topics:

  • Installation and deployment issues
  • Network connectivity problems
  • Performance troubleshooting
  • Resource allocation issues

Secret Management

Troubleshoot secret-related issues and implement proper secret management.

Key Topics:

  • Registry authentication problems
  • Console credential issues
  • Certificate management problems
  • Secret rotation procedures

Component Debugging

Debug platform component issues and failures.

Key Topics:

  • Component deployment problems
  • Dependencies and ordering
  • Resource conflicts

Quick Reference

For commands, procedures, and troubleshooting: