Merge branch 'main' into 114155

replicatedhq · Nov 13, 2024 · d9a9189 · d9a9189
2 parents 65398bf + 7000f7b
commit d9a9189
Show file tree

Hide file tree

Showing 21 changed files with 218 additions and 103 deletions.
diff --git a/docs/enterprise/installing-embedded-air-gap.mdx b/docs/enterprise/installing-embedded-air-gap.mdx
@@ -94,56 +94,50 @@ To install with Embedded Cluster in an air gap environment:
 
      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.
 
-1. When the installation command completes, go to the URL provided in the output to access the Admin Console.
-
-    **Example output:** 
+      **Example output:**
 
-    ```bash
-    ✔  Host files materialized
-    ? Enter an Admin Console password: ********
-    ? Confirm password: ********
-    ✔  Host files materialized!
-    ✔  Host preflights succeeded!
-    ✔  Node installation finished!
-    ✔  Storage is ready!
-    ✔  Embedded Cluster Operator is ready!
-    ✔  Admin Console is ready!
-    ✔  Additional components are ready!
-    Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000
-    ```
-    At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.
+      ```bash
+      ? Enter an Admin Console password: ********
+      ? Confirm password: ********
+      ✔  Host files materialized!
+      ✔  Running host preflights
+      ✔  Node installation finished!
+      ✔  Storage is ready!
+      ✔  Embedded Cluster Operator is ready!
+      ✔  Admin Console is ready!
+      ✔  Additional components are ready!
+      Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000
+      ```
+
+      At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.
+
+1. Go to the URL provided in the output to access to the Admin Console.
 
-1. Bypass the browser TLS warning by clicking **Continue to Setup**.
+1. On the Admin Console landing page, click **Start**.
 
-1. Click **Advanced > Proceed**.
+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.
 
-1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
+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.
 
     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.
 
 1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.
 
-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**.
+1. On the **Configure the cluster** screen, optionally add nodes to the cluster before deploying the application. Click **Continue**.
 
-1. On the config screen, complete the fields for the application configuration options and then click **Continue**.
+1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
 
-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**.
+1. On the **Validate the environment & deploy [App Name]** screen, address any warnings or failures identified by the preflight checks and then 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.
-    :::
-
-    :::note
-    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.
-    :::  
+    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.
 
 The Admin Console dashboard opens.
 
 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:
 
 ![Admin console dashboard showing ready status](/images/gitea-ec-ready.png)
 
-[View a larger version of this image](/images/gitea-ec-ready.png) 
+[View a larger version of this image](/images/gitea-ec-ready.png)
 
 ## Add Nodes to Air Gap Clusters
 

diff --git a/docs/enterprise/installing-embedded.mdx b/docs/enterprise/installing-embedded.mdx
@@ -56,48 +56,42 @@ To install an application with Embedded Cluster:
 
      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.
 
-1. When the installation command completes, go to the URL provided in the output to access the Admin Console.
-
-    **Example output:** 
+      **Example output:**
 
-    ```bash
-    ✔  Host files materialized
-    ? Enter an Admin Console password: ********
-    ? Confirm password: ********
-    ✔  Host files materialized!
-    ✔  Host preflights succeeded!
-    ✔  Node installation finished!
-    ✔  Storage is ready!
-    ✔  Embedded Cluster Operator is ready!
-    ✔  Admin Console is ready!
-    ✔  Additional components are ready!
-    Visit the admin console to configure and install gitea-kite: http://104.155.145.60:30000
-    ```
-    At this point, the cluster is provisioned and the KOTS Admin Console is deployed, but the application is not yet installed.
+      ```bash
+      ? Enter an Admin Console password: ********
+      ? Confirm password: ********
+      ✔  Host files materialized!
+      ✔  Running host preflights
+      ✔  Node installation finished!
+      ✔  Storage is ready!
+      ✔  Embedded Cluster Operator is ready!
+      ✔  Admin Console is ready!
+      ✔  Additional components are ready!
+      Visit the Admin Console to configure and install gitea-kite: http://104.155.145.60:30000
+      ```
+
+      At this point, the cluster is provisioned and the Admin Console is deployed, but the application is not yet installed.
 
-1. Bypass the browser TLS warning by clicking **Continue to Setup**.
+1. Go to the URL provided in the output to access to the Admin Console.
 
-1. Click **Advanced > Proceed**.
+1. On the Admin Console landing page, click **Start**.
 
-1. On the HTTPS page, upload your own private key and certificacte or select **Self-signed**.
+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.
+
+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.
 
     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.
 
 1. On the login page, enter the Admin Console password that you created during installation and click **Log in**.
 
-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**.
+1. On the **Configure the cluster** screen, optionally add nodes to the cluster before deploying the application. Click **Continue**.
 
-1. On the config screen, complete the fields for the application configuration options and then click **Continue**.
+1. On the **Configure [App Name]** screen, complete the fields for the application configuration options. Click **Continue**.
 
-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**.
+1. On the **Validate the environment & deploy [App Name]** screen, address any warnings or failures identified by the preflight checks and then 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.
-    :::
-
-    :::note
-    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.
-    :::
+    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.
 
 The Admin Console dashboard opens.
 

diff --git a/docs/partials/embedded-cluster/_ec-config.mdx b/docs/partials/embedded-cluster/_ec-config.mdx
@@ -2,5 +2,5 @@
 apiVersion: embeddedcluster.replicated.com/v1beta1
 kind: Config
 spec:
-  version: 1.16.0+k8s-1.30
+  version: 1.17.0+k8s-1.30
 ```
diff --git a/docs/partials/getting-started/_gitea-ec-config.mdx b/docs/partials/getting-started/_gitea-ec-config.mdx
@@ -2,5 +2,5 @@
 apiVersion: embeddedcluster.replicated.com/v1beta1
 kind: Config
 spec:
-  version: 1.16.0+k8s-1.30
+  version: 1.17.0+k8s-1.30
 ```
diff --git a/docs/partials/kurl/_kurl-availability.mdx b/docs/partials/kurl/_kurl-availability.mdx
@@ -0,0 +1,5 @@
+:::note
+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).
+
+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).
+:::
diff --git a/docs/reference/cron-expressions.md b/docs/reference/cron-expressions.md
@@ -33,7 +33,7 @@ The following table lists the required cron fields and supported values:
     <tr>
       <td>Day-of-month</td>
       <td>1 through 31</td>
-      <td>, - * ? L W </td>
+      <td>, - * ? </td>
     </tr>
     <tr>
       <td>Month</td>
@@ -43,12 +43,14 @@ The following table lists the required cron fields and supported values:
     <tr>
       <td>Day-of-week</td>
       <td>1 through 7 or SUN through SAT</td>
-      <td>, - * ? L</td>
+      <td>, - * ?</td>
     </tr>
   </table>
 
 ## Special Characters
 
+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). 
+
 The following table describes the supported special characters:
 
 <table>
@@ -72,14 +74,6 @@ The following table describes the supported special characters:
       <td>Question mark (?)</td>
       <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>
     </tr>
-    <tr>
-      <td>L</td>
-      <td>Specifies the last day of the month or week respectively for the Day-of-month or Day-of-week fields.</td>
-    </tr>
-    <tr>
-      <td>W</td>
-      <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>
-    </tr>
 </table>
 
 ## Predefined Schedules
@@ -151,18 +145,6 @@ The following examples show valid cron expressions to schedule checking for upda
     30 11 * * *
     ```
 
-- At 6:00 PM on the fourth Monday of every month:
-
-    ```
-    0 18 ? * 2#4
-    ```
-
-- At midnight on the last day of every month:
-
-    ```
-    0 0 L * ?
-    ```
-
 - After 1 hour and 45 minutes, and then every interval following that:
 
   ```

diff --git a/docs/reference/embedded-config.mdx b/docs/reference/embedded-config.mdx
@@ -24,7 +24,7 @@ For additional property-specific limitations, see the sections below.
 apiVersion: embeddedcluster.replicated.com/v1beta1
 kind: Config
 spec:
-  version: 1.16.0+k8s-1.30
+  version: 1.17.0+k8s-1.30
   roles:
     controller:
       name: management

diff --git a/docs/reference/kots-cli-download.md b/docs/reference/kots-cli-download.md
@@ -14,14 +14,16 @@ kubectl kots download [app-slug] [flags]
 This command supports all [global flags](kots-cli-global-flags) and also:
 
 
-| Flag                 | Type | Description |
-|:----------------------|------|-------------|
-| `--decrypt-password-values` | bool | decrypt password values to plaintext |
-| `--dest` | string | the directory to store the application in _(defaults to current working dir)_ |
-| `-h, --help` | | help for download |
-| `-n, --namespace` | string | the namespace to download from _(default `"default"`)_ |
-| `--overwrite` | | overwrite any local files, if present |
-| `-o, --output` | string | output format (currently supported: json) _(defaults to plain text if not set)_ |
+| Flag                        | Type   | Description                                                                                                           |
+|:----------------------------|--------|-----------------------------------------------------------------------------------------------------------------------|
+| `--decrypt-password-values` | bool   | decrypt password values to plaintext                                                                                  |
+| `--dest`                    | string | the directory to store the application in _(defaults to current working dir)_                                         |
+| `--current`                 | bool   | download the archive of the currently deployed app version                                                            |
+| `--sequence`                | int    | sequence of the app version to download the archive for (defaults to the latest version unless --current flag is set) |
+| `-h, --help`                |        | help for download                                                                                                     |
+| `-n, --namespace`           | string | the namespace to download from _(default `"default"`)_                                                                |
+| `--overwrite`               |        | overwrite any local files, if present                                                                                 |
+| `-o, --output`              | string | output format (currently supported: json) _(defaults to plain text if not set)_                                       |
 
 ## Example
 ```bash

diff --git a/docs/release-notes/rn-app-manager.md b/docs/release-notes/rn-app-manager.md
@@ -18,6 +18,24 @@ The following table lists the versions of Kubernetes that are compatible with ea
 
 <!--RELEASE_NOTES_PLACEHOLDER-->
 
+## 1.121.0
+
+Released on November 12, 2024
+
+Support for Kubernetes: 1.29, 1.30, and 1.31
+
+### New Features {#new-features-1-121-0}
+* 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.
+
+## 1.120.3
+
+Released on November 7, 2024
+
+Support for Kubernetes: 1.29, 1.30, and 1.31
+
+### Improvements {#improvements-1-120-3}
+* Various updates for Embedded Cluster.
+
 ## 1.120.2
 
 Released on November 5, 2024

diff --git a/docs/release-notes/rn-embedded-cluster.md b/docs/release-notes/rn-embedded-cluster.md
@@ -10,9 +10,44 @@ This topic contains release notes for the [Replicated Embedded Cluster](/vendor/
 
 Additionally, these release notes list the versions of Kubernetes and Replicated KOTS that are available with each version of Embedded Cluster.
 
+## 1.18.0
+
+Released on November 8, 2024
+
+<table>
+  <tr>
+    <th>Version</th>
+    <td id="center">1.18.0+k8s-1.30</td>
+    <td id="center">1.18.0+k8s-1.29</td>
+  </tr>
+  <tr>
+    <th>Kubernetes Version</th>
+    <td id="center">1.30.5</td>
+    <td id="center">1.29.9</td>
+  </tr>
+  <tr>
+    <th>KOTS Version</th>
+    <td id="center" colspan="2">1.120.3</td>
+  </tr>
+</table>
+
+### New Features {#new-features-1-18-0}
+* 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.
+
+### Improvements {#improvements-1-18-0}
+* 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.
+* 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.
+
+### Bug Fixes {#bug-fixes-1-18-0}
+* Fixes an issue where registry logs weren't included in support bundles.
+* 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.
+* 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.
+* The copy button now works for the command to validate the authenticity of the self-signed certificate during Admin Console setup.
+* Fixes an issue where the **Config** page showed an error and wouldn't load.
+
 ## 1.17.0
 
-Released on October 31, 2024
+Released on November 4, 2024
 
 <table>
   <tr>

diff --git a/docs/release-notes/rn-kubernetes-installer.md b/docs/release-notes/rn-kubernetes-installer.md
@@ -10,6 +10,24 @@ This topic contains release notes for the [Replicated kURL](/vendor/kurl-about)
 
 <!--RELEASE_NOTES_PLACEHOLDER-->
 
+## v2024.11.08-0
+
+Released on November 8, 2024
+
+### Bug Fixes {#bug-fixes-v2024-11-08-0}
+* Fixes an issue where the public-address flag provided to the install script is ignored and not included in the api server cert sans.
+
+## v2024.11.07-0
+
+Released on November 7, 2024
+
+### New Features {#new-features-v2024-11-07-0}
+* Adds support for discovering the EC2 instance public IP address using AWS IMDSv2.
+* Updates [Containerd add-on](https://kurl.sh/docs/add-ons/containerd) to include runc v1.2.1.
+* Adds [Flannel add-on](https://kurl.sh/docs/add-ons/flannel) version 0.26.0.
+* Adds [MinIO add-on](https://kurl.sh/docs/add-ons/minio) version RELEASE.2024-10-29T16-01-48Z.
+* Adds [Prometheus add-on](https://kurl.sh/docs/add-ons/prometheus) version 0.77.2-65.8.0.
+
 ## v2024.10.24-0
 
 Released on October 24, 2024