GitHub Integration

​

Overview

• Configuration Storage: Store Helm values and manifests in your repository
• Version Control: Track all infrastructure changes with Git history
• GitOps Workflows: Sync changes between Ankra and your repository
• Audit Trail: Full history of who changed what and when
• Collaboration: Use pull requests and code review for infrastructure changes

​

Connecting GitHub

​

Repository Structure

repository/
└── cluster/
    └── {cluster-name}/
        ├── stacks/
        │   └── {stack-name}/
        │       ├── values/
        │       │   └── {addon-name}.yaml
        │       └── manifests/
        │           └── {manifest-name}.yaml
        └── settings.yaml

​

Files Explained

​

Sync Behavior

​

Ankra → GitHub

1. Changes are saved to the platform
2. Configuration is exported to the connected repository
3. A commit is created with the changes
4. You can see the commit in GitHub history

​

GitHub → Ankra

1. Push changes to the configured branch
2. Ankra detects the changes
3. Configuration is imported and validated
4. Changes are applied to your cluster

​

Using GitOps

​

Making Changes via Git

git clone https://github.com/your-org/your-repo.git
cd your-repo

# Edit an add-on's values
vim cluster/my-cluster/stacks/monitoring/values/prometheus.yaml

git add .
git commit -m "Increase Prometheus retention to 30d"
git push origin main

​

Pull Request Workflow

1. Create a feature branch
2. Make configuration changes
3. Open a pull request
4. Review changes with your team
5. Merge to trigger sync

​

Viewing Git History

​

In Ankra

• Last sync timestamp
• Recent commits affecting this cluster
• Sync status and any errors

​

In GitHub

• All configuration changes over time
• Who made each change
• Commit messages explaining changes

​

Managing Access

​

Repository Permissions

​

Revoking Access

1. Go to cluster Settings → Repository
2. Click Disconnect

1. Go to GitHub Settings → Applications → Installed GitHub Apps
2. Find Ankra and click Configure, then Uninstall (or adjust which repositories it can access)

​

Troubleshooting

​

Sync Failures

1. Repository Access: Ensure the Ankra app still has access to the repository
2. Branch Exists: Verify the configured branch exists
3. Valid YAML: Ensure all configuration files are valid YAML
4. Conflicts: Resolve any merge conflicts in the repository

​

Permission Errors

1. Go to GitHub Settings → Applications → Installed GitHub Apps
2. Find Ankra and click Configure
3. Ensure the repository is in the “Selected repositories” list
4. If GitHub shows a review updated permissions prompt, approve it. New permissions added to the Ankra App (such as Pull requests or Workflows) are not granted to existing installations until an owner re-approves them.

​

Out of Sync

1. Navigate to the cluster’s GitOps page
2. Click Force Sync to re-sync from the repository
3. Review any conflicts and resolve them

​

Best Practices

​

CI/CD Integration

​

GitHub Actions Example

name: Validate Ankra Config
on:
  pull_request:
    paths:
      - 'cluster/**'

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Validate YAML
        run: |
          find cluster -name "*.yaml" -exec yamllint {} \;

​

Deployment Pipeline

name: Deploy to Production
on:
  push:
    branches: [main]
    paths:
      - 'cluster/production/**'

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Trigger Ankra Sync
        run: |
          curl -X POST \
            -H "Authorization: Bearer ${{ secrets.ANKRA_API_TOKEN }}" \
            https://platform.ankra.app/api/v1/clusters/$CLUSTER_ID/sync