Skip to content

docs: OCI Pull/Push Doc Revision #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ redirects:
user-guide/clusters: user-guide/resource-browser.md
usage/clusters: user-guide/resource-browser.md
global-configurations/authorization/sso-login/okta: user-guide/global-configurations/authorization/sso/okta.md
<<<<<<< HEAD
usage/applications/creating-application/ci-pipeline/ci-build-pre-post-plugins: user-guide/creating-application/workflow/ci-build-pre-post-plugins.md
global-configurations/custom-charts: user-guide/global-configurations/deployment-charts.md
usage/deploy-chart/overview-of-charts: user-guide/deploy-chart/README.md
=======
global-configurations/custom-charts: user-guide/global-configurations/deployment-charts.md
global-configurations/plugins-policy: user-guide/global-configurations/plugin-policy.md
usage/sdh: user-guide/software-distribution-hub/README.md
Expand All @@ -149,3 +154,4 @@ redirects:
usage/deploy-chart/overview-of-charts: user-guide/deploy-chart/README.md
usage/integrations/clair: user-guide/integrations/vulnerability-scanning/clair.md
usage/resource-browser/devtron-intelligence: user-guide/devtron-intelligence.md
>>>>>>> main
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](user-guide/use-cases/airgapped-app-deployment.md)
* [Telemetry Overview](user-guide/telemetry.md)
* [Devtron on Graviton](reference/graviton.md)
* [Release Notes](https://github.com/devtron-labs/devtron/releases)
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This section expects four inputs from you:

| Setting | Description | Options |
| ----------- | ---------------------------------------------------------- | ------------------------- |
| Environment | Select the environment where you want to deploy your application | (List of available environments) |
| Environment | Select the environment where you want to deploy your application. | (List of available environments) |
| Namespace | Automatically populated based on the selected environment | Not Applicable |
| Trigger | When to execute the deployment pipeline | **Automatic**: Deployment triggers automatically when a new image completes the previous stage (build pipeline or another deployment pipeline) <br /> **Manual**: Deployment is not initiated automatically. You can trigger deployment with a desired image. |
| Deployment Approach | How to deploy the application | **Helm** or **GitOps** <br /> Refer [GitOps](../../global-configurations/gitops.md) |
Expand All @@ -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 dropdown.
* **Repository** - Enter the repository name. You can find the username from your registry provider account (e.g., Docker Hub).

{% endhint %}
Expand Down
69 changes: 68 additions & 1 deletion docs/user-guide/deploy-chart/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,72 @@
# Chart Store

## Introduction
<<<<<<< HEAD

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)

![Figure 1: Chart Store](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/overview-of-charts/chart-store-main.jpg)

### Prerequisites

* 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

---

## Populating your Charts to the Chart Store

1. From the left sidebar, go to **Chart Store**.

2. You can find your chart(s) either by using the search bar or by selecting your chart source.

![Figure 2: Searching your Chart](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/chart-search.jpg)

You have successfully pulled your charts to the chart store.

![Figure 3: Uploaded Helm Charts](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/chart-list.jpg)

### Unable to find your Charts?

Deprecated charts won't show up in the Chart Store unless you enable the **Show deprecated charts** filter as shown below

![Figure 4: Checking Deprecated Charts](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/deprecated.jpg)

Or, you may try performing a chart resync as shown below:

![Figure 5: Performing a Resync](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/chart-sync.jpg)

---


## Removing your Charts from the Chart Store

{% hint style="warning" %}
### Who Can Perform This Action?
You cannot remove a chart from the Chart Store if the source was a [chart repository](../global-configurations/chart-repo.md). Removal is possible only if the charts [come from OCI registry](../global-configurations/container-registries.md#push-helm-packages).
{% endhint %}

1. Go to your OCI registry settings in Devtron.

2. In the **List of repositories** field, remove the unwanted chart repo.

![Figure 6: Removing a Chart Repo](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/use-cases/oci-pull/remove-chart-repo.jpg)

3. Click **Update**.

The removed chart will no longer appear in the Chart Store.

{% hint style="info" %}
Deleting a chart repo from your OCI registry will not lead to the removal of chart from the Chart Store
{% endhint %}

A light alternative is to disable the chart source as shown below, but this doesn't imply the removal of a chart.

![Figure 7: Disabling a Chart Source](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/overview-of-charts/disable-chart-source.jpg)
=======

A [Helm Chart](../../reference/glossary.md#helm-chartspackages) is like a blueprint for deploying your application on Kubernetes. It contains all the necessary configuration files needed to define what and how your application should run. The **Chart Store** in Devtron offers a wide variety of helm charts from different sources for you to select and install based on your requirement. It helps you in managing and organizing charts in the same way an app store helps you manage apps.

Expand Down Expand Up @@ -74,4 +140,5 @@ Refer to:

* [Deploy Charts](deployment-of-charts.md) - if you need to deploy, update, upgrade, disable, or delete charts.

* [Chart Groups](chart-group.md) - if you need to create a chart group and bulk deploy them.
* [Chart Groups](chart-group.md) - if you need to create a chart group and bulk deploy them.
>>>>>>> main
93 changes: 92 additions & 1 deletion docs/user-guide/deploy-chart/chart-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,96 @@

## Introduction

<<<<<<< HEAD
Using the Chart Group feature of Devtron, you can group and deploy one or more Helm charts in a single click.

---

## 1. Create a Group

1. Go to the **Chart Store** page and click **+ Create Group**.

![Figure 1: Creating a Group](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/create-group.jpg)

2. In the **Create Chart Group** window, give a name and description (optional) to your chart group, and then click **Create Group**.

![Figure 2: Adding Group Data](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/create-group-window.jpg)

Once you create a group, you can now select and add charts to it.

---

## 2. Add Charts to the Group

1. To add a chart to the group, click the `+` sign next to the chart you wish to add. You also can add multiple copies of the same chart in the chart group as per your requirements.

![Figure 3: Adding Charts](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/add-chart.jpg)

2. Once you have finalized the charts for your group, click **Save**.

![Figure 4: Saving Chart Group](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/save-chart.jpg)

---

## 3. Bulk Deploy and Edit Option for Charts

1. By default, a chart group will show all the charts you added to it. However, you may choose to deploy only selected charts and deselect the rest from the chart group.

![Figure 5: Selecting Charts for Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/deploy-selected-charts.jpg)

2. In the **Deploy Selected Charts** window, select the project and environment where you wish to deploy the chart group. You may use the [Advanced Options](#advanced-options) if you wish to edit the chart configurations too.

![Figure 6: Deploying Selected Charts](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/deploy-chart-group-window.jpg)

3. Click **Deploy** to initiate the deployment of the selected charts in the Chart Group.

![Figure 7: Deploying Chart Group](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/deploy-chart.jpg)

### Advanced Options

Before deploying your chart group, you may click **Advanced Options** to edit the chart configuration of any chart in the group.

![Figure 8: Using Advanced Options](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/advanced-options.jpg)

<!-- {% hint style="warning" %}
If you selected specific charts for deployment, and then if you use **Advanced Options**, you may have to select the charts again and deselect the ones you don't wish to deploy.
{% endhint %} -->

![Figure 9: Editing Individual Chart Configurations](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/advanced-options-2.jpg)

You can edit the following fields and also the YAML file of the corresponding chart.

| Key | Description |
| :--- | :--- |
| **App name** | Name of the app |
| **Deploy to Environment** | Select the environment in which the chart has to be deployed |
| **Chart version** | Select the version of the chart to be used |
| **Values** | You can use a default value or custom value. Ensure the value that you select for the chart is compatible with the 'Chart Version' you selected. |

After changing the configurations, select your project and click **Deploy**

![Figure 10: Deploying Chart Group](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/project-selection.jpg)

---

## Extras

### Edit a Chart Group

You can rename a chart group, remove charts from it, or add new charts to the group. To edit a chart group, click it and use the **Edit** button.

{% embed url="https://www.youtube.com/watch?v=4bsxuUyRYTI" caption="Editing Chart Group in Devtron" %}

You may click **Group Detail** to view the charts added to the group and check their running instances.


### Delete a Chart Group

To delete a chart group, click it and use the **Delete** button.

![Figure 11: Deleting a Chart Group](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-group/delete-chart-group.gif)

=======
A Chart Group in Devtron is a collection of [Helm charts](../../reference/glossary.md#helm-chartspackages) grouped together (e.g., what a folder is to files) to help you create, manage, and deploy them easily.

When setting up a new environment or a microservice, or when your application requires multiple Helm charts, you can simply group the required charts into a chart group. You can then view, manage, and deploy related charts together in one place instead of searching and installing each one individually.
Expand Down Expand Up @@ -132,4 +222,5 @@ The **Advanced Options** page enables you to change the chart values, chart conf

5. Select the project in the **Project** drop-down box.

6. Click **Deploy** to deploy the charts. The deployment will be initiated.
6. Click **Deploy** to deploy the charts. The deployment will be initiated.
>>>>>>> main
Loading