Getting Started

Getting started with UX

To get started with Omnistrate UX, its really simple and you just need to follow quick self-onboarding steps:

Signup

Go here and follow the instructions. Once logged in, click "Get Started" to start building your SaaS.

Configure Cloud Accounts

To configure your own account, you can grant us a security role through different mechanisms to provision infrastructure on your behalf. If you wish to host on our account, you can skip this step.

Here is how it looks like:

• For AWS, we have a 1-click integration to create your Cloudformation stack. For step-by-step instructions, here is a link to the video
• For GCP, we have a 1-click integration using Cloud Shell to create the security role. For step-by-step instructions, here is a link to the video
• For Azure, we have a 1-click integration using Azure Cloud Shell to create the security role. For step-by-step instructions, here is a link to the video

Note

If you encounter any error due to the already created AWSLoadBalancerControllerIAMPolicy policy in AWS, please select the option to onboard your AWS account without creating that policy

Note

Azure needs in addition to full subscription permissions the ability to bind AD roles. User running the onboarding script needs to have a role such as Privileged Role Administrator allowing binding of AD roles assigned at AD level ('Microsoft Entra ID' service).

Build SaaS Product

There are several options to start building your SaaS Product:

• Click "Hello world project" to build an example Mage AI service
• Click "Bring your container image" to build a service from your container image
• Click "Bring your Docker Compose" to build a service with your own Compose spec or one of our Certified templates.
• Reach out to [email protected] to build a service with Kubernetes Operators
• Reach out to [email protected] to build a service with Helm Charts

Note

To learn more on how to build with your Compose spec, please see this. For any questions or help, please reach out to us at support@omnistrate.com and we will be happy to help.

Here is how it looks like:

Once you have submitted your service build, Omnistrate will build your service definition and deploy your SaaS Product in a Development environment

Launch SaaS Product

Once your SaaS Product has been created, you can optionally decide to make your SaaS Product live for any one to sign-up and access publicly.

Here is how it looks like:

If you click "Yes", Omnistrate will deploy your SaaS Product in a Production environment.

Getting started with CLI or API

Alternatively, check out our Developer CLI and follow the instructions here

For API, please see here

Getting started video

Hello world example using PostgreSQL

One of the easiest ways to get going is to leverage compose templates. You can existing templates or create your own. Here is a sample compose spec to create single writer Postgres SaaS:

version: '3.9'
services:
  postgres:
    image: postgres
    ports:
      - '5432:5432'
    environment:
      - SECURITY_CONTEXT_USER_ID=999
      - SECURITY_CONTEXT_GROUP_ID=999
      - POSTGRES_USER=username
      - POSTGRES_PASSWORD=password
      - PGDATA=/var/lib/postgresql/data/dbdata
    volumes:
      - ./data:/var/lib/postgresql/data

In the above case:

• We are using only 1 Resource (postgres) with the standard image (postgres) and infra (port: 5432)
• Given no account config is specified, the infrastructure for your SaaS is provisioned in the Omnistrate account
• There are a few static environment variables that will be injected into the runtime process like POSTGRES_USER

In general, the compose config allows you to specify:

• Resources and relationship across them
• Image(s)
• Environment
• Infrastructure
• Capabilities
• Account config information
• Enable/Disable Integrations
• SaaS experience (input/output params with constraints)

For detailed setup instructions, please visit this

Here is the generated Postgres SaaS from the above spec looks like:

In addition, Omnistrate fully automates scaling, monitoring, billing, observability, patching and much more.

As next steps:

• To learn more on what we do, visit this
• To learn more about how to build your SaaS using Omnistrate, visit this.