Skip to content

intro.mdx

Latest commit

 

History

History
706 lines (699 loc) · 25.7 KB

intro.mdx

File metadata and controls

706 lines (699 loc) · 25.7 KB
slug /
pagination_next
title Home
hide_table_of_contents true
hide_title true

import clsx from "clsx";

Welcome to Replicated Docs

Learn how to use the Replicated Platform to secure and distribute your software to enterprise customers

Get started

Lightbulb icon

Explore labs

Learn about Replicated by completing common tasks in a lab environment

Computer icon

Set up your environment

Install required and optional tools on your local workstation

Alien vault icon

Follow the onboarding guide

Integrate Replicated features into your application releases

What's New

Set up notifications for key events (Beta)

Get email or webhook notifications on the events that matter to your team, such as support bundle uploads, license expirations, release promotions, and more. 

  <div className={clsx("col", "col--4")}>
    <div className="did-you-know-container">
      <div className="did-you-know-card">
        <div className="did-you-know-badge">Did You Know</div>
        <h3 className="did-you-know-card-title">
          Add custom license fields
        </h3>
        <p className="did-you-know-card-description">
          Custom license fields allow you to define application-specific entitlements and add other types of metadata to customer licenses.
        </p>
        <a href="/vendor/licenses-adding-custom-fields#manage-custom-license-fields"
          className="did-you-know-card-link">
          Learn more →
        </a>
      </div>
    </div>
  </div>
</div>

Browse product documentation

Vendor Platform

Teams and Accounts

Manage team members, RBAC, API tokens, and more

Applications

Manage your application in the Vendor Portal

Channels and Releases

Create and promote application versions

Customers and Licenses

Manage customer records and license entitlements

Custom Domains

Alias Replicated domains

Insights and Telemetry

Get telemetry and event data from customer instances

Replicated CLI

Use the CLI to manage applications, releases, and more

Vendor API

Integrate Vendor Platform functionality into your workflows

Embedded Cluster

Overview

Distribute a Kubernetes cluster and your application together as a single appliance

Embedded Cluster Config

Embedded Cluster Config resource

Online Installation with Embedded Cluster

Install with internet access using Embedded Cluster

Air Gap Installation with Embedded Cluster

Install in environments without internet access

Perform Updates with Embedded Cluster

Update an application and the cluster infrastructure

Helm CLI Installations

Overview

An introduction to Helm CLI installations for applications distributed with Replicated

Install with the Helm CLI

Install your application using Helm CLI

Install and Update with the Helm CLI in Air Gap Environments

Use Helm in environments without internet access

Enterprise Portal

Overview

Give customers access to releases and instance data

Customize the Enterprise Portal

Configure branding and appearance for customers

Manage Customer Access to the Enterprise Portal

Invite and manage customer portal users

Use the Enterprise Portal

Access and use the Enterprise Portal

Self-Service Sign-ups

Enable self-service access to trial or community licenses for customers

Compatibility Matrix

Overview

Test your application across customer-representative environments

CMX Pricing

Learn about pricing for CMX clusters and VMs

Test in Air Gap Environments

Simulate networks with no outbound internet access

Use CMX VMs

Create and manage virtual machines for testing

Use CMX Clusters

Create and manage Kubernetes clusters for testing

Test in CMX with CI/CD

Automate testing workflows with continuous integration

Replicated Proxy Registry

Overview

Grant proxy access to private images

Add and Manage External Registries

Connect external image registries

Use the Proxy Registry with Embedded Cluster

Proxy images for Embedded Cluster installations

Use the Proxy Registry with Helm CLI Installations

Proxy images for Helm CLI installations

Connect to a Public Registry

Pull images from public registries 

<div className="browse-docs-category">
  <h3 className="browse-docs-category-title">Replicated SDK</h3>
  <div className={clsx("container")}>
    <div className={clsx("row", "browse-docs-links")}>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/replicated-sdk-overview"
            className="browse-docs-link"
          >
            Overview
          </a>
          <p className="browse-docs-link-description">
            In-cluster service and API to integrate key Replicated
            functionality into your application
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/replicated-sdk-installing"
            className="browse-docs-link"
          >
            Install the Replicated SDK
          </a>
          <p className="browse-docs-link-description">
            Install alongside an application or as a standalone component
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/replicated-sdk-development"
            className="browse-docs-link"
          >
            Development Mode
          </a>
          <p className="browse-docs-link-description">
            Develop against the SDK API to test changes locally
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/reference/replicated-sdk-apis"
            className="browse-docs-link"
          >
            Replicated SDK API
          </a>
          <p className="browse-docs-link-description">
            API reference for Replicated SDK endpoints
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/reference/replicated-sdk-apis"
            className="browse-docs-link"
          >
            Customize the Replicated SDK
          </a>
          <p className="browse-docs-link-description">
            Customize RBAC, set environment variables, add tolerations, and
            more
          </p>
        </div>
      </div>
    </div>
  </div>
</div>
<div className="browse-docs-category">
  <h3 className="browse-docs-category-title">Troubleshoot</h3>
  <div className={clsx("container")}>
    <div className={clsx("row", "browse-docs-links")}>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a href="#" className="browse-docs-link">
            Overview
          </a>
          <p className="browse-docs-link-description">
            Learn about troubleshooting tools for customer environments
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a href="/vendor/preflight-defining" className="browse-docs-link">
            Define Preflight Checks
          </a>
          <p className="browse-docs-link-description">
            Verify that customer environments meet application requirements
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/support-bundle-customizing"
            className="browse-docs-link"
          >
            Add and Customize Support Bundles
          </a>
          <p className="browse-docs-link-description">
            Configure support bundles for troubleshooting
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/support-bundle-generating"
            className="browse-docs-link"
          >
            Generate Support Bundles
          </a>
          <p className="browse-docs-link-description">
            Collect support bundles in customer environments
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/support-inspecting-support-bundles"
            className="browse-docs-link"
          >
            Inspect Support Bundles
          </a>
          <p className="browse-docs-link-description">
            Analyze support bundles to troubleshoot issues
          </p>
        </div>
      </div>
      <div className={clsx("col", "col--4")}>
        <div className="browse-docs-link-container">
          <a
            href="/vendor/support-submit-request"
            className="browse-docs-link"
          >
            Submit a Support Request
          </a>
          <p className="browse-docs-link-description">
            Contact Replicated support for assistance
          </p>
        </div>
      </div>
    </div>
  </div>
</div>