Skip to main content

Administrator Guide

Welcome to the TrendGate Administrator documentation. As an Admin, you have full control over your organization's quality monitoring system.

🔧 Your Responsibilities​

As a TrendGate Administrator, you manage:

  • Team Access: User invitations and role assignments
  • System Configuration: Organization-wide settings
  • Integration Management: API keys and webhooks
  • Security: Access controls and audit logs
  • Billing: Subscription and usage management

🚀 Initial Setup Checklist​

1. Organization Configuration​

  • Set organization name and details
  • Configure default quality policies
  • Set up notification channels
  • Enable required integrations

2. Team Setup​

  • Invite team members
  • Assign appropriate roles
  • Create teams/groups
  • Set up SSO (if available)

3. Repository Integration​

  • Connect GitHub repositories
  • Configure branch protection
  • Set up webhooks
  • Test quality gates

4. Security Configuration​

  • Enable 2FA requirement
  • Set session timeout
  • Configure IP allowlists
  • Review audit settings

👥 User Management​

Role Assignment​

Assign roles based on responsibilities:

RoleUse CasePermissions
AdminSystem administratorsFull access
DeveloperEngineering teamAPI keys, view all data
QA LeadQuality managersPolicy config, reports
ViewerStakeholdersRead-only access

Inviting Users​

  1. Navigate to Settings → Team
  2. Click Invite Member
  3. Enter email address
  4. Select appropriate role
  5. Add to teams (optional)
  6. Send invitation

Managing Existing Users​

  • Change Roles: Click user → Edit → Select new role
  • Remove Access: Click user → Remove → Confirm
  • Reset Password: Click user → Actions → Reset password
  • View Activity: Click user → Activity log

🔐 Security Best Practices​

Access Control​

  • Enable SSO for enterprise accounts
  • Require 2FA for all users
  • Use role-based permissions
  • Regular access audits

API Key Management​

  • Rotate keys regularly
  • Use descriptive names
  • Set expiration dates
  • Monitor usage

Audit Logging​

  • Review logs weekly
  • Set up alerts for anomalies
  • Export logs for compliance
  • Retain according to policy

⚙️ System Configuration​

Organization Settings​

Configure organization-wide preferences:

organization:
  name: "Your Company"
  timezone: "America/New_York"
  work_days: ["Mon", "Tue", "Wed", "Thu", "Fri"]
  
defaults:
  quality_threshold: 90
  coverage_target: 80
  
notifications:
  channels:
    - email
    - slack
  frequency: "immediate"

Integration Settings​

GitHub Integration​

  1. Install TrendGate GitHub App
  2. Select repositories
  3. Configure permissions
  4. Set up branch protection

Slack Integration​

  1. Add TrendGate to Slack
  2. Choose notification channels
  3. Set alert preferences
  4. Test connection

Custom Webhooks​

{
  "url": "https://your-system.com/webhook",
  "events": ["quality_gate_failed", "policy_violation"],
  "headers": {
    "Authorization": "Bearer YOUR_TOKEN"
  }
}

📊 Monitoring & Maintenance​

System Health​

Monitor key metrics:

  • API response times
  • Data ingestion rates
  • Storage usage
  • Active users

Regular Tasks​

Daily​

  • Check system alerts
  • Review failed quality gates
  • Monitor API usage

Weekly​

  • Review audit logs
  • Check user activity
  • Update team access

Monthly​

  • Rotate API keys
  • Review security settings
  • Analyze usage trends
  • Plan capacity

💰 Billing Management​

Subscription Overview​

  • Current plan details
  • Usage statistics
  • Billing cycle
  • Payment method

Usage Monitoring​

  • Test runs per month
  • Data storage used
  • API calls made
  • Active users

Cost Optimization​

  • Remove inactive users
  • Archive old data
  • Optimize test frequency
  • Review plan fit

🚨 Troubleshooting​

Common Issues​

Users can't access TrendGate

  • Verify invitation sent
  • Check email spam folder
  • Confirm role assignment
  • Review SSO configuration

Quality gates not working

  • Check GitHub permissions
  • Verify webhook delivery
  • Review policy configuration
  • Test with sample PR

High API usage

  • Identify heavy users
  • Review CI/CD frequency
  • Check for loops
  • Implement rate limiting

Emergency Procedures​

Security Breach

  1. Revoke all API keys
  2. Force password resets
  3. Review audit logs
  4. Contact support

System Outage

  1. Check status page
  2. Notify team
  3. Implement fallback
  4. Document incident

📈 Admin Dashboard​

Your admin dashboard provides:

Organization Overview​

  • Total users and roles
  • Repository count
  • Quality trends
  • System usage

Quick Actions​

  • Invite users
  • Create API keys
  • View audit logs
  • Manage billing

Alerts & Notifications​

  • System issues
  • Security alerts
  • Usage warnings
  • Policy violations

🛠️ Advanced Configuration​

Custom Roles​

Create specialized roles:

custom_roles:
  release_manager:
    base_role: "qa_lead"
    additional_permissions:
      - "approve_production_deploy"
      - "override_quality_gates"

Data Retention​

Configure data lifecycle:

retention:
  test_results: 90  # days
  audit_logs: 365
  metrics: 180
  
archival:
  enabled: true
  storage: "s3"
  compress: true

Advanced Security​

security:
  ip_allowlist:
    - "10.0.0.0/8"
    - "192.168.0.0/16"
    
  session:
    timeout: 30  # minutes
    max_concurrent: 3
    
  password_policy:
    min_length: 12
    require_special: true
    expire_days: 90

📚 Resources​

Need help? Contact support@trendgate.ai or call our admin hotline.