-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release-4-4' into edge-cli-update
- Loading branch information
Showing
48 changed files
with
48,569 additions
and
65,831 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -65,4 +65,6 @@ artifact.zip | |
|
||
# Netlify | ||
|
||
.netlify/ | ||
.netlify/ | ||
# Ignore _partials/index.ts | ||
_partials/index.ts |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
113,045 changes: 47,470 additions & 65,575 deletions
113,045
docs/api-content/api-docs/palette-apis.json
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
docs/docs-content/clusters/edge/cluster-management/certificate-renewal.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
17 changes: 17 additions & 0 deletions
17
docs/docs-content/clusters/edge/cluster-management/cluster-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.