_nav.md

id	nav
title	Documentation Navigation
sidebar_label	Navigation
description	Navigation guide to find the right openCenter documentation for your needs.
doc_type	reference
audience	all users
tags	navigation guide documentation

openCenter CLI Documentation Navigation

This navigation guide helps you find the right documentation for your needs.

Quick Links

• Documentation Home
• Getting Started Tutorial
• CLI Commands Reference
• Contributing Guide

By Documentation Type

Tutorials (Learning-Oriented)

For learning openCenter through hands-on practice:

1. Getting Started - Your first cluster in 10 minutes
2. OpenStack First Cluster - Deploy on OpenStack
3. Kind Local Development - Local development setup
4. VMware Deployment - Deploy on pre-provisioned VMs
5. Multi-Cluster Management - Manage multiple clusters

How-To Guides (Task-Oriented)

For accomplishing specific tasks:

Configuration & Validation

• Validate Configuration
• Customize Services
• Configure Networking

Secrets & Security

• Manage Secrets
• Configure Flux Bootstrap Authentication

Cluster Creation

• Create OpenStack Cluster
• Create Kind Cluster

Operations

• Add Worker Pools
• Backup and Restore
• Upgrade Kubernetes
• Migrate Clusters

Plugins

• Create and Install a CLI Plugin

Troubleshooting & Integration

• Troubleshoot Deployment
• Integrate CI/CD

Reference (Information-Oriented)

For looking up technical details:

CLI & Configuration

• CLI Commands
• Configuration Schema
• Configuration Precedence
• Default Values
• Environment Variables
• Exit Codes
• File Locations

Security

• Audit Signing Key

Platform & Providers

• Platform Services
• Providers
• Validation Rules

Development

• Mise Tasks

Explanation (Understanding-Oriented)

For understanding concepts and design:

• Architecture - System design and decisions
• GitOps Workflow - Repository structure
• Security Model - Security architecture
• Plugin Internal Services - Service plugins, cert-manager behavior, and how to add a new service
• Plugin External CLI - Command plugin discovery and execution model
• Configuration Lifecycle - Config management
• Provider Comparison - Choosing providers
• Drift Detection - Drift and reconciliation

Developer Documentation

For contributors and developers:

Getting Started

• Contributing Guide
• Development Setup
• Code Structure

Testing

• Testing Guide

Extending

• Adding Providers
• Adding Services
• Service Enable/Disable Lifecycle

Building & Releasing

• Build System
• Release Process

Codemaps (Architecture Maps)

Generated from source code for navigating the codebase:

• Index - Package map and cross-references
• CLI Commands - Command tree and registration flow
• Config System - Loader pipeline and type hierarchy
• GitOps Engine - Generation pipeline and templates
• Cluster Lifecycle - Lifecycle services
• Secrets Management - Secrets architecture
• Providers - Cloud provider implementations
• DI Container - Dependency injection

By User Journey

First-Time User

1. Getting Started Tutorial
2. CLI Commands Reference
3. Configuration Schema
4. Troubleshoot Deployment

Operator

1. Validate Configuration
2. Manage Secrets
3. Backup and Restore
4. Upgrade Kubernetes

Developer/Contributor

1. Contributing Guide
2. Development Setup
3. Testing Guide
4. Code Structure

Architect/Decision Maker

1. Architecture
2. Security Model
3. Provider Comparison
4. GitOps Workflow

By Task

Initial Setup

• Getting Started Tutorial
• OpenStack First Cluster
• Create OpenStack Cluster
• Kind Local Development

Configuration

• Configuration Schema
• Default Values
• Validate Configuration

Secrets Management

• Manage Secrets
• Configure Flux Bootstrap Authentication
• Security Model

Deployment

• CLI Commands
• Platform Services
• Troubleshoot Deployment

Day-2 Operations

• Add Worker Pools
• Upgrade Kubernetes
• Backup and Restore
• Migrate Clusters

Troubleshooting

• Troubleshoot Deployment
• Validation Rules
• Exit Codes

Development

• Development Setup
• Testing Guide
• Adding Providers
• Adding Services

External Resources

• Diátaxis Framework - Documentation framework we follow
• GitHub Repository
• Issue Tracker
• Discussions

---

Using This Navigation:

• If you're learning: Start with Tutorials
• If you have a specific task: Check How-To Guides
• If you need technical details: Look in Reference
• If you want to understand why: Read Explanation
• If you're contributing: See Developer Documentation