Glossary¶
Service¶
A Service represents a SaaS Product that you are trying to build. You can create an empty new service or bring your compose specification or choose from one of the existing compose templates to get started. A service object by itself is a container object to store the service metadata.
Plan¶
A service consists of several Plans that allows you to offer your service in different Deployment Models and Tenancy Types. For more information on Deployment Models and Tenancy Types, please see here and here
Resource¶
Resource (also referred to as resource) is a unit of functionality that can be run independently like a microservice. Your SaaS may have 1 or more Resources. For more information, please see here. It is a representation of your SaaS, reflecting its health status, compute/node configuration and other metadata.
Resource Instance¶
A resource instance is a running instance of a Resource. Users can create and run multiple instances running in different environments (like dev, stage, prod) - regions (like us-east-1, us-west-1) and cloud providers. A resource instance is not to be confused with a container or a Kubernetes pod.
API Parameters¶
API parameters is a way for you to define the external parameters for your customers to configure a Resource. For more information, please see here
Images¶
Images are primarily Container Images that can be configured and attached to the service components
Infrastructure¶
Infrastructure is your compute/network/storage configuration for different Resources.
Action Hooks¶
Action hooks allows you to customize your control plane by injecting custom code at different phase of the lifecycle of your SaaS operations. For more information, please see here
Dependencies¶
Dependencies allows you to specify DAG and how different Resources are dependent on each other. For more information, please see here
Integrations¶
Integrations are 1st/3rd party SaaS applications that you want to integrate with for your SaaS. For more information, please see here
Environment¶
Environment allows you setup continuous delivery right in the omnistrate platform to test things in a sandbox environment, or promote changes from developer to stage to production environment.
Patching¶
Patching refers to the process of applying updates, fixes, or patches to the software and configurations including infrastructure upgrades. For more information, please see here
Deployments¶
Deployments refer to the process of deploying your resource instances to a specific version of your Plan. It can be triggered by either creating a new resource instance or patching an existing resource instance.
Live Deployments¶
Live Deployments are the currently running resource instances of your Resources that have been successfully deployed and are operational in a specific environment. These are active deployments that are serving users or are actively maintained. Monitoring live deployments is crucial to ensure uptime, performance, and the correct functioning of your services.
Releases¶
Releases refer to the process of releasing a new version of your Plan. Releases are tagged with a version number and can include updates, bug fixes, new features, or other changes. You can mark a release as active, preferred, or deprecated to indicate its status and availability for deployment.
Alerts¶
Alerts are notifications generated by the system to inform you of important events or issues that require your attention. These could be related to deployment issues, security, or other operational concerns. Alerts are often categorized by priority and will expire in a specific time frame given the severity of the issue.
Open Alerts¶
Open Alerts are the currently active alerts that have not been resolved. These alerts require immediate attention to prevent service disruptions or other issues. Monitoring open alerts is crucial to ensure the health and stability of your services.
Notifications¶
Notifications are system-generated messages that inform you about the status and events related to your SaaS Product operations. Unlike Alerts, which are triggered by issues or problems that require immediate attention, Notifications provide general information about routine activities such as successful deployments, plan updates, user signups, or scheduled maintenance. Notifications are informational in nature and typically do not indicate problems that need urgent resolution.
Signups¶
Signups refer to the number of new users that have registered for your service. Tracking signups is important to measure the growth of your user base and the effectiveness of your marketing and sales efforts.
Workflows¶
Workflows encompass all user actions to interact with the resource instances. This includes creating, updating, deleting, stopping, starting, patching, and other operations performed on the resource instances.