Skip to content

Commit d9a9189

Browse files
paigecalvertpaigecalvert
authored
Merge branch 'main' into 114155
2 parents 65398bf + 7000f7b commit d9a9189

21 files changed

+218
-103
lines changed

‎docs/enterprise/installing-embedded-air-gap.mdx‎

Lines changed: 25 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -94,56 +94,50 @@ To install with Embedded Cluster in an air gap environment:
9494

9595
The installation command takes a few minutes to complete. During installation, Embedded Cluster completes tasks to prepare the cluster and install KOTS in the cluster. Embedded Cluster also automatically runs a default set of [_host preflight checks_](/vendor/embedded-overview#about-host-preflight-checks) which verify that the environment meets the requirements for the installer.
9696

97-
1. When the installation command completes, go to the URL provided in the output to access the Admin Console.
98-
99-
**Example output:**
97+
**Example output:**
10098

101-
```bash
102-
✔ Host files materialized
103-
? Enter an Admin Console password: ********
104-
? Confirm password: ********
105-
✔ Host files materialized!
106-
✔ Host preflights succeeded!
107-
✔ Node installation finished!
108-
✔ Storage is ready!
109-
✔ Embedded Cluster Operator is ready!
110-
✔ Admin Console is ready!
111-
✔ Additional components are ready!
112-
Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000
113-
```
114-
At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.
99+
```bash
100+
? Enter an Admin Console password: ********
101+
? Confirm password: ********
102+
✔ Host files materialized!
103+
✔ Running host preflights
104+
✔ Node installation finished!
105+
✔ Storage is ready!
106+
✔ Embedded Cluster Operator is ready!
107+
✔ Admin Console is ready!
108+
✔ Additional components are ready!
109+
Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000
110+
```
111+
112+
At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.
113+
114+
1. Go to the URL provided in the output to access to the Admin Console.
115115

116-
1. Bypass the browser TLS warning by clicking **Continue to Setup**.
116+
1. On the Admin Console landing page, click **Start**.
117117

118-
1. Click **Advanced > Proceed**.
118+
1. On the **Secure the Admin Console** screen, review the instructions and click **Continue**. In your browser, follow the instructions that were provided on the **Secure the Admin Console** screen to bypass the warning.
119119

120-
1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
120+
1. On the **Certificate type** screen, either select **Self-signed** to continue using the self-signed Admin Console certificate or click **Upload your own** to upload your own private key and certificacte.
121121

122122
By default, a self-signed TLS certificate is used to secure communication between your browser and the Admin Console. You will see a warning in your browser every time you access the Admin Console unless you upload your own certificate.
123123

124124
1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.
125125

126-
1. On the **Nodes** page, you can view details about the machine where you installed, including its node role, status, CPU, and memory. Optionally, add nodes before deploying the application. Click **Continue**.
126+
1. On the **Configure the cluster** screen, optionally add nodes to the cluster before deploying the application. Click **Continue**.
127127

128-
1. On the config screen, complete the fields for the application configuration options and then click **Continue**.
128+
1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
129129

130-
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**.
130+
1. On the **Validate the environment & deploy [App Name]** screen, address any warnings or failures identified by the preflight checks and then click **Deploy**.
131131

132-
:::note
133-
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.
134-
:::
135-
136-
:::note
137-
If the application does not include preflight checks, you need to click **Deploy** then **Yes, Deploy** next to the target version on the Admin Console dashboard to install.
138-
:::
132+
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.
139133

140134
The Admin Console dashboard opens.
141135

142136
On the Admin Console dashboard, the application status changes from Missing to Unavailable while the application is being installed. When the installation is complete, the status changes to Ready. For example:
143137

144138
![Admin console dashboard showing ready status](/images/gitea-ec-ready.png)
145139

146-
[View a larger version of this image](/images/gitea-ec-ready.png)
140+
[View a larger version of this image](/images/gitea-ec-ready.png)
147141

148142
## Add Nodes to Air Gap Clusters
149143

‎docs/enterprise/installing-embedded.mdx‎

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -56,48 +56,42 @@ To install an application with Embedded Cluster:
5656

5757
The installation command takes a few minutes to complete. During installation, Embedded Cluster completes tasks to prepare the cluster and install KOTS in the cluster. Embedded Cluster also automatically runs a default set of [_host preflight checks_](/vendor/embedded-overview#about-host-preflight-checks) which verify that the environment meets the requirements for the installer.
5858

59-
1. When the installation command completes, go to the URL provided in the output to access the Admin Console.
60-
61-
**Example output:**
59+
**Example output:**
6260

63-
```bash
64-
✔ Host files materialized
65-
? Enter an Admin Console password: ********
66-
? Confirm password: ********
67-
✔ Host files materialized!
68-
✔ Host preflights succeeded!
69-
✔ Node installation finished!
70-
✔ Storage is ready!
71-
✔ Embedded Cluster Operator is ready!
72-
✔ Admin Console is ready!
73-
✔ Additional components are ready!
74-
Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000
75-
```
76-
At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.
61+
```bash
62+
? Enter an Admin Console password: ********
63+
? Confirm password: ********
64+
✔ Host files materialized!
65+
✔ Running host preflights
66+
✔ Node installation finished!
67+
✔ Storage is ready!
68+
✔ Embedded Cluster Operator is ready!
69+
✔ Admin Console is ready!
70+
✔ Additional components are ready!
71+
Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000
72+
```
73+
74+
At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.
7775

78-
1. Bypass the browser TLS warning by clicking **Continue to Setup**.
76+
1. Go to the URL provided in the output to access to the Admin Console.
7977

80-
1. Click **Advanced > Proceed**.
78+
1. On the Admin Console landing page, click **Start**.
8179

82-
1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
80+
1. On the **Secure the Admin Console** screen, review the instructions and click **Continue**. In your browser, follow the instructions that were provided on the **Secure the Admin Console** screen to bypass the warning.
81+
82+
1. On the **Certificate type** screen, either select **Self-signed** to continue using the self-signed Admin Console certificate or click **Upload your own** to upload your own private key and certificacte.
8383

8484
By default, a self-signed TLS certificate is used to secure communication between your browser and the Admin Console. You will see a warning in your browser every time you access the Admin Console unless you upload your own certificate.
8585

8686
1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.
8787

88-
1. On the **Nodes** page, you can view details about the VM where you installed, including its node role, status, CPU, and memory. Optionally, add nodes before deploying the application. Click **Continue**.
88+
1. On the **Configure the cluster** screen, optionally add nodes to the cluster before deploying the application. Click **Continue**.
8989

90-
1. On the config screen, complete the fields for the application configuration options and then click **Continue**.
90+
1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
9191

92-
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**.
92+
1. On the **Validate the environment & deploy [App Name]** screen, address any warnings or failures identified by the preflight checks and then click **Deploy**.
9393

94-
:::note
95-
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.
96-
:::
97-
98-
:::note
99-
If the application does not include preflight checks, next to the target version on the dashboard, click **Deploy** then **Yes, Deploy** to install the application.
100-
:::
94+
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.
10195

10296
The Admin Console dashboard opens.
10397

‎docs/partials/embedded-cluster/_ec-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
apiVersion: embeddedcluster.replicated.com/v1beta1
33
kind: Config
44
spec:
5-
version: 1.16.0+k8s-1.30
5+
version: 1.17.0+k8s-1.30
66
```

‎docs/partials/getting-started/_gitea-ec-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
apiVersion: embeddedcluster.replicated.com/v1beta1
33
kind: Config
44
spec:
5-
version: 1.16.0+k8s-1.30
5+
version: 1.17.0+k8s-1.30
66
```

‎docs/partials/kurl/_kurl-availability.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:::note
2+
Replicated kURL is available only for existing customers. If you are not an existing kURL user, use Replicated Embedded Cluster instead. For more information, see [Using Embedded Cluster](/vendor/embedded-overview).
3+
4+
kURL is a Generally Available (GA) product for existing customers. For more information about the Replicated product lifecycle phases, see [Support Lifecycle Policy](/vendor/policies-support-lifecycle).
5+
:::

‎docs/reference/cron-expressions.md‎

Lines changed: 4 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The following table lists the required cron fields and supported values:
3333
<tr>
3434
<td>Day-of-month</td>
3535
<td>1 through 31</td>
36-
<td>, - * ? L W </td>
36+
<td>, - * ? </td>
3737
</tr>
3838
<tr>
3939
<td>Month</td>
@@ -43,12 +43,14 @@ The following table lists the required cron fields and supported values:
4343
<tr>
4444
<td>Day-of-week</td>
4545
<td>1 through 7 or SUN through SAT</td>
46-
<td>, - * ? L</td>
46+
<td>, - * ?</td>
4747
</tr>
4848
</table>
4949

5050
## Special Characters
5151

52+
Replicated uses an external cron Go library. For more information about it's usage, see [cron](https://pkg.go.dev/github.com/robfig/cron/v3).
53+
5254
The following table describes the supported special characters:
5355

5456
<table>
@@ -72,14 +74,6 @@ The following table describes the supported special characters:
7274
<td>Question mark (?)</td>
7375
<td> Specifies that one or another value can be used. For example, enter <code>5</code> for Day-of-the-month and <code>?</code> for Day-of-the-week to check for updates on the 5th day of the month, regardless of which day of the week it is.</td>
7476
</tr>
75-
<tr>
76-
<td>L</td>
77-
<td>Specifies the last day of the month or week respectively for the Day-of-month or Day-of-week fields.</td>
78-
</tr>
79-
<tr>
80-
<td>W</td>
81-
<td>Specifies the "N-th" occurrence or given day in the month. For example, the second Friday of the month is specified as <code>6#2</code>.</td>
82-
</tr>
8377
</table>
8478

8579
## Predefined Schedules
@@ -151,18 +145,6 @@ The following examples show valid cron expressions to schedule checking for upda
151145
30 11 * * *
152146
```
153147
154-
- At 6:00 PM on the fourth Monday of every month:
155-
156-
```
157-
0 18 ? * 2#4
158-
```
159-
160-
- At midnight on the last day of every month:
161-
162-
```
163-
0 0 L * ?
164-
```
165-
166148
- After 1 hour and 45 minutes, and then every interval following that:
167149
168150
```

‎docs/reference/embedded-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ For additional property-specific limitations, see the sections below.
2424
apiVersion: embeddedcluster.replicated.com/v1beta1
2525
kind: Config
2626
spec:
27-
version: 1.16.0+k8s-1.30
27+
version: 1.17.0+k8s-1.30
2828
roles:
2929
controller:
3030
name: management

‎docs/reference/kots-cli-download.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,16 @@ kubectl kots download [app-slug] [flags]
1414
This command supports all [global flags](kots-cli-global-flags) and also:
1515

1616

17-
| Flag | Type | Description |
18-
|:----------------------|------|-------------|
19-
| `--decrypt-password-values` | bool | decrypt password values to plaintext |
20-
| `--dest` | string | the directory to store the application in _(defaults to current working dir)_ |
21-
| `-h, --help` | | help for download |
22-
| `-n, --namespace` | string | the namespace to download from _(default `"default"`)_ |
23-
| `--overwrite` | | overwrite any local files, if present |
24-
| `-o, --output` | string | output format (currently supported: json) _(defaults to plain text if not set)_ |
17+
| Flag | Type | Description |
18+
|:----------------------------|--------|-----------------------------------------------------------------------------------------------------------------------|
19+
| `--decrypt-password-values` | bool | decrypt password values to plaintext |
20+
| `--dest` | string | the directory to store the application in _(defaults to current working dir)_ |
21+
| `--current` | bool | download the archive of the currently deployed app version |
22+
| `--sequence` | int | sequence of the app version to download the archive for (defaults to the latest version unless --current flag is set) |
23+
| `-h, --help` | | help for download |
24+
| `-n, --namespace` | string | the namespace to download from _(default `"default"`)_ |
25+
| `--overwrite` | | overwrite any local files, if present |
26+
| `-o, --output` | string | output format (currently supported: json) _(defaults to plain text if not set)_ |
2527

2628
## Example
2729
```bash

‎docs/release-notes/rn-app-manager.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,24 @@ The following table lists the versions of Kubernetes that are compatible with ea
1818

1919
<!--RELEASE_NOTES_PLACEHOLDER-->
2020

21+
## 1.121.0
22+
23+
Released on November 12, 2024
24+
25+
Support for Kubernetes: 1.29, 1.30, and 1.31
26+
27+
### New Features {#new-features-1-121-0}
28+
* Adds the ability to download the application archive for any version, including the currently deployed version, by using the `--sequence` and `--current` flags for the `kots download` command.
29+
30+
## 1.120.3
31+
32+
Released on November 7, 2024
33+
34+
Support for Kubernetes: 1.29, 1.30, and 1.31
35+
36+
### Improvements {#improvements-1-120-3}
37+
* Various updates for Embedded Cluster.
38+
2139
## 1.120.2
2240

2341
Released on November 5, 2024

‎docs/release-notes/rn-embedded-cluster.md‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,44 @@ This topic contains release notes for the [Replicated Embedded Cluster](/vendor/
1010

1111
Additionally, these release notes list the versions of Kubernetes and Replicated KOTS that are available with each version of Embedded Cluster.
1212

13+
## 1.18.0
14+
15+
Released on November 8, 2024
16+
17+
<table>
18+
<tr>
19+
<th>Version</th>
20+
<td id="center">1.18.0+k8s-1.30</td>
21+
<td id="center">1.18.0+k8s-1.29</td>
22+
</tr>
23+
<tr>
24+
<th>Kubernetes Version</th>
25+
<td id="center">1.30.5</td>
26+
<td id="center">1.29.9</td>
27+
</tr>
28+
<tr>
29+
<th>KOTS Version</th>
30+
<td id="center" colspan="2">1.120.3</td>
31+
</tr>
32+
</table>
33+
34+
### New Features {#new-features-1-18-0}
35+
* Adds support for passing ConfigValues using the `--config-values` flag for the `install` command. This also enables automated installations of both Embedded Cluster and the application.
36+
37+
### Improvements {#improvements-1-18-0}
38+
* When the Admin Console URL is printed at the end of the `install` command, it will now use the public IP address instead of the private IP address for AWS EC2 instances that use IMDSv2.
39+
* During setup of the Admin Console when a self-signed certificate is used, the instructions are updated to better inform users how to ignore the warning on different browsers.
40+
41+
### Bug Fixes {#bug-fixes-1-18-0}
42+
* Fixes an issue where registry logs weren't included in support bundles.
43+
* Fixes an issue when installing on Azure that caused the Admin Console URL shown at the end of the `install` command to use the private IP address rather than the public IP address.
44+
* Fixes an issue that prevented you from updating an application if the new version contained a required config item without a `default` or `value` set.
45+
* The copy button now works for the command to validate the authenticity of the self-signed certificate during Admin Console setup.
46+
* Fixes an issue where the **Config** page showed an error and wouldn't load.
47+
1348
## 1.17.0
1449

15-
Released on October 31, 2024
50+
Released on November 4, 2024
1651

1752
<table>
1853
<tr>

0 commit comments

Comments
 (0)