diff --git a/docs/envgene-pipelines.md b/docs/envgene-pipelines.md index 77878e0f..360920e8 100644 --- a/docs/envgene-pipelines.md +++ b/docs/envgene-pipelines.md @@ -22,6 +22,11 @@ If multiple [`ENV_NAMES`](/docs/instance-pipeline-parameters.md#env_names) are s ### [Instance pipeline] Job sequence +```mermaid +flowchart LR + A[trigger_passport] --> B[get_passport] --> C[process_decryption_mode] --> D[env_inventory_generation] --> E[credential_rotation] --> F[app_reg_def_process] --> G[process_sd] --> H[env_build] --> I[generate_effective_set] --> J[git_commit] +``` + 1. **trigger_passport**: - **Condition**: Runs if [`GET_PASSPORT: true`](/docs/instance-pipeline-parameters.md#get_passport) - **Docker image**: None. The Discovery repository is triggered from the pipeline @@ -42,18 +47,28 @@ If multiple [`ENV_NAMES`](/docs/instance-pipeline-parameters.md#env_names) are s - **Condition**: Runs if [`CRED_ROTATION_PAYLOAD`](/docs/instance-pipeline-parameters.md#cred_rotation_payload) is provided - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) -6. **process_sd**: +6. **app_reg_def_process**: + - **What happens in this job**: + 1. Downloads the Environment Template artifact. + 2. Renders [Application Definitions](/docs/envgene-objects.md#application-definition) and [Registry Definitions](/docs/envgene-objects.md#registry-definition) from: + 1. Templates, as described in [User Defined by Template](/docs/features/app-reg-defs.md#user-defined-by-template) + 2. External Job, as described in [External Job](/docs/features/app-reg-defs.md#external-job) + 3. Runs [Application and Registry Definitions Transformation](/docs/features/app-reg-defs.md#application-and-registry-definitions-transformation) + - **Condition**: Runs if ( [`ENV_BUILD: true`](/docs/instance-pipeline-parameters.md#env_builder) ) OR ( [`SOURCE_TYPE: json`](/docs/instance-pipeline-parameters.md#sd_source_type) AND [`SD_DATA`](/docs/instance-pipeline-parameters.md#sd_data) is provided ) OR ( [`SOURCE_TYPE: artifact`](/docs/instance-pipeline-parameters.md#sd_source_type) AND [`SD_VERSIONS`](/docs/instance-pipeline-parameters.md#sd_version) is provided ) + - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) + +7. **process_sd**: - **Condition**: Runs if ( [`SOURCE_TYPE: json`](/docs/instance-pipeline-parameters.md#sd_source_type) AND [`SD_DATA`](/docs/instance-pipeline-parameters.md#sd_data) is provided ) OR ( [`SOURCE_TYPE: artifact`](/docs/instance-pipeline-parameters.md#sd_source_type) AND [`SD_VERSIONS`](/docs/instance-pipeline-parameters.md#sd_version) is provided ) - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) -7. **env_build**: +8. **env_build**: - **Condition**: Runs if [`ENV_BUILD: true`](/docs/instance-pipeline-parameters.md#env_builder). - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) -8. **generate_effective_set**: +9. **generate_effective_set**: - **Condition**: Runs if [`GENERATE_EFFECTIVE_SET: true`](/docs/instance-pipeline-parameters.md#generate_effective_set) - **Docker image**: [`qubership-effective-set-generator`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-effective-set-generator) -9. **git_commit**: - - **Condition**: Runs if there are jobs requiring changes to the repository AND [`ENV_TEMPLATE_TEST: false`](/docs/instance-pipeline-parameters.md#env_template_test) - - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) +10. **git_commit**: + - **Condition**: Runs if there are jobs requiring changes to the repository AND [`ENV_TEMPLATE_TEST: false`](/docs/instance-pipeline-parameters.md#env_template_test) + - **Docker image**: [`qubership-envgene`](https://github.com/Netcracker/qubership-envgene/pkgs/container/qubership-envgene) diff --git a/docs/features/app-reg-defs.md b/docs/features/app-reg-defs.md index 7b952a72..52f141ad 100644 --- a/docs/features/app-reg-defs.md +++ b/docs/features/app-reg-defs.md @@ -48,7 +48,7 @@ There are two sources for obtaining Application and Registry Definitions in EnvG An external job (not implemented in EnvGene itself, but serves as an extension point) that somehow creates/discovers/generates Application and Registry Definitions as YAML files and saves them in its artifact with the contract name `definitions.zip`. -During the generation of an Environment Instance (as part of `env_build_job`), EnvGene retrieves the Application and Registry Definitions from this artifact and saves them as part of the environment instance. +During the [`app_reg_def_process`](/docs/envgene-pipelines.md#instance-pipeline) job execution, EnvGene retrieves the Application and Registry Definitions from this artifact and saves them as part of the Environment instance. EnvGene uses the following instance repository pipeline parameters: @@ -79,7 +79,7 @@ These files can be either Jinja templates of the object or plain objects without Each Application and Registry Definition is created as a separate file. -During Environment Instance generation (as part of `env_build_job`), EnvGene renders these templates and saves them as part of the Environment Instance. +During the [`app_reg_def_process`](/docs/envgene-pipelines.md#instance-pipeline) job execution, EnvGene renders these templates and saves them as part of the Environment Instance. ### Using Application and Registry Definitions