doc: Chart Store Doc Revamp + OCI push/pull with Usecase by ashoknayak777 · Pull Request #11 · devtron-labs/devtron-documentation

ashoknayak777 · 2024-10-09T11:26:06Z

Added Isolated Cluster Documentation.
Removed OCI pull doc from usecases and segregated them in Container Registry doc, Chart Store, Cluster and Environments doc.
Removed duplicate content of chart group and chart doc from Chart Store's overview file.
Rewrote Chart Store's README file.
Segregated OCI push feature in Container Registry doc, Chart Store, Cluster and Environments doc, CD Pipeline doc.
Updated snapshots
Added redirection for removed OCI pull doc
Added Airgapped Deployment in Use Case section

abhibhaw · 2024-10-13T12:23:30Z

docs/user-guide/creating-application/workflow/cd-pipeline.md

+  * **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.
+      * **Repository** - Write the repository name in the format `username/repo-name`. You can find the username from your registry provider account (e.g., Docker Hub).


This format is only true for dockerhub ig not all repositories...

abhibhaw · 2024-10-13T12:25:31Z

docs/user-guide/deploy-chart/README.md


-**Parts of Documentation**
+Devtron makes it easier for you to populate your charts from multiple sources to the [chart store](../../reference/glossary.md#chart-store). These sources are: 
+* [Chart Respository](../global-configurations/chart-repo.md)


Helm chart repostories...

abhibhaw · 2024-10-13T12:25:44Z

docs/user-guide/deploy-chart/README.md

-**Parts of Documentation**
+Devtron makes it easier for you to populate your charts from multiple sources to the [chart store](../../reference/glossary.md#chart-store). These sources are: 
+* [Chart Respository](../global-configurations/chart-repo.md)
+* [OCI Registry](../global-configurations/container-registries.md#use-as-chart-repository)


OCI repositories

abhibhaw · 2024-10-13T12:27:37Z

docs/user-guide/deploy-chart/README.md

+### Prerequisites 

-[Chart Group Create Edit And Deploy](chart-group.md)
+* Helm Chart(s)


If this page is about chart store, helm chart cannot be a pre-requisite

abhibhaw · 2024-10-17T16:07:05Z

docs/user-guide/deploy-chart/README.md

-[Chart Group Create Edit And Deploy](chart-group.md)
+* Helm Chart(s)
+* Chart Repository added to Devtron
+* OCI-Compliant Registry (e.g. Docker Hub and [many more](../global-configurations/container-registries.md#supported-registry-providers)) with 


Either Helm chart repository or OCI repository, any one should be sufficient, maybe this feels like both are required steps?

abhibhaw · 2024-10-17T16:18:00Z

docs/user-guide/global-configurations/cluster-and-environments.md

+## Add Kubernetes Cluster

->**Prerequisites:** `kubectl` must be installed on the bastion.
+Use this option to add a managed or on-premise Kubernetes cluster.


what does this mean? I think we should remove this, or reframe it like use this option to add a kubernetes cluster if you have access to it... managed or on-premise misses a lot of other combinations

abhibhaw · 2024-10-21T12:42:35Z

docs/user-guide/global-configurations/cluster-and-environments.md


 ### Configure Prometheus (Enable Applications Metrics)

 If you want to see application metrics against the applications deployed in the  cluster, Prometheus must be deployed in the cluster. Prometheus is a powerful tool to provide graphical insight into your application behavior.


Prometheus is a powerful tool to provide ~~graphical insight~~ metrics and alerting based on your application behavior

abhibhaw · 2024-12-05T08:41:46Z

docs/user-guide/global-configurations/cluster-and-environments.md

 Your Kubernetes cluster gets mapped with Devtron when you save the cluster configurations. Now, the Devtron agent must be installed on the added cluster so that you can deploy your applications on that cluster.

-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/install-devtron-agent.png)
+![Figure 8: Installing Devtron Agent](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/install-devtron-agent.png)


Let's remove devtron agent from doc, wherever it is mentioned, it is not required now, devtron agent has retired

abhibhaw · 2024-12-05T08:46:30Z

docs/user-guide/global-configurations/container-registries.md

+![Figure 3b: Pushed Helm Chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-push/helm-chart.jpg)
+
+{% hint style="warning" %}
+Devtron doesn't support pushing helm packages to [chart repositories](../global-configurations/chart-repo.md)


we shouldn't write such lines, what if it gets indexed by some LLM 😂

abhibhaw · 2024-12-05T08:47:51Z

docs/user-guide/global-configurations/container-registries.md

+
+Search your OCI registry in the list and click it. 
+
+In the **List of repositories** field, add your chart repo(s). The format should be `username/chartname`. You can [find the username](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/find-username.jpg) from your registry provider account.


the format depends on the cloudprovider, I guess I have commented this above somewhere

abhibhaw · 2024-12-06T12:27:08Z

Some of the screenshots are outdated, specially the one mentioning virtual environment. Need to be replaced @ashokdevtron

ashoknayak777 · 2025-06-28T04:31:10Z

Closing this PR as it has now been re-written from scratch and published in PR: 103 by @bharathvaj-p

ashoknayak777 added 3 commits October 8, 2024 21:06

Rough Restructuring + Changes

55f371b

Rewrote for OCI pull and push

949329b

Added Airgapped Usecase

c3b0d80

ashoknayak777 requested review from a team as code owners October 9, 2024 11:26

ashoknayak777 requested review from abhibhaw and uxarya-d October 9, 2024 11:28

ashoknayak777 self-assigned this Oct 9, 2024

ashoknayak777 added the documentation Improvements or additions to documentation label Oct 9, 2024

Commented chart reselection in chart group

7400798

abhibhaw requested changes Dec 5, 2024

View reviewed changes

ashoknayak777 closed this Jun 28, 2025


		### Configure Prometheus (Enable Applications Metrics)

		If you want to see application metrics against the applications deployed in the cluster, Prometheus must be deployed in the cluster. Prometheus is a powerful tool to provide graphical insight into your application behavior.


		Search your OCI registry in the list and click it.

		In the List of repositories field, add your chart repo(s). The format should be `username/chartname`. You can [find the username](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/find-username.jpg) from your registry provider account.

Conversation

ashoknayak777 commented Oct 9, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhibhaw commented Dec 6, 2024

Uh oh!

ashoknayak777 commented Jun 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants