How-to Guides

Practical, goal-oriented instructions for accomplishing specific OCM tasks.

Master OCM through practical, task-oriented guides that solve real problems. These how-to guides help you accomplish specific goals when working with OCM in production environments.

What Are How-to Guides?

How-to guides are task-oriented recipes that show you how to solve specific problems. Unlike tutorials, which are learning experiences, how-to guides assume you understand the basics and need to accomplish a concrete task.

Each guide follows a consistent structure:

  • Clear objective and prerequisites
  • Step-by-step instructions
  • Expected results and verification
  • Troubleshooting (when needed)

Prerequisites

Before using these guides, you should have:

  • Completed the Getting Started guides or equivalent OCM experience
  • Basic understanding of OCM concepts (components, resources, versions)
  • The OCM CLI installed and configured
  • Access to necessary tools and infrastructure for your specific task

Learning Path

These guides follow the task-oriented approach from the Diataxis framework. They focus on achieving specific goals rather than teaching concepts. If you’re new to OCM, complete the Getting Started guides first.

For deeper understanding of OCM’s architecture and design, explore the Concepts section. To build comprehensive knowledge through hands-on exploration, check out the Tutorials section.

Transfer Components across an Air Gap
Transfer a signed OCM component version into an air-gapped registry via a CTF archive.
Configure Credentials for OCM Controllers
Configure authentication for OCM Controllers to access private OCM repositories.
Configure Credentials for Multiple Registries
Set up OCM credentials to authenticate against multiple OCI registries with explicit entries and Docker config fallback.
Configure Credentials for Signing
Configure OCM signing and verification keys using .ocmconfig or signer specification files.
Download Resources from Component Versions
Extract resources from OCM component versions to your local filesystem.
Migrate Legacy Credentials
Update your legacy OCM credential configuration to work with the new OCM.
Resolving Components across Multiple Registries
Configure resolvers to recursively resolve component references distributed across multiple OCI registries.
Sign Component Versions
Cryptographically sign a component version to establish authenticity and enable verification.
Verify Component Versions
Validate component version signatures to ensure authenticity and integrity.
Generate Signing Keys
Create an RSA key pair for signing and verifying OCM component versions.
Migrate from Fallback to Deterministic Repository Resolvers
Replace deprecated fallback resolvers with glob-based resolvers for deterministic and efficient component resolution.
Transfer Helm Charts with OCM
Transfer component versions containing Helm chart resources between OCI registries using the OCM CLI.
How to use the OCM CLI container image
Use the OCM CLI container image to create and get a component version.