diff --git a/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc b/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc new file mode 100644 index 0000000000..e086f39c66 --- /dev/null +++ b/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: ASSEMBLY + +[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm_{context}"] += Installing Orchestrator plugin in an air-gapped environment with the Helm chart + +You can configure {product} ({product-very-short}) with the Orchestrator plugin in a fully disconnected or partially disconnected environment by using the Helm chart. + +include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc[leveloffset=+1] + +include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc[leveloffset=+1] \ No newline at end of file diff --git a/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc b/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc new file mode 100644 index 0000000000..4435171591 --- /dev/null +++ b/assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc @@ -0,0 +1,10 @@ +:_mod-docs-content-type: ASSEMBLY + +[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator_{context}"] += Installing Orchestrator plugin in an air-gapped environment with the Operator + +You can configure {product} ({product-very-short}) with the Orchestrator plugin in a fully disconnected or partially disconnected environment by using the Operator. + +include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc[leveloffset=+1] + +include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc new file mode 100644 index 0000000000..bbf0dcc5a4 --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc @@ -0,0 +1,156 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full_{context}"] += Installing {product} with Orchestrator in a fully disconnected {ocp-short} environment using the Helm chart + +You can install {product} ({product-very-short}) with the Orchestrator plugin in a fully air-gapped {ocp-short} environment using the Helm chart. + +You can mirror images to an intermediary disk, and then mirror from the disk to your target local registry and apply the generated cluster resources. + +.Prerequisites + +include::snip-installing-the-orchestrator-common-prerequisites.adoc[] + +.Procedure + +. Create an `ImageSetConfiguration.yaml` file for `oc-mirror`. You must use an `ImageSetConfiguration` file to include all mirrored images required by the Serverless Logic Operator, as shown in the following example: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: mirror.openshift.io/v2alpha1 +kind: ImageSetConfiguration +mirror: + additionalimages: + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:{rhoserverless-version}.0 + + helm: + repositories: + - name: openshift-charts + url: https://charts.openshift.io + charts: + - name: redhat-developer-hub + version: "{product-bundle-version}" + - name: redhat-developer-hub-orchestrator-infra + version: "{product-bundle-version}" + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} + # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 + packages: + - name: logic-operator-rhel8 + channels: + - name: alpha + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.0 + - name: serverless-operator + channels: + - name: stable + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.1 +---- ++ +Alternatively, you can use `podman` commands to find the missing images and add them to the `additionalimages` list if the versions change: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:{rhoserverless-version} +mkdir local-manifests-osl +podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml" +podman cp temp-container:/manifests ./local-manifests-osl +podman rm temp-container +yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.*\\/.*:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml +---- + +. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2 +---- ++ +[NOTE] +==== +The `oc-mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `/path/to/mirror-archive` directory. +==== ++ +. Apply the cluster-wide resources generated during the push step to redirect all image pulls to your local registry, as shown in the following example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +cd /working-dir/cluster-resources/ +oc apply -f . +---- ++ +. Transfer the generated mirror archive file, for example, `/path/to/mirror-archive/mirror_000001.tar`, to a bastion host within your disconnected environment. + +. From the bastion host in your disconnected environment, which has access to the mirror registry, mirror the images from the archive file to your target registry. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc-mirror --v2 --from docker:// --workspace file:// --authfile /path/to/authfile +---- ++ +where: + +``:: Enter the name of the transferred `tar` file. + +``:: Enter your local registry, for example, `registry.localhost:5000`. ++ +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 simplified package references with the full URLs that point to your custom NPM registry, as shown in the following example: ++ +[source,yaml] +---- +orchestrator: + plugins: + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz + integrity: sha512-xxxxxx + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz + integrity: sha512-xxxxxy + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz + integrity: sha512-xxxxxz + - disabled: false + package: [:]/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz + integrity: sha512-xxxx1 +---- ++ +where: + +``:: +Enter the address of your custom registry and make sure the integrity checksum, such as sha512-xxxxxx, matches the files in your registry. + +.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. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc new file mode 100644 index 0000000000..a72386adcc --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc @@ -0,0 +1,131 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial_{context}"] += Installing {product} with Orchestrator in a partially disconnected {ocp-short} environment using the Helm chart + +You can install {product} ({product-very-short}) with the Orchestrator plugin in a partial {ocp-short} environment using the Helm chart. + +A disconnected installation prevents unauthorized access, data transfer, or communication with external sources. + +You can use the `oc-mirror` command to mirror resources directly to your accessible local registry and apply the generated cluster resources. + +.Prerequisites + +include::snip-installing-the-orchestrator-common-prerequisites.adoc[] + +.Procedure + +. Create an `ImageSetConfiguration` file for `oc-mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as `oc-mirror` does not automatically mirror all images. Use the following example: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: mirror.openshift.io/v2alpha1 +kind: ImageSetConfiguration +mirror: + additionalimages: + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:{rhoserverless-version}.0 + + helm: + repositories: + - name: openshift-charts + url: https://charts.openshift.io + charts: + - name: redhat-developer-hub + version: "{product-bundle-version}" + - name: redhat-developer-hub-orchestrator-infra + version: "{product-bundle-version}" + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} + # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 + packages: + - name: logic-operator-rhel8 + channels: + - name: alpha + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.0 + - name: serverless-operator + channels: + - name: stable + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.1 +---- + +. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command to pull images and charts, and push the images directly to the target registry. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc-mirror --config=imagesetconfiguration.yaml docker:// --workspace file:// --authfile /path/to/authfile --v2 +---- ++ +[NOTE] +==== +The `oc-mirror` command pulls the charts listed in the `ImageSetConfiguration` file and makes them available as `tgz` archives under the `` directory. +==== + +. Apply the generated cluster resources to the disconnected cluster. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +cd /working-dir/cluster-resources/ +oc apply -f . +---- ++ +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 simplified package references with the full URLs that point to your custom NPM registry, as shown in the following example: ++ +[source,yaml] +---- +orchestrator: + plugins: + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz + integrity: sha512-xxxxxx + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz + integrity: sha512-xxxxxy + - disabled: false + package: [:]/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz + integrity: sha512-xxxxxz + - disabled: false + package: [:]/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz + integrity: sha512-xxxx1 +---- ++ +where: + +``:: +Enter the address of your custom registry and make sure the integrity checksum, such as sha512-xxxxxx, matches the files in your registry. + +.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. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc new file mode 100644 index 0000000000..c7d93e472b --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc @@ -0,0 +1,117 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-install-rhdh-orchestrator-airgapped-env-using-operator-full_{context}"] += Installing {product} with Orchestrator in a fully disconnected {ocp-short} environment using the Operator + +You can install {product} with Orchestrator plugin in a fully air-gapped environment using the Operator. + +A disconnected installation prevents unauthorized access, data transfer, or communication with external sources. + +You can use the helper script to install {product} by mirroring the Operator-related images to disk and transferring them to your disconnected environment without any connection to the internet. + +.Prerequisites + +* You have mirrored the {product} Operator images to the local registry using the {product-very-short} mirroring script. For more information, see {installing-in-air-gap-book-link}#proc-install-rhdh-operator-airgapped-full.adoc_title-install-rhdh-air-grapped[_Installing {product} in a fully disconnected environment with the Operator_]. + +include::snip-installing-the-orchestrator-common-prerequisites.adoc[] + +.Procedure + +. Create an `ImageSetConfiguration` file for `oc-mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as `oc-mirror` does not automatically mirror all images. Use the following example: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: mirror.openshift.io/v2alpha1 +kind: ImageSetConfiguration +mirror: + additionalimages: + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:{rhoserverless-version}.0 + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} + # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 + packages: + - name: logic-operator-rhel8 + channels: + - name: alpha + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.0 + - name: serverless-operator + channels: + - name: stable + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.1 +---- ++ +Alternatively, you can use `podman` commands to find the missing images and add them to the `additionalimages` list if the versions change: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:{rhoserverless-version} +mkdir local-manifests-osl +podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml" +podman cp temp-container:/manifests ./local-manifests-osl +podman rm temp-container +yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.*\\/.*:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml +---- + +. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc-mirror --config=ImageSetConfiguration.yaml file:///path/to/mirror-archive --authfile /path/to/authfile --v2 +---- ++ +[NOTE] +==== +The `oc-mirror` command generates a local workspace containing the mirror archive files and the required cluster manifests. +==== ++ +. Transfer the directory specified by `/path/to/mirror-archive` to a bastion host within your disconnected environment. + +. From the bastion host which has access to the mirror registry, mirror the images from the disk directory to your target registry. For example: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +oc-mirror --v2 --from docker:// --workspace file:// --authfile /path/to/authfile +---- ++ +where: + +``:: Enter the name of the transferred `tar` file. + +``:: Enter your local registry, for example, `registry.localhost:5000`. ++ +. Apply the cluster-wide resources generated during the push step to redirect all image pulls to your local registry, as shown in the following example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +cd /working-dir/cluster-resources/ +oc apply -f . +---- + +include::snip-installing-the-orchestrator-common-steps.adoc[] ++ +. Install the OpenShift Serverless Operator and OpenShift Serverless Logic Operators using `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. +==== \ No newline at end of file diff --git a/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc new file mode 100644 index 0000000000..80cc2d5f06 --- /dev/null +++ b/modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc @@ -0,0 +1,91 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial_{context}"] += Installing {product} with Orchestrator in a partially disconnected {ocp-short} environment using the Operator + +You can install {product} with Orchestrator plugin in a partial air-gapped environment using the Operator. + +A disconnected installation prevents unauthorized access, data transfer, or communication with external sources. + +You can use the `oc-mirror` command to mirror resources directly to your accessible local mirror registry and apply the generated cluster resources. + +.Prerequisites + +* You have mirrored the {product} Operator images to the local registry using the {product-very-short} mirroring script. For more information, see {installing-in-air-gap-book-link}#proc-install-rhdh-operator-airgapped-partial.adoc_title-install-rhdh-air-grapped[_Installing {product} in a partially disconnected environment with the Operator_]. + +include::snip-installing-the-orchestrator-common-prerequisites.adoc[] + +.Procedure + +. Create an `ImageSetConfiguration` file for `oc-mirror`. You must include the images and operators required by the Serverless Logic Operator in the `ImageSetConfiguration` file, as `oc-mirror` does not automatically mirror all images. Use the following example: ++ +[source,yaml,subs="+attributes,+quotes"] +---- +apiVersion: mirror.openshift.io/v2alpha1 +kind: ImageSetConfiguration +mirror: + additionalimages: + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-jobs-service-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-postgresql-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-data-index-ephemeral-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-db-migrator-tool-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-builder-rhel8:{rhoserverless-version}.0 + - name: registry.redhat.io/openshift-serverless-1/logic-swf-devmode-rhel8:{rhoserverless-version}.0 + operators: + - catalog: registry.redhat.io/redhat/redhat-operator-index:{ocp-version} + # For example: registry.redhat.io/redhat/redhat-operator-index:v4.19 + packages: + - name: logic-operator-rhel8 + channels: + - name: alpha + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.0 + - name: serverless-operator + channels: + - name: stable + minVersion: {rhoserverless-version}.0 + maxVersion: {rhoserverless-version}.1 +---- ++ +Alternatively, you can use the `podman` commands to find the missing images and add them to the `additionalimages` list if the versions change: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +IMG=registry.redhat.io/openshift-serverless-1/logic-operator-bundle:{rhoserverless-version}.0-8 +mkdir local-manifests-osl +podman create --name temp-container "$IMG" -c "cat /manifests/logic-operator-rhel8.clusterserviceversion.yaml" +podman cp temp-container:/manifests ./local-manifests-osl +podman rm temp-container +yq -r '.data."controllers_cfg.yaml" | from_yaml | .. | select(tag == "!!str") | select(test("^.*\\/.*:.*$"))' ./local-manifests-osl/manifests/logic-operator-rhel8-controllers-config_v1_configmap.yaml +---- + +. Mirror the images in the `ImageSetConfiguration.yaml` file by running the `oc-mirror` command. For example: ++ +[source,terminal,subs="+attributes,+quotes"] +---- +oc-mirror --config=imagesetconfiguration.yaml docker:// --workspace file:// --authfile /path/to/authfile --v2 +cd /working-dir/cluster-resources/ +oc apply -f . +---- ++ +include::snip-installing-the-orchestrator-common-steps.adoc[] ++ +. Install the OpenShift Serverless Operator and OpenShift Serverless Logic Operators using `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_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. +==== \ No newline at end of file diff --git a/modules/orchestrator/snip-installing-the-orchestrator-common-prerequisites.adoc b/modules/orchestrator/snip-installing-the-orchestrator-common-prerequisites.adoc new file mode 100644 index 0000000000..fbc3ab01a8 --- /dev/null +++ b/modules/orchestrator/snip-installing-the-orchestrator-common-prerequisites.adoc @@ -0,0 +1,5 @@ +* You have set up your disconnected environment using a local registry. + +* You have permissions to push NPM packages to a NPM server available in your restricted network. + +* You have installed the {ocp-docs-link}/html-single/disconnected_environments/index#installation-oc-mirror-installing-plugin_about-installing-oc-mirror-v2[`oc-mirror`] tool, with a version corresponding to the version of your {ocp-short} cluster. \ No newline at end of file diff --git a/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc b/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc new file mode 100644 index 0000000000..3d218665b1 --- /dev/null +++ b/modules/orchestrator/snip-installing-the-orchestrator-common-steps.adoc @@ -0,0 +1,26 @@ +. Download the Node Package Manager (NPM) packages for orchestrator {product-bundle-version} using any of the following methods: +* Download them as `tgz` files from the following registry: +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator/-/backstage-plugin-orchestrator-{product-bundle-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-backend-dynamic/-/backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic/-/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz +** https://npm.registry.redhat.com/@redhat/backstage-plugin-orchestrator-form-widgets/-/backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz ++ +* Alternatively, use the NPM packages from link:https://npm.registry.redhat.com[{company-name} NPM registry] as shown in the following example: ++ +[source,subs="+attributes,+quotes"] +---- +npm pack "@redhat/backstage-plugin-orchestrator@{product-bundle-version}" --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-orchestrator-backend-dynamic@{product-bundle-version}" --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-scaffolder-backend-module-orchestrator-dynamic@{product-bundle-version} --registry=https://npm.registry.redhat.com +npm pack "@redhat/backstage-plugin-orchestrator-form-widgets@{product-bundle-version}" --registry=https://npm.registry.redhat.com +---- + +. Push the NPM packages you have downloaded to your NPM server, as shown in the following example: ++ +[source,subs="+attributes,+quotes"] +---- +npm publish backstage-plugin-orchestrator-{product-bundle-version}.tgz +npm publish backstage-plugin-orchestrator-backend-dynamic-{product-bundle-version}.tgz +npm publish backstage-plugin-orchestrator-form-widgets-{product-bundle-version}.tgz +npm publish backstage-plugin-scaffolder-backend-module-orchestrator-dynamic-{product-bundle-version}.tgz +---- \ No newline at end of file diff --git a/titles/orchestrator/master.adoc b/titles/orchestrator/master.adoc index f483c3021e..dba76a5d30 100644 --- a/titles/orchestrator/master.adoc +++ b/titles/orchestrator/master.adoc @@ -11,3 +11,7 @@ include::assemblies/assembly-orchestrator-rhdh.adoc[leveloffset=+1] include::assemblies/assembly-building-and-deploying-serverless-workflows.adoc[leveloffset=+1] include::assemblies/assembly-install-rhdh-orchestrator.adoc[leveloffset=+1] + +include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm.adoc[leveloffset=+1] + +include::assemblies/assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator.adoc[leveloffset=+1] \ No newline at end of file