Draft
Conversation
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/intro-replicated.mdx
Outdated
| <Replicated/> | ||
|
|
||
| The Replicated Platform features are designed to support ISVs during each phase of the Commercial Software Distribution Lifecycle. For more information, see [Commercial Software Distribution Lifecycle](#csdl) below. | ||
| The Replicated Platform features are designed to support ISVs during each phase of the Commercial Software Distribution Lifecycle. For more information, see [Commercial Software Distribution Lifecycle](#csdl) on this page. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are designed').
docs/intro-replicated.mdx
Outdated
| <Replicated/> | ||
|
|
||
| The Replicated Platform features are designed to support ISVs during each phase of the Commercial Software Distribution Lifecycle. For more information, see [Commercial Software Distribution Lifecycle](#csdl) below. | ||
| The Replicated Platform features are designed to support ISVs during each phase of the Commercial Software Distribution Lifecycle. For more information, see [Commercial Software Distribution Lifecycle](#csdl) on this page. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'ISVs'?
docs/intro-replicated.mdx
Outdated
| The Replicated Platform features are designed to support ISVs during each phase of the Commercial Software Distribution Lifecycle. For more information, see [Commercial Software Distribution Lifecycle](#csdl) on this page. | ||
|
|
||
| The following diagram demonstrates the process of using the Replicated Platform to distribute an application, install the application in a customer environment, and support the application after installation: | ||
| The following diagram demonstrates the processes of using the Replicated Platform to distribute an application, install the application in a customer environment using Embedded Cluster, and support the application after installation: |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/intro-replicated.mdx
Outdated
| [View a larger version of this image](/images/replicated-platform.png) | ||
|
|
||
| The diagram above shows an application that is packaged with the [**Replicated SDK**](/vendor/replicated-sdk-overview). The application is tested in clusters provisioned with the [**Replicated Compatibility Matrix (CMX)**](/vendor/testing-about), then added to a new release in the [**Vendor Portal**](/vendor/releases-about) using an automated CI/CD pipeline. | ||
| As shown in the diagram above, software vendors can use CI/CD pipelines to test their application releases in environments provisioned by the [Replicated Compatibility Matrix (CMX)](/vendor/testing-about), then promote releases to a customer-facing or internal channel in the [Vendor Portal](/vendor/releases-about). |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/intro-replicated.mdx
Outdated
| [View a larger version of this image](/images/replicated-platform.png) | ||
|
|
||
| The diagram above shows an application that is packaged with the [**Replicated SDK**](/vendor/replicated-sdk-overview). The application is tested in clusters provisioned with the [**Replicated Compatibility Matrix (CMX)**](/vendor/testing-about), then added to a new release in the [**Vendor Portal**](/vendor/releases-about) using an automated CI/CD pipeline. | ||
| As shown in the diagram above, software vendors can use CI/CD pipelines to test their application releases in environments provisioned by the [Replicated Compatibility Matrix (CMX)](/vendor/testing-about), then promote releases to a customer-facing or internal channel in the [Vendor Portal](/vendor/releases-about). |
Contributor
There was a problem hiding this comment.
[Replicated.PositionalLanguage] Avoid spacial and directional language like 'above'. Instead, use 'on this page', 'the following', or link to the section.
docs/intro-replicated.mdx
Outdated
| As shown in the diagram above, software vendors can use CI/CD pipelines to test their application releases in environments provisioned by the [Replicated Compatibility Matrix (CMX)](/vendor/testing-about), then promote releases to a customer-facing or internal channel in the [Vendor Portal](/vendor/releases-about). | ||
|
|
||
| The application is then installed by a customer ("Big Bank") on a VM. To install, the customer downloads their license, which grants proxy access to the application images through the [**Replicated proxy registry**](/vendor/private-images-about). They also download the installation assets for the [**Replicated Embedded Cluster**](/vendor/embedded-overview) installer. | ||
| Customers can install application releases that are promoted to the channel where they are subscribed. To install, the customer logs in to the [Replicated Enterprise Portal](/vendor/enterprise-portal-about) to download their license, which grants proxy access to the application images through the [Replicated proxy registry](/vendor/private-images-about). They also download the installation assets for the [Replicated Embedded Cluster](/vendor/embedded-overview) installer. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are promoted').
docs/intro-replicated.mdx
Outdated
| As shown in the diagram above, software vendors can use CI/CD pipelines to test their application releases in environments provisioned by the [Replicated Compatibility Matrix (CMX)](/vendor/testing-about), then promote releases to a customer-facing or internal channel in the [Vendor Portal](/vendor/releases-about). | ||
|
|
||
| The application is then installed by a customer ("Big Bank") on a VM. To install, the customer downloads their license, which grants proxy access to the application images through the [**Replicated proxy registry**](/vendor/private-images-about). They also download the installation assets for the [**Replicated Embedded Cluster**](/vendor/embedded-overview) installer. | ||
| Customers can install application releases that are promoted to the channel where they are subscribed. To install, the customer logs in to the [Replicated Enterprise Portal](/vendor/enterprise-portal-about) to download their license, which grants proxy access to the application images through the [Replicated proxy registry](/vendor/private-images-about). They also download the installation assets for the [Replicated Embedded Cluster](/vendor/embedded-overview) installer. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are subscribed').
docs/intro-replicated.mdx
Outdated
| Customers can install application releases that are promoted to the channel where they are subscribed. To install, the customer logs in to the [Replicated Enterprise Portal](/vendor/enterprise-portal-about) to download their license, which grants proxy access to the application images through the [Replicated proxy registry](/vendor/private-images-about). They also download the installation assets for the [Replicated Embedded Cluster](/vendor/embedded-overview) installer. | ||
|
|
||
| Embedded Cluster runs [**preflight checks**](/vendor/preflight-support-bundle-about) to verify that the environment meets the installation requirements, provisions a cluster on the VM, and installs [**Replicated KOTS**](intro-kots) in the cluster. KOTS provides an [**Admin Console**](intro-kots#kots-admin-console) where the customer enters application-specific configurations, runs application preflight checks, optionally joins nodes to the cluster, and then deploys the application. After installation, customers can manage both the application and the cluster from the Admin Console. | ||
| Customers can access the Enterprise Portal at any time to get installation and update instructions, upload [support bundles](/vendor/preflight-support-bundle-about#support-bundles) to get support from their software vendor, view security information for each application release from the [Security Center](/vendor/security-center-about), and more. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
docs/intro-replicated.mdx
Outdated
|
|
||
| Embedded Cluster also deploys the [Replicated SDK](/vendor/replicated-sdk-overview) in the cluster, if the vendor included the SDK as a dependency of their application. The SDK's in-cluster API sends [instance data](/vendor/instance-insights-event-data) and custom metrics from the customer environment to the Vendor Portal. | ||
|
|
||
| Vendors can configure [event notifications](/vendor/event-notifications) to email or webhook destinations to get alerted of important events, such as a customer uploading a support bundle, when an instance is in an unhealthy state for a given period of time, or when a trial license is close to expiring. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| Embedded Cluster also deploys the [Replicated SDK](/vendor/replicated-sdk-overview) in the cluster, if the vendor included the SDK as a dependency of their application. The SDK's in-cluster API sends [instance data](/vendor/instance-insights-event-data) and custom metrics from the customer environment to the Vendor Portal. | ||
|
|
||
| Vendors can configure [event notifications](/vendor/event-notifications) to email or webhook destinations. These notifications alert vendors when a customer uploads a support bundle, when an instance is unhealthy for an extended period, or when a trial license is about to expire. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
| 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. This design _embeds_ Kubernetes with the application. | ||
|
|
||
| Additionally, each version of Embedded Cluster includes a specific version of [Replicated KOTS](#kots) that is installed in the cluster during installation. KOTS is used by Embedded Cluster to deploy the application and also provides the Admin Console UI where users can manage both the application and the cluster. | ||
| Additionally, each version of Embedded Cluster includes a specific version of [Replicated KOTS](#kots) that Embedded Cluster installs in the cluster during installation. Embedded Cluster uses KOTS to deploy the application; KOTS also provides the Admin Console UI where users can manage both the application and the cluster. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Semicolons] Use semicolons judiciously.
| KOTS is a kubectl plugin and in-cluster Admin Console that installs Kubernetes applications in customer-controlled environments. | ||
|
|
||
| KOTS is used by [Replicated Embedded Cluster](#embedded-cluster) to deploy applications and also to provide the Admin Console UI where users can manage both the application and the cluster. KOTS can also be used to install applications in existing Kubernetes clusters in customer-controlled environments, including clusters in air-gapped environments with limited or no outbound internet access. | ||
| [Replicated Embedded Cluster](#embedded-cluster) uses KOTS to deploy applications and provide the Admin Console UI where users can manage both the application and the cluster. You can also use KOTS to install applications in existing Kubernetes clusters in customer-controlled environments, including air-gapped environments with limited or no outbound internet access. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
| ### Develop | ||
|
|
||
| The Replicated SDK exposes an in-cluster API that can be developed against to quickly integrate and test core functionality with an application. For example, when the SDK is installed alongside an application in a customer environment, the in-cluster API can be used to send custom metrics from the instance to the Replicated vendor platform. | ||
| The Replicated SDK exposes an in-cluster API that you can develop against to quickly integrate and test core functionality with an application. For example, after installing the SDK in a customer environment alongside your application, use the in-cluster API to send custom metrics to the Replicated vendor platform. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
No description provided.