import KurlAbout from "../partials/install/_kurl-about.mdx" import IntroEmbedded from "../partials/install/_intro-embedded.mdx" import IntroAirGap from "../partials/install/_intro-air-gap.mdx" import PrereqsEmbeddedCluster from "../partials/install/_prereqs-embedded-cluster.mdx" import HaLoadBalancerPrereq from "../partials/install/_ha-load-balancer-prereq.mdx" import AirGapLicense from "../partials/install/_airgap-license-download.mdx" import BuildAirGapBundle from "../partials/install/_airgap-bundle-build.mdx" import DownloadAirGapBundle from "../partials/install/_airgap-bundle-download.mdx" import ViewAirGapBundle from "../partials/install/_airgap-bundle-view-contents.mdx" import LicenseFile from "../partials/install/_license-file-prereq.mdx" import HAStep from "../partials/install/_embedded-ha-step.mdx" import LoginPassword from "../partials/install/_embedded-login-password.mdx" import DownloadKurlBundle from "../partials/install/_download-kurl-bundle.mdx" import ExtractKurlBundle from "../partials/install/_extract-kurl-bundle.mdx" import KurlAvailability from "../partials/kurl/_kurl-availability.mdx"
Complete the following prerequisites:
To install an application with kURL:
-
Download the customer license:
-
Go the channel where the target release was promoted to build and download the air gap bundle for the release:
-
Download the
.tar.gz
air gap bundle for the kURL installer, which includes the components needed to run the kURL cluster and install the application with KOTS. kURL air gap bundles can be downloaded from the channel where the given release is promoted:-
To download the kURL air gap bundle for the Stable channel:
-
To download the kURL bundle for channels other than Stable:
replicated channel inspect CHANNEL
Replace
CHANNEL
with the exact name of the target channel, which can include uppercase letters or special characters, such asUnstable
ormy-custom-channel
.In the output of this command, copy the curl command with the air gap URL.
-
-
Run one of the following commands to install in air gap mode:
-
For a regular installation, run:
cat install.sh | sudo bash -s airgap
-
For high availability, run:
cat install.sh | sudo bash -s airgap ha
-
-
Go to the address provided in the
Kotsadm
field in the output of the installation command. For example,Kotsadm: http://34.171.140.123:8800
. -
On the Bypass Browser TLS warning page, review the information about how to bypass the browser TLS warning, and then click Continue to Setup.
-
On the HTTPS page, do one of the following:
- To use the self-signed TLS certificate only, enter the hostname (required) if you are using the identity service. If you are not using the identity service, the hostname is optional. Click Skip & continue.
- To use a custom certificate only, enter the hostname (required) if you are using the identity service. If you are not using the identity service, the hostname is optional. Then upload a private key and SSL certificate to secure communication between your browser and the Admin Console. Click Upload & continue.
-
Log in to the Admin Console with the password that was provided in the
Login with password (will not be shown again):
field in the output of the installation command. -
Upload your license file.
-
Upload the
.airgap
bundle for the release that you downloaded in an earlier step. -
On the Preflight checks page, the application-specific preflight checks run automatically. Preflight checks are conformance tests that run against the target namespace and cluster to ensure that the environment meets the minimum requirements to support the application. Click Deploy.
:::note Replicated recommends that you address any warnings or failures, rather than dismissing them. Preflight checks help ensure that your environment meets the requirements for application deployment. :::
-
(Minimal RBAC Only) If you are installing with minimal role-based access control (RBAC), KOTS recognizes if the preflight checks failed due to insufficient privileges. When this occurs, a kubectl CLI preflight command displays that lets you manually run the preflight checks. The Admin Console then automatically displays the results of the preflight checks. Click Deploy.
View a larger version of this image
The Admin Console dashboard opens.
On the Admin Console dashboard, the application status changes from Missing to Unavailable while the Deployment is being created. When the installation is complete, the status changes to Ready.
-
(Recommended) Change the Admin Console login password:
- Click the menu in the top right corner of the Admin Console, then click Change password.
- Enter a new password in the dialog, and click Change Password to save.
Replicated strongly recommends that you change the password from the default provided during installation in a kURL cluster. For more information, see Changing an Admin Console Password.
-
Add primary and secondary nodes to the cluster. You might add nodes to either meet application requirements or to support your usage of the application. See Adding Nodes to Embedded Clusters.