Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Embedded Cluster to Replicated intro content #2562

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Conversation

paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented Aug 12, 2024

Intro to Replicated:

Intro to KOTS:

@paigecalvert paigecalvert requested a review from a team as a code owner August 12, 2024 18:05
Copy link

netlify bot commented Aug 12, 2024

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit 5f86418
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/67366e16eca53700073a1411
😎 Deploy Preview https://deploy-preview-2562--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Aug 12, 2024
Copy link

netlify bot commented Aug 12, 2024

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit 5f86418
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/67366e1609a4db000807fb8c
😎 Deploy Preview https://deploy-preview-2562--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


![Admin console dashboard with Cluster Management tab](/images/gitea-ec-ready.png)

[View a larger version of this image](/images/gitea-ec-ready.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

^ Added an example of the dashboard with a Cluster Management tab

import CSDL from "/docs/partials/getting-started/_csdl-overview.mdx"
import PreflightSbAbout from "/docs/partials/preflights/_preflights-sb-about.mdx"

# Introduction to Replicated
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Intro to Replicated updated to include both the Platform Overview and the description of the Commercial Software Distribution Platform. (Previously, these were two different topics)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted in favor of moving the platform overview to the existing Intro to Replicated topic. Added redirect

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the customer environment portion of this diagram so that it reflects an EC install


![replicated platform features workflow](/images/replicated-platform.png)

[View a larger version of this image](/images/replicated-platform.png)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated this diagram to reflect an EC install in a VM, and updated the description of the diagram below accordingly. Tried to keep the description fairly high level and also make key features bold/xrefs so this is easier to skim


Finally, the diagram shows how [**instance data**](instance-insights-event-data) is automatically sent from the customer environment to the Vendor Portal by the Replicated SDK API and the KOTS Admin Console. Additionally, tooling from the open source [**Troubleshoot**](https://troubleshoot.sh/docs/collect/) project is used to generate and send [**support bundles**](preflight-support-bundle-about), which include logs and other important diagnostic data.

## Replicated Platform Features
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

List of key features (mirroring what's in the Product Docs drop down at the top of the docs site)


* **Vendor API v3**: The Vendor API can be used to complete tasks programmatically, including all tasks for packaging and managing applications, and managing artifacts such as teams and license files. For more information, see [Using the Vendor API v3](/reference/vendor-api-using).

## Commercial Software Distribution Lifecycle {#csdl}
Copy link
Contributor Author

@paigecalvert paigecalvert Nov 14, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview of the Distro Lifecycle. This was copied over from the existing content, apart from the Install section which I did rewrite to better highlight EC

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants