You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/enterprise/installing-embedded-air-gap.mdx
-2Lines changed: 0 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,8 +46,6 @@ To install with Embedded Cluster in an air gap environment:
46
46
* If the **Automatically create airgap builds for newly promoted releases in this channel** setting is enabled on the channel, watch for the build status to complete.
47
47
* If automatic air gap builds are not enabled, go to the **Release history** page for the channel and build the air gap bundle manually.
48
48
49
-
For more information, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles#air-gap-bundle).
50
-
51
49
:::note
52
50
Errors in building either the application air gap bundle or the Embedded Cluster infrastructure will be shown if present.
@@ -17,16 +20,6 @@ import KotsVersionMatch from "../partials/install/_kots-airgap-version-match.mdx
17
20
18
21
<IntroAirGap/>
19
22
20
-
## About Private Registries
21
-
22
-
Air gapped networks must have a Docker image registry that is available inside the network. KOTS rewrites the application image names in all application manifests to read from the on-premises registry, and it re-tags and pushes the images to the on-premises registry. When authenticating to the registry, credentials with `push` permissions are required.
23
-
24
-
A single application expects to use a single namespace in the Docker image registry. The namespace name can be any valid URL-safe string, supplied at installation time. A registry typically expects the namespace to exist before any images can be pushed into it.
25
-
26
-
:::note
27
-
ECR does not use namespaces.
28
-
:::
29
-
30
23
## Prerequisites
31
24
32
25
Complete the following prerequisites:
@@ -35,15 +28,31 @@ Complete the following prerequisites:
35
28
36
29
* Ensure that there is a compatible Docker image registry available inside the network. For more information about Docker registry compatibility, see [Private Registry Requirements](/enterprise/installing-general-requirements#private-registry-requirements).
37
30
38
-
<AirGapBundle/>
31
+
KOTS rewrites the application image names in all application manifests to read from the on-premises registry, and it re-tags and pushes the images to the on-premises registry. When authenticating to the registry, credentials with `push` permissions are required.
39
32
40
-
<LicenseFile/>
33
+
A single application expects to use a single namespace in the Docker image registry. The namespace name can be any valid URL-safe string, supplied at installation time. A registry typically expects the namespace to exist before any images can be pushed into it.
41
34
42
-
* <DownloadKotsBundle/>
35
+
:::note
36
+
Amazon Elastic Container Registry (ECR) does not use namespaces.
37
+
:::
43
38
44
39
## Install {#air-gap}
45
40
46
-
To install KOTS and an application in an air gap existing cluster:
41
+
To install in an air gap cluster with KOTS:
42
+
43
+
1. Download the customer license:
44
+
45
+
<AirGapLicense/>
46
+
47
+
1. Go the channel where the target release was promoted to build and download the air gap bundle for the release:
Copy file name to clipboardExpand all lines: docs/enterprise/installing-existing-cluster-automation.mdx
+8-16Lines changed: 8 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,27 +45,25 @@ For a tutorial that demonstrates how to install a sample application using the K
45
45
46
46
## Limitation
47
47
48
-
Replicated Embedded Cluster does not support headless installations with the KOTS CLI.
48
+
[Replicated Embedded Cluster](/vendor/embedded-overview) does not support automated, or _headless_, installations with the KOTS CLI.
49
49
50
50
## Prerequisite
51
51
52
-
Create a ConfigValues file to define the configuration settings for the application. For air gap environments, ensure that you can access the ConfigValues file that you create from your installation environment.
52
+
Create a ConfigValues YAML file to define the configuration settings for the application. For air gap environments, ensure that you can access the ConfigValues file that you create from your installation environment.
53
+
54
+
A ConfigValues file includes the names of the configuration fields for the application along with a user-supplied `value` for each field. The ConfigValues file is specific to the application. For more information, see [Generating a ConfigValues File](/vendor/releases-configvalues).
53
55
54
56
**Example:**
55
57
56
58
<ConfigValuesExample/>
57
-
58
-
As shown in the example above, the ConfigValues file includes the names of the configuration fields for the application along with a user-supplied `value` for each field.
59
-
60
-
The ConfigValues file is specific to the application. For more information, see [Sharing a ConfigValues File](/vendor/releases-configvalues).
61
59
62
60
## Install
63
61
64
62
This section provides the steps for installing an application with the KOTS CLI in different types of environments.
65
63
66
64
### Existing Cluster
67
65
68
-
To install in an existing cluster:
66
+
To install with KOTS in an existing cluster:
69
67
70
68
1. <InstallKotsCli/>
71
69
@@ -114,13 +112,11 @@ To install with kURL on a VM or bare metal server:
114
112
115
113
<PlaceholderNamespaceEmbedded/>
116
114
117
-
### Air Gap Existing Cluster
115
+
### Air Gap Existing Cluster
118
116
119
-
Air gap installations in existing clusters require the application `.airgap` bundle and the KOTS Admin Console `kotsadm.tar.gz`air gap bundle. Additionally, images for the application and the KOTS Admin Console must be pushed to a local private registry. For more information about downloading the necessary air gap bundles, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles).
117
+
To install with KOTS in an air gap existing cluster:
120
118
121
-
To install in an air gap existing cluster:
122
-
123
-
1. Install the KOTS CLI. See [Manually Download and Install](/reference/kots-cli-getting-started#manually-download-and-install) in _Installing the KOTS CLI_.
119
+
1. <InstallKotsCliAirGap/>
124
120
125
121
1. <DownloadKotsBundle/>
126
122
@@ -157,16 +153,12 @@ To install in an air gap existing cluster:
157
153
158
154
<IntroEmbedded/>
159
155
160
-
Air gap installations with kURL require the application `.airgap` bundle and the kURL `.tar.gz` air gap bundle. For more information about downloading the necessary air gap bundles, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles).
161
-
162
156
To install in an air gap kURL cluster on a VM or bare metal server:
163
157
164
158
1. Download the kURL `.tar.gz` air gap bundle:
165
159
166
160
<DownloadkURLBundle/>
167
161
168
-
For more information, see [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_.
@@ -23,21 +27,42 @@ Complete the following prerequisites:
23
27
24
28
<PrereqsEmbeddedCluster/>
25
29
26
-
<AirGapBundle/>
27
-
28
-
<LicenseFile/>
29
-
30
-
* Download the `.tar.gz` air gap bundle for the kURL installer. Ensure that you can access the downloaded bundle from the environment where you will install the application. See [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_.
31
-
32
30
<HaLoadBalancerPrereq/>
33
31
34
32
## Install {#air-gap}
35
33
36
34
To install an application with kURL:
37
35
36
+
1. Download the customer license:
37
+
38
+
<AirGapLicense/>
39
+
40
+
1. Go the channel where the target release was promoted to build and download the air gap bundle for the release:
41
+
42
+
<BuildAirGapBundle/>
43
+
44
+
1. <DownloadAirGapBundle/>
45
+
46
+
1. <ViewAirGapBundle/>
47
+
48
+
1. 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:
49
+
50
+
* To download the kURL air gap bundle for the Stable channel:
51
+
52
+
<DownloadKurlBundle/>
53
+
54
+
* To download the kURL bundle for channels other than Stable:
55
+
56
+
```bash
57
+
replicated channel inspect CHANNEL
58
+
```
59
+
Replace `CHANNEL` with the exact name of the target channel, which can include uppercase letters or special characters, such as `Unstable` or `my-custom-channel`.
60
+
61
+
In the output of this command, copy the curl command with the air gap URL.
62
+
38
63
1. <ExtractKurlBundle/>
39
64
40
-
1. Run one of the following commands to create the cluster and install KOTS in air gap mode:
65
+
1. Run one of the following commands to install in air gap mode:
41
66
42
67
- For a regular installation, run:
43
68
@@ -68,7 +93,7 @@ To install an application with kURL:
68
93
69
94
1. Upload your license file.
70
95
71
-
1. Upload the `.airgap`application air gap bundle.
96
+
1. Upload the `.airgap`bundle for the release that you downloaded in an earlier step.
72
97
73
98
1. 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**.
@@ -43,7 +46,13 @@ Add the `--deploy` flag to automatically deploy this version.
43
46
44
47
To update an application in air gap environments:
45
48
46
-
1. Get the new `.airgap` bundle for the target application release and ensure that it is available on your local machine.
49
+
1. In the [Vendor Portal](https://vendor.replicated.com), go the channel where the target release is promoted to build and download the new `.airgap` bundle:
50
+
51
+
<BuildAirGapBundle/>
52
+
53
+
1. <DownloadAirGapBundle/>
54
+
55
+
1. <ViewAirGapBundle/>
47
56
48
57
1. Run the following command to update the application:
49
58
@@ -57,7 +66,7 @@ To update an application in air gap environments:
57
66
```
58
67
Replace:
59
68
*`APP_SLUG` with the unique slug for the application. See [Get the Application Slug](/vendor/vendor-portal-manage-app#slug) in _Managing Applications_.
60
-
*`NEW_AIRGAP_BUNDLE` with the `.airgap` bundle for the target application version. See [Download Air Gap Bundles from the Download Portal](/vendor/releases-download-airgap-bundles#download-portal).
69
+
*`NEW_AIRGAP_BUNDLE` with the `.airgap` bundle for the target application version.
61
70
*`REGISTRY_HOST` with the private registry that contains the Admin Console images.
62
71
*`REGISTRY_NAMESPACE` with the registry namespace where the images are hosted (Optional).
63
72
*`RO_USERNAME` and `RO_PASSWORD` with the username and password for an account that has read-only access to the private registry.
@@ -107,11 +116,9 @@ To update KOTS in an online existing cluster:
107
116
108
117
To update KOTS in an existing air gap cluster:
109
118
110
-
1. Download the target version of the following assets from the download portal or from the [Releases](https://github.com/replicatedhq/kots/releases/latest) page in the KOTS GitHub repository:
119
+
1. Download the target version of the following assets from the [Releases](https://github.com/replicatedhq/kots/releases/latest) page in the KOTS GitHub repository:
111
120
* KOTS Admin Console `kotsadm.tar.gz` bundle
112
121
* KOTS CLI plugin
113
-
114
-
For more information, see [Download Air Gap Bundles from the Download Portal](/vendor/releases-download-airgap-bundles#download-portal).
115
122
116
123
Ensure that you can access the downloaded bundles from the environment where the Admin Console is running.
@@ -62,14 +63,29 @@ To update the kURL cluster in an air gap environment:
62
63
63
64
1. Edit the kURL installer spec as desired. For example, update the version of Kubernetes or add, remove, or update add-ons. For more information, see [Creating a kURL Installer](/vendor/packaging-embedded-kubernetes).
64
65
65
-
1.On each node in the cluster, download the kURL `.tar.gz` air gap bundle for the updated spec. See [Download the kURL Bundle](/vendor/releases-download-airgap-bundles#installer-bundle) in _Downloading Air Gap Bundles_.
66
+
1.Repeat the following steps on each node in the cluster to download and extract the kURL `.tar.gz` air gap bundle for the updated spec:
66
67
67
-
Then, extract the contents:
68
+
1. Download the kURL `.tar.gz` air gap bundle from the channel where the new kURL installer spec is promoted:
68
69
69
-
```bash
70
-
tar -xvzf FILENAME.tar.gz
71
-
```
72
-
Replace `FILENAME` with the name of the downloaded kURL `.tar.gz` air gap bundle.
70
+
* To download the kURL air gap bundle for the Stable channel:
71
+
72
+
<DownloadKurlBundle/>
73
+
74
+
* To download the kURL bundle for channels other than Stable:
75
+
76
+
```bash
77
+
replicated channel inspect CHANNEL
78
+
```
79
+
Replace `CHANNEL` with the exact name of the target channel, which can include uppercase letters or special characters, such as `Unstable` or `my-custom-channel`.
80
+
81
+
In the output of this command, copy the curl command with the air gap URL.
82
+
83
+
1. Extract the contents of the bundle:
84
+
85
+
```bash
86
+
tar -xvzf FILENAME.tar.gz
87
+
```
88
+
Replace `FILENAME` with the name of the downloaded kURL `.tar.gz` air gap bundle.
73
89
74
90
1. Run the following KURL script to ensure all required images are available:
Air gap bundles (`.airgap`) contain the images needed to install and run a single release of your application in _air gap_ environments with no outbound internet access. For more information about how to build and download air gap bundles, see [Downloading Air Gap Bundles](/vendor/releases-download-airgap-bundles).
1
+
Air gap bundles (`.airgap`) contain the images needed to install and run a single release of your application in _air gap_ environments with no outbound internet access.
* If the **Automatically create airgap builds for newly promoted releases in this channel** setting is enabled on the channel, watch for the build status to complete.
2
+
* If automatic air gap builds are not enabled, go to the **Release history** page for the channel and build the air gap bundle manually.
3
+
4
+
<imgalt="Release history link on a channel card"src="/images/release-history-link.png"width="400px"/>
5
+
6
+
[View a larger version of this image](/images/release-history-link.png)
7
+
8
+
9
+
10
+
[View a larger version of this image](/images/release-history-build-airgap-bundle.png)
After the build completes, download the bundle. Ensure that you can access the downloaded bundle from the environment where you will install the application.
0 commit comments