mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
helm flow
helm img review edits added revision details review edits 2 review edits 3 review edits
This commit is contained in:
@@ -8,6 +8,17 @@ toc::[]
|
||||
include::modules/helm-understanding-helm.adoc[leveloffset=+1]
|
||||
|
||||
|
||||
You can use the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective] in the xref:../../web_console/web-console.adoc#web-console[web console] to create Helm releases.
|
||||
You can use the *Developer* perspective in the web console to select and install a chart from the Helm charts listed in the *Developer Catalog*. You can create a Helm release using these charts, upgrade, rollback, and uninstall the release.
|
||||
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have logged in to the web console and have switched to the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
|
||||
|
||||
include::modules/odc-installing-helm-charts.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/odc-upgrading-helm-release.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/odc-rolling-back-helm-release.adoc[leveloffset=+1]
|
||||
|
||||
include::modules/odc-uninstalling-helm-release.adoc[leveloffset=+1]
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 51 KiB After Width: | Height: | Size: 179 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 44 KiB |
BIN
images/odc_helm_revision_history.png
Normal file
BIN
images/odc_helm_revision_history.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
@@ -6,8 +6,15 @@
|
||||
[id="helm-understanding-helm_{context}"]
|
||||
= Understanding Helm
|
||||
|
||||
Helm is a command-line interface (CLI) tool that simplifies deployment of applications and services to {product-title} clusters. Helm uses a packaging format called _charts_.
|
||||
A Helm chart is a collection of files that describes {product-title} resources. A running instance of the chart in a cluster is called a _release_. A new release is created every time a chart is installed on the cluster.
|
||||
Helm is a software package manager that simplifies deployment of applications and services to {product-title} clusters.
|
||||
|
||||
Helm uses a packaging format called _charts_.
|
||||
A Helm chart is a collection of files that describes the {product-title} resources.
|
||||
|
||||
A running instance of the chart in a cluster is called a _release_. A new release is created every time a chart is installed on the cluster.
|
||||
|
||||
Each time a chart is installed, or a release is upgraded or rolled back, an incremental revision is created.
|
||||
|
||||
|
||||
== Key features
|
||||
|
||||
|
||||
@@ -5,26 +5,20 @@
|
||||
[id="odc-installing-helm-charts_{context}"]
|
||||
= Installing Helm charts
|
||||
|
||||
You can use the *Developer* perspective to create Helm releases from the Helm charts provided in the *Developer Catalog*.
|
||||
|
||||
.Prerequisites
|
||||
|
||||
* You have logged in to the web console and have switched to the *Developer* perspective.
|
||||
You can use either the *Developer* perspective or the CLI to create Helm releases and see them in the *Developer* perspective of the web console.
|
||||
|
||||
.Procedure
|
||||
To create Helm releases from the Helm charts provided in the *Developer Catalog*:
|
||||
|
||||
. In the *Developer* perspective, navigate to the *Add* view and select the *From Catalog* option to see the *Developer Catalog*.
|
||||
. In the filters listed on the left, under *Type*, select the *Helm Charts* filter to see the available Helm charts.
|
||||
. In the *Developer* perspective, navigate to the *Add* view and select the *Helm Chart* option to see all the Helm Charts in the *Developer Catalog*.
|
||||
. Select a chart and read the description, README, and other details about the chart.
|
||||
. Click *Install Helm Chart*.
|
||||
+
|
||||
image::odc_helm_chart_devcatalog.png[Helm charts in developer catalog]
|
||||
+
|
||||
. Select the Node.js chart to see the description of the chart and click *Install Helm Chart*.
|
||||
. In the *Install Helm Chart* page:
|
||||
.. Enter a unique name for the release in the *Release Name* field.
|
||||
.. Optionally, in the YAML editor, modify the YAML file.
|
||||
. Click *Install* to create a Helm release. The release is displayed in the *Topology* view.
|
||||
+
|
||||
image::odc_helm_release_topology.png[Helm release in topology]
|
||||
+
|
||||
. In the left panel of the *Developer* perspective, click *More* > *Helm* to see the list of all the Helm releases in the namespace.
|
||||
. Click on a listed Helm release to see the details and resources for that release.
|
||||
. Click *Install* to create a Helm release. You will be redirected to the *Topology* view where the release is displayed. If the Helm chart has release notes, the chart is pre-selected and the right panel displays the release notes for that release.
|
||||
|
||||
If required, you can now use the *Actions* button on the side panel or right-click the Helm release to upgrade, rollback, or uninstall the Helm release.
|
||||
|
||||
21
modules/odc-rolling-back-helm-release.adoc
Normal file
21
modules/odc-rolling-back-helm-release.adoc
Normal file
@@ -0,0 +1,21 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc
|
||||
|
||||
[id="odc-rolling-back-helm-release_{context}"]
|
||||
= Rolling back a Helm release
|
||||
|
||||
If a release fails, you can rollback the Helm release to a previous version.
|
||||
|
||||
.Procedure
|
||||
To rollback a release using the *Helm* view:
|
||||
|
||||
. In the *Developer* perspective, navigate to the *Helm* view to see the *Helm Releases* in the namespace.
|
||||
. Click the *Options* menu {kebab} adjoining the listed release, and select *Rollback*.
|
||||
. In the *Rollback Helm Release* page, select the *Revision* you want to rollback to and click *Rollback*.
|
||||
. In the *Helm Releases* page, click on the chart to see the details and resources for that release.
|
||||
. Go to the *Revision History* tab to see all the revisions for the chart.
|
||||
+
|
||||
image::odc_helm_revision_history.png[Helm revision history]
|
||||
+
|
||||
. If required, you can further use the *Options* menu {kebab} adjoining a particular revision and select the revision to rollback to.
|
||||
10
modules/odc-uninstalling-helm-release.adoc
Normal file
10
modules/odc-uninstalling-helm-release.adoc
Normal file
@@ -0,0 +1,10 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc
|
||||
|
||||
[id="odc-uninstalling-helm-release_{context}"]
|
||||
= Uninstalling a Helm release
|
||||
|
||||
.Procedure
|
||||
. In the *Topology* view, right-click the Helm release and select *Uninstall Helm Release*.
|
||||
. In the confirmation prompt, enter the name of the chart and click *Uninstall*.
|
||||
14
modules/odc-upgrading-helm-release.adoc
Normal file
14
modules/odc-upgrading-helm-release.adoc
Normal file
@@ -0,0 +1,14 @@
|
||||
// Module included in the following assemblies:
|
||||
//
|
||||
// applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc
|
||||
|
||||
[id="odc-upgrading-helm-release_{context}"]
|
||||
= Upgrading a Helm release
|
||||
|
||||
You can upgrade a Helm release to upgrade to a new chart version or update your release configuration.
|
||||
|
||||
.Procedure
|
||||
|
||||
. In the *Topology* view, select the Helm release to see the side panel.
|
||||
. Click *Actions* -> *Upgrade Helm Release*.
|
||||
. In the *Upgrade Helm Release* page, select the *Chart Version* you want to upgrade to, and then click *Upgrade* to create another Helm release. The *Helm Releases* page displays the two revisions.
|
||||
Reference in New Issue
Block a user