Skip to content

Commit

Permalink
Add basic description to site
Browse files Browse the repository at this point in the history
Signed-off-by: Moti Asayag <[email protected]>
  • Loading branch information
masayag committed Feb 6, 2024
1 parent e91b09a commit 7f765eb
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 28 deletions.
50 changes: 27 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,37 @@
# serverless-workflows-helm
## Orchestrator Workflows Helm Repository

*UNDER DEVELOPMENT*
This repository serves as a Helm chart repository for deploying serverless workflows with the Sonataflow Operator. It encompasses a collection of pre-defined workflows, each tailored to specific use cases. These workflows have undergone thorough testing and validation through Continuous Integration (CI) processes and are organized according to their chart versions.

serverless workflows helm charts
The repository includes a variety of serverless workflows, such as:

This is a chart repo for serverless workflows to be deployed using Sonataflow Operator.
All the workflows address defined use-cases, tested and validated using CI, and versioned by the chart version.
* Greeting: A basic example workflow to demonstrate functionality.
* Migration Toolkit for Application Analysis (MTA): This workflow performs an evaluation of applications to determine potential risks and the associated costs of containerizing the applications.
* Move2Kube: Designed to facilitate the transition of an application to Kubernetes (K8s) environments.

The chart contains the workflows and all their needed dependencies and it may reference other workflows chart repo
by dependency resolution, meaning we don't have to have all the worlflows definition here.
Consider this chart as a meta chart or template chart for other workflows or sub-workflows:
## Usage

### Pre-requisites
o utilize the workflows contained in this repository, the Orchestrator Deployment must be installed on your OpenShift Container Platform (OCP) cluster. For detailed instructions on installing the Orchestrator, please visit the [Orchestrator Helm Repository](https://www.parodos.dev/orchestrator-helm-chart/)

Visit workflows pre-requisites before installing the workflows:
* [Greeting](./greeting/README.md)
* [MTA](./mta/README.md)
* [Move2Kube](./move2kube/README.md)

## Installation
```
/
charts/
workflows/
Chart.yaml
values.yaml
charts/
workflow-1/
Chart.yaml
values.yaml
templates/
workflow-2-0.1.0.tgz
workflow-3-0.1.1.tgz
$ helm repo add orchestrator-workflows https://parodos.dev/serverless-workflows-helm
"orchestrator-workflows" has been added to your repositories
$ helm install orchestrator-workflows orchestrator-workflows/workflows
```

Notice that workflow-1 has the code embedded while workflow-2 and 3 is a dependency resolved from the root Chat.yaml
## Configuration

The following table lists the configurable parameters of the Workflows chart and their default values.

| Parameter | Description | Default |
| ------------------------ | ----------------------- | -------------- |
| `mta.enabled` | Indicates that mta workflow is enabled | `true` |
| `greeting.enabled` | Indicates that greeting workflow is enabled | `true` |
| `move2kube.enabled` | Indicates that move2kube workflow is enabled | `true` |
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
theme: jekyll-theme-cayman
name: Orchestrator Workflows Helm Repository
description: Orchestrator Workflows Helm Repository
4 changes: 4 additions & 0 deletions greeting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Greeting Workflow

The greeting workflow is a basic workflow without any external dependencies.
Its purpose is to demonstrate functionality of the workflows system.
8 changes: 3 additions & 5 deletions move2kube/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
Move2kube
===========
# Move2kube Workflow

# Configuration
## Configuration

We need to use `initContainers` and `securityContext` in our Knative services to allow SSH key exchange in move2kube workflow, we have to tell Knative to enable that feature:
```bash
Expand Down Expand Up @@ -31,8 +30,7 @@ If you do not have ssh keys, you can generate them with `ssh-keygen` command. Yo

Note that those ssh keys needs to be added in your git repository as well. For bitbucket it should be on the [account level](https://bitbucket.org/account/settings/ssh-keys/)

# Installation

## Installation

Run
```console
Expand Down
4 changes: 4 additions & 0 deletions mta/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# MTA Workflow

Migration Toolkit for Application Analysis (MTA) workflow performs an evaluation of applications to determine potential risks and the associated costs of containerizing the applications. It uses the [MTA Operator](https://access.redhat.com/documentation/en-us/migration_toolkit_for_applications/6.2/html/introduction_to_the_migration_toolkit_for_applications/index) to perform the analysis.
At the end of a successful assessment workflow, a link to the report will be available in Backstage, under the notifications plugin.

0 comments on commit 7f765eb

Please sign in to comment.