Skip to content
Closed
Show file tree
Hide file tree
Changes from 35 commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
7b7946c
Sidebar and onboarding updates for EC GA
paigecalvert Jul 29, 2024
631f37b
edits to onboarding flow
paigecalvert Jul 30, 2024
9a64a24
edits
paigecalvert Jul 31, 2024
c132ef6
adding partials
paigecalvert Aug 1, 2024
5f274ca
edits
paigecalvert Aug 5, 2024
66dce75
edits
paigecalvert Aug 5, 2024
be92182
updating quick start steps
paigecalvert Aug 5, 2024
d32018c
ec quick start update steps
paigecalvert Aug 5, 2024
86ffc0f
helm quick start edits
paigecalvert Aug 5, 2024
843cba0
adding partials for the quick starts
paigecalvert Aug 6, 2024
1774f6d
edit onboarding flow
paigecalvert Aug 6, 2024
c2b0293
add to kots onboarding tasks
paigecalvert Aug 6, 2024
0e444b1
add to kots onboarding tasks
paigecalvert Aug 6, 2024
b0a4df8
add to kots onboarding tasks
paigecalvert Aug 6, 2024
a30aa7a
add to kots onboarding tasks
paigecalvert Aug 6, 2024
1317eee
more edits and move partials
paigecalvert Aug 6, 2024
89acc95
edits
paigecalvert Aug 6, 2024
99c79c8
add related topics
paigecalvert Aug 7, 2024
14ddd03
onboarding task edits
paigecalvert Aug 7, 2024
606ae23
edits
paigecalvert Aug 7, 2024
b1c66c3
undo changes to unrelated topic
paigecalvert Aug 7, 2024
0c6b270
replace cluster setup with partial
paigecalvert Aug 7, 2024
37fa0f3
edits from convo with chuck
paigecalvert Aug 8, 2024
9e236ef
edits
paigecalvert Aug 8, 2024
2d3a4de
edits
paigecalvert Aug 8, 2024
d1c91be
edits to ec quick start
paigecalvert Aug 14, 2024
9167d15
edits
paigecalvert Aug 15, 2024
969a117
edits
paigecalvert Aug 20, 2024
46ae9be
edits to helm onboarding
paigecalvert Aug 20, 2024
2b52245
edits to quick start flows
paigecalvert Aug 20, 2024
6e4ea87
helm quick start edits
paigecalvert Aug 20, 2024
8030046
edits
paigecalvert Aug 20, 2024
706357d
edits
paigecalvert Aug 20, 2024
04c6f00
edits
paigecalvert Aug 20, 2024
78f2840
edits
paigecalvert Aug 20, 2024
7c9e2a5
undo changes to intro content
paigecalvert Aug 22, 2024
d81fc37
udpate landing page
paigecalvert Aug 22, 2024
3e45efc
edits
paigecalvert Aug 22, 2024
6602e9d
edits based on chuck's feedback
paigecalvert Sep 6, 2024
b0c66f3
Merge branch 'main' into sidebar-kots-reorg
paigecalvert Sep 6, 2024
8dd39ee
Merge branch 'main' into sidebar-kots-reorg
paigecalvert Sep 23, 2024
09378a9
removing the helm-only content
paigecalvert Sep 23, 2024
367dad9
remove more helm-only stuff
paigecalvert Sep 23, 2024
9ba18ba
remove helm only topics
paigecalvert Sep 23, 2024
07b394c
undo some sidebar changes
paigecalvert Sep 23, 2024
0379db2
chagne EC to Replicated
paigecalvert Sep 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 20 additions & 14 deletions docs/intro-replicated.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,30 +83,36 @@ Support teams can use Replicated features to more quickly diagnose and resolve a
- Provision customer-representative environments with Compatibility Matrix to recreate and diagnose issues. See [About Compatibility Matrix](/vendor/testing-about).
- Get insights into an instance's status by accessing telemetry data, which covers the health of the application, the current application version, and details about the infrastructure and cluster where the application is running. For more information, see [Customer Reporting](/vendor/customer-reporting). For more information, see [Customer Reporting](/vendor/customer-reporting).

## Vendor Platform Interfaces
## Replicated Terminology

This section describes the GUI, CLI, and API that software vendors use to interact with the vendor platform.
The following are some key Replicated Platform terms that are helpful to know before getting started:

### Vendor Portal
* **Replicated KOTS**: Replicated KOTS is a kubectl plugin and in-cluster Admin Console that installs Kubernetes applications in customer-controlled environments. See [Introduction to KOTS](intro-kots).

The Replicated Vendor Portal is the web-based user interface that you can use to configure and manage all of the Replicated features for distributing and managing application releases, supporting your release, viewing customer insights and reporting, and managing teams.
* **Admin Console**: The Admin Console is the user interface for installing and managing applications with KOTS.

The following shows an example of the **Reporting** page for a customer:
* **Replicated 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 a single appliance on a VM or bare metal server. In this way, Kubernetes is _embedded_ alongside the application. Each version of Embedded Cluster includes a specific version of Replicated KOTS, which provides the Admin Console. See [Using Embedded Cluster](/vendor/embedded-overview).

![Customer reporting page showing two active instances](/images/customer-reporting-page.png)
* **Air gap**: _Air gap_ refers to customer environments that do not have outbound internet access. Air gap environments are common for enterprise users that require high security.

[View a larger version of this image](/images/customer-reporting-page.png)
* **Preflight Checks**:

### Replicated CLI
* **Support Bundles**:

The Replicated command-line interface (CLI) is the CLI for the Vendor Portal. The Replicated CLI can be used to complete tasks programmatically, including all tasks for packaging and managing applications, and managing artifacts such as teams, license files, and so on. For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing).
* **Vendor Portal**: The Replicated Vendor Portal is the web-based user interface that you can use to configure and manage all of the Replicated features for distributing and managing application releases, supporting your release, viewing customer insights and reporting, and managing teams.

![terminal with Replicated CLI commands](/images/replicated-cli.gif)
* **Replicated CLI**: The Replicated command-line interface (CLI) is the CLI for the Vendor Portal. The Replicated CLI can be used to complete tasks programmatically, including all tasks for packaging and managing applications, and managing artifacts such as teams, license files, and so on. For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing).

### Vendor API v3
* **Vendor API v3**: The Vendor API is the API for the Vendor Portal. This 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.

<ApiAbout/>
* **Customer**: In the Vendor Portal, a customer represents a single licensed user of your software.

For more information, see [Using the Vendor API V3](/reference/vendor-api-using).
* **Release**: A release represents a single version of your application. Releases contain the files (Helm charts and YAML manifests) that will be distributed to your customers. For example, an Embedded Cluster release includes the application Helm chart, the Embedded Cluster Config, and a KOTS manifest that describes the Helm chart.

![landing page of the vendor api documentation site](/images/vendor-api-docs.png)
* **Channel**: Each release is promoted to one or more channels, which are used to control which customers can access the release. For example, vendors might keep separate channels for internal-only, experimental, beta, and generally available (GA) releases. Customers and internal users can access the releases promoted to the channel where they are assigned.

* **Application**: Within a Vendor Portal team, an application is the top-level container that groups a set of customers, releases, and channels. It is common for teams to create multiple different applications for testing purposes.

* **Replicated SDK**: The Replicated SDK is a Helm chart that can be installed as a small service alongside your application. It provides access to telemetry and custom metrics on instances of your application running in customer environments as well as an in-cluster API. See [About the Replicated SDK](/vendor/replicated-sdk-overview).

* **Replicated Compatibility Matrix**: Replicated Compatibility Matrix quickly provisions clusters with support for various Kubernetes distributions and versions. You can use Compatibility Matrix to get kubectl access to running clusters within minutes or less. See [About Compatibility Matrix](/vendor/testing-about).
83 changes: 40 additions & 43 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,66 +43,60 @@ pagination_next: null
<p>Onboarding workflows, tutorials, and labs to help you get started with Replicated quickly.</p>
</li>
<li>
<a href="intro-replicated">Introduction to Replicated</a>
<a href="intro-replicated">Introduction to the Commercial Software Distribution Life Cycle</a>
</li>
<li>
<a href="/vendor/distributing-overview">About Distributing Applications with Replicated</a>
<a href="/vendor/quick-start-embedded">Embedded Cluster Quick Start</a>
</li>
<li>
<a href="/vendor/replicated-onboarding">Replicated Quick Start</a>
<a href="/vendor/quick-start-helm">Helm CLI-Only Quick Start</a>
</li>
<li>
<a href="/vendor/tutorial-kots-helm-setup">Tutorials</a>
<a href="/vendor/tutorial-kots-helm-setup">Getting Started Tutorials</a>
</li>
<li>
<a href="https://play.instruqt.com/embed/replicated/tracks/distributing-with-replicated?token=em_VHOEfNnBgU3auAnN">Getting Started Lab in Instruqt</a>
</li>
</ul>
</section>
<section class="tile__container">
<ul>
<ul>
<li class="tile__header">
<img src="images/icons/vendor_portal_1.png" alt="vendor portal icon" width="55px" height="55px"></img>
<p>Vendor Platform</p>
<img src="images/icons/admin.png" alt="kots icon"></img>
<p>Replicated KOTS</p>
</li>
<li>
<p>Create and manage your account and team.</p>
<p>A kubectl plugin and in-cluster Admin Console that installs applications in customer-controlled environments.</p>
</li>
<li>
<a href="/vendor/vendor-portal-creating-account">Creating a Vendor Account</a>
<a href="intro-kots">Introduction to KOTS</a>
</li>
<li>
<a href="/vendor/team-management#invite-members">Managing Team Members</a>
<a href="/vendor/kots-faq">KOTS Terminology and FAQs</a>
</li>
<li>
<a href="/vendor/team-management-rbac-configuring">Configuring RBAC Policies</a>
<a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
</li>
<li>
<a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
</li>
</ul>
<ul>
<li class="tile__header">
<img src="images/icons/release.png" alt="rocket ship icon" width="55px" height="55px"></img>
<p>Compatibility Matrix</p>
</li>
<li>
<p>Rapidly create Kubernetes clusters, including OpenShift.</p>
</li>
<li>
<a href="/vendor/testing-about">About Compatibility Matrix</a>
</li>
<li>
<a href="/vendor/testing-how-to">Using Compatibility Matrix</a>
<img src="images/icons/k8s_installer.png" alt="installer icon"></img>
<p>Embedded Cluster</p>
</li>
<li>
<a href="/vendor/testing-supported-clusters">Supported Cluster Types</a>
<p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
</li>
<li>
<a href="/vendor/testing-cluster-addons">Cluster Add-ons</a>
<a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
</li>
<li>
<a href="/vendor/ci-workflows">Recommended CI/CD Workflows</a>
<a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
</li>
</ul>
</section>
</section>
<section class="tile__container">
<ul>
<li class="tile__header">
Expand All @@ -128,45 +122,48 @@ pagination_next: null
<a href="/vendor/replicated-sdk-overview">About the Replicated SDK</a>
</li>
</ul>
</section>
</section>
<section class="tile__container">
<ul>
<ul>
<li class="tile__header">
<img src="images/icons/admin.png" alt="kots icon"></img>
<p>Replicated KOTS</p>
</li>
<li>
<p>A kubectl plugin and in-cluster Admin Console that installs applications in customer-controlled environments.</p>
<img src="images/icons/vendor_portal_1.png" alt="vendor portal icon" width="55px" height="55px"></img>
<p>Vendor Platform</p>
</li>
<li>
<a href="intro-kots">Introduction to KOTS</a>
<p>Create and manage your account and team.</p>
</li>
<li>
<a href="/vendor/kots-faq">KOTS Terminology and FAQs</a>
<a href="/vendor/vendor-portal-creating-account">Creating a Vendor Account</a>
</li>
<li>
<a href="/vendor/distributing-workflow">Onboarding with KOTS</a>
<a href="/vendor/team-management#invite-members">Managing Team Members</a>
</li>
<li>
<a href="/vendor/helm-native-about">About Distributing Helm Charts with KOTS</a>
<a href="/vendor/team-management-rbac-configuring">Configuring RBAC Policies</a>
</li>
</ul>
<ul>
<li class="tile__header">
<img src="images/icons/k8s_installer.png" alt="installer icon"></img>
<p>Embedded Kubernetes</p>
<img src="images/icons/release.png" alt="rocket ship icon" width="55px" height="55px"></img>
<p>Compatibility Matrix</p>
</li>
<li>
<p>Embed Kubernetes with your application to support installations on VMs or bare metal servers.</p>
<p>Rapidly create Kubernetes clusters.</p>
</li>
<li>
<a href="/vendor/embedded-kubernetes-overview">About Embedded Kubernetes</a>
<a href="/vendor/testing-about">About Compatibility Matrix</a>
</li>
<li>
<a href="/vendor/kurl-about">Introduction to kURL</a>
<a href="/vendor/testing-how-to">Using Compatibility Matrix</a>
</li>
<li>
<a href="/vendor/embedded-overview">Using Embedded Cluster (Beta)</a>
<a href="/vendor/testing-supported-clusters">Supported Cluster Types</a>
</li>
<li>
<a href="/vendor/testing-cluster-addons">Cluster Add-ons</a>
</li>
<li>
<a href="/vendor/ci-workflows">Recommended CI/CD Workflows</a>
</li>
</ul>
</section>
Expand Down
7 changes: 7 additions & 0 deletions docs/partials/embedded-cluster/_default-config.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```yaml
apiVersion: embeddedcluster.replicated.com/v1beta1
kind: Config
spec:
version: 1.8.0+k8s-1.29
```
See the Embedded Cluster [GitHub repo](https://github.com/replicatedhq/embedded-cluster/releases) to find the latest version.
3 changes: 3 additions & 0 deletions docs/partials/getting-started/_add-license-entitlements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
You can add custom license entitlements for your application in the Vendor Portal. Custom license fields are useful when there is entitlement information that applies to a subset of customers. For example, you can create a custom license field to limit the number of active users permitted. Or, you can create a field that limits the number of nodes a customer is permitted on their cluster.

After you add custom entitlements, you can also add logic to your application to query license entitlements both before deployment and at runtime.
7 changes: 7 additions & 0 deletions docs/partials/getting-started/_best-practices.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
The following are some best practices and recommendations for successfully onboarding with Replicated:

* When integrating new Replicated features with an application, make changes in small iterations and test frequently by installing or upgrading the application in a development environment. This will help you to more easily identify issues and troubleshoot.

* Try creating and managing releases with both the Vendor Portal and the Replicated CLI. For more information, see [Installing the Replicated CLI](/reference/replicated-cli-installing).

* Ask for help from the Replicated community. For more information, see [Get Help from the Community](#get-help-from-the-community).
6 changes: 6 additions & 0 deletions docs/partials/getting-started/_ci-cd.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Replicated recommends that teams integrate the Replicated Platform into their existing develeopment and production CI/CD workflows. This can be useful for automating the processes of creating new releases, promoting releases, and testing releases with the Replicated Compatibility Matrix.

For more information, see:
* [About Integrating with CI/CD](/vendor/ci-overview)
* [About Compatibility Matrix](/vendor/testing-about)
* [Recommended CI/CD Workflows](/vendor/ci-workflows)
5 changes: 5 additions & 0 deletions docs/partials/getting-started/_community.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The [Replicated community site](https://community.replicated.com/) is a forum where Replicated team members and users can post questions and answers related to working with the Replicated Platform. It is designed to help Replicated users troubleshoot and learn more about common tasks involved with distributing, installing, observing, and supporting their application.

Before posting in the community site, use the search to find existing knowledge base articles related to your question. If you are not able to find an existing article that addresses your question, create a new topic or add a reply to an existing topic so that a member of the Replicated community or team can respond.

To search and participate in the Replicated community, see https://community.replicated.com/.
3 changes: 3 additions & 0 deletions docs/partials/getting-started/_connect-image-registry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Add credentials for your image registry to the Vendor Portal. This will allow you to enable the Replicated proxy service in a later step so that you can grant proxy access to application images without exposing registry credentials to your customers.

For more information, see [Connecting to an External Registry](/vendor/packaging-private-images).
9 changes: 9 additions & 0 deletions docs/partials/getting-started/_create-app.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
To create an application:

1. Create a new application using the Replicated CLI or the Vendor Portal. For the application name, use an official name for your application. You will not be able to modify the name. See [Create an Application](/vendor/vendor-portal-manage-app#create-an-application).

1. Set the `REPLICATED_APP` environment variable to the unique slug of the application that you created. See [Set Environment Variables](/reference/replicated-cli-installing#replicated_app) in _Installing the Replicated CLI_. For example:

```bash
export REPLICATED_APP=my-app
```
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Create a new release and promote it to the Unstable channel. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).
11 changes: 11 additions & 0 deletions docs/partials/getting-started/_custom-channels.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
By default, the Vendor Portal includes Unstable, Beta, and Stable channels. You can customize the channels in the Vendor Portal based on your application needs.

Consider the following recommendations:
* Use the Stable channel for your primary release cadence. Releases should be promoted to the Stable channel only as frequently as your average customer can consume new releases. Typically, this is no more than monthly. However, this cadence varies depending on the customer base.
* If you have a SaaS product, you might want to create an "Edge" channel where you promote the latest SaaS releases.
* You can consider a “Long Term Support” channel where you promote new releases less frequently and support those releases for longer.
* It can be useful to create channels for each feature branch so that internal teams reviewing a PR can easily get the installation artifacts as well as review the code. You can automate channel creation as part of a pipeline or Makefile.

For more information, see:
* [About Channels and Releases](releases-about-releases)
* [Creating and Editing Channels](/vendor/releases-creating-channels)
3 changes: 3 additions & 0 deletions docs/partials/getting-started/_custom-domains.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Replicated recommends that you use custom domains to alias Replicated endpoints. Replicated domains are external to your domain and can require additional security reviews by your customer. Using custom domains as aliases can bring the domains inside an existing security review and reduce your exposure.

For more information, see [Using Custom Domains](/vendor/custom-domains-using).
3 changes: 3 additions & 0 deletions docs/partials/getting-started/_custom-metrics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
In addition to the built-in insights displayed in the Vendor Portal by default (such as uptime and time to install), you can also configure custom metrics to measure instances of your application running customer environments. Custom metrics can be collected for application instances running in online or air gap environments using the Replicated SDK.

For more information, see [Configuring Custom Metrics](/vendor/custom-metrics).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
After adding basic specs, you can continue to add to the preflights and support bundles for your application by adding additional collectors and analyzers.

At a minimum, Replicated recommends that your support bundle spec includes all of the collectors and analyzers that are included in your preflight checks.

For more information, see:
* [Defining Preflight Checks](/vendor/preflight-defining)
* [(Optional) Customize the Specification](/vendor/support-bundle-customizing#optional-customize-the-specification) in _Adding and Customizing Support Bundles_
11 changes: 11 additions & 0 deletions docs/partials/getting-started/_enable-proxy-service.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import HelmPackage from "../helm/_helm-package.mdx"

1. Follow the steps in [Using the Proxy Service with Helm Installations](/vendor/helm-image-registry) to authenticate with the Replicated proxy service by creating a Secret with `type: kubernetes.io/dockerconfigjson` in your Helm chart.

1. Update dependencies and package the chart as a `.tgz` file:

<HelmPackage/>

1. Add the `.tgz` file to a release. For more information, see [Managing Releases with the Vendor Portal](releases-creating-releases) or [Managing Releases with the CLI](releases-creating-cli).

1. Install the release with the Helm CLI to test your changes. For more information, see [Installing with Helm](/vendor/install-with-helm).
1 change: 1 addition & 0 deletions docs/partials/getting-started/_onboard-intro.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Complete the tasks in this section to onboard your application. When you are done, you can continue to [Next Steps](#next-steps) to integrate other Replicated features with your application.
1 change: 1 addition & 0 deletions docs/partials/getting-started/_package-sdk.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
In your application Helm chart `Chart.yaml` file, add the YAML below to declare the SDK as a dependency. If your application is installed as multiple charts, declare the SDK as a dependency of the chart that customers install first. Do not declare the SDK in more than one chart. For more information, see [Packaging a Helm Chart for a Release](helm-install-release).
Loading