Deployment Modes
Choose how instances are deployed: directly to Kubernetes, via GitOps, or both
Overview
When deploying an instance from the catalog, you can choose between three deployment modes:
| Mode | Description | Use Case |
|---|---|---|
| Direct | Deploy directly to the Kubernetes cluster | Quick deployments, development environments |
| GitOps | Push manifest to Git repository only | Production environments with ArgoCD/Flux |
| Hybrid | Deploy to cluster AND push to Git | Immediate deployment with Git audit trail |
Selecting a Deployment Mode
Step 1: Start Deployment
- Navigate to Catalog in the left sidebar
- Find the RGD you want to deploy
- Click Deploy
Step 2: Fill in Parameters
Complete the deployment form with the required parameters for your instance.
Step 3: Choose Deployment Mode
At the bottom of the deployment form, you will see the Deployment Mode selector:
┌─────────────────────────────────────────┐
│ Deployment Mode │
│ ┌─────────┐ ┌─────────┐ ┌─────────┐ │
│ │ Direct │ │ GitOps │ │ Hybrid │ │
│ └─────────┘ └─────────┘ └─────────┘ │
└─────────────────────────────────────────┘
Click on your preferred mode before deploying.
Deployment Modes Explained
Direct Deployment
What happens: The instance manifest is applied directly to the Kubernetes cluster.
When to use:
- Development and testing environments
- Quick iterations
- When GitOps is not required
UI Flow:
- Select Direct mode
- Click Deploy
- Instance is created immediately in the cluster
- View status on the Instances page
GitOps Deployment
What happens: The instance manifest is committed to a configured Git repository. An external GitOps tool (ArgoCD, Flux) syncs the manifest to the cluster.
When to use:
- Production environments
- When all changes must go through Git
- Audit and compliance requirements
Prerequisites:
- Project must have a repository configured (see Repository Configuration)
- GitOps tool (ArgoCD/Flux) must be configured to watch the repository
UI Flow:
- Select GitOps mode
- Click Deploy
- Manifest is committed to the configured repository
- GitOps tool detects the change and syncs to cluster
- Once synced, instance appears on the Instances page
With GitOps mode, there may be a delay before the instance appears in knodex. This depends on your GitOps tool's sync interval.
Knodex does not currently redact or prevent secrets from being committed to Git. If your RGD spec contains sensitive values (passwords, API keys, connection strings), those values will be stored as plaintext in the Git repository. Use Kubernetes Secrets, ExternalSecrets, or sealed-secrets to manage sensitive data outside of the instance spec.
Hybrid Deployment
What happens: The instance is deployed directly to the cluster AND the manifest is committed to Git.
When to use:
- Immediate deployment needed with Git audit trail
- Environments transitioning to full GitOps
- When you want both speed and traceability
Prerequisites:
- Project must have a repository configured
UI Flow:
- Select Hybrid mode
- Click Deploy
- Instance is created immediately in the cluster
- Manifest is also committed to the repository
- View status on the Instances page
Repository Requirements
GitOps and Hybrid modes require a repository to be configured for your project.
Check repository status:
- Navigate to Settings → Projects
- Select your project
- Look for the Repository section
If no repository is configured, only Direct mode will be available.
Contact your Platform Administrator to configure a repository for GitOps deployments.
Mode Availability
The available deployment modes depend on your project configuration:
| Project Configuration | Available Modes |
|---|---|
| No repository configured | Direct only |
| Repository configured | Direct, GitOps, Hybrid |
Best Practices
- Development: Use Direct mode for fast iteration
- Staging: Use Hybrid mode for testing with Git trail
- Production: Use GitOps mode for full audit compliance
Next: Browsing the Catalog | Previous: Managing Instances