Skip to content

Commit

Permalink
Merge pull request #2600 from replicatedhq/102026
Browse files Browse the repository at this point in the history
Add Embedded Cluster diagram
  • Loading branch information
paigecalvert authored Aug 30, 2024
2 parents f1abbd3 + 920f64a commit 5018aec
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 1 deletion.
8 changes: 8 additions & 0 deletions docs/enterprise/updating-embedded.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ Embedded cluster is in beta. If you are instead looking for information about Re

<Overview/>

The following diagram demonstrates how updates are performed with Embedded Cluster in online (internet-connected) environments:

![Embedded Cluster updates Kubernetes and an app in a customer environment](/images/embedded-cluster-update.png)

[View a larger version of this image](/images/embedded-cluster-update.png)

As shown in the diagram above, users check for available updates from the KOTS Admin Console. When deploying the new version, both the application and the cluster infrastructure are updated as needed.

## Update in Online Clusters

<DoNotDowngrade/>
Expand Down
2 changes: 1 addition & 1 deletion docs/partials/embedded-cluster/_definition.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Replicated Embedded Cluster allows you to distribute a Kubernetes cluster and your application together as a single appliance, making it easy for enterprise users to install, update, and manage the application and the cluster in tandem. Embedded Cluster is based on the open source Kubernetes distribution k0s. For more information, see the [k0s documentation](https://docs.k0sproject.io/stable/).

For software vendors, Embedded Cluster provides a simplified config for defining characteristics of the cluster that will be created in the customer environment. Additionally, each version of Embedded Cluster includes a specific version of Replicated KOTS, ensuring compatibility between KOTS and the cluster. For enterprise users, cluster updates are done automatically at the same time as application updates, allowing users to more easily keep the cluster up-to-date without needing to use kubectl.
For software vendors, Embedded Cluster provides a Config for defining characteristics of the cluster that will be created in the customer environment. Additionally, each version of Embedded Cluster includes a specific version of Replicated KOTS, ensuring compatibility between KOTS and the cluster. For enterprise users, cluster updates are done automatically at the same time as application updates, allowing users to more easily keep the cluster up-to-date without needing to use kubectl.
10 changes: 10 additions & 0 deletions docs/vendor/embedded-overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,16 @@ Embedded cluster is in beta. If you are instead looking for information about cr

<EmbeddedCluster/>

The following diagram demonstrates how Kubernetes and an application are installed into a customer environment using Embedded Cluster:

![Embedded Cluster installs an app in a customer environment](/images/embedded-cluster-install.png)

[View a larger version of this image](/images/embedded-cluster-install.png)

As shown in the diagram above, the Embedded Cluster Config is included in the application release in the Replicated Vendor Portal and is used to generate the Embedded Cluster installation assets. Users can download these installation assets from the Replicated app service (`replicated.app`) on the command line, then run the Embedded Cluster installation command to install Kubernetes and the KOTS Admin Console. Finally, users access the Admin Console to optionally add nodes to the cluster and to configure and install the application.

### Comparison to kURL

<KurlComparison/>

### Requirements
Expand Down
Binary file added static/images/embedded-cluster-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/embedded-cluster-update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5018aec

Please sign in to comment.