Skip to content

Commit

Permalink
docs(website): added more docs literature, removed references to glas…
Browse files Browse the repository at this point in the history
…skube cloud
  • Loading branch information
jakepage91 committed Jan 27, 2025
1 parent 41c0447 commit 0f9a4db
Show file tree
Hide file tree
Showing 17 changed files with 159 additions and 96 deletions.
24 changes: 24 additions & 0 deletions docs/cloud/02_getting-started/01_what-is-distr.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import Install from '@site/src/partials/_install.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# What is Distr?

Distr is an open-core commercial software distribution platform designed for Independent Software Vendors ISVs. It supports ISVs in delivering their software solutions to end customers operating in complex, customer-controlled environments. These environments feature diverse deployment configurations, including on-premises, self-hosted, Bring Your Own Cloud (BYOC), air-gapped systems, and private clouds.

The platform is also designed to support ISVs operating edge locations or devices where they control the infrastructure. Distr was developed in response to the increasing number of ISVs managing forward-deployed environments and devices, where traditional deployment and management tools fell short. The platform delivers the same robust features ISVs rely on for on-prem customers but tailored to meet the unique challenges of their complex edge locations.

Distr is built on a hub and spoke model where ISV can have a centralized view of all of their dispersed customer or internal deployments. The centralized control plane can be accessed via the GUI, API of SDK.

The platform aims to deliver features that aid in the delivery, management and licensing of [“on-premises“ ready](/white-paper/building-blocks/) applications.

### Here are some of the main value propositions Distr brings to ISVs:

- Increased customer onboarding velocity
- Frictionless application updates
- Centralized application uptime monitoring
- Software license management
- Support for Docker compose and Helm charts
- Control over internally deployed applications
- BYOC mode for deployments to ISV controlled environments
- Increased troubleshooting speed and effectiveness
24 changes: 0 additions & 24 deletions docs/cloud/02_getting-started/01_what-is-gc.mdx

This file was deleted.

24 changes: 12 additions & 12 deletions docs/cloud/02_getting-started/02_how-it-works.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,24 @@ import TabItem from '@theme/TabItem';

## Components

Glasskube Cloud is a comprehensive platform available both as a SaaS solution and as a fully self-hostable option. It allows ISVs to deliver their applications to on-premises customers through a centralized platform. This platform enables end customers to access available application versions and maintain control over when and where installations are deployed.
Distr is a comprehensive platform available both as a SaaS solution and as a fully self-hostable option. It allows ISVs to deliver their applications to on-premises customers through a centralized platform. This platform enables end customers to access available application versions and maintain control over when and where installations are deployed.

The platform consists of two key components:

1. **Glasskube Cloud Server**: A centralized platform accessible via a GUI, API, or SDK. This is where ISVs manage their application deployments and provide version updates to customers.
2. **Glasskube Cloud Agents**: Lightweight components, one for Docker Compose and another for Helm-packaged applications, deployed within the customer-controlled environment, alongside the ISV application. The agent handles maintenance and lifecycle tasks and communicates with the centralized platform. It reports critical information such as uptime status and the current application version while comparing it to the versions available from the ISV.
1. **Distr Server**: A centralized platform accessible via a GUI, API, or SDK. This is where ISVs manage their application deployments and provide version updates to customers.
2. **Distr Agents**: Lightweight components, one for Docker Compose and another for Helm-packaged applications, deployed within the customer-controlled environment, alongside the ISV application. The agent handles maintenance and lifecycle tasks and communicates with the centralized platform. It reports critical information such as uptime status and the current application version while comparing it to the versions available from the ISV.

This architecture ensures that communication and updates between the ISV and their end customers is as close to real time as possible, facilitating efficient application lifecycle management.

:::info
Ready to get started? Create your Glasskube Cloud account [here](https://glasskube.cloud/signup.html) and then following the onboarding steps here
Ready to get started? Create your Distr account [here](https://glasskube.cloud/signup.html) and then following the onboarding steps here
:::

## Two Portals, One Platform

The Glasskube Cloud platform was designed with ISVs in mind, prioritizing their success by ensuring end customers are satisfied. To achieve this, the platform includes two distinct control consoles.
The Distr platform was designed with ISVs in mind, prioritizing their success by ensuring end customers are satisfied. To achieve this, the platform includes two distinct control consoles.

Upon signing up, ISVs are greeted with the default view: the "Vendor Platform." This can be verified from the top-right corner of the interface, this console allows ISVs to onboard customer profiles and invite their customers to the Glasskube Cloud platform. When an ISV sends an invite link, customers are directed to the "Customer Portal." This portal provides customers with access to the ISV’s application, available versions, and tools to manage the deployment and lifecycle of the application.
Upon signing up, ISVs are greeted with the default view: the "Vendor Platform." This can be verified from the top-right corner of the interface, this console allows ISVs to onboard customer profiles and invite their customers to the Distr platform. When an ISV sends an invite link, customers are directed to the "Customer Portal." This portal provides customers with access to the ISV’s application, available versions, and tools to manage the deployment and lifecycle of the application.

![vendor-portal](https://github.com/user-attachments/assets/d470a418-cc90-41e2-bf28-00f0e0b7e9ed)

Expand All @@ -34,14 +34,14 @@ The Customer Portal takes a "less is more" approach, offering only the essential
ISVs also have the option to white-label the Customer Portal, aligning it with their corporate [branding](/products/cloud/docs/product/branding). This creates a impression of an extension of the ISV’s product suite, often leaving end customers unaware that a third-party platform powers the delivery of their on-premises offering.

## Programmatic access
In addition to the graphical user interfaces, Glasskube Cloud provides programmatic access for users and developers.
In addition to the graphical user interfaces, Distr provides programmatic access for users and developers.

### Glasskube Cloud API
The Glasskube Cloud API, available at [API endpoint], allows users to bypass the GUI for direct programmatic interaction. The API used in Glasskube Cloud is the same as the open-source version, ensuring feature parity between the SaaS platform and the API. This guarantees a consistent experience regardless of the access method chosen.
### Distr API
The Distr API, available at [API endpoint], allows users to bypass the GUI for direct programmatic interaction. The API used in Distr is the same as the open-source version, ensuring feature parity between the SaaS platform and the API. This guarantees a consistent experience regardless of the access method chosen.

### Glasskube Cloud SDK
The Glasskube Cloud SDK enables users and developers to embed Glasskube Cloud’s application management features directly into their own applications or to even write new applications that leverage the SDK. While SDK development runs in parallel with Glasskube Cloud development, there may be occasional gaps in feature parity due to development speed and the impracticality of implementing certain platform-specific features in the SDK. Nevertheless, the SDK provides a powerful way to integrate Glasskube Cloud functionality into your workflows, and we encourage you to explore its capabilities.
### Distr SDK
The Distr SDK enables users and developers to embed Distr’s application management features directly into their own applications or to even write new applications that leverage the SDK. While SDK development runs in parallel with Distr development, there may be occasional gaps in feature parity due to development speed and the impracticality of implementing certain platform-specific features in the SDK. Nevertheless, the SDK provides a powerful way to integrate Distr functionality into your workflows, and we encourage you to explore its capabilities.

:::info
For more in-depth information on both the Glasskube Cloud API and SDK, head over to the Developer Tools section of the docs.
For more in-depth information on both the Distr API and SDK, head over to the Developer Tools section of the docs.
:::
49 changes: 33 additions & 16 deletions docs/cloud/02_getting-started/03_quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,35 @@ import TabItem from '@theme/TabItem';
# Quickstart

## Prerequisites
Glasskube Cloud is designed to help distribute "on-prem" ready software to customer-controlled environments. The key phrase here is "on-prem ready."
Distr is designed to help distribute "on-prem" ready software to customer-controlled environments. The key phrase here is "on-prem ready."

## What does "on-prem ready" mean?
### What does "on-prem ready" mean?

### On-prem ready checklist:
#### On-prem ready checklist:

- Your application is fully containerized (Docker or Helm)
- You are using some sort of consistent versioning
- If your application has dependencies, these should also be standardized and declared
- Your application is **fully containerized** (Docker or Helm)
- You are using some sort of **consistent versioning**
- If your application has dependencies, these should also be **standardized and declared**

If you're an ISV who has developed a SaaS product and later been approached by a customer requesting to use your product "on-prem," you’ve likely experienced the challenges of lacking on-prem readiness. Deploying to on-premises, self-hosted, or complex customer-controlled environments requires deliberate decisions and architectural considerations made early in the development process to ensure such deployments are practical.

Software built with on-prem readiness in mind from the start often reflects thoughtful design, focusing on maintainability and configurations suitable for future on-prem use cases. However, many software solutions aren’t initially created with these scenarios in mind. As customer requirements evolve, SaaS products may need adjustments to support on-prem deployments. Ideally, your application should already be containerized, with a Docker Compose file or Helm chart prepared. If not, feel free to reach out for white-glove onboarding assistance.

### What changes are needed for on-prem readiness?
#### What changes are needed for on-prem readiness?

To bridge this gap, we've compiled a document outlining the foundational building blocks for achieving on-prem readiness. You can access this comprehensive [whitepaper here](/white-paper/building-blocks/).

## Quickstart

In this Quickstart guide, we’ll walk through the primary workflow designed to help Distr users get the most value from the platform. Here’s what we’ll cover:
- **Onboarding a sample application** to explore how Distr works.
- **Choosing a deployment target setup**:
- Onboard your first customer, or
- Assign yourself as the owner of the deployment target environment.
- **Creating a deployment** and verifying its installation using the Distr agent.

All of this can be easily accomplished by following the helpful Onboarding Wizard. Let’s get started!

## Follow the onboarding wizard to get started

:::warning
Expand Down Expand Up @@ -62,7 +73,7 @@ Once you click "Continue," Distr will create a deployment named "Test-Customer."
Deployment with status: *initial*
![deployment-check](https://github.com/user-attachments/assets/84437f8d-31e1-419c-899b-b714610e9a0c)

### Connect the Target Environment with the Dirstr Agent
### Connect the Target Environment with the Distr Agent

To complete the final step and connect the target environment to Distr, you'll need to access the target environment and run the curl command displayed in the Onboarding Wizard console. In this test case, the agent will be installed in a local Docker Desktop environment. So make sure to have access to a local Docker desktop instance.

Expand Down Expand Up @@ -100,21 +111,27 @@ You can also navigate to the main Dashboard page, where the widgets will update
## Onboard more applications, customers and deployments.

Distr users will only see the Onboarding Wizard once, and only if no applications have been onboarded. After completing the onboarding process by adding their first application, customer, and running the first deployment, all of these steps can be repeated individually as needed.
### Add another application

### Add More Applications

Head over to the `Applications` tab and on the top right corner click on the `+ Add Application` button. And simply follow the steps.

![add-application](https://github.com/user-attachments/assets/10b46258-6966-4178-909c-861ea83162fe)
![add-application](https://github.com/user-attachments/assets/8479305e-add9-4945-916c-fda88c04124b)

### Invite more customer
### Invite More Customers
Head over to the `Customers` tab and on the top right corner click on the `+ Invite customer` button. And simply follow the steps.

![invite-customer](https://github.com/user-attachments/assets/caa362f6-16bc-4e3b-9bed-cbcbe53add02)
### Add more deployments
![invite-customer](https://github.com/user-attachments/assets/83818aae-8201-42a1-a22b-49b0bb4a810f)

:::info
Once the customer's email address is submitted, the recipient will receive an email containing login credentials for the Distr Customer Portal. Through this portal, they can view and manage the deployments of the applications they have purchased from the ISV.
:::

### Add More Deployments

Head over to the `Deployments` tab and click on the `+ Add deployment` button and follow the steps.

![Add deployments](https://github.com/user-attachments/assets/4ec8fe54-7d24-46b9-88a0-6596f686d3ba)
![Add deployments](https://github.com/user-attachments/assets/5cfb11f6-a5c7-4a47-91e0-d029515c4386)

- For more information on how to deploy a Docker compose packaged application, check out this guide.
- For more information on how to deploy a Helm chart packaged application, check out this guide.
- For more information on how to deploy a Docker compose packaged application, check out this [guide](/products/cloud/docs/guides/onboarding-a-docker-app/).
- For more information on how to deploy a Helm chart packaged application, check out this [guide](/products/cloud/docs/guides/onboard-helm-app/).
12 changes: 6 additions & 6 deletions docs/cloud/02_getting-started/04_deployment-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ import TabItem from '@theme/TabItem';

# Deployment Methods

Glasskube Cloud is a versatile platform designed to adapt to user preferences, thanks to its open-core foundation. It offers two deployment methods: as a SaaS solution hosted, maintained by the Glasskube team or as a self-hosted option.
Distr is a versatile platform designed to adapt to user preferences, thanks to its open-core foundation. It offers two deployment methods: as a SaaS solution hosted, maintained by the Glasskube team or as a self-hosted option.

Let’s explore the features of each deployment method:

## Glasskube Cloud as a SaaS
## Distr as a SaaS

Features:
- Maximum flexibility with access to the latest updates and features.
Expand All @@ -19,16 +19,16 @@ Features:
- No platform management responsibilities.

:::info
Get started by creating your Glasskube cloud account [here](https://glasskube.cloud/signup.html) and then following the onboarding steps here
Get started by creating your Distr account [here](https://glasskube.cloud/signup.html) and then following the onboarding steps here
:::

## Self-Hosted Glasskube Cloud
## Self-Hosted Distr

Features:
- Complete control over the deployed version of Glasskube Cloud.
- Complete control over the deployed version of Distr.
- Full responsibility for platform availability and maintenance.
- Ideal for users who prefer to manage their environment independently.

:::info
To get started with the self-hosted option, create your [account](https://glasskube.cloud/signup.html) on Glasskube cloud first and then follow our [guide](/products/cloud/docs/guides/how-to-self-host-gc/) to deploy Glasskube Cloud in your environment.
To get started with the self-hosted option, create your [account](https://glasskube.cloud/signup.html) on Distr first and then follow our [guide](/products/cloud/docs/guides/how-to-self-host-distr/) to deploy Distr in your environment.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ import Install from '@site/src/partials/_install.mdx';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Glasskube Cloud API
# How To Self-Host Distr
5 changes: 0 additions & 5 deletions docs/cloud/03_guides/04_how-to-self-host-gc.mdx

This file was deleted.

Loading

0 comments on commit 0f9a4db

Please sign in to comment.