Skip to content

Commit

Permalink
changes ater github org rename
Browse files Browse the repository at this point in the history
  • Loading branch information
pkliczewski committed Dec 9, 2024
1 parent 47c57f4 commit 4cf5a73
Show file tree
Hide file tree
Showing 46 changed files with 127 additions and 127 deletions.
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
www.parodos.dev
www.rhdhorchestrator.io
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
parodos-dev.github.io
rhdhoperator.github.io

This site is built by hugo static site generater and published using a github action to https://parodos.dev
This site is built by hugo static site generater and published using a github action to https://rhdhorchestrator.io

# Devleopment
- Requiremens
- go
- git
- Download `hugo` *extended* version from [hugo releases page](https://github.com/gohugoio/hugo/releases/) or run
- Download `hugo` *extended* version from [hugo releases page](https://github.com/gohugoio/hugo/releases/) or run
```bash
sudo snap install hugo
```

- Run it
- Run it
```bash
hugo server
```
Expand All @@ -23,21 +23,21 @@ This site is built by hugo static site generater and published using a github ac
# Content Organization

- content/docs \
The main directory for the project document
The main directory for the project document
- content/docs/workflows \
Document for the selected set of workflows, for https://parodos-dev/serverless-workflows
Document for the selected set of workflows, for https://rhdhoperator/serverless-workflows
- content/docs/workflows-examples \
Document for the examples workflows, for https://parodos-dev/serverless-workflow-examples
Document for the examples workflows, for https://rhdhoperator/serverless-workflow-examples
- content/post \
Articles, blog posts, etc.

Read more the on hugo documentation https://gohugo.io/documentation/

# How to add a document?
Documents can include markdown content from all the related *`parodos-dev`* repositories.
Documents can include markdown content from all the related *`rhdhoperator`* repositories.
To create a document entry from a markdown file use this:

```bash
./generate-doc-for-repo.sh \
https://github.com/parodos-dev/$REPO/blob/$BRANCH//README.md > content/docs/newdoc.md
https://github.com/rhdhoperator/$REPO/blob/$BRANCH//README.md > content/docs/newdoc.md
```
10 changes: 5 additions & 5 deletions content/1.2/docs/core-concepts/workflow-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ annotations:
The Orchestrator plugin utilizes this metadata to facilitate the processing and visualization of infrastructure workflow inputs and outputs within the user interface.
##### Examples:
- [Greeting](https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/greeting/greeting.sw.yaml)
- [Ticket Escalation](https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/escalation/ticketEscalation.sw.yaml)
- [Move2Kube](https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/move2kube/m2k.sw.yml)
- [Greeting](https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/greeting/greeting.sw.yaml)
- [Ticket Escalation](https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/escalation/ticketEscalation.sw.yaml)
- [Move2Kube](https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/move2kube/m2k.sw.yml)
### Assessment workflow
Expand Down Expand Up @@ -65,8 +65,8 @@ The *workflowOptions* object must possess six essential attributes with specific
```

##### Examples:
- [MTA](https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/mta/mta.sw.yaml)
- [Dummy Assessment](https://github.com/parodos-dev/serverless-workflow-examples/tree/main/assessment)
- [MTA](https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/mta/mta.sw.yaml)
- [Dummy Assessment](https://github.com/rhdhoperator/serverless-workflow-examples/tree/main/assessment)

#### Note
If the aforementioned annotation is missing in the workflow definition file, the Orchestrator plugin will default to treating the workflow as an infrastructure workflow, without considering its output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ When [RHDH](https://developers.redhat.com/rhdh) is already installed and in use,
- 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/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.
- For your convenience, a [reference implementation](https://github.com/rhdhoperator/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/rhdhoperator/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.

In this approach, since the RHDH instance is not managed by the Orchestrator operator, its configuration is handled through the Backstage CR along with the associated resources, such as ConfigMaps and Secrets.

The installation steps are detailed [here](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/release-1.2/existing-rhdh.md).
The installation steps are detailed [here](https://github.com/rhdhoperator/orchestrator-helm-operator/blob/main/docs/release-1.2/existing-rhdh.md).
2 changes: 1 addition & 1 deletion content/1.2/docs/installation/orchestrator-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ kubectl patch daemonsets -n projectcontour envoy -p '{"spec":{"template":{"spec"

The cluster should be up and running with [Contour ingress-controller](https://projectcontour.io) installed, so localhost:9090 will direct the traffic to Backstage, because of the ingress created by the helm chart on port 80.

{{< remoteMD "https://raw.githubusercontent.com/parodos-dev/orchestrator-helm-chart/main/charts/orchestrator-k8s/README.md" >}}
{{< remoteMD "https://raw.githubusercontent.com/rhdhoperator/orchestrator-helm-chart/main/charts/orchestrator-k8s/README.md" >}}
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 @@ -12,4 +12,4 @@ When installing a Red Hat Developer Hub (RHDH) instance using the Orchestrator o

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/main/docs/release-1.2/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/orchestrator-helm-operator/blob/main/docs/release-1.2/README.md?raw=true" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Deploy From Helm Repository
date: "2024-02-20"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows-config/blob/gh-pages-1.2/docs/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows-config/blob/gh-pages-1.2/docs/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.2/docs/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This quickstart guide will help you install the Orchestrator using the Helm-base
Follow the [installation instructions for Orchestrator](/1.2/docs/installation/).

2. **Install a sample workflow**:
Follow the [installation instructions for the greetings workflow](https://github.com/parodos-dev/serverless-workflows-config/blob/main/docs/release-1.2/greeting/README.md).
Follow the [installation instructions for the greetings workflow](https://github.com/rhdhoperator/serverless-workflows-config/blob/main/docs/release-1.2/greeting/README.md).

3. **Access Red Hat Developer Hub**:
Open your web browser and navigate to the Red Hat Developer Hub application. Retrieve the URL using the following OpenShift CLI command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: MTA Analysis
date: "2024-02-29"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/mta-v7.x/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/mta-v7.x/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.2/docs/serverless-workflows/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ date: "2024-02-20"
weight: 100
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.2/docs/serverless-workflows/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ date: 2024-03-03
weight: 110
---

Our Orchestrator Serverless Workflow Examples repository, located at [GitHub](https://github.com/parodos-dev/serverless-workflow-examples), provides a collection of sample workflows designed to help you explore and understand how to build serverless workflows using Orchestrator. These examples showcase a range of use cases, demonstrating how workflows can be developed, tested, and executed based on various inputs and conditions.
Our Orchestrator Serverless Workflow Examples repository, located at [GitHub](https://github.com/rhdhoperator/serverless-workflow-examples), provides a collection of sample workflows designed to help you explore and understand how to build serverless workflows using Orchestrator. These examples showcase a range of use cases, demonstrating how workflows can be developed, tested, and executed based on various inputs and conditions.

Please note that this repository is intended for development and testing purposes only. It serves as a reference for developers looking to create custom workflows and experiment with serverless orchestration concepts. These examples are not optimized for production environments and should be used to guide your own development processes.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Move2Kube
date: "2024-02-27"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/move2kube/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/move2kube/README.md?raw=true" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Simple Escalation
date: "2024-02-28"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.2.x/escalation/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.2.x/escalation/README.md?raw=true" >}}
12 changes: 6 additions & 6 deletions content/1.2/docs/serverless-workflows/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ This document provides solutions to common problems encountered with serverless
---

## HTTP Errors
Many workflow operations are REST requests to REST endpoints. If an HTTP error occurs then the workflow will fail and the HTTP code and message will be displayed. Here is an [example](https://github.com/parodos-dev/parodos-dev.github.io/blob/main/content/1.2/docs/serverless-workflows/409-error.png?raw=true) of the error in the UI.
Please use [HTTP codes documentation](https://developer.mozilla.org/docs/Web/HTTP/Status) for understanding the meaning of such errors.
Many workflow operations are REST requests to REST endpoints. If an HTTP error occurs then the workflow will fail and the HTTP code and message will be displayed. Here is an [example](https://github.com/rhdhoperator/rhdhoperator.github.io/blob/main/content/1.2/docs/serverless-workflows/409-error.png?raw=true) of the error in the UI.
Please use [HTTP codes documentation](https://developer.mozilla.org/docs/Web/HTTP/Status) for understanding the meaning of such errors.
Here are some examples:
- `409`. Usually indicates that we are trying to update or create a resource that already exists. E.g. K8S/OCP resources.
- `401`. Unauthorized access. A token, password or username might be wrong or expired.

## Workflow Errors

### Problem: Workflow execution fails
Expand Down Expand Up @@ -68,13 +68,13 @@ Here are some examples:
$ oc get pods -l sonataflow.org/service=sonataflow-platform-data-index-service -n sonataflow-infra
NAME READY STATUS RESTARTS AGE
sonataflow-platform-data-index-service-546f59f89f-b7548 1/1 Running 0 11kh

$ oc rollout restart deployment my-workflow
```

### Problem: Workflow is failing to reach an HTTPS endpoint because it can't verify it

- REST actions performed by the workflow can fail the SSL certificate check if the target endpoint is signed with
- REST actions performed by the workflow can fail the SSL certificate check if the target endpoint is signed with
a CA which is not available to the workflow. The error in the workflow pod log usually looks like this:

```console
Expand All @@ -99,7 +99,7 @@ If the PostgreSQL pod is running but the issue persists, verify that the `sonata

**Solution:**

Get the NetworkPolicy name from its [definition](https://github.com/parodos-dev/orchestrator-helm-operator/blob/03ddd07bcd8e2aaf9fb37cedb6604be2cf37b6f3/helm-charts/orchestrator/templates/network-policies.yaml#L5). or example, it may be `allow-rhdh-to-sonataflow-and-workflows`.
Get the NetworkPolicy name from its [definition](https://github.com/rhdhoperator/orchestrator-helm-operator/blob/03ddd07bcd8e2aaf9fb37cedb6604be2cf37b6f3/helm-charts/orchestrator/templates/network-policies.yaml#L5). or example, it may be `allow-rhdh-to-sonataflow-and-workflows`.

View the details of the specified NetworkPolicy:

Expand Down
10 changes: 5 additions & 5 deletions content/1.3/docs/core-concepts/workflow-types/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ annotations:
The Orchestrator plugin utilizes this metadata to facilitate the processing and visualization of infrastructure workflow inputs and outputs within the user interface.
##### Examples:
- [Greeting](https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/greeting/greeting.sw.yaml)
- [Ticket Escalation](https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/escalation/ticketEscalation.sw.yaml)
- [Move2Kube](https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/move2kube/m2k.sw.yml)
- [Greeting](https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/greeting/greeting.sw.yaml)
- [Ticket Escalation](https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/escalation/ticketEscalation.sw.yaml)
- [Move2Kube](https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/move2kube/m2k.sw.yml)
### Assessment workflow
Expand Down Expand Up @@ -65,8 +65,8 @@ The *workflowOptions* object must possess six essential attributes with specific
```

##### Examples:
- [MTA](https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/mta/mta.sw.yaml)
- [Dummy Assessment](https://github.com/parodos-dev/serverless-workflow-examples/tree/main/assessment)
- [MTA](https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/mta/mta.sw.yaml)
- [Dummy Assessment](https://github.com/rhdhoperator/serverless-workflow-examples/tree/main/assessment)

#### Note
If the aforementioned annotation is missing in the workflow definition file, the Orchestrator plugin will default to treating the workflow as an infrastructure workflow, without considering its output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ When [RHDH](https://developers.redhat.com/rhdh) is already installed and in use,
- 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/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.
- For your convenience, a [reference implementation](https://github.com/rhdhoperator/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/rhdhoperator/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.

In this approach, since the RHDH instance is not managed by the Orchestrator operator, its configuration is handled through the Backstage CR along with the associated resources, such as ConfigMaps and Secrets.

The installation steps are detailed [here](https://github.com/parodos-dev/orchestrator-helm-operator/blob/main/docs/release-1.3/existing-rhdh.md).
The installation steps are detailed [here](https://github.com/rhdhoperator/orchestrator-helm-operator/blob/main/docs/release-1.3/existing-rhdh.md).
2 changes: 1 addition & 1 deletion content/1.3/docs/installation/orchestrator-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ kubectl patch daemonsets -n projectcontour envoy -p '{"spec":{"template":{"spec"

The cluster should be up and running with [Contour ingress-controller](https://projectcontour.io) installed, so localhost:9090 will direct the traffic to Backstage, because of the ingress created by the helm chart on port 80.

{{< remoteMD "https://raw.githubusercontent.com/parodos-dev/orchestrator-helm-chart/main/charts/orchestrator-k8s/README.md" >}}
{{< remoteMD "https://raw.githubusercontent.com/rhdhoperator/orchestrator-helm-chart/main/charts/orchestrator-k8s/README.md" >}}
2 changes: 1 addition & 1 deletion content/1.3/docs/installation/orchestrator.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ When installing a Red Hat Developer Hub (RHDH) instance using the Orchestrator o

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/main/docs/release-1.3/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/orchestrator-helm-operator/blob/main/docs/release-1.3/README.md?raw=true" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: Deploy From Helm Repository
date: "2024-02-20"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows-config/blob/gh-pages/docs/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows-config/blob/gh-pages/docs/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.3/docs/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This quickstart guide will help you install the Orchestrator using the Helm-base
Follow the [installation instructions for Orchestrator](/main/docs/installation/).

2. **Install a sample workflow**:
Follow the [installation instructions for the greetings workflow](https://github.com/parodos-dev/serverless-workflows-config/blob/main/docs/release-1.3/greeting/README.md).
Follow the [installation instructions for the greetings workflow](https://github.com/rhdhoperator/serverless-workflows-config/blob/main/docs/release-1.3/greeting/README.md).

3. **Access Red Hat Developer Hub**:
Open your web browser and navigate to the Red Hat Developer Hub application. Retrieve the URL using the following OpenShift CLI command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ title: MTA Analysis
date: "2024-02-29"
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/mta-v7.x/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/mta-v7.x/README.md?raw=true" >}}
2 changes: 1 addition & 1 deletion content/1.3/docs/serverless-workflows/best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ title: Best Practices
date: "2024-10-31"
---

{{< remoteMD "https://raw.githubusercontent.com/parodos-dev/serverless-workflows/refs/heads/main/best-practices.md?raw=true" >}}
{{< remoteMD "https://raw.githubusercontent.com/rhdhoperator/serverless-workflows/refs/heads/main/best-practices.md?raw=true" >}}

2 changes: 1 addition & 1 deletion content/1.3/docs/serverless-workflows/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ date: "2024-02-20"
weight: 100
---

{{< remoteMD "https://github.com/parodos-dev/serverless-workflows/blob/v1.3.x/README.md?raw=true" >}}
{{< remoteMD "https://github.com/rhdhoperator/serverless-workflows/blob/v1.3.x/README.md?raw=true" >}}
Loading

0 comments on commit 4cf5a73

Please sign in to comment.