Skip to content

Commit 963100d

Browse files
Fixed peer-review comments
1 parent a59d923 commit 963100d

File tree

64 files changed

+175
-297
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+175
-297
lines changed

_topic_map.yml

+23-24
Original file line numberDiff line numberDiff line change
@@ -616,16 +616,6 @@ Topics:
616616
File: odo-cli-reference
617617
- Name: odo architecture
618618
File: odo-architecture
619-
- Name: Helm CLI
620-
Dir: helm_cli
621-
Distros: openshift-enterprise,openshift-origin
622-
Topics:
623-
- Name: Getting started with Helm
624-
File: getting-started-with-helm-on-openshift-container-platform
625-
- Name: Configuring custom Helm chart repositories
626-
File: configuring-custom-helm-chart-repositories
627-
- Name: Disabling Helm chart repositories
628-
File: disabling-helm-chart-repositories
629619
- Name: Knative CLI (kn) for use with OpenShift Serverless
630620
File: kn-cli-tools
631621
Distros: openshift-enterprise,openshift-origin
@@ -1516,7 +1506,7 @@ Topics:
15161506
- Name: Customizing source-to-image images
15171507
File: customizing-s2i-images
15181508
---
1519-
Name: Applications
1509+
Name: Building Applications
15201510
Dir: applications
15211511
Distros: openshift-enterprise,openshift-origin
15221512
Topics:
@@ -1531,23 +1521,28 @@ Topics:
15311521
- Name: Configuring project creation
15321522
File: configuring-project-creation
15331523
Distros: openshift-enterprise,openshift-origin
1534-
- Name: Application life cycle management
1535-
Dir: application_life_cycle_management
1524+
- Name: Creating Applications
1525+
Dir: creating_applications
15361526
Topics:
15371527
- Name: Creating applications using the Developer perspective
15381528
File: odc-creating-applications-using-developer-perspective
15391529
- Name: Creating applications from installed Operators
15401530
File: creating-apps-from-installed-operators
15411531
- Name: Creating applications using the CLI
15421532
File: creating-applications-using-cli
1543-
- Name: Viewing application composition using the Topology view
1544-
File: odc-viewing-application-composition-using-topology-view
1545-
- Name: Editing applications
1546-
File: odc-editing-applications
1547-
- Name: Working with Helm charts using the Developer perspective
1548-
File: odc-working-with-helm-charts-using-developer-perspective
1549-
- Name: Deleting applications
1550-
File: odc-deleting-applications
1533+
- Name: Viewing application composition using the Topology view
1534+
File: odc-viewing-application-composition-using-topology-view
1535+
- Name: Working with Helm charts
1536+
Dir: working_with_helm_charts
1537+
Topics:
1538+
- Name: Understanding Helm
1539+
File: understanding-helm
1540+
- Name: Installing Helm
1541+
File: installing-helm
1542+
- Name: Configuring custom Helm chart repositories
1543+
File: configuring-custom-helm-chart-repositories
1544+
- Name: Working with Helm releases
1545+
File: odc-working-with-helm-releases
15511546
- Name: Deployments
15521547
Dir: deployments
15531548
Topics:
@@ -1572,15 +1567,19 @@ Topics:
15721567
File: odc-monitoring-project-and-application-metrics-using-developer-perspective
15731568
- Name: Monitoring application health
15741569
File: application-health
1570+
- Name: Editing applications
1571+
File: odc-editing-applications
15751572
- Name: Working with quotas
15761573
File: working-with-quotas
15771574
Distros: openshift-online,openshift-dedicated
1578-
- Name: Idling applications
1579-
File: idling-applications
1580-
Distros: openshift-origin,openshift-enterprise
15811575
- Name: Pruning objects to reclaim resources
15821576
File: pruning-objects
15831577
Distros: openshift-origin,openshift-enterprise
1578+
- Name: Idling applications
1579+
File: idling-applications
1580+
Distros: openshift-origin,openshift-enterprise
1581+
- Name: Deleting applications
1582+
File: odc-deleting-applications
15841583
- Name: Using the Red Hat Marketplace
15851584
File: red-hat-marketplace
15861585
Distros: openshift-origin,openshift-enterprise

applications/application-health.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,4 +28,4 @@ include::modules/odc-monitoring-health-checks.adoc[leveloffset=+1]
2828

2929
.Additional Resources
3030
* For details on switching to the *Developer* perspective in the web console, see xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[About *Developer* perspective].
31-
* For details on adding health checks while creating and deploying an application, see *Advanced Options* in the xref:../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective] section.
31+
* For details on adding health checks while creating and deploying an application, see *Advanced Options* in the xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective] section.

applications/application_life_cycle_management/images

-1
This file was deleted.

applications/application_life_cycle_management/modules

-1
This file was deleted.

applications/application_life_cycle_management/odc-editing-applications.adoc

-18
This file was deleted.

applications/application_life_cycle_management/odc-working-with-helm-charts-using-developer-perspective.adoc

-25
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules

applications/deployments/deployment-strategies.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ include::modules/deployments-canary-deployments.adoc[leveloffset=+2]
3939
include::modules/deployments-creating-rolling-deployment.adoc[leveloffset=+2]
4040
include::modules/odc-starting-rolling-deployment.adoc[leveloffset=+2]
4141
.Additional resources
42-
- xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
43-
- xref:../../applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]
42+
- xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
43+
- xref:../../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]
4444

4545
include::modules/deployments-recreate-strategy.adoc[leveloffset=+1]
4646
include::modules/odc-starting-recreate-deployment.adoc[leveloffset=+1]
4747
.Additional resources
48-
- xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
49-
- xref:../../applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]
48+
- xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating and deploying applications on {product-title} using the *Developer* perspective]
49+
- xref:../../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[Viewing the applications in your project, verifying their deployment status, and interacting with them in the *Topology* view]
5050

5151
include::modules/deployments-custom-strategy.adoc[leveloffset=+1]
5252
include::modules/deployments-lifecycle-hooks.adoc[leveloffset=+1]
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[id="odc-editing-applications"]
2+
= Editing applications
3+
include::modules/common-attributes.adoc[]
4+
:context: odc-editing-applications
5+
6+
toc::[]
7+
8+
You can edit the configuration and the source code of the application you create using the *Topology* view.
9+
10+
== Prerequisites
11+
12+
* You have xref:../web_console/web-console.adoc#web-console[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].
13+
* You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create and modify applications in {product-title}.
14+
* You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective].
15+
16+
include::modules/odc-editing-source-code-using-developer-perspective.adoc[leveloffset=+1]
17+
18+
include::modules/odc-editing-application-configuration-using-developer-perspective.adoc[leveloffset=+1]

applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The *Monitoring* view in the *Developer* perspective provides options to monitor
1111
== Prerequisites
1212

1313
* You have xref:../web_console/web-console.adoc#web-console-overview[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].
14-
* You have xref:../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed applications on {product-title}].
14+
* You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed applications on {product-title}].
1515

1616
include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1]
1717

Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ The *Topology* view in the *Developer* perspective of the web console provides a
1010
== Prerequisites
1111
To view your applications in the *Topology* view and interact with them, ensure that:
1212

13-
* You have xref:../../web_console/web-console.adoc#web-console[logged in to the web console].
14-
* You are in the xref:../../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
15-
* You have the appropriate xref:../../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create applications and other workloads in {product-title}.
16-
* You have xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective].
13+
* You have xref:../web_console/web-console.adoc#web-console[logged in to the web console].
14+
* You are in the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective].
15+
* You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create applications and other workloads in {product-title}.
16+
* You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective].
1717

1818

1919
include::modules/odc-viewing-application-topology.adoc[leveloffset=+1]
@@ -34,4 +34,4 @@ include::modules/odc-labels-and-annotations-used-for-topology-view.adoc[leveloff
3434

3535
.Additional resources
3636

37-
* See xref:../../applications/application_life_cycle_management/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Importing a codebase from Git to create an application] for more information on creating an application from Git.
37+
* See xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Importing a codebase from Git to create an application] for more information on creating an application from Git.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[id="configuring-custom-helm-chart-repositories"]
2+
3+
= Configuring custom Helm chart repositories
4+
include::modules/common-attributes.adoc[]
5+
:context: configuring-custom-helm-chart-repositories
6+
7+
toc::[]
8+
9+
You can install Helm charts on an {product-title} cluster using the following methods:
10+
11+
* The CLI.
12+
* The *Developer* perspective of the web console.
13+
14+
The *Developer Catalog*, in the *Developer* perspective of the web console, displays the Helm charts available in the cluster. By default, it lists the Helm charts from the Red Hat OpenShift Helm chart repository. For a list of the charts, see link:https://charts.openshift.io/index.yaml[the Red Hat `Helm index` file].
15+
16+
As a cluster administrator, you can add multiple Helm chart repositories, apart from the default one, and display the Helm charts from these repositories in the *Developer Catalog*.
17+
18+
19+
include::modules/helm-installing-a-helm-chart-on-an-openshift-cluster.adoc[leveloffset=+1]
20+
21+
include::modules/odc-installing-helm-charts-using-developer-perspective.adoc[leveloffset=+1]
22+
23+
== Using Helm in the web terminal
24+
25+
You can use Helm by initializing the web terminal in the *Developer* perspective of the web console. For more information, see xref:../../web_console/odc-about-web-terminal.html#odc-using-web-terminal_odc-about-web-terminal[Using the web terminal].
26+
27+
include::modules/helm-creating-a-custom-helm-chart-on-openshift.adoc[leveloffset=+1]
28+
29+
include::modules/helm-adding-helm-chart-repositories.adoc[leveloffset=+1]
30+
31+
include::modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc[leveloffset=+1]
32+
33+
include::modules/helm-filtering-helm-charts-by-certification-level.adoc[leveloffset=+1]
34+
35+
include::modules/helm-disabling-helm-chart-repositories.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../images

modules/helm-installing-helm.adoc renamed to applications/working_with_helm_charts/installing-helm.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
// Module included in the following assemblies:
2-
//
3-
// * cli_reference/helm/getting-started-with-helm-on-openshift.adoc
4-
5-
[id="installing-helm_{context}"]
1+
[id="installing-helm"]
62
= Installing Helm
3+
include::modules/common-attributes.adoc[]
4+
:context: installing-helm
5+
6+
toc::[]
77

88
The following section describes how to install Helm on different platforms using the CLI.
99

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../modules
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[id="odc-working-with-helm-releases"]
2+
= Working with Helm releases
3+
include::modules/common-attributes.adoc[]
4+
:context: working-with-helm-releases
5+
6+
toc::[]
7+
8+
9+
You can use the *Developer* perspective in the web console to upgrade, rollback, or uninstall a Helm release.
10+
11+
12+
== Prerequisites
13+
14+
* 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].
15+
16+
include::modules/odc-upgrading-helm-release.adoc[leveloffset=+1]
17+
18+
include::modules/odc-rolling-back-helm-release.adoc[leveloffset=+1]
19+
20+
include::modules/odc-uninstalling-helm-release.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[id="understanding-helm"]
2+
= Understanding Helm
3+
include::modules/common-attributes.adoc[]
4+
:context: understanding-helm
5+
6+
toc::[]
7+
8+
Helm is a software package manager that simplifies deployment of applications and services to {product-title} clusters.
9+
10+
Helm uses a packaging format called _charts_.
11+
A Helm chart is a collection of files that describes the {product-title} resources.
12+
13+
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.
14+
15+
Each time a chart is installed, or a release is upgraded or rolled back, an incremental revision is created.
16+
17+
18+
== Key features
19+
20+
Helm provides the ability to:
21+
22+
* Search through a large collection of charts stored in the chart repository.
23+
* Modify existing charts.
24+
* Create your own charts with {product-title} or Kubernetes resources.
25+
* Package and share your applications as charts.
26+
27+
== Red Hat Certification of Helm charts for OpenShift
28+
29+
You can choose to verify and certify your Helm charts by Red Hat for all the components you will be deploying on the Red Hat {product-title}. Charts go through an automated Red Hat OpenShift certification workflow that guarantees security compliance as well as best integration and experience with the platform. Certification assures the integrity of the chart and ensures that the Helm chart works seamlessly on Red Hat OpenShift clusters.
30+
31+
== Additional resources
32+
33+
* For more information on how to certify your Helm charts as a Red Hat partner, see link:https://redhat-connect.gitbook.io/partner-guide-for-red-hat-openshift-and-container/helm-chart-certification/overview[Red Hat Certification of Helm charts for OpenShift].
34+
* For more information on OpenShift and Container certification guides for Red Hat partners, see link:https://redhat-connect.gitbook.io/partner-guide-for-red-hat-openshift-and-container/[Partner Guide for OpenShift and Container Certification].
35+
* For a list of the charts, see link:https://charts.openshift.io/index.yaml[the Red Hat `Helm index` file].
36+
* You can view the available charts at the link:https://marketplace.redhat.com/en-us/documentation/access-red-hat-marketplace[Red Hat Marketplace]. For more information, see xref:../../applications/red-hat-marketplace.adoc#red-hat-marketplace[Using the Red Hat Marketplace].

0 commit comments

Comments
 (0)