Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: miscellaneous updates (edge) #1936

Merged
merged 4 commits into from
Dec 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions docs/docs-content/clusters/edge/networking/vxlan-overlay.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ The Analytics team of a manufacturing company is deploying an Edge host to their

## Prerequisites

* At least one Edge host with an AMD64 or X86_64 processor architecture registered with your Palette account.
* At least one Edge host registered with your Palette account.
* Your cluster profile must have K3s as its Kubernetes distribution.
* All Edge hosts must be on the same network. You may provision your own virtual network to connect Edge hosts that are on different physical networks, but all Edge hosts to be included in the cluster must be on the same network before cluster creation.

## Enable Overlay Network
Expand All @@ -57,7 +58,15 @@ You will not be able to change the network overlay configurations after the clus

6. Select a cluster profile. If you don't have a cluster profile for Edge Native, refer to the [Create Edge Native Cluster Profile](../site-deployment/model-profile.md) guide. Click on **Next** after you have selected a cluster profile.

7. In the network layer of your cluster profile, specify the name of the Network Interface Controllers (NIC) on your Edge hosts to be `scbr-100`. This is the name of the interface Palette creates on your Edge devices to establish the overlay network.
7. In the Kubernetes layer of the cluster profile, add the parameter `cluster.kubevipArgs.vip_interface` and set its value to `scbr-100`:

```yaml
cluster:
kubevipArgs:
vip_interface: "scbr-100"
```

8. In the network layer of your cluster profile, specify the name of the Network Interface Controllers (NIC) on your Edge hosts to be `scbr-100`. This is the name of the interface Palette creates on your Edge devices to establish the overlay network.

The following are the sections of the packs you need to change depending on which CNI pack you are using:

Expand Down Expand Up @@ -103,19 +112,19 @@ You will not be able to change the network overlay configurations after the clus
</TabItem>
</Tabs>

8. Review the rest of your cluster profile values and make changes as needed. Click on **Next**.
9. Review the rest of your cluster profile values and make changes as needed. Click on **Next**.

9. In the **Cluster Config** stage, toggle on **Enable Overlay Network**. This will prompt you to provide additional configuration for your virtual overlay network.
10. In the **Cluster Config** stage, toggle on **Enable Overlay Network**. This will prompt you to provide additional configuration for your virtual overlay network.

10. In the **Overlay CIDR Range** field, provide a private IP range for your cluster to use. Ensure that this range is not used by others in the same network environment. When you toggle on **Enable Overlay Network**, Palette provides with a default commonly unused range. We suggest you keep the default range unless you have a specific IP range you want to use.
11. In the **Overlay CIDR Range** field, provide a private IP range for your cluster to use. Ensure this range is not used by others in the same network environment. When you toggle on **Enable Overlay Network**, Palette provides a default range that is typically unused. We suggest you keep the default range unless you have a specific IP range you want to use.

:::caution
The overlay CIDR range cannot be changed after the cluster creation.
:::

After you have provided the overlay CIDR, the **VIP** field at the top of the page will be grayed out, and the first IP address in the overlay CIDR range will be used as the Overlay VIP. This VIP is the internal overlay VIP used by the cluster.

11. Finish the rest of the cluster configurations and click **Finish Configuration** to deploy the cluster. For more information, refer to [Create Cluster Definition](../site-deployment/site-installation/cluster-deployment.md).
12. Finish the rest of the cluster configurations and click **Finish Configuration** to deploy the cluster. For more information, refer to [Create Cluster Definition](../site-deployment/site-installation/cluster-deployment.md).

## Validate

Expand All @@ -125,7 +134,7 @@ You will not be able to change the network overlay configurations after the clus

3. Select the host cluster you created to view its details page.

4. Select the **Nodes** tab, in the **Overlay IP Address** column, each host has an overlay IP address within the CIDR range you provided during cluster configuration.
4. Select the **Nodes** tab. For each host, the **Private Ips** column lists an overlay IP address within the CIDR range you provided during cluster configuration.

:::tip
To view the external IP addresses of the edge hosts, from the **Main Menu**, go to **Clusters**, and click the **Edge Hosts** tab. The IP address displayed in the table is the external IP address.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you have specified registry credentials in the `registryCredentials` field in

## Prerequisites

- At least one Edge host with an x86_64 or AMD64 processor architecture.
- At least one Edge host registered with your Palette account.

- A private image registry.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/integrations/byoos.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The BYOS Edge OS pack supports the following parameters.
| `pack.content.images` | Specifies a list of OS images to use with the pack. | list |
| `pack.content.images.image` | An OS image to use with the pack. | string|
| `system.uri` | The system URI specifies the location of BYOOS image. | string|
| `providerCredentials.registry` | Specifies the private registry for the cluster to pull images from | string |
| `providerCredentials.registry` | Specifies the private registry for the cluster from which to pull images. If you are using a Harbor registry, provide the Harbor domain and the project's name. For example, `harbor.spectrocloud.com/default.` If you are using a Docker registry, provide the domain of the registry. For example, `registry-1.docker.io`. | string |
| `providerCredentials.username` | Specifies the username used for authentication with a private registry. | string |
| `providerCredentials.password` | Specifies the password used for authentication with a private registry. | string |
| `providerCredentials.certificate` | Specifies the X509 certificate used for authentication and encryption with a private registry | string |
Expand All @@ -65,7 +65,7 @@ The BYOS Edge OS pack supports the following parameters.
# - image: example.io/my-other-images/example:v1.0.0
# - image: example.io/my-super-other-images/example:v1.0.0
providerCredentials:
registry: domain/project
registry: registry-1.docker.io
user: user
password: ******
certificates: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Spectro CLI tool is a command-line interface to interact with Palette regist

:::info

We recommend using an OCI registry for storing and maintaining your packs. Refer to the [OCI registry](oci-registry.md) section for more information.
We recommend using an OCI registry to store and maintain your packs. Refer to the [OCI registry](registries/oci-registry/oci-registry.md) section for more information.

:::

Expand Down