Skip to content

Commit

Permalink
Merge branch 'release-4-4' into edge-cli-update
Browse files Browse the repository at this point in the history
  • Loading branch information
lennessyy committed May 30, 2024
2 parents 866d921 + 81cddc2 commit d89b6ae
Show file tree
Hide file tree
Showing 48 changed files with 48,569 additions and 65,831 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,6 @@ artifact.zip

# Netlify

.netlify/
.netlify/
# Ignore _partials/index.ts
_partials/index.ts
6 changes: 6 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ init: ## Initialize npm dependencies
npx husky install

start: ## Start a local development server
make generate-partials
npm run start

build: ## Run npm build
Expand Down Expand Up @@ -203,6 +204,11 @@ format-images: ## Format images
@echo "formatting images in /static/assets/docs/images/ folder"
./scripts/compress-convert-images.sh

###@ Generate _partials/index.ts required to automatic partials usage.

generate-partials: ## Generate
./scripts/generate-partials.sh

###@ Aloglia Indexing

update-dev-index: ## Update the Algolia index for the dev environment
Expand Down
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,6 +554,64 @@ scheme. The rows of cards are dynamically created according to the list of speci
/>
```
## Partials Component
This is a custom component that allows you to create and use
[Import Markdown](https://docusaurus.io/docs/3.2.1/markdown-features/react#importing-markdown).
Partials must be created under the `_partials` folder. They must be named using an `_` prefix and the `*.mdx` filetype.
Partials may be organised in any further subfolders as required. For example, you could create
`_partials/public-cloud/_palette_setup.mdx`.
In order to aid with organisation and categorization, partials must have a `partial_category` and `partial_name` defined
in their frontmatter:
```mdx
---
partial_category: public-cloud
partial_name: palette-setup
---
This is how you set up Palette in {props.cloud}.
```
Partials are customized using properties which can be read using the `{props.field}` syntax.
Once your partial has been created, run the `make generate-partials` command to make your partial available for use.
This command will also be invoked during the `make start` and `make build` commands.
Finally, you can reference your partial in any `*.md` file by using the `PartialsComponent`, together with the specified
category and name of the partial:
```md
<PartialsComponent
category="public-cloud"
name="palette-setup"
cloud="AWS"
/>
```
Note that the `cloud` field corresponds to the `{props.cloud}` reference in the `*.mdx` file.
### Internal Links
Due to the complexities of Docusaurus plugin rendering, links do not support versioning in `*.mdx` files. If you want to
add an internal link you will have to use the `VersionedLink` component inside the `*.mdx` file.
```mdx
---
partial_category: public-cloud
partial_name: palette-setup
---
This is how you set up Palette in {props.cloud}.
This is an <VersionedLink name="Internal Link" url="/getting-started/additional-capabilities"/>.
```
The path of the link should be the path of the destination file from the root directory, without any back operators
`..`. External links can be referenced as usual.
## Netlify Previews
By default Netlify previews are enabled for pull requests. However, some branches do not require Netlify previews. In
Expand Down
8 changes: 8 additions & 0 deletions _partials/_partial_example.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
partial_category: example-cat
partial_name: example-name
---

This is an example partial with an example property. {props.message}

Read more about how to use partials in our [README](https://github.com/spectrocloud/librarium/blob/master/README.md).
2 changes: 1 addition & 1 deletion docs/api-content/api-docs/1-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ host name.

```shell
curl --location 'https://10.10.135.182:5080/v1/edge-mgmt/edgehosts/current' \
--header 'Cookie: Authorization=*******'
--header 'Authorization: *******'
```

```hideClipboard
Expand Down
113,045 changes: 47,470 additions & 65,575 deletions docs/api-content/api-docs/palette-apis.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Palette allows you to update active clusters. You can update any layer of a clus
and add-on layers. Depending on the nature of the update, a cluster update could trigger different cluster repave
operations. For more information, refer to
[Repave Behaviors and Configurations](./node-pool.md#repave-behavior-and-configuration) for non-Edge clusters and
[Edge Cluster Upgrade Behavior](../edge/upgrade-behavior.md) for Edge clusters. operations.
[Edge Cluster Upgrade Behavior](../edge/cluster-management/upgrade-behavior.md) for Edge clusters. operations.

:::info

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/cluster-management/node-pool.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Different types of repaving operations may occur, depending on what causes them:
:::info

This section only applies to non-Edge clusters. To learn about the upgrade behavior of Edge clusters, refer to the
[Edge Cluster Upgrade Behavior](../edge/upgrade-behavior.md) page.
[Edge Cluster Upgrade Behavior](../edge/cluster-management/upgrade-behavior.md) page.

:::

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
---
sidebar_label: "Renew Certificates for Air-gap Clusters"
title: "Renew Certificates for Air-gap Clusters"
description: "Learn how to renew certificates for different Kubernetes components in your cluster."
hide_table_of_contents: false
sidebar_position: 80
tags: ["edge", "architecture"]
---

Kubernetes uses SSL certificates to secure the communication between different components of a cluster. Using these
certificates allows Kubernetes to secure API connections, verify the authenticity of the nodes, and encrypt connections.
All certificates have an expiry date, and need to be renewed periodically.

This page guides you through the different methods used to renew certificates in an air-gapped Palette Edge cluster. An
air-gapped cluster means a cluster that has no connection to a Palette instance.

## Limitations

- The procedure described in this guide only renews certificates for control plane nodes. Certificate renewal for worker
nodes is not supported.
- The certificates used are generated by Kubernetes. You cannot use your own certificates.

## Automatic Renewal

Palette Edge will automatically renew all control plane certificates your cluster uses for you 30 days before they
expire. You can follow the steps below to check when the next automatic renewal will happen.

### Prerequisite

- You have an active cluster in a air-gapped Edge host.
- You have access to the local UI for the Edge host. For more information, refer to
[Access Local UI](../local-ui/host-management/access-console.md).

### Check Next Auto Renewal Time

1. Log in to [local UI](../local-ui/host-management/access-console.md).

2. From the left **Main Menu**, select **Cluster**.

3. Select the **Overview** tab on the **Cluster** page.

4. In **Overview**, click **View Certificates** in the **Kubernetes Certificates** row. This will display all the
certificates currently in use by your cluster.

5. The next renewal time, which is 30 days before the expiry date, for your certificates is at the top of the pop-up
box.

### Validate

In **Overview**, click **View Certificates** in the **Kubernetes Certificates** row. This will display all the
certificates currently in use by your cluster. You can confirm that the certificates have been renewed by looking at the
issue date of certificates.

## Manual Renewal

You can also manually renew your certificates whenever you want. You can do this through the local UI or through the
Edge Management API.

### Prerequisite

- You have an active cluster in a air-gapped Edge host.
- You have access to the local UI for the Edge host. For more information, refer to
[Access Local UI](../local-ui/host-management/access-console.md).

### Manually Renew Certificates

<Tabs group="methods">

<TabItem label="Local UI" value="ui">

1. Log in to [local UI](../local-ui/host-management/access-console.md).

2. From the left **Main Menu**, select **Cluster**.

3. Select the **Overview** tab on the **Cluster** page.

4. In **Overview**, click **View Certificates** in the **Kubernetes Certificates** row. This will display all the
certificates currently in use by your cluster.

5. Click **Renew** to renew all certificates used by the cluster.

</TabItem>

<TabItem label="API" value="api">

1. Issue the following command to call the Edge Management authentication API. Replace `edge-host-ip` with the IP of
your Edge host and replace `os-username` and `os-password` with your Operating System (OS) user credentials.

```shell
curl --location 'https://edge-host-ip:5080/v1/users/default/login' \
--header 'Content-Type: application/json' \
--data '{
"username": "os-username",
"password": "os-password"
}'
```

This will return an authentication token.

```json
{
"Token": {
"Authorization": "******"
}
}
```

2. Issue the following command to call the endpoint to renew your control plane node certificates. Put the
authentication token you obtained in the previous step in the header.

```shell
curl -X POST "https://edge-host-ip:5080/v1/edge-mgmt/cluster/renew-certificates" \
--header "Authorization: *******"
```

This will renew all certificates on the control plane nodes.

</TabItem>

</Tabs>

### Validate

In **Overview**, click **View Certificates** in the **Kubernetes Certificates** row. This will display all the
certificates currently in use by your cluster. You can confirm that the certificates have been renewed by looking at the
issue date of certificates.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: "Cluster Management"
title: "Cluster Management for Edge Clusters"
description: "Learn about the different available day-2 operations for Edge clusters."
hide_table_of_contents: false
sidebar_position: 55
tags: ["edge", "architecture"]
---

After deployment, Palette Edge offers several options to manage Kubernetes clusters on an ongoing basis, such as
upgrading software versions and managing certificate renewals. This section provides you with resources on day-2
operations for your Palette Edge cluster.

## Resources

- [Edge Cluster Upgrade Behavior](upgrade-behavior.md)
- [Renew Certificates](certificate-renewal.md)
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ tags: ["edge", "architecture"]
When you update an active Edge cluster's profile, Palette will upgrade the active cluster to the latest version of the
profile. Depending on the nature of the change, implementing an upgrade might involve repaving a cluster, rebooting a
cluster, restarting services, or doing nothing. For more information about cluster repaves, refer to
[Repave Behavior and Configurations](../cluster-management/node-pool.md#repave-behavior-and-configuration). For more
information about how to update a cluster profile, refer to
[Update a Cluster](../cluster-management/cluster-updates.md).
[Repave Behavior and Configurations](../../../clusters/cluster-management/node-pool.md#repave-behavior-and-configuration).
For more information about how to update a cluster profile, refer to
[Update a Cluster](../../../clusters/cluster-management/cluster-updates.md).

:::warning

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,13 @@ stylus:

### Initial Configuration

You can configure the Edge Installer to enable the initial configuration in the Terminal User Interface (TUI) when you
boot up the Edge host for the first time. For more information about initial configuration, refer to
You can configure the Edge Installer to enable the initial configuration in the Palette Terminal User Interface (TUI)
when you boot up the Edge host for the first time. For more information about initial configuration, refer to
[Initial Edge Host Configuration](../site-deployment/initial-setup.md).

| Parameter | Description |
| ------------ | --------------------------------------------------------------------- |
| `includeTui` | Enable the initial Edge host configuration. Default value is `false`. |
| Parameter | Description |
| ------------ | --------------------------------------------------------------------------------- |
| `includeTui` | Enable Palette TUI for initial Edge host configuration. Default value is `false`. |

For example, the following configuration enables the Palette TUI.

Expand Down
Loading

0 comments on commit d89b6ae

Please sign in to comment.