Skip to content
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
d8bf883
Update the disconnected environment
invalid-email-address Oct 8, 2025
3255dce
Update the disconnected environment
invalid-email-address Oct 9, 2025
9a68ec0
Apply suggestions
invalid-email-address Oct 9, 2025
bd175b4
Apply suggestions
invalid-email-address Oct 9, 2025
0d5c802
Merge branch 'main' into RHIDP-8711-Orchestrator-flavors-airgap-suppo…
jmagak Oct 9, 2025
7d62883
Apply suggestions
invalid-email-address Oct 9, 2025
139631b
Apply suggestions
invalid-email-address Oct 9, 2025
c4a28b5
New updates
invalid-email-address Oct 9, 2025
0ee86e2
Apply new suggestions
invalid-email-address Oct 14, 2025
85acddf
Apply suggestion
invalid-email-address Oct 14, 2025
2709a98
Apply suggestion
invalid-email-address Oct 14, 2025
e8e3ac3
Minor update
invalid-email-address Oct 15, 2025
e1decc3
Apply new suggestions
invalid-email-address Oct 20, 2025
90d481b
Apply new suggestions
invalid-email-address Oct 27, 2025
e0b43a7
Apply new suggestions
invalid-email-address Oct 27, 2025
01abaa5
Apply new suggestions
invalid-email-address Oct 28, 2025
a9ddf1f
New suggestions
invalid-email-address Oct 29, 2025
585611c
Apply mirroring instructions
invalid-email-address Oct 30, 2025
e29b644
Apply mirroring instructions
invalid-email-address Oct 30, 2025
726cb80
Apply new suggestions
invalid-email-address Oct 31, 2025
80d2584
Apply new suggestions
invalid-email-address Oct 31, 2025
6121d2f
Update new suggestions
invalid-email-address Nov 3, 2025
ea6b329
Apply new suggestions
invalid-email-address Nov 4, 2025
75a96dc
Apply new suggestions
invalid-email-address Nov 4, 2025
1c19f52
Apply new suggestion
invalid-email-address Nov 4, 2025
02233f2
Apply new suggestions
invalid-email-address Nov 4, 2025
24dd582
Apply new suggestions
invalid-email-address Nov 4, 2025
5d251c7
Update links
invalid-email-address Nov 5, 2025
42359f8
Merge branch 'main' into RHIDP-8711-Orchestrator-flavors-airgap-suppo…
Gerry-Forde Nov 5, 2025
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:_mod-docs-content-type: ASSEMBLY

[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment_{context}"]
= Installing Orchestrator plugin in an air-gapped environment

You can configure {product} ({product-very-short}) with Orchestrator plugin in an air-gapped environment by using either the Operator or Helm chart.

include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator.adoc[leveloffset=+1]

include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
:_mod-docs-content-type: PROCEDURE

[id="proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart.adoc_{context}"]
= Installing {product} with Orchestrator in an air-gapped {ocp-short} environment using the Helm chart


.Prerequisites

include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

. Mirror the {product} {product-version} Helm chart images to the local registry. See {installing-in-air-gap-book-link}#assembly-install-rhdh-airgapped-environment-ocp-helm_title-install-rhdh-air-grapped[Installing {product} on {ocp-short} in an air-gapped environment with the Helm chart] for instructions.

. Mirror the `redhat-developer-hub-orchestrator-infra` chart images to the local registry.

include::snip-installing-the-orchestrator-common-steps.adoc[]

. Apply the `redhat-developer-hub-orchestrator-infra` Helm chart and approve the install plans. See {installing-in-air-gap-book-link}#assembly-install-rhdh-airgapped-environment-ocp-helm_title-install-rhdh-air-grapped[Air-gapped installation with Helm chart instructions] for details.

. Apply the {product-very-short} {product-version} Helm chart. Include the version {product-bundle-version} and enable the Orchestrator plugin as shown in the following example:
+
[source,yaml]
----
orchestrator.enabled=true
----

. The {product-very-short} {product-version} Helm chart defaults to pulling Orchestrator plugins from the official {company-name} NPM registry using full URL references. You must override this behavior to point to your local registry.
+
To configure the Orchestrator plugins to use a custom registry, complete the following steps:
+
* Open your `values.yaml` file.
+
* Explicitly list the Orchestrator plugin packages under the `orchestrator.plugins` section.
You must replace the full URLs with the simplified package references that point to your custom NPM registry as shown in the following example:
+
[source,yaml]
----
- package: "@redhat/backstage-plugin-orchestrator@{product-bundle-version}"
- package: "@redhat/backstage-plugin-orchestrator-backend-dynamic@{product-bundle-version}"
- package: "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{product-bundle-version}"
- package: "@redhat/backstage-plugin-orchestrator-form-widgets@{product-bundle-version}"
----

.Verification

* Restart the {product-very-short} pod and wait for the components to deploy properly.

* After deployment is complete, go to the **{product-very-short}** UI and confirm that the Orchestrator UI is accessible and functioning correctly.

[NOTE]
====
The successful accessibility of the Orchestrator UI confirms that the underlying components are running and the cluster recognizes the plugin.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:_mod-docs-content-type: PROCEDURE

[id="proc-install-rhdh-orchestrator-airgapped-env-using-operator.adoc_{context}"]
= Installing {product} with Orchestrator in an air-gapped {ocp-short} environment using the Operator

You can install {product} with Orchestrator plugin in an air-gapped environment using Operator.

In a network-restricted environment, a disconnected installation prevents unauthorized access, data transfer, or communication with external sources.

.Prerequisites

* You have mirrored the {product} Operator images to the local registry using the included script. For {product-very-short} installation using Operator, the mirroring script automatically deploys the {product-very-short} Operator for you.

include::snip-installing-the-orchestrator-common-prerequisites.adoc[]

.Procedure

include::snip-installing-the-orchestrator-common-steps.adoc[]

. Install the OpenShift Serverless Operator and OpenShift Serverless Logic Operators using the OperatorHub.

. Create a {product-custom-resource-type} custom resource (CR).

. Configure the {product-custom-resource-type} CR for the Orchestrator as described in the {orchestrator-book-link}#con-orchestrator-plugin-dependencies-operator.adoc_orchestrator-rhdh[Orchestrator plugin dependencies for Operator installation].
+
Create all the resources and configure the {product-custom-resource-type} instance accordingly. See {release-notes-book-link}#removed-functionality-rhdhbugs-2000[Configuring a custom NPM registry] for instructions on how to point {product-very-short} towards the custom NPM registry.

.Verification

* Restart the {product-very-short} pod and wait for the components to deploy properly.

* Once stable, go to the {product-very-short} UI, and confirm that the Orchestrator UI is accessible and functioning correctly.

[NOTE]
====
The successful accessibility of the Orchestrator UI confirms that the underlying components are running and the cluster recognizes the plugin.
====
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* You have set up your disconnected environment using a local registry.

* You have permissions to push NPM packages to a local NPM server.

* Optional: Create and configure a local NPM server.
Loading