Skip to content

Commit a6bc2fb

Browse files
jmagakGitHub Actions
andauthored
RHIDP-9097: Documentation should explain the difference between Helm chart vs Operator (redhat-developer#2171)
* Difference between Helm chart and Operator * Apply peer suggestions * Apply Fabrice's suggestion --------- Co-authored-by: GitHub Actions <github-actions@github.com>
1 parent 5211f97 commit a6bc2fb

3 files changed

Lines changed: 73 additions & 2 deletions

File tree

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
:_mod-docs-content-type: CONCEPT
2+
3+
[id="compare-the-helm-chart-and-operator-to-choose-the-optimal-deployment-method_{context}"]
4+
= Compare the Helm chart and Operator to choose the optimal deployment method
5+
6+
[role="_abstract"]
7+
When planning your {product} deployment, you must choose between the Helm chart and Operator installation methods. Use the following table to choose the method that aligns with your operational model and team capabilities:
8+
9+
[cols="1,1",options="header"]
10+
|===
11+
|Helm chart |Operator
12+
13+
a|*Platform requirements*
14+
15+
* You deploy across multiple Kubernetes platforms ({eks-short}, {gke-short}, {aks-short}).
16+
* You need maximum portability across different environments.
17+
a|*Platform requirements*
18+
19+
* You primarily use {ocp-short}.
20+
* Your platform has Operator Lifecycle Manager (OLM) installed.
21+
22+
a|*Setup and deployment priorities*
23+
24+
* You want the simplest initial setup.
25+
* You prefer fewer deployment steps to get started.
26+
* You are familiar with Helm workflows.
27+
a|*Setup and deployment priorities*
28+
29+
* You prioritize long-term automation over initial simplicity.
30+
* You accept more initial setup complexity for ongoing operational benefits.
31+
* You want integrated lifecycle management from the start.
32+
33+
a|*Update preferences*
34+
35+
* You want full control over update timing.
36+
* You test updates in stages across environments.
37+
* You manage updates manually on your schedule.
38+
a|*Update preferences*
39+
40+
* You want automated update availability through subscription channels.
41+
* You prefer continuous reconciliation of desired state.
42+
* You want less operational overhead for maintaining {product-short}.
43+
44+
a|*Team capabilities*
45+
46+
* Your team has Helm expertise.
47+
* You want direct access to Kubernetes resources.
48+
* You prefer hands-on management and troubleshooting.
49+
a|*Team capabilities*
50+
51+
* Your team follows Kubernetes-native Operator patterns.
52+
* You want built-in lifecycle management.
53+
* You are comfortable working with custom resources.
54+
55+
a|*Control and customization needs*
56+
57+
* You need direct control over all Kubernetes resources.
58+
* You want full visibility into generated manifests.
59+
* You prefer to inspect and modify deployed resources directly.
60+
a|*Control and customization needs*
61+
62+
* You prefer declarative configuration through custom resources.
63+
* You want validation and reconciliation by the Operator.
64+
* You value standardized deployment patterns across your organization.
65+
66+
|===
67+
68+
Both installation methods are fully supported by Red Hat. Choose the method that best matches your operational priorities, platform requirements, and team expertise.
69+
70+
For detailed installation instructions, see {installing-on-ocp-book-link}[{installing-on-ocp-book-title}].

modules/install_installing-rhdh-on-ocp/con-rhdh-installation-methods-on-ocp.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ The {product} Helm chart::
2121
* Requires manual installation and management
2222
--
2323

24+
For guidance on choosing between the Helm chart and Operator based on your operational requirements and team capabilities, see {about-book-link}#compare-the-helm-chart-and-operator-to-choose-the-optimal-deployment-method_about-rhdh[Compare the Helm chart and Operator to choose the optimal deployment method].
25+
2426
[IMPORTANT]
2527
====
2628
You must set the `baseUrl` in `{my-app-config-file}` to match the external URL of your {product-short} instance, such as `pass:c,a,q[{my-product-url}]`.
2729
This value is required for the {product} to function correctly. If it is not set, front-end and back-end services cannot communicate properly, and features might not work as expected.
2830
====
29-
30-
Use the installation method that best meets your needs and preferences.

titles/discover_about-rhdh/master.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Designed for enterprise-scale software teams, {product-very-short} helps develop
2222

2323
include::modules/discover_about-rhdh/con-understanding-internal-developer-platforms.adoc[leveloffset=+1]
2424
include::modules/discover_about-rhdh/con-system-architecture-for-deployment-planning.adoc[leveloffset=+1]
25+
include::modules/discover_about-rhdh/con-compare-the-helm-chart-and-operator-to-choose-the-optimal-deployment-method.adoc[leveloffset=+1]
2526
include::modules/discover_about-rhdh/con-high-availability-with-database-and-cache-layers.adoc[leveloffset=+1]
2627
include::modules/discover_about-rhdh/con-integrations-in-rhdh.adoc[leveloffset=+1]
2728
include::modules/discover_about-rhdh/ref-supported-platforms.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)