Key Concepts
Project
Environment
Webhook
Pipeline
Required Permissions
Project Permissions
Webhook Permissions
How to Create a Project
Click Add Project
Select Template
Enter Project Name
Select Git Provider
Configure Repository
- For new repos: Select organization/group and enter repository name
- For existing repos: Select from available repositories
Set Visibility
Select Namespace (Optional)
Configure Environments
- Environment name (e.g., dev, staging, production)
- ArgoCD instance
- Cluster name
- Namespace
Create
How to Run a Pipeline
Open Project
Click Run Pipeline
Select Environment
Select Strategy
- Trunk Based: Branch + commit SHA
- Tag Based: Git tag release
- Feature: Branch name only
- Manual: Custom tag
Select Branch
Select Commit
Select Tag (Optional)
Run
Image Tag Strategies
How to Monitor Pipelines
Pipeline Statuses
Pipeline Actions
How to Manage Environments
Adding an Environment
Open Project Settings
Click Add Environment
Enter Environment Name
Add Deployment Target
- ArgoCD Instance: Select the ArgoCD server
- Cluster Name: Select the Kubernetes cluster
- Namespace: Select the target namespace
- Active: Enable/disable deployments to this target
Add More Targets (Optional)
Save
Environment Requirements
How to Configure Webhooks
Webhooks enable automatic pipeline triggering from Git events.Creating a Webhook
Open Project Settings
Click Create Webhook
Copy Webhook URL
Save Webhook Secret
Configure Git Provider
Webhook Event Types
Managing Webhook Settings
How to Manage Project Variables
Open Variables Tab
Add Variable
Set Variable Type
Save
How to Edit a Project
Open Project
Go to Settings
Click Edit
Modify Settings
Save
How to Delete a Project
Open Project Settings
Click Delete
Choose Repository Action
- Keep repository: Only delete project configuration
- Delete repository: Also delete the Git repository
Confirm
Troubleshooting
Pipeline not triggered by webhook
Pipeline not triggered by webhook
- Verify webhook is enabled (active status)
- Check event type is configured (push, tag, merge_request)
- Confirm webhook URL is correctly configured in Git provider
- Verify webhook secret matches
- Check branch filters match the pushed branch
- Review webhook delivery logs in Git provider
Pipeline fails immediately
Pipeline fails immediately
- Verify Git provider credentials are valid
- Check repository access permissions
- Ensure pipeline configuration files exist in repository
- Verify template configuration is complete
Cannot run pipeline
Cannot run pipeline
- Verify you have execute permission
- Check that at least one environment is configured
- Ensure Git provider connection is active
- Verify branch and commit selection
Environment deployment fails
Environment deployment fails
- Verify ArgoCD instance is accessible
- Check cluster and namespace exist
- Ensure ArgoCD has permissions to deploy
- Review ArgoCD application logs
Cannot create project
Cannot create project
- Verify you have write permission
- Check Git provider is configured and active
- Ensure repository name is valid and unique
- Verify required template fields are filled
Webhook secret lost
Webhook secret lost
- Click Regenerate to create a new secret
- Update the secret in your Git provider settings
- Old webhook deliveries will fail signature verification
Variables not available in pipeline
Variables not available in pipeline
- Verify variables are saved
- Check variable key spelling (case-sensitive)
- Namespace variables require project to be in that namespace
- Project variables override namespace variables
FAQ
Can I use multiple Git providers for one project?
Can I use multiple Git providers for one project?
How do I migrate a project to a different repository?
How do I migrate a project to a different repository?
Can I have multiple environments with the same name?
Can I have multiple environments with the same name?
What happens when I cancel a running pipeline?
What happens when I cancel a running pipeline?
How do I roll back a deployment?
How do I roll back a deployment?
Can webhooks trigger specific environments?
Can webhooks trigger specific environments?
Are pipeline logs retained permanently?
Are pipeline logs retained permanently?
Can I run the same pipeline configuration multiple times?
Can I run the same pipeline configuration multiple times?
What's the difference between Retry and Re-run?
What's the difference between Retry and Re-run?
How do I deploy to multiple clusters simultaneously?
How do I deploy to multiple clusters simultaneously?
Best Practices
Project Organization
- Use consistent naming conventions (team-service-env)
- Group related projects in the same namespace
- Keep one project per microservice/application
- Document project purpose in description
Pipeline Execution
- Use Tag Based strategy for production releases
- Use Trunk Based for continuous deployment
- Always verify environment selection before running
- Monitor pipeline progress for failures
Environment Configuration
- Create separate environments for dev/staging/production
- Use multiple targets for multi-cluster deployments
- Disable targets during maintenance
- Keep production targets with restricted access
Webhook Configuration
- Always configure webhook secrets for security
- Enable only required event types
- Monitor webhook delivery statistics
- Update secrets periodically
Security
- Use private repositories for sensitive code
- Limit execute permission to authorized users
- Store secrets in variables, not in code
- Review pipeline logs for sensitive data exposure
- Rotate webhook secrets regularly
Variables
- Use UPPER_SNAKE_CASE for environment variables
- Document variable purposes
- Use namespace variables for shared configuration
- Override with project variables for specific needs