docs: OCI Pull/Push Doc Revision #109
Open
+206
−185
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ashokdevtron
reviewed
Jul 2, 2025
ashokdevtron
reviewed
Jul 2, 2025
ashokdevtron
reviewed
Jul 2, 2025
ashokdevtron
reviewed
Jul 2, 2025
ashokdevtron
reviewed
Jul 2, 2025
ashokdevtron
requested changes
Jul 2, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR revises the OCI Pull/Push documentation by removing the outdated OCI pull documentation and replacing it with new comprehensive documentation for deploying software to air-gapped environments. The revision improves clarity and provides updated guidance for using Devtron's OCI features in various scenarios.
Key changes:
- Removed the existing OCI pull documentation
- Added new air-gapped deployment use case documentation
- Updated references and links throughout the documentation
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
docs/user-guide/use-cases/oci-pull.md |
Completely removed existing OCI pull documentation |
docs/user-guide/use-cases/airgapped-app-deployment.md |
Added comprehensive documentation for air-gapped environment deployments |
docs/user-guide/use-cases/README.md |
Added reference to new air-gapped deployment documentation |
docs/user-guide/plugins/copy-container-image.md |
Updated reference link for container registry configuration |
docs/user-guide/global-configurations/container-registries.md |
Extensively revised and restructured container registry documentation |
docs/user-guide/global-configurations/cluster-and-environments.md |
Added informational note about cluster credentials |
docs/user-guide/creating-application/workflow/cd-pipeline.md |
Minor text improvements and duplicate content fix |
docs/SUMMARY.md |
Updated navigation to reference new air-gapped deployment documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| In fully air-gapped environments with no Internet access, the vendor and client may rely on physical transfer of Helm packages. Devtron facilitates this as follows: | ||
|
|
||
| 1. **Vendor Action:** | ||
| - Similar to [Scanario 1](#scenario-1-air-gapped-cluster-has-access-to-oci-registry), the vendor generates a helm package by deploying the application to an [isolated cluster](../global-configurations/cluster-and-environments.md#add-isolated-cluster). |
There was a problem hiding this comment.
There's a typo in the reference link text. 'Scanario' should be 'Scenario'.
Suggested change
| - Similar to [Scanario 1](#scenario-1-air-gapped-cluster-has-access-to-oci-registry), the vendor generates a helm package by deploying the application to an [isolated cluster](../global-configurations/cluster-and-environments.md#add-isolated-cluster). | |
| - Similar to [Scenario 1](#scenario-1-air-gapped-cluster-has-access-to-oci-registry), the vendor generates a helm package by deploying the application to an [isolated cluster](../global-configurations/cluster-and-environments.md#add-isolated-cluster). |
Copilot uses AI. Check for mistakes.
| @@ -44,7 +44,7 @@ This section expects four inputs from you: | |||
| In case you are choosing an [isolated environment](../../global-configurations/cluster-and-environments.md#add-isolated-cluster) for deployment, you will get two additional options to choose from in the 'Deploy to Environment' window ([check snapshot](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-push/create-cd2.jpg)): | |||
| * **Do not push** - A link to download the helm package will be available after the deployment. However, it will not push the helm package to the OCI registry. | |||
| * **Push to registry** - This will generate and [push the helm package to the OCI registry](../../global-configurations/container-registries.md#push-helm-packages). Upon selecting this option, you will get two more fields: | |||
| * **Registry** - Choose the OCI registry to which the helm chart package must be pushed. Only those registries that have `Push helm packages` enabled will be shown in the dropdown. | |||
| * **Registry** - Choose the OCI registry to which the helm chart package must be pushed. Only those registries that have [Push helm packages](../../global-configurations/container-registries.md#push-helm-packages) enabled will be shown in the dropdownChoose the OCI registry to which the helm chart package must be pushed. Only those registries that have [Push helm packages](../../global-configurations/container-registries.md#push-helm-packages) enabled will be shown in the dropdown. | |||
There was a problem hiding this comment.
There's duplicate content in this line. The text 'Choose the OCI registry to which the helm chart package must be pushed. Only those registries that have Push helm packages enabled will be shown in the dropdown' appears twice, and there's a missing period after 'dropdown' in the first occurrence.
Suggested change
| * **Registry** - Choose the OCI registry to which the helm chart package must be pushed. Only those registries that have [Push helm packages](../../global-configurations/container-registries.md#push-helm-packages) enabled will be shown in the dropdownChoose the OCI registry to which the helm chart package must be pushed. Only those registries that have [Push helm packages](../../global-configurations/container-registries.md#push-helm-packages) enabled will be shown in the dropdown. | |
| * **Registry** - Choose the OCI registry to which the helm chart package must be pushed. Only those registries that have [Push helm packages](../../global-configurations/container-registries.md#push-helm-packages) enabled will be shown in the dropdown. |
Copilot uses AI. Check for mistakes.
| @@ -185,7 +185,7 @@ | |||
| * [Connect SpringBoot with Mysql Database](user-guide/use-cases/connect-springboot-with-mysql-database.md) | |||
| * [Connect Expressjs With Mongodb Database](user-guide/use-cases/connect-expressjs-with-mongodb-database.md) | |||
| * [Connect Django With Mysql Database](user-guide/use-cases/connect-django-with-mysql-database.md) | |||
| * [Pull Helm Charts from OCI Registry](user-guide/use-cases/oci-pull.md) | |||
| * [Deploying Software on Air-gapped Environment](../docs/user-guide/use-cases/airgapped-app-deployment.md) | |||
There was a problem hiding this comment.
The relative path contains an incorrect '../docs/' prefix. Since the SUMMARY.md file is already in the docs directory, the path should be 'user-guide/use-cases/airgapped-app-deployment.md' to match the pattern of other entries in the same list.
Suggested change
| * [Deploying Software on Air-gapped Environment](../docs/user-guide/use-cases/airgapped-app-deployment.md) | |
| * [Deploying Software on Air-gapped Environment](user-guide/use-cases/airgapped-app-deployment.md) |
Copilot uses AI. Check for mistakes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sample Preview