doc: Chart Store Doc Revamp + OCI push/pull with Usecase #11
Conversation
This file contains 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
Contributor
ashokdevtron
commented
Oct 9, 2024
ashokdevtron
commented
- 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
requested changes
Dec 5, 2024
| * **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). |
There was a problem hiding this comment.
This format is only true for dockerhub ig not all repositories...
|
|
||
| **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) |
| **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) |
|
|
||
| [Chart Group Create Edit And Deploy](chart-group.md) | ||
| * Helm Chart(s) |
There was a problem hiding this comment.
If this page is about chart store, helm chart cannot be a pre-requisite
| [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 |
There was a problem hiding this comment.
Either Helm chart repository or OCI repository, any one should be sufficient, maybe this feels like both are required steps?
|
|
||
| >**Prerequisites:** `kubectl` must be installed on the bastion. | ||
| Use this option to add a managed or on-premise Kubernetes cluster. |
There was a problem hiding this comment.
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
|
|
||
| **Note:** Please ensure that the kubeconfig file you use has `admin permissions`. It is crucial for Devtron to have the necessary administrative privileges; otherwise, it may encounter failures or disruptions during deployments and other operations. Admin permission is essential to ensure the smooth functioning of Devtron and to prevent any potential issues that may arise due to insufficient privileges. | ||
|
|
||
| ### 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. |
There was a problem hiding this comment.
Prometheus is a powerful tool to provide graphical insight metrics and alerting based on your application behavior
| @@ -108,15 +98,45 @@ Now, click `Save Cluster` to save your cluster on Devtron. | |||
|
|
|||
| 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. | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Let's remove devtron agent from doc, wherever it is mentioned, it is not required now, devtron agent has retired
|  | ||
|
|
||
| {% hint style="warning" %} | ||
| Devtron doesn't support pushing helm packages to [chart repositories](../global-configurations/chart-repo.md) |
There was a problem hiding this comment.
we shouldn't write such lines, what if it gets indexed by some LLM 😂
|
|
||
| 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. |
There was a problem hiding this comment.
the format depends on the cloudprovider, I guess I have commented this above somewhere
|
Some of the screenshots are outdated, specially the one mentioning virtual environment. Need to be replaced @ashokdevtron |
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.