Create and manage instances for Workflows

Prerequisites

• You have a STACKIT customer account: Create a customer Account
• You have a STACKIT user account: Create a user account
• You have a STACKIT project: Create a project

Instance properties

Independent of the method you choose to create and manage an instance, there are common properties of a Workflows instance. This chapter explains the parameters and properties.

General properties

Every instance has a name and operates on a specified version. Optionally you can also add a description.

External IdP

As for now, Workflows depends on an external Identity Provider for authentication, authorization and single-sign-on. It uses the OpenID Connect protocol. At the moment the following IdPs are supported:

• Azure
• Google
• Okta
• AWS Cognito
• Keycloak

To integrate an IdP you need to provide the Client ID, the Client secret, the Scope and the Discovery Endpoint. You need to get these values from the repective provider. May configuration at your IdP is needed to gather those information.

The values for Scope are in most cases openid email, for EntraID it is openid email User.Read.

The format for a Discovery Endpoint is https://\<provider-domain\>/.well-known/openid-configuration.

DAG

You need to provide an existing DAG repository with the following parameters: DAG repository URL, Branch name, Username and Password or PAT.

As for now only Basic Authentication is supported.

Create an instance

STACKIT Portal

To create the a Workflows instance, follow these steps:

1. On the sidebar click on Workflows. You can find it in the Data & AI category.
2. Click on Create Workflows.
3. On the new pange, fill in all needed information. See Instance Properties for a better understanding of all options.
4. After checking the input, click on Order fee-based tp create the instance.
5. Wait for the instance to become Active.
   The status may changes several times, until it reaches the Active state.

List instances

STACKIT Portal

To list your Workflows instances, follow these steps:

1. On the sidebar click on Workflows. You can find it in the Data & AI category.
2. You see your instances on the panel on the right.

Edit an instance

STACKIT Portal

To create the a Workflows instance, follow these steps:

1. On the sidebar click on Workflows. You can find it in the Data & AI category.

2. Click on one existing instance to open the detail view.

3. You can make changes to the General properties, the Identity provider and the DAG repository. To make changes click on the Edit button in the respective section.

   After making your changes click on Save

   Changes are only possible, when the instance is in the Active state.

4. After making changes the instance will be in the Updating state. Monitor the instance to reach the Active state again.

   It is also possible, that the state changes to Error, for example when there are problems with the credentials. In this case, you need to troubleshoot manually.

Delete an instance

STACKIT Portal

To create the a Workflows instance, follow these steps:

1. On the sidebar click on Workflows. You can find it in the Data & AI category.
2. On the right side click on the three dots menu and then on Delete-
3. On the new pane enter the instance name as confirmation and click on Delete to finally delete the instance.