Catalog Item Prerequisites

Complete these prerequisites before creating or deploying GitOps Catalog items.

Required Access

• Platform Admin or Team Admin role in Konstruct
• Git repository access with write permissions to your organization's GitOps repository
• GitOps repository registered with your Konstruct organization

Required Knowledge

All Catalog Item Types

• Basic understanding of GitOps architecture
• Familiarity with Git workflows (clone, commit, push)
• Understanding of YAML syntax
• Knowledge of Kubernetes basics (pods, deployments, namespaces)

For Application Catalog Items

• Basic Helm chart knowledge (Chart.yaml, values.yaml, templates)
• Understanding of Kubernetes manifests
• Familiarity with Argo CD Applications

For IaC Catalog Items

• Terraform fundamentals (resources, variables, outputs, providers)
• Understanding of Crossplane and Terraform provider integration
• Cloud provider knowledge (AWS, Azure, or GCP)
• Familiarity with infrastructure-as-code concepts

For Hybrid Catalog Items

• All requirements from both Application Catalog Items and IaC Catalog Items
• Understanding of how infrastructure and applications connect

Required Tools

Install these tools on your local machine:

1. Git client

   git --version

2. Text editor or IDE

   • VS Code, Vim, or any editor with YAML/HCL support

3. Access to GitOps repository

   • Repository URL from your organization settings
   • Git credentials or SSH key configured

Validation Steps

Follow these steps to verify you have the required access:

1. Verify Organization Registration

1. Navigate to Organizations in the Konstruct UI

2. Click your organization name

3. Go to the Repository tab

4. Confirm your GitOps repository URL is displayed

2. Clone GitOps Repository

1. Clone your organization's GitOps repository:

   git clone <your-gitops-repo-url>

2. Navigate into the repository:

   cd <your-gitops-repo>

3. Verify repository structure:

   ls -la

3. Verify Catalog Directory

1. Check if the catalog directory exists:

   ls catalog/

2. If the directory does not exist, create it:

   mkdir -p catalog
   git add catalog/
   git commit -m "feat: add catalog directory"
   git push origin main

4. Verify Write Access

1. Create a test file:

   echo "test" > catalog/test.txt

2. Commit and push:

   git add catalog/test.txt
   git commit -m "test: verify write access"
   git push origin main

3. Remove the test file:

   git rm catalog/test.txt
   git commit -m "test: cleanup test file"
   git push origin main

If all commands succeed, you have the required access.

Additional Requirements

For IaC Catalog Items

Ensure your Konstruct platform has:

• Crossplane installed in the management cluster
• Terraform provider configured for Crossplane
• Cloud provider credentials configured (AWS IRSA, Azure Managed Identity, or GCP Workload Identity)
• S3 or equivalent backend configured for Terraform state storage

Contact your Platform Admin if any of these are not configured.

For Production Use

• Secret management backend configured (HashiCorp Vault, AWS Secrets Manager, or Azure Key Vault)
• Git repository backup strategy in place
• Argo CD installed and configured
• Monitoring for deployment tracking

What's Next?

• Understand catalog item types and choose the right type
• Create an Application catalog item
• Create an IaC catalog item
• Learn about catalog item annotations