Skip to content

Commit

Permalink
docs: add base64 requirement (#4500) (#4502)
Browse files Browse the repository at this point in the history 
* docs: add clarification

* docs: fix font awesome

* docs: style guide

* docs: fix font awesome

* docs: add prereq

* docs: fix typo

---------

Co-authored-by: Lenny Chen <[email protected]>
(cherry picked from commit ab546a7)

Co-authored-by: Lenny Chen <[email protected]>
  • Loading branch information
@vault-token-factory-spectrocloud @lennessyy
vault-token-factory-spectrocloud[bot] and lennessyy authored Oct 29, 2024
1 parent bf29864 commit 3c4b26a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/edge/edge-configuration/installer-reference.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The `stylus.site` blocks accept the following parameters.

| Parameter | Description | Default |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| `stylus.site.caCerts` | The Secure Sockets Layer (SSL) certificate authority (CA) certificates. | |
| `stylus.site.caCerts` | The Secure Sockets Layer (SSL) Certificate Authority (CA) certificates. The certificates must be base64-encoded. | |
| `stylus.site.clusterId` | The ID of the host cluster the edge host belongs to. | |
| `stylus.site.clusterName` | The name of the host cluster the edge host belongs to. | |
| `stylus.site.deviceUIDPaths` | Specify the file path for reading in product or board serial that can be used to set the device ID. The default file path is **/sys/class/dmi/id/product_uuid**. Refer to the [Device ID (UID) Parameters](#device-id-uid-parameters) section to learn more. | |
Expand Down
6 changes: 5 additions & 1 deletion docs/docs-content/clusters/edge/local-ui/host-management/configure-proxy.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ The proxy server configured through the local UI will be retained even after a

- An active HTTP proxy server.

- If your Certificate Authority (CA) certificates are not base64-encoded, you need a utility or tool to convert the
certificate and key files to base64-encoded strings. You can use the `base64` command in Unix-based systems.
Alternatively, you can use an online tool to convert the files to base64-encoded strings.

## Configure HTTP Proxy

1. Log in to the local UI. You should be directed to the **Edge Host** page after signing in. If not, click on **Edge
Expand All @@ -43,7 +47,7 @@ The proxy server configured through the local UI will be retained even after a
| HTTP Endpoint | The address where the HTTP proxy server is located. It's used to route HTTP traffic through the proxy. |
| HTTPS Endpoint | The address where the HTTPS proxy server is located. It's used to route HTTPS traffic through the proxy. |
| No Proxy | Specifies exceptions to the proxy rules. It lists addresses or domains that should bypass the proxy and connect directly, useful for local or internal network resources. |
| CA Certificates | CA certificates that are used to authenticate the proxy server. |
| CA Certificates | CA certificates that are used to authenticate the proxy server. The certificates must be base64-encoded. |

4. Click **Confirm**. Updating the HTTP proxy settings causes HTTP/HTTPS services on the Edge host to restart, so you
will not be able to access the console for a short duration .
Expand Down

0 comments on commit 3c4b26a

Please sign in to comment.