-
Notifications
You must be signed in to change notification settings - Fork 26
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
Merged
Merged
Changes from all commits
Commits
Show all changes
34 commits
Select commit
Hold shift + click to select a range
0087240
Add Embedded Cluster to Replicated intro content
paigecalvert c20bc83
typos
paigecalvert 7e0f6a0
edits
paigecalvert ecb9d52
edits
paigecalvert 7b528e5
remove separate topic on distributing apps
paigecalvert 805fa71
merge conflict
paigecalvert fb34191
file extension changes
paigecalvert c3a3243
edits
paigecalvert 2fb98a8
update platform diagram
paigecalvert 3c78f88
updating diagram description
paigecalvert 35d387e
updating diagram description
paigecalvert b10b493
edits
paigecalvert 45d0db4
editing faqs
paigecalvert 4578195
editing faqs
paigecalvert d3ad7f8
add missing partial
paigecalvert cd5436d
undo changes to faqs
paigecalvert 4e4388a
intro kots edits
paigecalvert 20cb63d
edits to diagram description
paigecalvert 31ee890
edits
paigecalvert 9b9feef
edit
paigecalvert 7e58a37
edits
paigecalvert 0547650
Merge branch 'main' into 95831
paigecalvert 5c82481
edits
paigecalvert 5f86418
edits to kots intro
paigecalvert 3027f43
Merge branch 'main' into 95831
paigecalvert 5036a18
edits
paigecalvert 49fb00b
edit diagram description
paigecalvert 641221f
edits
paigecalvert 5cce2d9
edits
paigecalvert a14f8e6
edits
paigecalvert 446c618
merge conflict
paigecalvert e90de43
md error
paigecalvert 4c4f029
redundant redirect
paigecalvert 2be211f
fix redirect
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 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 |
---|---|---|
|
@@ -12,14 +12,14 @@ The Replicated KOTS entitlement is required to install applications with KOTS. F | |
|
||
<Kots/> | ||
|
||
KOTS communicates securely with the Replicated vendor platform to synchronize customer licenses, check for available application updates, send instance data, share customer-generated support bundles, and more. | ||
KOTS communicates securely with the Replicated Vendor Portal to synchronize customer licenses, check for available application updates, send instance data, share customer-generated support bundles, and more. | ||
|
||
Installing an application with KOTS provides access to features such as: | ||
|
||
* Support for air gap installations | ||
* Support for installations on VMs or bare metal servers | ||
* Support for air gap installations in environments with limited or no outbound internet access | ||
* Support for installations on VMs or bare metal servers, when using Replicated Embedded Cluster or Replicated kURL | ||
* The KOTS Admin Console, which provides a user interface where customers can install and manage their application instances | ||
* Instance telemetry automatically sent to the vendor portal for instances running in customer environments | ||
* Instance telemetry automatically sent to the Vendor Portal for instances running in customer environments | ||
* Strict preflight checks that block installation if environment requirements are not met | ||
* Backup and restore with Replicated snapshots | ||
* Support for marking releases as required to prevent users from skipping them during upgrades | ||
|
@@ -28,25 +28,25 @@ KOTS is an open source project that is maintained by Replicated. For more inform | |
|
||
## About Installing with KOTS | ||
|
||
KOTS can be used to install applications in Kubernetes clusters, including: | ||
KOTS can be used to install Kubernetes applications and Helm charts in the following environments: | ||
* Clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL | ||
* Existing clusters brought by the user | ||
* Online or air gapped clusters | ||
* Embedded clusters provisioned on VMs or bare metal servers with Replicated Embedded Cluster or Replicated kURL | ||
* Online (internet-connected) or air-gapped (disconnected) environments | ||
|
||
To install an application with KOTS, users first run an installation script to install KOTS in the target cluster and deploy the KOTS Admin Console. After KOTS is installed, users can log in to the KOTS Admin Console to upload their license file, configure the application, run preflight checks, and install and deploy the application. | ||
To install an application with KOTS, users first run an installation script that installs KOTS in the target cluster and deploys the KOTS Admin Console. After KOTS is installed, users can log in to the KOTS Admin Console to upload their license file, configure the application, run preflight checks, and install and deploy the application. | ||
|
||
The following diagram demonstrates how a single release promoted to the Stable channel in the Replicated vendor platform can be installed using KOTS in an embedded cluster on a VM, in an air gapped cluster, and in an existing internet-connected cluster: | ||
The following diagram demonstrates how a single release promoted to the Stable channel in the Vendor Portal can be installed with KOTS in an embedded cluster on a VM, in an existing air-gapped cluster, and in an existing internet-connected cluster: | ||
|
||
<img alt="Embedded cluster, air gap, and existing cluster app installation workflows" src="/images/kots-installation-overview.png"/> | ||
|
||
[View a larger version of this image](/images/kots-installation-overview.png) | ||
|
||
As shown in the diagram above: | ||
* For installations in existing internet-connected clusters, users run a command to install KOTS in their cluster. | ||
* For embedded cluster installations on VMs or bare metal servers, users run an installation script that both provisions a cluster in their environment and installs KOTS in the cluster. | ||
* For installations in air gapped clusters, users download air gap bundles for KOTS and the application from the Replicated download portal and then provide the bundles during installation. | ||
* For installations in existing online (internet-connected) clusters, users run a command to install KOTS in their cluster. | ||
* For installations on VMs or bare metal servers, users run an Embedded Cluster or kURL installation script that both provisions a cluster in their environment and installs KOTS in the cluster. | ||
* For installations in air-gapped clusters, users download air gap bundles for KOTS and the application from the Replicated Download Portal and then provide the bundles during installation. | ||
|
||
All users must provide a license file to install with KOTS. After KOTS is installed in the cluster, users can access the KOTS Admin Console to provide their license file and deploy the application. | ||
All users must have a valid license file to install with KOTS. After KOTS is installed in the cluster, users can access the KOTS Admin Console to provide their license and deploy the application. | ||
|
||
For more information about how to install applications with KOTS, see the [Installing an Application](/enterprise/installing-overview) section. | ||
|
||
|
@@ -64,9 +64,15 @@ The following shows an example of the Admin Console dashboard for an application | |
|
||
[View a larger version of this image](/images/guides/kots/application.png) | ||
|
||
For applications installed with Replicated Embedded Cluster in a VM or bare metal server, the Admin Console also includes a **Cluster Management** tab where users can add and manage nodes in the embedded cluster, as shown below: | ||
|
||
 | ||
|
||
[View a larger version of this image](/images/gitea-ec-ready.png) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ^ Added an example of the dashboard with a Cluster Management tab |
||
|
||
### KOTS CLI | ||
|
||
The kots command-line interface (CLI) is a kubectl plugin. Customers can run commands with the KOTS CLI to install and manage their application instances with KOTS programmatically. | ||
The KOTS command-line interface (CLI) is a kubectl plugin. Customers can run commands with the KOTS CLI to install and manage their application instances with KOTS programmatically. | ||
|
||
For information about getting started with the KOTS CLI, see [Installing the KOTS CLI](/reference/kots-cli-getting-started). | ||
|
||
|
This file was deleted.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ reordered this so embedded is at the top