Skip to content

Commit 0d01dd3

Browse files
authored
Merge branch 'main' into 120396
2 parents bfac104 + 329ba1b commit 0d01dd3

22 files changed

+16309
-14006
lines changed

.github/dependabot.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,18 @@ updates:
55
directory: "/" # Root directory
66
schedule:
77
interval: "weekly"
8+
open-pull-requests-limit: 10
9+
labels:
10+
- "dependencies"
11+
- "npm"
12+
- "type::security"
813

914
# Keep Dependabot itself up to date
1015
- package-ecosystem: "github-actions"
1116
directory: "/" # Root directory (or specify if actions are elsewhere)
1217
schedule:
1318
interval: "weekly"
19+
labels:
20+
- "dependencies"
21+
- "github-actions"
22+
- "type::security"

README.md

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,39 +40,52 @@ This repository has been made public so that vendors and the open-source communi
4040

4141
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4242

43-
When you submit a PR in GitHub, Netlify builds a preview automatically. However, you can preview your changes locally. To do this, you must install `yarn` and run a build to create a Docusaurus preview in your local browser.
43+
When you submit a PR in GitHub, Netlify builds a preview automatically. However, you can preview your changes locally using Node.js and npm. This repository uses npm as its package manager.
4444

45-
### Install yarn
45+
### Prerequisites
4646

47-
The Yarn documentation recommends installing Yarn using the npm package manager, which comes bundled with Node.js when you install it on your system.
47+
- Node.js version 18 or higher
48+
- npm (comes bundled with Node.js)
4849

49-
After you install npm, you can run the following both to install and upgrade Yarn:
50+
### Start the local dev server with `npm start`
5051

51-
```
52-
npm install --global yarn
53-
```
52+
1. Install dependencies using npm:
53+
54+
```bash
55+
npm install
56+
```
5457

55-
If you use Homebrew, you can run this command to install Yarn:
58+
2. Start a local development server in a browser window:
5659

57-
```
58-
$ brew install yarn
59-
```
60+
```bash
61+
npm start
62+
```
6063

61-
### Create a Local Development Server and WYSIWYG Preview
64+
Most changes are reflected live without having to restart the server (changes to the sidebar file typically require restarting the dev server). This preview shows the formatting and styles as they would render on the live site.
6265

63-
1. Install the docusaurus package using Yarn:
66+
If you encounter any build errors, they will appear in the terminal and often indicate issues like broken links or formatting problems in the content.
6467

65-
```
66-
yarn add docusaurus
67-
```
68+
## Build and test locally with `npm run build` and `npm run serve`
6869

69-
1. Run the following command to start a local development server and open up a browser window. Most changes are reflected live without having to restart the server. This preview shows the formatting and styles as they would render on the live site (also known as what-you-see-is-what-you-get or WYSIWYG), which can be more helpful than viewing content in a VS Code preview.
70+
Before pushing changes to the remote repository, build and serve the site locally to check for errors, including broken links.
7071

71-
```
72-
$ yarn start
73-
```
72+
1. Install dependencies using npm:
7473

75-
If `yarn start` refuses to start, try reinstalling the `yarn` CLI. You do not need to uninstall `yarn` before reinstalling it. However, if you get build errors from your content, such as broken links, the Preview itself fails and error messages appear in the terminal that can help you troubleshoot the problems in the content.
74+
```bash
75+
npm install
76+
```
77+
1. Build the static site files:
78+
79+
```bash
80+
npm run build
81+
```
82+
Any broken links and anchor links are listed in the output.
83+
84+
1. Serve the `build` directory locally to test:
85+
86+
```bash
87+
npm run serve
88+
```
7689

7790
## Folder Structure and TOC
7891

docs/enterprise/installing-embedded-automation.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import ConfigValuesExample from "../partials/configValues/_configValuesExample.mdx"
22
import ConfigValuesProcedure from "../partials/configValues/_config-values-procedure.mdx"
33

4-
# Installing with Embedded Cluster from the Command Line
4+
# Automating Installation with Embedded Cluster
55

6-
This topic describes how to install an application with Replicated Embedded Cluster from the command line.
6+
This topic describes how to install an application with Replicated Embedded Cluster from the command line, without needing to access the Replicated KOTS Admin Console.
77

88
## Overview
99

10-
You can use the command line to install an application with Replicated Embedded Cluster. A common use case for installing from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
10+
A common use case for installing with Embedded Cluster from the command line is to automate installation, such as performing headless installations as part of CI/CD pipelines.
1111

12-
To install from the command line, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
12+
With headless installation, you provide all the necessary installation assets, such as the license file and the application config values, with the installation command rather than through the Admin Console UI. Any preflight checks defined for the application run automatically during headless installations from the command line rather than being displayed in the Admin Console.
1313

1414
## Prerequisite
1515

docs/enterprise/installing-embedded-requirements.mdx

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,52 @@ This topic lists the installation requirements for Replicated Embedded Cluster.
3838
</table>
3939

4040
&#42; Required only if the application uses the [Replicated private registry](/vendor/private-images-replicated).
41+
42+
## About Firewalld Configuration
43+
44+
When Firewalld is enabled in the installation environment, Embedded Cluster modifies the Firewalld config to allow traffic over the pod and service networks and to open the required ports on the host. No additional configuration is required.
45+
46+
The following rule is added to Firewalld:
47+
48+
```xml
49+
<?xml version="1.0" encoding="utf-8"?>
50+
<zone target="ACCEPT">
51+
<interface name="cali+"/>
52+
<interface name="tunl+"/>
53+
<interface name="vxlan-v6.calico"/>
54+
<interface name="vxlan.calico"/>
55+
<interface name="wg-v6.cali"/>
56+
<interface name="wireguard.cali"/>
57+
<source address="[pod-network-cidr]"/>
58+
<source address="[service-network-cidr]"/>
59+
</zone>
60+
```
61+
62+
The following ports are opened in the default zone:
63+
64+
<table>
65+
<tr>
66+
<th>Port</th>
67+
<th>Protocol</th>
68+
</tr>
69+
<tr>
70+
<td>6443</td>
71+
<td>TCP</td>
72+
</tr>
73+
<tr>
74+
<td>10250</td>
75+
<td>TCP</td>
76+
</tr>
77+
<tr>
78+
<td>9443</td>
79+
<td>TCP</td>
80+
</tr>
81+
<tr>
82+
<td>2380</td>
83+
<td>TCP</td>
84+
</tr>
85+
<tr>
86+
<td>4789</td>
87+
<td>UDP</td>
88+
</tr>
89+
</table>

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.21.0+k8s-1.30
5+
version: 2.1.3+k8s-1.30
66
```

docs/partials/embedded-cluster/_port-reqs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Additionally, port 30000 must be accessible by nodes joining the cluster.
3636

3737
If port 30000 is occupied, you can select a different port for the Admin Console during installation. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).
3838

39-
#### LAM Port (Air Gap Only)
39+
#### LAM Port
4040

41-
In addition to the ports above, air gap installations also require that port 50000/TCP is open and available for the Local Artifact Mirror (LAM).
41+
The Local Artifact Mirror (LAM) requires that port 50000/TCP is open and available.
4242

4343
If port 50000 is occupied, you can select a different port for the LAM during installation. For more information, see [Embedded Cluster Install Command Options](/reference/embedded-cluster-install).

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.21.0+k8s-1.30
5+
version: 2.1.3+k8s-1.30
66
```

docs/partials/replicated-sdk/_dependency-yaml.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
dependencies:
44
- name: replicated
55
repository: oci://registry.replicated.com/library
6-
version: 1.1.0
6+
version: 1.1.1
77
```
88
99
For the latest version information for the Replicated SDK, see the [replicated-sdk repository](https://github.com/replicatedhq/replicated-sdk/releases) in GitHub.

docs/reference/embedded-cluster-install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ sudo ./APP_SLUG install --license LICENSE_FILE [flags]
4848
<tr>
4949
<td>`--config-values`</td>
5050
<td>
51-
<p>Path to the ConfigValues file for the application. The ConfigValues file can be used to pass the application configuration values from the command line during installation, such as when performing automated installations as part of CI/CD pipelines. For more information, see [Installing with Embedded Cluster from the Command Line](/enterprise/installing-embedded-automation).</p>
51+
<p>Path to the ConfigValues file for the application. The ConfigValues file can be used to pass the application configuration values from the command line during installation, such as when performing automated installations as part of CI/CD pipelines. For more information, see [Automating Installation with Embedded Cluster](/enterprise/installing-embedded-automation).</p>
5252
<p><strong>Requirement:</strong> Embedded Cluster 1.18.0 and later.</p>
5353
</td>
5454
</tr>

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.21.0+k8s-1.30
27+
version: 2.1.3+k8s-1.30
2828
roles:
2929
controller:
3030
name: management

0 commit comments

Comments
 (0)