Skip to content

Commit

Permalink
Merge pull request #102 from masayag/operator-docs
Browse files Browse the repository at this point in the history
Update links to operator docs folder
  • Loading branch information
masayag authored Sep 25, 2024
2 parents 55ae262 + 154d5d4 commit 95fef02
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
date: 2024-03-13
title: Installing the Orchestrator on existing RHDH instance
title: "Orchestrator on existing RHDH instance"
---

When [RHDH](https://developers.redhat.com/rhdh) is already installed and in use, reinstalling it is unnecessary. Instead, integrating the Orchestrator into such an environment involves a few key steps:

1. Utilize the Helm chart to install the requisite components, such as the SonataFlow operator and the OpenShift Serverless Operator, while ensuring the RHDH installation is disabled.
1. Utilize the Orchestrator operator to install the requisite components, such as the OpenShift Serverless Logic Operator and the OpenShift Serverless Operator, while ensuring the RHDH installation is disabled.
2. Manually update the existing RHDH ConfigMap resources with the necessary configuration for the Orchestrator plugin.
3. Import the Orchestrator software templates into the Backstage catalog.

## Prerequisites
- RHDH is already deployed with a running Backstage instance.
- Software templates for workflows requires GitHub provider to be configured.
- Ensure that a [PostgreSQL](https://www.postgresql.org/) database is available and that you have credentials to manage the tablespace (optional).
- For your convenience, a [reference implementation](https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/postgresql/README.md) is provided.
- If you already have a PostgreSQL database installed, please refer to this [note](https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/postgresql/README.md#note-the-default-settings-provided-in-postgresql-values-match-the-defaults-provided-in-the-orchestrator-values) regarding default settings.
- For your convenience, a [reference implementation](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/postgresql/README.md) is provided.
- If you already have a PostgreSQL database installed, please refer to this [note](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/postgresql/README.md#note-the-default-settings-provided-in-postgresql-values-match-the-defaults-provided-in-the-orchestrator-values) regarding default settings.

The required configurations for Orchestrator can be found at the following links:
* [v1.2.x](https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/existing-rhdh.md) - for RHDH-1.2.x
* [v1.2.x](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/release-1.2/existing-rhdh.md) - for RHDH-1.2.x
2 changes: 1 addition & 1 deletion content/1.2/docs/installation/orchestrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The Orchestrator plugins are deployed on [Red Hat Developer Hub
](https://developers.redhat.com/rhdh/overview) instance, serves as the frontend.
To utilize *Backstage* capabilities, the Orchestrator imports software templates designed to ease the development of new workflows and offers an opinionated method for managing their lifecycle by including CI/CD resources as part of the template.

{{< remoteMD "https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/README.md?raw=true" >}}
{{< remoteMD "https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/release-1.2/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.2/docs/serverless-workflows/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ a CA which is not available to the workflow. The error in the workflow pod log u
### Problem: Workflow installed in a different namespace than Sonataflow services fails to start

**Solution:**
When deploying a workflow in a namespace other than the one where Sonataflow services are running (e.g., sonataflow-infra), there are essential steps to follow to enable persistence and connectivity for the workflow. See the following [steps](https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/README.md#additional-workflow-namespaces).
When deploying a workflow in a namespace other than the one where Sonataflow services are running (e.g., sonataflow-infra), there are essential steps to follow to enable persistence and connectivity for the workflow. See the following [steps](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/release-1.2/README.md#additional-workflow-namespaces).
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ cascade:
{{< blocks/cover title="Orchestrating Systems | Migrating Code Infrastructure | Keeping Developers in Sync" color="primary" image_anchor="top" height="min" >}}

<div class="mx-auto">
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/parodos-dev/orchestrator-helm-operator/tree/gh-pages">
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/parodos-dev/orchestrator-helm-operator/tree/main/docs/release-1.2">
Setup Orchestrator <i class="fa-brands fa-github ms-2"></i>
</a>
</div>
Expand Down
2 changes: 1 addition & 1 deletion content/blog/developer-experience-detailed.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Next, add robot account permissions to the created repository.
![Setting permissions](/blog/images/add-robot-accout-perm-to-workflow.png)

### Creating a Secret for GitOps Cluster
Refer to the instructions [here](https://github.com/parodos-dev/orchestrator-helm-operator/blob/gh-pages/gitops/README.md#installing-docker-credentials) for creating and configuring the secret for the target cluster.
Refer to the instructions [here](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/gitops/README.md#installing-docker-credentials) for creating and configuring the secret for the target cluster.

## Creating the Software Template
The Orchestrator plugin provides templates to kickstart your workflow project. By selecting a template tagged with `orchestrator`, you gain access to the following benefits:
Expand Down

0 comments on commit 95fef02

Please sign in to comment.