Skip to content

Commit

Permalink
edits
Browse files Browse the repository at this point in the history
  • Loading branch information
paigecalvert committed Nov 13, 2024
1 parent 9b9feef commit 7e58a37
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
11 changes: 10 additions & 1 deletion docs/intro-replicated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import Kots from "/docs/partials/kots/_kots-definition.mdx"
import KotsEntitlement from "/docs/partials/kots/_kots-entitlement-note.mdx"
import SDKOverview from "/docs/partials/replicated-sdk/_overview.mdx"
import CSDL from "/docs/partials/getting-started/_csdl-overview.mdx"
import PreflightSbAbout from "/docs/partials/preflights/_preflights-sb-about.mdx"

# Introduction to Replicated

Expand Down Expand Up @@ -46,7 +47,7 @@ For more information, see [About Compatibility Matrix](/vendor/testing-about).

### Embedded Cluster

Replicated Embedded Cluster is a Kubernetes installer based on the open source Kubernetes distribution k0s. With Embedded Cluster, users install and manage both the cluster and the application together as a single appliance on a VM or bare metal server. In this way, Kubernetes is _embedded_ alongside the application.
Replicated Embedded Cluster is a Kubernetes installer based on the open source Kubernetes distribution k0s. With Embedded Cluster, users install and manage both the cluster and the application together as a single appliance on a VM or bare metal server. In this way, Kubernetes is _embedded_ with the application.

Additionally, each version of Embedded Cluster includes a specific version of the Replicated KOTS installer. KOTS is used to install the application and also provides the Admin Console.

Expand All @@ -60,6 +61,12 @@ The Admin Console is the user interface for installing and managing applications

For more information, see [Introduction to KOTS](intro-kots).

### Preflight Checks and Support Bundles

<PreflightSbAbout/>

For more information, see [About Preflight Checks and Support Bundles](/vendor/preflight-support-bundle-about).

### Proxy Registry

The Replicated proxy registry grants proxy access to an application's images using the customer's unique license. This means that customers can get access application images during installation without the vendor needing to provide registry credentials.
Expand Down Expand Up @@ -92,6 +99,8 @@ Replicated Platform features are designed to support ISVs in each phase of the C

<CSDL/>

For more information about to download a copy of The Commercial Software Distribution Handbook, see [The Commercial Software Distribution Handbook](https://www.replicated.com/the-commercial-software-distribution-handbook).

The following describes the phases of the software distribution lifecycle:

* **[Develop](#develop)**: Application design and architecture decisions align with customer needs, and development teams can quickly iterate on new features.
Expand Down
5 changes: 5 additions & 0 deletions docs/partials/preflights/_preflights-sb-about.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Preflight checks and support bundles are provided by the Troubleshoot open source project, which is maintained by Replicated. Troubleshoot is a kubectl plugin that provides diagnostic tools for Kubernetes applications. For more information, see the open source [Troubleshoot](https://troubleshoot.sh/docs/collect/) documentation.

Preflight checks and support bundles analyze data from customer environments to provide insights that help users to avoid or troubleshoot common issues with an application:
* **Preflight checks** run before an application is installed to check that the customer environment meets the application requirements.
* **Support bundles** collect troubleshooting data from customer environments to help users diagnose problems with application deployments.
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
import Overview from "../partials/preflights/_preflights-sb-about.mdx"

# About Preflight Checks and Support Bundles

This topic provides an introduction to preflight checks and support bundles, which are provided by the [Troubleshoot](https://troubleshoot.sh/) open source project.

## Overview

Preflight checks and support bundles are provided by the Troubleshoot open source project, which is maintained by Replicated. Troubleshoot is a kubectl plugin that provides diagnostic tools for Kubernetes applications. For more information, see the open source [Troubleshoot](https://troubleshoot.sh/docs/collect/) documentation.

Preflight checks and support bundles analyze data from customer environments to provide insights that help users to avoid or troubleshoot common issues with an application:
* **Preflight checks** run before an application is installed to check that the customer environment meets the application requirements.
* **Support bundles** collect troubleshooting data from customer environments to help users diagnose problems with application deployments.
<Overview/>

Preflight checks and support bundles consist of _collectors_, _redactors_, and _analyzers_ that are defined in a YAML specification. When preflight checks or support bundles are executed, data is collected, redacted, then analyzed to provide insights to users, as illustrated in the following diagram:

Expand Down

0 comments on commit 7e58a37

Please sign in to comment.