Skip to main content
Version: 5.5

Versioning

Versioning of configurations

Versioning of configurations is essential for ensuring that the OPC router operates securely and transparently in enterprise environments. It offers several advantages: Traceability: All changes to the system configuration are documented so that you can see who made which changes and when at any time. Security: In the event of problems or misconfigurations, you can quickly revert to an earlier, stable version. Compliance: Many industries have regulatory requirements that demand documentation and traceability of system changes.

Integrated versioning in OPC Router

OPC Router supports Git internally and uses YAML configuration files, which enables effective management and versioning of configurations. This integrated versioning provides a ready-to-use solution for tracking changes and rolling back to previous versions.

Advantages of integrated versioning

Easy to use: No additional tools or setups required. Automatic versioning: Every change is automatically versioned and documented. Quick recovery: If necessary, you can easily revert to a previous version.

Extension through integration with hosted Git servers

Integrated versioning can be made even more powerful by connecting to hosted Git servers such as GitHub, Bitbucket, or Microsoft Azure DevOps. These external repositories offer additional features such as centralized management, advanced access control, and comprehensive change tracking.

Implementation strategies Integration with hosted Git servers

Advantages: Centralized management, access control, and comprehensive change tracking. Implementation: Connect the OPC Router's internal Git system to a hosted Git server (e.g., GitHub, Bitbucket, Microsoft Azure DevOps).

warning

It is important to ensure that the repositories are private to prevent unauthorized access.

Automated versioning

Support from the OPC Router: Automatic versioning and change tracking directly in the OPC Router. Automated backups: Set up automated backup processes to regularly back up the configuration files.

Best Practices

To take full advantage of versioning, the following best practices should be observed

Commits: Regular commits of the current configuration to the local Git repository. Pushes: Regular pushing of commits to the hosted Git server, e.g., daily or after every significant change. This can be done manually with a Git client such as Git Console, GitHub Desktop, or SourceTree. Change logs: Keep a detailed log of all changes made, including the date, time, and name of the person responsible. Use tools that can automate this logging. Test environment: Implement a test environment where changes are first validated before being transferred to the production environment. Use staging environments to introduce changes gradually and monitor their effects. Security of secrets: Secrets or passwords should never be stored in the Git repository. The OPC Router always stores secrets in a separate, local vault to ensure that they are not versioned.

Practical implementation Integration into hosted Git servers

Setting up the Git server: Setting up a hosted Git server (e.g., GitHub, Bitbucket, Microsoft Azure DevOps) to manage the configuration files. Ensure that the repositories are private. Connecting the OPC Router: Configure the OPC Router to use the hosted Git server for versioning. Management and monitoring: Use the Git server to manage, track, and monitor all configuration changes.

Automated versioning

Activation in the OPC Router: Activation of automatic versioning and change tracking in the OPC Router. Automated commits: Setting up commit routines to regularly back up the configuration files. Push processes: Manually or automatically push commits to the hosted Git server. Monitoring: Regularly check and maintain versioning systems to ensure integrity and availability.

Summary

Versioning configurations is an essential part of operating OPC Router in enterprise environments.

It ensures that changes are traceable, increases security through easy rollbacks, and meets regulatory requirements.

By using the OPC Router's integrated versioning and extending it with hosted Git servers, companies can significantly improve the reliability and maintainability of their OPC Router instances.