Skip to content

Commit ff6be3c

Browse files
authored
Merge branch 'master' into doc-2423-slack-notif-sec-advisories
2 parents daf298f + c6d386e commit ff6be3c

File tree

19 files changed

+382
-332
lines changed

19 files changed

+382
-332
lines changed

.github/workflows/clean-up-unused-images.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# This workflow removed unused images from the repository and creates a PR to clean them up.
2-
# The workflow runs on the first day of every month at 2 am UTC.
2+
# The workflow runs on the first day of every month at 12PM UTC.
33
# Any image that is not referenced in the repository is considered unused.
44
# This workflow supports on-demand execution using the workflow_dispatch event.
55

66
name: Clean Up Unused Images
77

88
on:
99
schedule:
10-
# On the first of every month at 2 am
11-
- cron: '0 2 1 * *'
10+
# On the first of every month at 12 PM UTC
11+
- cron: '0 12 1 * *'
1212
workflow_dispatch:
1313

1414
concurrency:

.github/workflows/spellcheck-report.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# This workflow runs the set of core vale checks on the entire repo.
2-
# The workflow runs every Monday at 8 am UTC.
2+
# The workflow runs every Monday at 4PM UTC.
33
# This workflow supports on-demand execution using the workflow_dispatch event.
44

55
name: Spellcheck Entire Librarium
66
on:
77
schedule:
8-
# Every Monday at 8AM UTC
9-
- cron: '0 8 * * 1'
8+
# Every Monday at 4PM UTC
9+
- cron: '0 16 * * 1'
1010
workflow_dispatch:
1111

1212
concurrency:

.github/workflows/url-checks.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# This workflow scans the markdown files in the repository for broken URLs.
22
# Additional logic is added to the Make command verify-rate-limited-links-ci to check for rate-limited URLs, including guidance on what domains to ignore.
3-
# The workflow is scheduled to run every Monday at 6 am.
3+
# The workflow is scheduled to run every Monday at 2PM UTC.
44

55
on:
66
schedule:
7-
# Every Monday at 6 am
8-
- cron: '0 6 * * 1'
7+
# Every Monday at 2PM UTC
8+
- cron: '0 14 * * 1'
99
workflow_dispatch:
1010

1111

_partials/self-hosted/feature-flags/_feature-flags-intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The following table lists all available feature flags and their supported platfo
1717
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----------------: | :------------------------: |
1818
| **AwsSecretPartition** | Configure [AWS Secret Cloud](https://aws.amazon.com/federal/secret-cloud/) and [AWS Top Secret Cloud](https://aws.amazon.com/federal/top-secret-cloud/) accounts and deploy EKS clusters in AWS Secret and Top Secret clouds. Refer to our [Register and Manage AWS Accounts](/clusters/public-cloud/aws/add-aws-accounts) guide for more information. | :x: | :white_check_mark: |
1919
| **AzureUSSecretCloud** | Configure [Azure Government Secret cloud](https://azure.microsoft.com/en-us/explore/global-infrastructure/government/national-security) accounts and deploy Azure IaaS clusters in Azure Government Secret cloud. Refer to our [Register and Manage Azure Accounts](/clusters/public-cloud/azure/azure-cloud/#azure-government-secret-cloud) guide for more information. | :x: | :white_check_mark: |
20-
| **LxdMaas** | Spawn multiple control plane nodes as LXD VMs and consolidate them on MAAS-managed servers while your worker nodes run on bare metal devices. Refer to our [Create and Manage MAAS Clusters Using LXD VMs](/clusters/data-center/maas/create-manage-maas-lxd-clusters/) /> guide for more information. | :white_check_mark: | :white_check_mark: |
20+
| **LxdMaas** | Spawn multiple control plane nodes as LXD VMs and consolidate them on MAAS-managed servers while your worker nodes run on bare metal devices. Refer to our [Create and Manage MAAS Clusters Using LXD VMs](/clusters/data-center/maas/create-manage-maas-lxd-clusters/) guide for more information. | :white_check_mark: | :white_check_mark: |
2121
| **ApacheCloudStack** | Allows for the creation of workloads on Apache CloudStack. Refer to our [Create and Manage Apache CloudStack Clusters](/clusters/data-center/cloudstack/create-manage-cloudstack-clusters/) guide for more information. | :white_check_mark: | :white_check_mark: |
2222

2323

_partials/self-hosted/management-appliance/_installation-steps-enablement.mdx

Lines changed: 41 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -20,75 +20,20 @@ partial_name: installation-steps-enablement
2020

2121
4. Restart the nodes to start the installation process.
2222

23-
5. Once the nodes have rebooted and entered the GRand Unified Bootloader (GRUB) menu, select the **Palette eXtended Kubernetes Edge Install (manual)** option and press **ENTER**.
23+
5. Once the nodes have rebooted and entered the GRand Unified Bootloader (GRUB) menu, allow {props.version} to select the **Palette Edge Interactive Installer** boot option automatically.
2424

25-
:::caution
25+
6. Once the **Palette Edge Interactive Installer** window appears, select the target disk for installation.
2626

27-
Ensure that you select the option within the first five seconds of the GRUB menu appearing, as it will automatically proceed with the default installation option after this time.
27+
7. Choose the post-installation action: **nothing**, **reboot**, or **poweroff**, then press **ENTER**.
2828

29-
:::
29+
8. Review the **Installation Summary**.
3030

31-
6. Once the nodes have finished booting, in the terminal, issue the following command to list the block devices.
31+
9. Press **ENTER** to start the installation.
3232

33-
```bash
34-
lsblk --paths
35-
```
33+
10. Wait for the installation process to complete. This will take at least 15 minutes, depending on the resources
34+
available on the nodes. If you selected the **reboot** option in step 7, the nodes will reboot and display the Palette TUI after completion. If you chose the **poweroff** action in step 7, power on the nodes.
3635

37-
Use the output to identify the device name to use for the {props.version} ISO stack. For example, `/dev/sda`.
38-
39-
```shell hideClipboard title="Example output" {3}
40-
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
41-
/dev/loop0 7:0 0 1G 1 loop /run/rootfsbase
42-
/dev/sda 8:0 0 250G 0 disk
43-
/dev/sdb 8:16 0 5000G 0 disk
44-
/dev/sr0 11:0 1 17.3G 0 rom /run/initramfs/live
45-
```
46-
47-
7. If there are any partitions on the device you plan to use for the installation, you must delete them before proceeding. For example, if the device is `/dev/sda`, issue the following command to delete all partitions on the device.
48-
49-
```bash
50-
wipefs --all /dev/sda
51-
```
52-
53-
:::danger
54-
55-
Deleting partitions will erase all data on the device. Ensure that you back up any important data before proceeding.
56-
57-
:::
58-
59-
8. Issue the following command to edit the installation manifest.
60-
61-
```bash
62-
vi /oem/stylus_config.yaml
63-
```
64-
65-
9. Add the following `install.device` section to your manifest, replacing `<storage-drive>` with the device name identified in step 6.
66-
67-
```yaml hideClipboard {6}
68-
#cloud-config
69-
70-
cosign: false
71-
verify: false
72-
install:
73-
device: <storage-drive>
74-
grub-entry-name: "Palette eXtended Kubernetes Edge"
75-
system:
76-
size: 8192
77-
...
78-
```
79-
80-
10. Save the changes and exit the editor.
81-
82-
11. Issue the following command to start the installation process.
83-
84-
```bash
85-
kairos-agent install
86-
```
87-
88-
12. Wait for the installation process to complete. This will take at least 15 minutes, depending on the resources
89-
available on the nodes. After completion, the nodes will reboot and display the Palette TUI.
90-
91-
13. In the Palette TUI, provide credentials for the initial account. This account will be used to log in to Local UI and for SSH access to the node.
36+
11. In the Palette TUI, provide credentials for the initial account. This account will be used to log in to Local UI and for SSH access to the node.
9237

9338
| **Field** | **Description** |
9439
|--------------------------|--------------------------------------------|
@@ -98,13 +43,13 @@ partial_name: installation-steps-enablement
9843

9944
Press **ENTER** to continue.
10045

101-
14. In the Palette TUI, the available configuration options are displayed and are described in the next three steps.
46+
12. In the Palette TUI, the available configuration options are displayed and are described in the next three steps.
10247
Use the **TAB** key or the up and down arrow keys to switch between fields. When you make a change, press **ENTER**
10348
to apply the change. Use **ESC** to go back.
10449

105-
15. In **Hostname**, check the existing hostname and, optionally, change it to a new one.
50+
13. In **Hostname**, check the existing hostname and, optionally, change it to a new one.
10651

107-
16. In **Network Adapter**, select a network adapter to configure. By default, the network adapters request an IP
52+
14. In **Network Adapter**, select a network adapter to configure. By default, the network adapters request an IP
10853
automatically from the Dynamic Host Configuration Protocol (DHCP) server. The Classless Inter-Domain Routing (CIDR)
10954
block of an adapter's possible IP address is displayed in the **Network Adapter** screen without selecting an
11055
individual adapter.
@@ -122,10 +67,10 @@ partial_name: installation-steps-enablement
12267
- You can also specify the Maximum Transmission Unit (MTU) for your network adapter. The MTU defines the largest size,
12368
in bytes, of a packet that can be sent over a network interface without needing to be fragmented.
12469

125-
17. In **DNS Configuration**, specify the IP address of the primary and alternate name servers. You can optionally
70+
15. In **DNS Configuration**, specify the IP address of the primary and alternate name servers. You can optionally
12671
specify a search domain.
12772

128-
18. After you are satisfied with the configurations, navigate to **Quit** and press **ENTER** to finish the
73+
16. After you are satisfied with the configurations, navigate to **Quit** and press **ENTER** to finish the
12974
configuration. Press **ENTER** again on the confirmation prompt.
13075

13176
After a few seconds, the terminal displays the **Device Info** and prompts you to provision the device through Local UI.
@@ -136,11 +81,11 @@ partial_name: installation-steps-enablement
13681

13782
:::
13883

139-
19. Ensure you complete the configuration on each node before proceeding to the next step.
84+
17. Ensure you complete the configuration on each node before proceeding to the next step.
14085

141-
20. Decide on the host that you plan to use as the leader of the group. Refer to <VersionedLink text="Link Hosts" url="/clusters/edge/local-ui/cluster-management/link-hosts#leader-hosts"/> for more information about leader hosts.
86+
18. Decide on the host that you plan to use as the leader of the group. Refer to <VersionedLink text="Link Hosts" url="/clusters/edge/local-ui/cluster-management/link-hosts#leader-hosts"/> for more information about leader hosts.
14287

143-
21. Access the Local UI of the leader host. Local UI is used to manage the {props.version} nodes and perform administrative
88+
19. Access the Local UI of the leader host. Local UI is used to manage the {props.version} nodes and perform administrative
14489
tasks. It provides a web-based interface for managing the {props.version} management cluster.
14590

14691
In your web browser, go to `https://<node-ip>:5080`. Replace `<node-ip>` with the IP address of your node. If you
@@ -151,31 +96,31 @@ partial_name: installation-steps-enablement
15196
is because Local UI uses a self-signed certificate. You can safely ignore this warning and proceed to Local
15297
UI.
15398

154-
22. Log in to Local UI using the credentials you provided in step 10.
99+
20. Log in to Local UI using the credentials you provided in step 11.
155100

156-
23. (Optional) If you need to configure a HTTP proxy server for the node, follow the steps in the <VersionedLink text="Configure HTTP-Proxy in Local UI" url="/clusters/edge/local-ui/host-management/configure-proxy"/> guide. When done, proceed to the next step.
101+
21. (Optional) If you need to configure a HTTP proxy server for the node, follow the steps in the <VersionedLink text="Configure HTTP-Proxy in Local UI" url="/clusters/edge/local-ui/host-management/configure-proxy"/> guide. When done, proceed to the next step.
157102

158-
24. From the left main menu, click **Linked Edge Hosts**.
103+
22. From the left main menu, click **Linked Edge Hosts**.
159104

160-
25. Click **Generate token**. The host begins generating tokens that you will use to link this host with other
105+
23. Click **Generate token**. The host begins generating tokens that you will use to link this host with other
161106
hosts. The Base64 encoded token contains the IP address of the host, as well as an OTP that will expire in two
162107
minutes. Once a token expires, the leader generates another token automatically.
163108

164-
26. Click the **Copy** button to copy the token.
109+
24. Click the **Copy** button to copy the token.
165110

166-
27. Log in to Local UI on the host that you want to link to the leader host.
111+
25. Log in to Local UI on the host that you want to link to the leader host.
167112

168-
28. From the left main menu, click **Linked Edge Hosts**.
113+
26. From the left main menu, click **Linked Edge Hosts**.
169114

170-
29. Click **Link this device to another**.
115+
27. Click **Link this device to another**.
171116

172-
30. In the pop-up box that appears, enter the token you copied from the leader host.
117+
28. In the pop-up box that appears, enter the token you copied from the leader host.
173118

174-
31. Click **Confirm**.
119+
29. Click **Confirm**.
175120

176-
32. Repeat steps 27-31 for every host you want to link to the leader host.
121+
30. Repeat steps 25-29 for every host you want to link to the leader host.
177122

178-
33. Confirm that all linked hosts appear in the **Linked Edge Hosts** table. The following columns should show the
123+
31. Confirm that all linked hosts appear in the **Linked Edge Hosts** table. The following columns should show the
179124
required statuses.
180125

181126
| **Column** | **Status** |
@@ -186,19 +131,19 @@ partial_name: installation-steps-enablement
186131

187132
Content synchronization will take at least five minutes to complete, depending on your network resources.
188133

189-
34. On the left main menu, click **Cluster**.
134+
32. On the left main menu, click **Cluster**.
190135

191-
35. Click **Create cluster**.
136+
33. Click **Create cluster**.
192137

193-
36. For **Basic Information**, provide a name for the cluster and optional tags in `key:value` format.
138+
34. For **Basic Information**, provide a name for the cluster and optional tags in `key:value` format.
194139

195-
37. In **Cluster Profile**, the **Imported Applications preview** section displays the applications that are included
140+
35. In **Cluster Profile**, the **Imported Applications preview** section displays the applications that are included
196141
with the {props.app}. These applications are pre-configured and used to deploy your {props.version} management
197142
cluster.
198143

199144
Leave the default options in place and click **Next**.
200145

201-
38. In **Profile Config**, configure the cluster profile settings to your requirements. Review the following tables for
146+
36. In **Profile Config**, configure the cluster profile settings to your requirements. Review the following tables for
202147
the available options.
203148

204149
#### Cluster Profile Options
@@ -227,9 +172,9 @@ partial_name: installation-steps-enablement
227172
| **Root Domain (Optional)** | The root domain for the registry. The default is set for the internal Zot registry, which is a virtual IP address assigned by [kube-vip](https://kube-vip.io/). If using an external registry, adjust this to the appropriate domain. | String | **`{{.spectro.system.cluster.kubevip}}`** |
228173
| **Mongo Replicas** | The number of MongoDB replicas to create for the cluster. The accepted values are `1` or `3`. We recommend using **3** to provide high availability for the MongoDB database. _This value must match the **CSI Placement Count** value._ | Integer | **`3`** |
229174

230-
39. Click **Next** when you are done.
175+
37. Click **Next** when you are done.
231176

232-
40. In **Cluster Config**, configure the following options.
177+
38. In **Cluster Config**, configure the following options.
233178

234179
#### Cluster Config Options
235180

@@ -241,7 +186,7 @@ partial_name: installation-steps-enablement
241186

242187
Click **Next** when you are done.
243188

244-
41. In **Node Config**, configure the following options.
189+
39. In **Node Config**, configure the following options.
245190

246191
:::important
247192

@@ -290,9 +235,9 @@ partial_name: installation-steps-enablement
290235
| **NIC Name** | The name of the network interface card (NIC) to use for the nodes. Leave on **Auto** to let the system choose the appropriate NIC, or select one manually from the drop-down menu. | N/A | **Auto** |
291236
| **Host Name (Optional)** | The hostname for the nodes. This is used to identify the nodes in the cluster. A generated hostname is provided automatically, which you can adjust to your requirements. | String | **`edge-*`** |
292237

293-
42. Click **Next** when you are done.
238+
40. Click **Next** when you are done.
294239

295-
43. In **Review**, check that your configuration is correct. If you need to make changes, click on any of the sections
240+
41. In **Review**, check that your configuration is correct. If you need to make changes, click on any of the sections
296241
in the left sidebar to go back and edit the configuration.
297242

298243
When you are satisfied with your configuration, click **Deploy Cluster**. This will start the cluster creation
@@ -302,17 +247,17 @@ partial_name: installation-steps-enablement
302247
on the **Cluster** page in the left main menu. The cluster is fully provisioned when the status changes to
303248
**Running** and the health status is **Healthy**.
304249

305-
44. Once the cluster is provisioned, access the {props.version} system console using the virtual IP address (VIP) you configured
250+
42. Once the cluster is provisioned, access the {props.version} system console using the virtual IP address (VIP) you configured
306251
earlier. Open your web browser and go to `https://<vip-address>/system`. Replace `<vip-address>` with the VIP you
307252
configured for the cluster.
308253

309254
The first time you visit the system console, a warning message about an untrusted TLS certificate may appear. This
310255
is expected, as you have not yet uploaded your TLS certificate. You can ignore this warning message and proceed.
311256

312-
45. You will be prompted to log in to {props.version} system console. Use `admin` as the username and `admin` as the password.
257+
43. You will be prompted to log in to {props.version} system console. Use `admin` as the username and `admin` as the password.
313258
You will be prompted to change the password after logging in.
314259

315-
46. In the **Account Info** window, provide the following information.
260+
44. In the **Account Info** window, provide the following information.
316261

317262
| **Field** | **Description** |
318263
|--------------------------|--------------------|

0 commit comments

Comments
 (0)