-
Notifications
You must be signed in to change notification settings - Fork 31
WAIT FOR EC GA: Onboarding docs updates #2528
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
Closed
Closed
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 631f37b
edits to onboarding flow
paigecalvert 9a64a24
edits
paigecalvert c132ef6
adding partials
paigecalvert 5f274ca
edits
paigecalvert 66dce75
edits
paigecalvert be92182
updating quick start steps
paigecalvert d32018c
ec quick start update steps
paigecalvert 86ffc0f
helm quick start edits
paigecalvert 843cba0
adding partials for the quick starts
paigecalvert 1774f6d
edit onboarding flow
paigecalvert c2b0293
add to kots onboarding tasks
paigecalvert 0e444b1
add to kots onboarding tasks
paigecalvert b0a4df8
add to kots onboarding tasks
paigecalvert a30aa7a
add to kots onboarding tasks
paigecalvert 1317eee
more edits and move partials
paigecalvert 89acc95
edits
paigecalvert 99c79c8
add related topics
paigecalvert 14ddd03
onboarding task edits
paigecalvert 606ae23
edits
paigecalvert b1c66c3
undo changes to unrelated topic
paigecalvert 0c6b270
replace cluster setup with partial
paigecalvert 37fa0f3
edits from convo with chuck
paigecalvert 9e236ef
edits
paigecalvert 2d3a4de
edits
paigecalvert d1c91be
edits to ec quick start
paigecalvert 9167d15
edits
paigecalvert 969a117
edits
paigecalvert 46ae9be
edits to helm onboarding
paigecalvert 2b52245
edits to quick start flows
paigecalvert 6e4ea87
helm quick start edits
paigecalvert 8030046
edits
paigecalvert 706357d
edits
paigecalvert 04c6f00
edits
paigecalvert 78f2840
edits
paigecalvert 7c9e2a5
undo changes to intro content
paigecalvert d81fc37
udpate landing page
paigecalvert 3e45efc
edits
paigecalvert 6602e9d
edits based on chuck's feedback
paigecalvert b0c66f3
Merge branch 'main' into sidebar-kots-reorg
paigecalvert 8dd39ee
Merge branch 'main' into sidebar-kots-reorg
paigecalvert 09378a9
removing the helm-only content
paigecalvert 367dad9
remove more helm-only stuff
paigecalvert 9ba18ba
remove helm only topics
paigecalvert 07b394c
undo some sidebar changes
paigecalvert 0379db2
chagne EC to Replicated
paigecalvert File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). | ||
paigecalvert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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/. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. | ||
paigecalvert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| For more information, see: | ||
| * [About Channels and Releases](releases-about-releases) | ||
| * [Creating and Editing Channels](/vendor/releases-creating-channels) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). | ||
paigecalvert marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.