{"id":26256490,"url":"https://github.com/netcracker/qubership-envgene","last_synced_at":"2026-03-05T09:01:15.135Z","repository":{"id":273938171,"uuid":"918288793","full_name":"Netcracker/qubership-envgene","owner":"Netcracker","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-02T13:39:57.000Z","size":10034,"stargazers_count":6,"open_issues_count":92,"forks_count":21,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-03-02T14:38:04.810Z","etag":null,"topics":["qubership-cm"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Netcracker.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-01-17T16:17:16.000Z","updated_at":"2026-03-02T10:38:46.000Z","dependencies_parsed_at":"2025-02-10T10:21:37.051Z","dependency_job_id":"6ada666f-4a48-4b0f-93b0-ce8a677ed622","html_url":"https://github.com/Netcracker/qubership-envgene","commit_stats":null,"previous_names":["netcracker/qubership-envgene"],"tags_count":128,"template":false,"template_full_name":null,"purl":"pkg:github/Netcracker/qubership-envgene","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netcracker%2Fqubership-envgene","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netcracker%2Fqubership-envgene/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netcracker%2Fqubership-envgene/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netcracker%2Fqubership-envgene/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Netcracker","download_url":"https://codeload.github.com/Netcracker/qubership-envgene/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Netcracker%2Fqubership-envgene/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30117470,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T08:19:04.902Z","status":"ssl_error","status_checked_at":"2026-03-05T08:17:37.148Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["qubership-cm"],"created_at":"2025-03-13T20:18:17.168Z","updated_at":"2026-03-05T09:01:15.092Z","avatar_url":"https://github.com/Netcracker.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EnvGene\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Build Status](https://img.shields.io/badge/Build-Passing-brightgreen.svg)](https://github.com/Netcracker/qubership-envgene/actions)\n\n![Environment generator logo](/docs/images/envgene-logo.png \"Environment generator\")\n\n- [EnvGene](#envgene)\n  - [Overview](#overview)\n  - [🎯 Goals](#-goals)\n  - [✨ Key Features](#-key-features)\n    - [Version Control \\\u0026 History](#version-control--history)\n    - [Automation \\\u0026 CI/CD](#automation--cicd)\n    - [Security \\\u0026 Credentials](#security--credentials)\n  - [🚀 Quick Start](#-quick-start)\n    - [System Requirements](#system-requirements)\n    - [Basic Usage](#basic-usage)\n  - [📚 Documentation](#-documentation)\n    - [Getting Started](#getting-started)\n    - [Core Concepts](#core-concepts)\n    - [How-To Guides](#how-to-guides)\n    - [Advanced Features](#advanced-features)\n    - [Examples \\\u0026 Samples](#examples--samples)\n    - [Development](#development)\n  - [🤝 Contributing](#-contributing)\n  - [📄 License](#-license)\n\n## Overview\n\n**EnvGene** (Environment Generator) is git-based tool for generating and versioning Environment configs using templates. Helps manage parameters for many similar cloud Environments.\n\n## 🎯 Goals\n\nEnvGene simplifies Environment management by providing:\n\n- **Template-based Environment Creation**: Define reusable templates for your Environment types\n- **Environment Inventory Management**: Define and manage inventories of your Environments\n- **Automated Environment Provisioning**: Create Environments from inventory and versioned templates with automated pipelines\n- **Configuration as Code**: Store all Environment configurations in Git with full history and diff capabilities\n\n## ✨ Key Features\n\n### Version Control \u0026 History\n\n- **Git-native Versioning**: Full history of Environment/parameter changes using native Git functionality\n- **Configuration Comparison**: Compare Environments configuration using native Git diff\n- **Template Versioning**: Version-controlled templates with Maven artifact management\n- **Change Tracking**: Track all modifications with detailed commit history\n\n### Automation \u0026 CI/CD\n\n- **Automated Environment Creation/Update**: Automation for Environment generation\n- **Pipeline Integration**: Integration with GitLab CI and GitHub Actions\n- **Build Automation**: Automated template building and artifact publishing\n\n### Security \u0026 Credentials\n\n- **Encrypted Credentials Management**: Secure credential storage in Git using encryption\n- **Credential Rotation**: Automated credential rotation capabilities\n\n## 🚀 Quick Start\n\n### System Requirements\n\n1. GitHub account with permission to create repositories\n2. Git client installed locally\n\n### Basic Usage\n\n1. **Init Template Repository**\n\n2. **Create Environment Template**\n\n   See the guide: [Create Simple Template](/docs/how-to/create-simple-template.md)\n\n3. **Init Instance Repository**\n\n   Copy [the workflow files](/github_workflows/instance-repo-pipeline/.github) to your Instance repository on GitHub.\n\n4. **Create Cluster**\n\n   See: [Create Cluster guide](/docs/how-to/create-cluster.md)\n\n5. **Create Inventory for Environment**\n\n   See: [Create Inventory guide](/docs/how-to/create-environment-inventory.md)\n\n6. **Generate Environment**\n\n   Run the pipeline with [these parameters](/docs/instance-pipeline-parameters.md):\n\n   ```text\n   ENV_NAMES: \u003ccluster-name\u003e/\u003cenvironment-name\u003e\n   ENV_BUILDER: true\n   GENERATE_EFFECTIVE_SET: true\n   GH_ADDITIONAL_PARAMS:\n      SD_SOURCE_TYPE: json\n      SD_DATA: \u003cyour-Solution-Descriptor-content\u003e\n   ```\n\n   \u003e [!NOTE] For special instructions on the GitHub pipeline, see [GH_ADDITIONAL_PARAMS docs](/docs/instance-pipeline-parameters.md)\n   \u003e and the [pipeline description](/github_workflows/instance-repo-pipeline/.github/docs/README.md)\n\nAfter the pipeline finishes, the Environment configuration will be generated and committed to your instance repository:\n\n- [Environment Instance Object](/docs/envgene-objects.md#environment-instance-objects)\n- [Effective Set](/docs/features/calculator-cli.md)\n\n## 📚 Documentation\n\n### Getting Started\n\n- [**Quick Start Guide**](#-quick-start) - Create your first Environment\n\n### Core Concepts\n\n- [**EnvGene Objects**](/docs/envgene-objects.md) - What are EnvGene objects and how they work\n- [**Configuration Files**](/docs/envgene-configs.md) - File formats and config options\n- [**Pipeline Configuration**](/docs/envgene-pipelines.md) - How EnvGene pipelines work\n- [**Repository Variables**](/docs/envgene-repository-variables.md) - CI/CD variables used in EnvGene repositories\n- [**Template Macros**](/docs/template-macros.md) - How to use EnvGene macros in templates\n- [**Instance Pipeline Parameters**](/docs/instance-pipeline-parameters.md) - Reference for Instance pipeline inputs\n\n### How-To Guides\n\n**Repository Setup:**\n\n- [**Create Simple Template**](/docs/how-to/create-simple-template.md) - Create your first environment template\n- [**Create Cluster**](/docs/how-to/create-cluster.md) - Set up a new cluster\n- [**Create Environment Inventory**](/docs/how-to/create-environment-inventory.md) - Define environment inventory\n- [**Initialize and Upgrade Instance Repository**](/docs/how-to/envgene-maitanance.md) - Set up or upgrade Instance Repository using GSF\n\n**Configuration Management:**\n\n- [**Update Template Version**](/docs/how-to/update-template-version.md) - Update environment template version\n- [**Override Template Parameters**](/docs/how-to/environment-specific-parameters.md) - Override template parameters for specific environments\n- [**Configure Resource Profiles**](/docs/how-to/configure-resource-profiles.md) - Configure performance parameters for different environment types\n\n**Advanced Configuration:**\n\n- [**Configure Namespace Names for Sites**](/docs/how-to/configure-ns-names-for-sites.md) - Site-specific namespace naming\n- [**Credential Encryption**](/docs/how-to/credential-encryption.md) - Secure credential storage and rotation\n- [**Migrate to Dot-Notated Parameters**](/docs/how-to/dot-notated-parameter-migration.md) - Parameter format migration\n\n### Advanced Features\n\n- [**Solution Descriptor Processing**](/docs/features/sd-processing.md) - Manage [Solution Descriptor](/docs/envgene-objects.md#solution-descriptor) for your Environments\n- [**Effective Set Calculation**](/docs/features/calculator-cli.md) - Calculate the [Effective Set](/docs/features/calculator-cli.md#effective-set-v20)\n- [**Application and Registry Definition**](/docs/features/app-reg-defs.md) - Describe how applications and registries are defined and referenced\n- [**Environment Inventory Generation**](/docs/features/env-inventory-generation.md) - Auto-generate [Environment Inventory](/docs/envgene-configs.md#env_definitionyml)\n- [**Environment Instance Generation**](/docs/features/environment-instance-generation.md) - Generate Environment Instances from templates and inventories\n- [**Credential Rotation**](/docs/features/cred-rotation.md) - Automate [Credential](/docs/envgene-objects.md#credential) rotation\n- [**Namespace Render Filter**](/docs/features/namespace-render-filtering.md) - Render only selected [Namespaces](/docs/envgene-objects.md#namespace)\n- [**System Certificate Configuration**](/docs/features/system-certificate.md) - Auto-config system certs for internal registries or TLS services\n- [**Template Override**](/docs/features/template-override.md) - Use a base Environment template and override parts as needed\n- [**Automatic Environment Name Derivation**](/docs/features/auto-env-name-derivation.md) - Auto-detect Environment name from folder structure\n- [**Template Inheritance**](/docs/features/template-inheritance.md) - Advanced Environment template patterns\n- [**Blue-Green Deployment**](/docs/features/blue-green-deployment.md) - BG domains, state management, and `bg_manage` pipeline job\n- [**Resource Profiles**](/docs/features/resource-profile.md) - Baselines and overrides for performance parameters\n\n### Examples \u0026 Samples\n\n- [**Sample Configurations**](/docs/samples/README.md)\n- [**Environment Template Examples**](/docs/samples/template-repository/)\n- [**Environment Inventory Examples**](/docs/samples/instance-repository/)\n\n### Development\n\n- [**Development Guides**](/docs/dev/) - Development setup and guidelines\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:\n\n- Code of Conduct\n- Development setup\n- Pull request process\n- Issue reporting\n\n## 📄 License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetcracker%2Fqubership-envgene","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetcracker%2Fqubership-envgene","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetcracker%2Fqubership-envgene/lists"}