Skip to content

Commit 414d609

Browse files
committed
edits to kurl intro
1 parent e01b35d commit 414d609

File tree

2 files changed

+30
-11
lines changed

2 files changed

+30
-11
lines changed

docs/vendor/kurl-about.mdx

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,44 @@ This topic provides an introduction to the Replicated kURL installer.
44

55
## Overview
66

7-
kURL is an open source project maintained by Replicated that software vendors can use to create custom Kubernetes distributions.
7+
kURL is an open source project maintained by Replicated that software vendors can use to create custom Kubernetes distributions that are embedded with their application. Enterprise customers can then run a kURL installation script on their virtual machine (VM) or bare metal server to provision a cluster and install the application. This allows software vendors to distribute Kubernetes applications to customers that do not have access to a cluster in their environment.
88

9-
This means that you can distribute your Kubernetes application to customers who do not have access to a Kubernetes cluster in their environment.
9+
For more information about the kURL open source project, see the [kURL website](https://kurl.sh).
1010

11-
For more information about the kURL open source project, see the [kURL documentation](https://kurl.sh).
11+
### Kubernetes Installer Specs
1212

13-
## About Defining kURL Installer Specs
13+
To provision a cluster, kURL uses a spec that is defined in a manifest file with `apiVersion: cluster.kurl.sh/v1beta1` and `kind: Installer`. This _Kubernetes installer_ spec can be customized according to the application requirements by including add-ons. kURL provides add-ons for networking, storage, ingress, and more. kURL also provides a KOTS add-on, which installs KOTS in the cluster and deploys the KOTS admin console.
1414

15-
To provision a cluster, kURL uses a spec defined in a manifest file with `apiVersion: cluster.kurl.sh/v1beta1` and `kind: Installer`. Software vendors can add kURL add-ons to an Installer spec to create a custom Kubernetes distribution based on their application requirements. kURL add-ons include services for networking, storage, ingress, and more. kURL also includes a KOTS add-on, which installs KOTS in the cluster and deploys the KOTS admin console.
15+
Installer specs can be embedded with an application by promoting the spec to the same channel as the target application release in the Replicated vendor platform. When an installer spec is promoted to a channel, all releases on the channel use the installer for installations with kURL.
1616

17-
You can create Installer specs using the Replicated vendor portal [Kubernetes installers](https://vendor.replicated.com/kurl) page. To distribute the Installer alongside your application, promote the spec to the same channel as the target application release. All releases from that channel will use the currently promoted installer.
17+
For more information about creating Kubernetes installer specs for kURL, see [Creating a Kubernetes Installer](/vendor/packaging-embedded-kubernetes).
1818

19-
## About Embedded Cluster Installations with KOTS and kURL
19+
### Embedded Cluster Installations
2020

21-
kURL has a built-in integration with KOTS through the KOTS add-on. When the KOTS add-on is included in a kURL Installer spec, customers can run the kURL installation script in their environment to provision an embedded cluster and automatically deploy the KOTS admin console to the cluster.
21+
Installations with Replicated KOTS in clusters provisioned by kURL are called _embedded cluster_ installations. In embedded cluster installations, users run a kURL installation script on their VM or bare metal server to provision a cluster.
2222

23-
For information about how to install applications in embedded clusters with KOTS and kURL, see Installing with kURL.
23+
When the KOTS add-on is included in the Kubernetes installer spec, the kURL installation script also automatically installs the kots CLI and KOTS admin console in the cluster. After the installation script completes, users can access the admin console at the URL provided in the ouput of the command to configure and deploy the application. Users can also manage nodes for clusters provisioned with kURL from the **Cluster Management** page of the KOTS admin console.
2424

25-
## About kURL Cluster Node Management
25+
The following shows an example of the output of the kURL installation script:
26+
27+
```bash
28+
Installation
29+
Complete ✔
30+
31+
Kotsadm: http://10.128.0.35:8800
32+
Login with password (will not be shown again): 3Hy8WYYid
33+
34+
This password has been set for you by default. It is recommended that you change
35+
this password; this can be done with the following command:
36+
kubectl kots reset-password default
37+
```
38+
39+
Embedded cluster installations are supported in online (internet-connected) and air gapped environments.
40+
41+
For information about how to install applications in embedded clusters with KOTS and kURL, see [Online Installation with kURL](/enterprise/installing-embedded-cluster).
2642

2743
## About the Open Source kURL Documentation
2844

29-
The open source kURL documentation contains additional information and reference material about the kURL installation options, the supported kURL add-ons and
45+
The kURL project has open source documentation at [kurl.sh](https://kurl.sh/docs/introduction/).
46+
47+
The open source kURL documentation contains additional information about kURL installation options, kURL add-ons, and adding and managing nodes in kURL clusters. Software vendors can use the open source kURL documentation to find detailed reference information when creating Kubernetes installer specs or testing installation.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ const sidebars = {
8383
type: 'category',
8484
label: 'Replicated kURL',
8585
items: [
86+
'vendor/kurl-about',
8687
'vendor/packaging-embedded-kubernetes',
8788
'vendor/packaging-installer-storage',
8889
'vendor/kurl-nodeport-services',

0 commit comments

Comments
 (0)