Skip to content

GitOps

10x uses a GitOps-based approach for configuration management to provide a secure, version-controlled solution for managing configurations across distributed environments.

The 10x Engine can retrieve configuration files directly from a user-managed Git repository, ensuring all changes are version-controlled, auditable, and easily revertible if necessary.

By leveraging Git as the single source of truth, users benefit from built-in collaboration, history tracking, and the ability to manage configurations using existing tools.

Getting started

  1. Fork the Config Repo into your own GitHub account.

  2. Create a new branch for your app configuration (e.g., acmeCloudReporter)

  3. Edit app config files Use GitHub’s built-in file editor or clone the repository to make changes locally. See the documentation of each app for its available configuration options.

  4. Commit and Push Changes.

  5. Follow the instructions in the Deploy section for details on how to deploy 10x with your new configuration.

Best Practices

Branch Strategy: Use separate branches for different apps and environments to maintain configuration isolation and enable safe parallel development.

Secret Management: Never commit sensitive credentials to Git. Use JavaScript expressions with TenXEnv.get() to access runtime environment variables: 

apiKey: $=TenXEnv.get("API_SECRET")
dbPassword: $=TenXEnv.get("DB_PASSWORD")

Repository Sync: Regularly sync with the base repository to receive security patches, feature updates, and performance improvements.

Version Tags: Tag stable configurations for production deployments to enable quick rollbacks and maintain deployment history.

Configuration Validation: Test configuration changes in development environments before merging to production branches.

Access Control: Implement branch protection rules and code review requirements for production configuration changes.