Skip to content

Getting Started with Omnistrate

This guide provides step-by-step instructions to onboard your SaaS Product onto the Omnistrate platform. Follow these steps to transform your application into a fully managed, multi-tenant SaaS Product.

What makes up your SaaS Product?

Each SaaS Product built with Omnistrate platform is a collection of software, resources, parameters, features, and infrastructure configurations. Building a SaaS Product with Omnistrate is as simple as providing a proper specification to define it.

Omnistrate provides different options on how to specify your SaaS Product, the following steps will guide you on the different options.

Step 1: Sign up to Omnistrate

Before building your SaaS Product, you need to set up your Omnistrate account:

  1. Sign up for Omnistrate at omnistrate.cloud using your email, Google account, or GitHub account.

  2. When signing up with email Complete account verification through the email confirmation process

    Note

    You will receive a confirmation email. Please check your spam folder if you do not see the email in your inbox.

Once your account is set up, you'll have access to the Omnistrate dashboard where you can manage your SaaS Products, environments, and deployments.

Step 2: Onboard Your Account

After signing up, you need to onboard your cloud account. Omnistrate uses your cloud account (such as AWS, GCP, or Azure) to provision and manage the infrastructure required for your SaaS Product. This model ensures that your application and customer data remain within your own secure cloud environment. Onboarding involves granting Omnistrate the necessary permissions to automate deployments and manage resources on your behalf.

For detailed instructions, follow the Account Onboarding Guide.

Step 3: Choose Your Service Specification Model

Omnistrate provides flexible options to define your SaaS Product based on your existing infrastructure setup and development approach. Choose the model that best fits your current situation:

Starting From Scratch

If you're building a new service or want to containerize your existing application, these options are ideal:

a) Build from Source Repository

Build directly from your source code repository. Omnistrate will handle the containerization and deployment process.

  • Best for: Applications with source code in Git repositories
  • Benefits: Automated builds from code changes, simplified CI/CD integration
  • Guide: Build from Repository Examples

b) Build from Container Image

Use your existing Docker container images to define your service.

  • Best for: Applications already containerized or with existing Docker workflows
  • Benefits: Quick setup, leverages existing container investments
  • Guide: Getting Started with Compose

c) Build from Docker Compose

Transform your Docker Compose configuration into a multi-tenant SaaS Product.

  • Best for: Applications defined with Docker Compose files
  • Benefits: Familiar format, quick migration from development to production
  • Guide: Getting Started with Compose

Using Existing Infrastructure Packages

If you already have infrastructure automation in place, these options preserve your existing investments:

d) Build from Helm Charts

Integrate your existing Helm charts with Omnistrate's multi-tenancy and automation capabilities.

  • Best for: Kubernetes-native applications with existing Helm charts
  • Benefits: Preserves existing Kubernetes configurations and deployment patterns
  • Guide: Helm Charts Integration

e) Build from Terraform

Leverage your existing Terraform modules to define infrastructure and application components.

  • Best for: Infrastructure-heavy applications or multi-cloud deployments
  • Benefits: Reuses existing infrastructure code, supports complex architectures
  • Guide: Terraform Integration

f) Build from Kubernetes Operators

Use your custom Kubernetes operators to manage application lifecycle on Omnistrate.

  • Best for: Applications with complex operational requirements or custom controllers
  • Benefits: Preserves operational logic, enables advanced automation
  • Guide: Kubernetes Operators

g) Build from Kustomize

Transform your Kustomize configurations into managed SaaS Products.

  • Best for: Teams using Kustomize for Kubernetes configuration management
  • Benefits: Maintains configuration layering and customization patterns
  • Guide: Kustomize Integration

Step 3: Install Omnistrate CLI (CTL)

The Omnistrate Command Line Interface (CTL) is essential for building and managing your SaaS Products:

  1. Download and install the CTL from ctl.omnistrate.cloud/install
  2. Verify installation by running:
omnistrate-ctl --help
  1. Login to your account:
omnistrate-ctl login

The CTL provides commands for building services, managing deployments, and automating CI/CD workflows.

Step 4: Create Your Service

Based on your chosen model from Step 2, create the appropriate specification file and build your service:

For Container-based Approaches (a, b, c)

Create a Compose specification file and build your service:

omnistrate-ctl build --file compose-spec.yaml --name "Your SaaS Product Name" --description "Your service description"

Example guides and templates:

For Infrastructure Package Approaches (d, e, f, g)

Create a Plan specification file using the Plan spec format:

omnistrate-ctl build --file spec.yaml --name "Your SaaS Product Name" --description "Your service description"

Detailed guides for each approach:

Additional examples:

Next Steps

After completing these steps, you'll have:

  • ✅ An active Omnistrate account
  • ✅ A defined service specification matching your infrastructure approach
  • ✅ The CTL installed and configured
  • ✅ Your first SaaS Product built on Omnistrate

Continue Your Journey

  1. Configure Environments: Set up development, staging, and production environments
  2. Set Up Customer Portal: Enable customer self-service with the Customer Portal
  3. Implement CI/CD: Automate deployments with CI/CD workflows
  4. Add Advanced Features: Explore integrations, monitoring, and billing

For API-based automation and advanced control, see the API documentation.

For account management, including offboarding procedures, see Account Offboarding.

For any questions, please reach out to us at support@omnistrate.com. We would love to understand your use-case and assist you.